Changeset 149

Timestamp:

05/15/09 12:30:27 (3 years ago)

Author:

ddangelo

Message:

Logging Macro, which can controlled via LOG_LEVEL options in localdefs added

Location:

trunk

Files:

• avango-build/src/avango/build/__init__.py (modified) (1 diff)
• avango-core/SConscript (modified) (1 diff)
• avango-core/include/avango/Config.h.in (modified) (1 diff)
• avango-core/include/avango/logging/Logger.h (modified) (5 diffs)
• avango-core/src/avango/logging/Logger.cpp (modified) (4 diffs)
• avango-core/src/avango/logging/tests/TestLogging.cpp (modified) (2 diffs)

trunk/avango-build/src/avango/build/__init__.py

@@ -148 +148 @@
         scons.BoolOption('DEBUG', 'Debug build option', False),
         scons.BoolOption('TRACE_LOGGING', 'Enable/Disable trace log level', False),
+        scons.EnumOption('LOG_LEVEL', 'Support for higher log levels will be compiled out', "DEBUG",
+                         ("FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE")),
         scons.PathOption('BINARY_PATH',
                    'Additional binary search paths',

trunk/avango-core/SConscript

@@ -33 +33 @@
     'PREFIX': avango.build.get_prefix().abspath,
     'AVANGO_DEBUG': int(local_env['DEBUG']),
+    'AVANGO_LOG_LEVEL': local_env['LOG_LEVEL'],
     'AVANGO_DISTRIBUTION_SUPPORT': int(local_env['DISTRIBUTION_SUPPORT']),
     'PKG_CONFIG_REQUIRES': '',

trunk/avango-core/include/avango/Config.h.in

@@ -38 +38 @@
 #endif
 
+#define AVANGO_LOG_LEVEL av::logging::%(AVANGO_LOG_LEVEL)s
+
 #if %(AVANGO_DISTRIBUTION_SUPPORT)s
 #define AVANGO_DISTRIBUTION_SUPPORT 1

trunk/avango-core/include/avango/logging/Logger.h

@@ -45 +45 @@
 
 #include <avango/Assert.h>
+#include <avango/Config.h>
 #include <avango/logging/Level.h>
 #include <avango/logging/LoggerManager.h>
@@ -243 +244 @@
        * Returns the name of this logger.
        */
-      AV_DLL const std::string& getName();
+      AV_DLL const std::string& getName() const;
 
       /**
        * Returns true if the logger has a parent logger.
        */
-      AV_DLL bool hasParent();
+      AV_DLL bool hasParent() const;
 
       /**
@@ -257 +258 @@
 
       /**
+       * Returns the parent logger of this logger.
+       * \throw std::logic_error If the logger has no parents (which means it is the root logger).
+       */
+      AV_DLL const Logger& getParent() const;
+
+      /**
        * Get level of this logger. Only messages >= this level are logged
        */
-      AV_DLL Level getLevel();
+      AV_DLL Level getLevel() const;
 
       /**
@@ -294 +301 @@
        */
       AV_DLL void removeAllAppenders();
+
+      /**
+       * Check if this logger (or one of its parents) has at least one appender
+       */
+      AV_DLL bool isActive(Level level) const;
 
       /**
@@ -405 +417 @@
 #endif
 
+#define AVANGO_LOG(logger, level, message)\
+  if ((level <= AVANGO_LOG_LEVEL) && (logger.isActive(level)))\
+    logger.log(level, message);
+
 #endif // #if !defined(AVANGO_LOGGING_LOGGER_H)

trunk/avango-core/src/avango/logging/Logger.cpp

@@ -160 +160 @@
 
 const std::string&
-av::logging::Logger::getName()
+av::logging::Logger::getName() const
 {
   return mName;
@@ -166 +166 @@
 
 bool
-av::logging::Logger::hasParent()
+av::logging::Logger::hasParent() const
 {
   return mParent;
 }
 
-av::logging::Logger&
-av::logging::Logger::getParent()
+const av::logging::Logger&
+av::logging::Logger::getParent() const
 {
   if (mParent)
@@ -186 +186 @@
 }
 
+av::logging::Logger&
+av::logging::Logger::getParent()
+{
+  if (mParent)
+  {
+    return *mParent;
+  }
+  else
+  {
+    AV_ASSERT(this == &getRootLogger());
+    throw std::logic_error("av::logging::Logger::getParent: Logger has no parent.");
+    return *this;
+  }
+}
+
 av::logging::Level
-av::logging::Logger::getLevel()
+av::logging::Logger::getLevel() const
 {
   return mLevel;
@@ -229 +244 @@
   boost::mutex::scoped_lock lock(mAppenderMutex);
   mAppenders.clear();
+}
+
+bool
+av::logging::Logger::isActive(Level level) const
+{
+  return ( (!mAppenders.empty() && level <= mLevel) || getParent().isActive(level));
 }
 

trunk/avango-core/src/avango/logging/tests/TestLogging.cpp

@@ -192 +192 @@
   }
 
+  TEST(isActive)
+  {
+    av::Logger& child = av::Logger::getLogger("useLoggerHierarchy::Node");
+    av::Logger& parent = av::Logger::getLogger("useLoggerHierarchy");
+
+    boost::shared_ptr<av::logging::Appender> file_app(new av::logging::FileAppender(filename));
+    parent.addAppender(file_app);
+
+    parent.setLevel(av::logging::ERROR);
+    child.setLevel(av::logging::FATAL);
+
+    CHECK(child.isActive(av::logging::ERROR));
+  }
+
+  TEST(LOGMacroSuccessfulLogging)
+  {
+    av::Logger& logger = av::Logger::getLogger("useLoggerHierarchy");
+    std::ostringstream os;
+    boost::shared_ptr<av::logging::Appender> stream_app(new av::logging::StreamAppender(os));
+    logger.addAppender(stream_app);
+    logger.setLevel(av::logging::ERROR);
+
+    AVANGO_LOG(logger, av::logging::ERROR, "Test");
+
+    CHECK(!os.str().empty());
+  }
+
+  TEST(LOGMacroUnsuccessfulLogging)
+  {
+    av::Logger& logger = av::Logger::getLogger("useLoggerHierarchy");
+    std::ostringstream os;
+    boost::shared_ptr<av::logging::Appender> stream_app(new av::logging::StreamAppender(os));
+    logger.addAppender(stream_app);
+    logger.setLevel(av::logging::ERROR);
+
+    AVANGO_LOG(logger, av::logging::WARN, "Test");
+
+    CHECK(os.str().empty());
+  }
+
 } // namespace
 
@@ -198 +238 @@
 int main()
 {
-  //av::getRootLogger().addConsoleAppender();
   return UnitTest::RunAllTests();
 }