From c4c1fe2b30f12e22101dd1e19d2b4ac6b5ac75d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Atgeirr=20Fl=C3=B8=20Rasmussen?= Date: Wed, 18 May 2016 22:22:10 +0200 Subject: [PATCH] Rename methods according to code review. --- opm/common/OpmLog/LogBackend.cpp | 8 +++---- opm/common/OpmLog/LogBackend.hpp | 8 +++---- opm/common/OpmLog/MessageLimiter.hpp | 4 ++-- opm/common/OpmLog/StreamLog.cpp | 2 +- tests/test_OpmLog.cpp | 10 ++++---- tests/test_messagelimiter.cpp | 36 ++++++++++++++-------------- 6 files changed, 34 insertions(+), 34 deletions(-) diff --git a/opm/common/OpmLog/LogBackend.cpp b/opm/common/OpmLog/LogBackend.cpp index e8a5180d3..f24f04d5a 100644 --- a/opm/common/OpmLog/LogBackend.cpp +++ b/opm/common/OpmLog/LogBackend.cpp @@ -31,12 +31,12 @@ namespace Opm { { } - void LogBackend::configureDecoration(std::shared_ptr formatter) + void LogBackend::setMessageFormatter(std::shared_ptr formatter) { m_formatter = formatter; } - void LogBackend::configureMessageLimiter(std::shared_ptr limiter) + void LogBackend::setMessageLimiter(std::shared_ptr limiter) { m_limiter = limiter; } @@ -62,7 +62,7 @@ namespace Opm { // Use the message limiter (if any). MessageLimiter::Response res = m_limiter - ? m_limiter->encounteredMessage(messageTag) + ? m_limiter->handleMessageTag(messageTag) : MessageLimiter::Response::PrintMessage; if (res == MessageLimiter::Response::JustOverLimit) { // Special case: add a message to this backend about limit being reached. @@ -72,7 +72,7 @@ namespace Opm { return res == MessageLimiter::Response::PrintMessage; } - std::string LogBackend::decorateMessage(int64_t messageFlag, const std::string& message) + std::string LogBackend::formatMessage(int64_t messageFlag, const std::string& message) { if (m_formatter) { return m_formatter->format(messageFlag, message); diff --git a/opm/common/OpmLog/LogBackend.hpp b/opm/common/OpmLog/LogBackend.hpp index 9a6888ae4..644185688 100644 --- a/opm/common/OpmLog/LogBackend.hpp +++ b/opm/common/OpmLog/LogBackend.hpp @@ -40,11 +40,11 @@ namespace Opm /// Virtual destructor to enable inheritance. virtual ~LogBackend(); - /// Configure how decorateMessage() will modify message strings. - void configureDecoration(std::shared_ptr formatter); + /// Configure how formatMessage() will modify message strings. + void setMessageFormatter(std::shared_ptr formatter); /// Configure how message tags will be used to limit messages. - void configureMessageLimiter(std::shared_ptr limiter); + void setMessageLimiter(std::shared_ptr limiter); /// Add a message to the backend. /// @@ -69,7 +69,7 @@ namespace Opm bool includeMessage(int64_t messageFlag, const std::string& messageTag); /// Return decorated version of message depending on configureDecoration() arguments. - std::string decorateMessage(int64_t messageFlag, const std::string& message); + std::string formatMessage(int64_t messageFlag, const std::string& message); private: int64_t m_mask; diff --git a/opm/common/OpmLog/MessageLimiter.hpp b/opm/common/OpmLog/MessageLimiter.hpp index 664f01ff9..a991efc37 100644 --- a/opm/common/OpmLog/MessageLimiter.hpp +++ b/opm/common/OpmLog/MessageLimiter.hpp @@ -57,7 +57,7 @@ namespace Opm return message_limit_; } - /// Used for encounteredMessage() return type (see that + /// Used for handleMessageTag() return type (see that /// function). enum class Response { @@ -68,7 +68,7 @@ namespace Opm /// tag (count <= limit), respond PrintMessage. /// If (count == limit + 1), respond JustOverLimit. /// If (count > limit + 1), respond OverLimit. - Response encounteredMessage(const std::string& tag) + Response handleMessageTag(const std::string& tag) { if (tag.empty() || message_limit_ == NoLimit) { return Response::PrintMessage; diff --git a/opm/common/OpmLog/StreamLog.cpp b/opm/common/OpmLog/StreamLog.cpp index fb1809a6e..6813cb4cb 100644 --- a/opm/common/OpmLog/StreamLog.cpp +++ b/opm/common/OpmLog/StreamLog.cpp @@ -46,7 +46,7 @@ void StreamLog::close() { void StreamLog::addTaggedMessage(int64_t messageType, const std::string& messageTag, const std::string& message) { if (includeMessage( messageType, messageTag )) { - (*m_ostream) << decorateMessage(messageType, message) << std::endl; + (*m_ostream) << formatMessage(messageType, message) << std::endl; if (m_ofstream.is_open()) { m_ofstream.flush(); } diff --git a/tests/test_OpmLog.cpp b/tests/test_OpmLog.cpp index be63479c7..33fc07b53 100644 --- a/tests/test_OpmLog.cpp +++ b/tests/test_OpmLog.cpp @@ -276,7 +276,7 @@ BOOST_AUTO_TEST_CASE(TestOpmLogWithColors) BOOST_CHECK_EQUAL( true , OpmLog::hasBackend("COUNTER")); BOOST_CHECK_EQUAL( true , OpmLog::hasBackend("STREAM")); - streamLog->configureDecoration(std::make_shared(false, true)); + streamLog->setMessageFormatter(std::make_shared(false, true)); } OpmLog::warning("Warning"); @@ -322,10 +322,10 @@ BOOST_AUTO_TEST_CASE(TestOpmLogWithLimits) BOOST_CHECK_EQUAL( true , OpmLog::hasBackend("STREAM1")); BOOST_CHECK_EQUAL( true , OpmLog::hasBackend("STREAM2")); - streamLog1->configureDecoration(std::make_shared(false, true)); - streamLog1->configureMessageLimiter(std::make_shared(2)); - streamLog2->configureDecoration(std::make_shared(false, true)); - streamLog2->configureMessageLimiter(std::make_shared()); // no limit + streamLog1->setMessageFormatter(std::make_shared(false, true)); + streamLog1->setMessageLimiter(std::make_shared(2)); + streamLog2->setMessageFormatter(std::make_shared(false, true)); + streamLog2->setMessageLimiter(std::make_shared()); // no limit } const std::string tag = "ExampleTag"; diff --git a/tests/test_messagelimiter.cpp b/tests/test_messagelimiter.cpp index c48048989..b076f951f 100644 --- a/tests/test_messagelimiter.cpp +++ b/tests/test_messagelimiter.cpp @@ -47,33 +47,33 @@ BOOST_AUTO_TEST_CASE(Response) { // No limits. MessageLimiter m; - BOOST_CHECK(m.encounteredMessage("tag1") == MessageLimiter::Response::PrintMessage); - BOOST_CHECK(m.encounteredMessage("tag2") == MessageLimiter::Response::PrintMessage); - BOOST_CHECK(m.encounteredMessage("tag1") == MessageLimiter::Response::PrintMessage); - BOOST_CHECK(m.encounteredMessage("tag2") == MessageLimiter::Response::PrintMessage); - BOOST_CHECK(m.encounteredMessage("tag1") == MessageLimiter::Response::PrintMessage); - BOOST_CHECK(m.encounteredMessage("tag2") == MessageLimiter::Response::PrintMessage); + BOOST_CHECK(m.handleMessageTag("tag1") == MessageLimiter::Response::PrintMessage); + BOOST_CHECK(m.handleMessageTag("tag2") == MessageLimiter::Response::PrintMessage); + BOOST_CHECK(m.handleMessageTag("tag1") == MessageLimiter::Response::PrintMessage); + BOOST_CHECK(m.handleMessageTag("tag2") == MessageLimiter::Response::PrintMessage); + BOOST_CHECK(m.handleMessageTag("tag1") == MessageLimiter::Response::PrintMessage); + BOOST_CHECK(m.handleMessageTag("tag2") == MessageLimiter::Response::PrintMessage); } { // Limit == 0. MessageLimiter m(0); - BOOST_CHECK(m.encounteredMessage("tag1") == MessageLimiter::Response::JustOverLimit); - BOOST_CHECK(m.encounteredMessage("tag2") == MessageLimiter::Response::JustOverLimit); - BOOST_CHECK(m.encounteredMessage("tag1") == MessageLimiter::Response::OverLimit); - BOOST_CHECK(m.encounteredMessage("tag2") == MessageLimiter::Response::OverLimit); - BOOST_CHECK(m.encounteredMessage("tag1") == MessageLimiter::Response::OverLimit); - BOOST_CHECK(m.encounteredMessage("tag2") == MessageLimiter::Response::OverLimit); + BOOST_CHECK(m.handleMessageTag("tag1") == MessageLimiter::Response::JustOverLimit); + BOOST_CHECK(m.handleMessageTag("tag2") == MessageLimiter::Response::JustOverLimit); + BOOST_CHECK(m.handleMessageTag("tag1") == MessageLimiter::Response::OverLimit); + BOOST_CHECK(m.handleMessageTag("tag2") == MessageLimiter::Response::OverLimit); + BOOST_CHECK(m.handleMessageTag("tag1") == MessageLimiter::Response::OverLimit); + BOOST_CHECK(m.handleMessageTag("tag2") == MessageLimiter::Response::OverLimit); } { // Limit == 1. MessageLimiter m(1); - BOOST_CHECK(m.encounteredMessage("tag1") == MessageLimiter::Response::PrintMessage); - BOOST_CHECK(m.encounteredMessage("tag2") == MessageLimiter::Response::PrintMessage); - BOOST_CHECK(m.encounteredMessage("tag1") == MessageLimiter::Response::JustOverLimit); - BOOST_CHECK(m.encounteredMessage("tag2") == MessageLimiter::Response::JustOverLimit); - BOOST_CHECK(m.encounteredMessage("tag1") == MessageLimiter::Response::OverLimit); - BOOST_CHECK(m.encounteredMessage("tag2") == MessageLimiter::Response::OverLimit); + BOOST_CHECK(m.handleMessageTag("tag1") == MessageLimiter::Response::PrintMessage); + BOOST_CHECK(m.handleMessageTag("tag2") == MessageLimiter::Response::PrintMessage); + BOOST_CHECK(m.handleMessageTag("tag1") == MessageLimiter::Response::JustOverLimit); + BOOST_CHECK(m.handleMessageTag("tag2") == MessageLimiter::Response::JustOverLimit); + BOOST_CHECK(m.handleMessageTag("tag1") == MessageLimiter::Response::OverLimit); + BOOST_CHECK(m.handleMessageTag("tag2") == MessageLimiter::Response::OverLimit); } }