base_cpp: added log wrapper

base_c/src/log.c

@@ -59,7 +59,7 @@ void embb_log_set_log_function(
   embb_log_global_log_function = func;
 }
 
-static void embb_log_write_internal(
+void embb_log_write_internal(
   char const * channel,
   embb_log_level_t log_level,
   char const * message,
@@ -75,18 +75,20 @@ static void embb_log_write_internal(
       log_context = (void*)stdout;
     }
     switch (log_level) {
-    case EMBB_LOG_LEVEL_INFO:
-      log_level_str = "INFO ";
-      break;
     case EMBB_LOG_LEVEL_ERROR:
       log_level_str = "ERROR";
       break;
+    case EMBB_LOG_LEVEL_WARNING:
+      log_level_str = "WARN ";
+      break;
+    case EMBB_LOG_LEVEL_INFO:
+      log_level_str = "INFO ";
+      break;
     case EMBB_LOG_LEVEL_TRACE:
       log_level_str = "TRACE";
       break;
 
     case EMBB_LOG_LEVEL_NONE:
-    case EMBB_LOG_LEVEL_WARNING:
     default:
       log_level_str = "     ";
       break;

base_cpp/include/embb/base/log.h

+/*
+ * Copyright (c) 2014-2015, Siemens AG. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef EMBB_BASE_LOG_H_
+#define EMBB_BASE_LOG_H_
+
+#include <embb/base/c/log.h>
+
+/**
+ * \defgroup CPP_LOG Logging
+ * \ingroup CPP_BASE
+ * Simple logging facilities.
+ */
+
+namespace embb {
+namespace base {
+
+/**
+ * Simple logging facilities.
+ *
+ * \ingroup CPP_LOG
+ */
+class Log {
+ private:
+  // do not allow construction
+  Log();
+
+ public:
+  /**
+   * Sets the global log level.
+   * This determines what messages will be shown, messages with a more detailed
+   * log level will be filtered out. The default log level is EMBB_LOG_LEVEL_NONE.
+   * \notthreadsafe
+   */ 
+  static void SetLogLevel(
+    embb_log_level_t log_level           /**< [in] Log level to use for
+                                              filtering */
+  );
+
+  /**
+   * Sets the global logging function.
+   * The logging function implements the mechanism for transferring log messages
+   * to their destination. \c context is a pointer to data the user needs in the
+   * function to determine where the messages should go (may be NULL if no
+   * additional data is needed). The default logging function is
+   * embb_log_write_file() with context set to \c stdout.
+   * \see embb_log_function_t
+   * \ingroup C_LOG
+   * \notthreadsafe
+   */
+  static void SetLogFunction(
+    void * context,                      /**< [in] User context to supply as the
+                                              first parameter of the logging
+                                              function*/
+    embb_log_function_t func             /**< [in] The logging function */
+  );
+
+  /**
+   * Logs a message to the given channel with the specified log level.
+   * If the log level is greater than the configured log level for the channel,
+   * the message will be ignored.
+   * \see  embb::base::Log::SetLogLevel, embb::base::Log::SetLogFunction
+   * \threadsafe
+   */
+  static void Write(
+    char const * channel,                /**< [in] User specified channel id
+                                              for filtering the log later on.
+                                              Might be NULL, channel identifier
+                                              will be "global" in that case */
+    embb_log_level_t log_level,          /**< [in] Log level to use */
+    char const * message,                /**< [in] Message to convey, may use
+                                              \c printf style formatting */
+    ...                                  /**< Additional parameters determined by
+                                              the format specifiers in
+                                              \c message */
+  );
+
+  /**
+   * Logs a message to the given channel with EMBB_LOG_LEVEL_TRACE.
+   * In non-debug builds, this function does nothing.
+   * \see embb::base::Log::Write
+   * \threadsafe
+   */
+  static void Trace(
+    char const * channel,                /**< [in] User specified channel id */
+    char const * message,                /**< [in] Message to convey, may use
+                                              \c printf style formatting */
+    ...                                  /**< Additional parameters determined by
+                                              the format specifiers in
+                                              \c message */
+  );
+
+  /**
+   * Logs a message to the given channel with EMBB_LOG_LEVEL_INFO.
+   * In non-debug builds, this function does nothing.
+   * \see embb::base::Log::Write
+   * \threadsafe
+   */
+  static void Info(
+    char const * channel,                /**< [in] User specified channel id */
+    char const * message,                /**< [in] Message to convey, may use
+                                              \c printf style formatting */
+    ...                                  /**< Additional parameters determined by
+                                              the format specifiers in
+                                              \c message */
+  );
+
+  /**
+   * Logs a message to the given channel with EMBB_LOG_LEVEL_WARNING.
+   * \see embb::base::Log::Write
+   * \threadsafe
+   */
+  static void Warning(
+    char const * channel,                /**< [in] User specified channel id */
+    char const * message,                /**< [in] Message to convey, may use
+                                              \c printf style formatting */
+    ...                                  /**< Additional parameters determined by
+                                              the format specifiers in
+                                              \c message */
+  );
+
+  /**
+   * Logs a message to the given channel with EMBB_LOG_LEVEL_ERROR.
+   * \see embb::base::Log::Write
+   * \threadsafe
+   */
+  static void Error(
+    char const * channel,                /**< [in] User specified channel id */
+    char const * message,                /**< [in] Message to convey, may use
+                                              \c printf style formatting */
+    ...                                  /**< Additional parameters determined by
+                                              the format specifiers in
+                                              \c message */
+  );
+
+};
+
+} // namespace base
+} // namespace embb
+
+#endif /* EMBB_BASE_LOG_H_ */ 

base_cpp/src/log.cc

+/*
+ * Copyright (c) 2014-2015, Siemens AG. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <embb/base/log.h>
+#include <embb/base/c/internal/unused.h>
+
+#include <cstdarg>
+
+extern "C" void embb_log_write_internal(
+  char const * channel,
+  embb_log_level_t log_level,
+  char const * message,
+  va_list argp);
+
+namespace embb {
+namespace base {
+
+Log::Log() {
+  // empty
+}
+
+void Log::SetLogLevel(
+  embb_log_level_t log_level) {
+  embb_log_set_log_level(log_level);
+}
+
+void Log::SetLogFunction(
+  void * context,
+  embb_log_function_t func) {
+  embb_log_set_log_function(context, func);
+}
+
+void Log::Write(
+  char const * channel,
+  embb_log_level_t log_level,
+  char const * message,
+  ...) {
+  va_list argp;
+  va_start(argp, message);
+  embb_log_write_internal(channel, log_level, message, argp);
+  va_end(argp);
+}
+
+void Log::Trace(
+  char const * channel,
+  char const * message,
+  ...) {
+#if defined(EMBB_DEBUG)
+  va_list argp;
+  va_start(argp, message);
+  embb_log_write_internal(channel, EMBB_LOG_LEVEL_TRACE, message, argp);
+  va_end(argp);
+#else
+  EMBB_UNUSED(channel);
+  EMBB_UNUSED(message);
+#endif
+}
+
+void Log::Info(
+  char const * channel,
+  char const * message,
+  ...) {
+#if defined(EMBB_DEBUG)
+  va_list argp;
+  va_start(argp, message);
+  embb_log_write_internal(channel, EMBB_LOG_LEVEL_INFO, message, argp);
+  va_end(argp);
+#else
+  EMBB_UNUSED(channel);
+  EMBB_UNUSED(message);
+#endif
+}
+
+void Log::Warning(
+  char const * channel,
+  char const * message,
+  ...) {
+  va_list argp;
+  va_start(argp, message);
+  embb_log_write_internal(channel, EMBB_LOG_LEVEL_WARNING, message, argp);
+  va_end(argp);
+}
+
+void Log::Error(
+  char const * channel,
+  char const * message,
+  ...) {
+  va_list argp;
+  va_start(argp, message);
+  embb_log_write_internal(channel, EMBB_LOG_LEVEL_ERROR, message, argp);
+  va_end(argp);
+}
+
+} // namespace base
+} // namespace embb