Add an option to disable the log messages location

By disabling the log locations, the compiler will generate binaries
with lower size

Relates-To: DATASDK-51

Signed-off-by: Mykhailo Kuchma <[email protected]>

Author: mykhailo-kuchma

CMakeLists.txt

@@ -42,6 +42,7 @@ option(OLP_SDK_BUILD_EXTERNAL_DEPS "Download and build external dependencies" ON
 option(OLP_SDK_BUILD_EXAMPLES "Enable examples targets" OFF)
 option(OLP_SDK_MSVC_PARALLEL_BUILD_ENABLE "Enable parallel build on MSVC" ON)
 option(OLP_SDK_DISABLE_DEBUG_LOGGING "Disable debug and trace level logging" OFF)
+option(OLP_SDK_DISABLE_LOCATION_LOGGING "Disable the log location" OFF)
 option(OLP_SDK_ENABLE_DEFAULT_CACHE "Enable default cache implementation based on LevelDB" ON)
 option(OLP_SDK_ENABLE_DEFAULT_CACHE_LMDB "Enable default cache implementation based on LMDB" OFF)
 option(OLP_SDK_ENABLE_ANDROID_CURL "Enable curl based network layer for Android" OFF)

docs/get-started.md

@@ -133,6 +133,7 @@ cmake --build . --target docs
 | `OLP_SDK_BOOST_THROW_EXCEPTION_EXTERNAL` | Defaults to `OFF`. When `OLP_SDK_NO_EXCEPTION` is `ON`, `boost` requires `boost::throw_exception()` to be defined. If enabled, the external definition of `boost::throw_exception()` is used. Otherwise, the library uses own definition. |
 | `OLP_SDK_MSVC_PARALLEL_BUILD_ENABLE` (Windows Only) | Defaults to `ON`. If enabled, the `/MP` compilation flag is added to build the Data SDK using multiple cores. |
 | `OLP_SDK_DISABLE_DEBUG_LOGGING`| Defaults to `OFF`. If enabled, the debug and trace level log messages are not printed. |
+| `OLP_SDK_DISABLE_LOCATION_LOGGING`| Defaults to `OFF`. If enabled, the level messages locations are not generated by compiler.                                                                                                                                                |
 | `OLP_SDK_ENABLE_DEFAULT_CACHE `| Defaults to `ON`. If enabled, the default cache implementation based on the LevelDB backend is enabled. |
 | `OLP_SDK_ENABLE_DEFAULT_CACHE_LMDB `| Defaults to `OFF`. If enabled, the default cache implementation based on the LMDB backend is enabled. |
 | `OLP_SDK_ENABLE_ANDROID_CURL`| Defaults to `OFF`. If enabled, libcurl will be used instead of the Android native HTTP client. |

olp-cpp-sdk-core/CMakeLists.txt

@@ -423,6 +423,11 @@ if (OLP_SDK_DISABLE_DEBUG_LOGGING)
         PUBLIC LOGGING_DISABLE_DEBUG_LEVEL)
 endif()
 
+if (OLP_SDK_DISABLE_LOCATION_LOGGING)
+    target_compile_definitions(${PROJECT_NAME}
+        PUBLIC LOGGING_DISABLE_LOCATION)
+endif()
+
 target_compile_definitions(${PROJECT_NAME}
     PRIVATE ${OLP_SDK_DEFAULT_NETWORK_DEFINITION})
 

olp-cpp-sdk-core/include/olp/core/logging/Log.h

@@ -41,6 +41,15 @@
 /**
  * @brief Gets the current function signature for different compilers.
  */
+#ifdef LOGGING_DISABLE_LOCATION
+
+#define OLP_SDK_LOG_FUNCTION_SIGNATURE ""
+#define OLP_SDK_LOG_FILE ""
+#define OLP_SDK_LOG_LINE 0
+#define OLP_SDK_LOG_FUNCTION ""
+
+#else // LOGGING_DISABLE_LOCATION
+
 #if __GNUC__ >= 3 || defined(__clang__)
 #define OLP_SDK_LOG_FUNCTION_SIGNATURE __PRETTY_FUNCTION__
 #elif defined(_MSC_VER)
@@ -49,6 +58,12 @@
 #define OLP_SDK_LOG_FUNCTION_SIGNATURE __FUNCTION__
 #endif
 
+#define OLP_SDK_LOG_FILE __FILE__
+#define OLP_SDK_LOG_LINE __LINE__
+#define OLP_SDK_LOG_FUNCTION __FUNCTION__
+
+#endif // LOGGING_DISABLE_LOCATION
+
 /**
  * @brief Logs a message using C++ style streams.
  *
@@ -63,8 +78,9 @@
   do {                                                                  \
     std::ostringstream __strm;                                          \
     __strm << message;                                                  \
-    ::olp::logging::Log::logMessage(level, tag, __strm.str(), __FILE__, \
-                                    __LINE__, __FUNCTION__,             \
+    ::olp::logging::Log::logMessage(level, tag, __strm.str(),           \
+                                    OLP_SDK_LOG_FILE, OLP_SDK_LOG_LINE, \
+                                    OLP_SDK_LOG_FUNCTION,               \
                                     OLP_SDK_LOG_FUNCTION_SIGNATURE);    \
   }                                                                     \
   OLP_SDK_CORE_LOOP_ONCE()
@@ -156,8 +172,8 @@
 #define OLP_SDK_DO_LOG_F(level, tag, ...)                                      \
   do {                                                                         \
     std::string __message = ::olp::logging::format(__VA_ARGS__);               \
-    ::olp::logging::Log::logMessage(level, tag, __message, __FILE__, __LINE__, \
-                                    __FUNCTION__,                              \
+    ::olp::logging::Log::logMessage(level, tag, __message, OLP_SDK_LOG_FILE,   \
+                                    OLP_SDK_LOG_LINE, OLP_SDK_LOG_FUNCTION,    \
                                     OLP_SDK_LOG_FUNCTION_SIGNATURE);           \
   }                                                                            \
   OLP_SDK_CORE_LOOP_ONCE()
@@ -392,161 +408,160 @@
  * @brief A namespace for the logging library.
  */
 namespace olp {
-namespace logging {
-class Configuration;
-class FilterGroup;
-
-/**
- * @brief Used for disabled logs at compile time.
- */
-class NullLogStream {
- public:
-  template <typename T>
-
-  /**
-   * @brief The stream operator to print or serialize the given log stream.
-   */
-  NullLogStream& operator<<(const T&) {
-    return *this;
-  }
-};
-
-/**
- * @brief A primary interface for log messages.
- */
-class CORE_API Log {
- public:
-  /**
-   * @brief Configures the log system.
-   *
-   * It overrides the previous configuration.
-   *
-   * @return False if the configuration is invalid.
-   * The configuration does not change in this case.
-   */
-  static bool configure(Configuration configuration);
-
-  /**
-   * @brief Gets a copy of the current configuration.
-   *
-   * Use it to add an appender and reconfigure the system.
-   *
-   * @return A copy of the current configuration.
-   */
-  static Configuration getConfiguration();
-
-  /**
-   * @brief Sets the default log level.
-   *
-   * No messages below this level are displayed unless overridden by
-   * specific log tags.
-   *
-   * @param level The log level.
-   */
-  static void setLevel(Level level);
-
-  /**
-   * @brief Gets the default log level.
-   *
-   * @return The log level.
-   */
-  static Level getLevel();
-
-  /**
-   * @brief Sets the log level for a tag.
-   *
-   * It overrides the default configurations.
-   *
-   * @param level The log level.
-   * @param tag The tag for the log component. If empty, it sets the
-   * default level.
-   */
-  static void setLevel(Level level, const std::string& tag);
-
-  /**
-   * @brief Sets the log level for a tag.
-   *
-   * It overrides the default configurations.
-   *
-   * @param level The log level.
-   * @param tag The tag for the log component. If empty, it sets the
-   * default level.
-   */
-  static void setLevel(const std::string& level, const std::string& tag);
-
-  /**
-   * @brief Gets the log level for a tag.
-   *
-   * @param tag The tag for the log component. If empty, it sets the
-   * default level.
-   *
-   * @return The log level for the tag or `core::None` if the log level is unset.
-   */
-  static boost::optional<Level> getLevel(const std::string& tag);
-
-  /**
-   * @brief Clears the log level for a tag and sets it to
-   * the default value.
-   *
-   * @param tag The tag for the log component.
-   */
-  static void clearLevel(const std::string& tag);
-
-  /**
-   * @brief Clears the log levels for all tags and sets them to
-   * the default value.
-   */
-  static void clearLevels();
-
-  /**
-   * @brief Applies a filter group.
-   *
-   * It clears all the log levels for tags and replaces them
-   * with the levels set in the filter group. If the default log level is set in
-   * the filter group, it is also applied.
-   *
-   * @param filters The filter group to apply.
-   */
-  static void applyFilterGroup(const FilterGroup& filters);
-
-  /**
-   * @brief Checks whether a level is enabled by default.
-   *
-   * @param level The log level.
-   *
-   * @return True if the log is enabled; false otherwise.
-   */
-  static bool isEnabled(Level level);
-
-  /**
-   * @brief Checks whether a log tag is enabled for a level.
-   *
-   * @param tag The tag for the log component.
-   * @param level The log level.
-   *
-   * @return True if the log is enabled; false otherwise.
-   */
-  static bool isEnabled(Level level, const std::string& tag);
-
-  /**
-   * @brief Logs a message to the registered appenders.
-   *
-   * Outputting to the appender depends on whether
-   * the appender is enabled for this level.
-   *
-   * @param level The log level.
-   * @param tag The tag for the log component.
-   * @param message The log message.
-   * @param file The file that generated the message.
-   * @param line The line in the file where the message was logged.
-   * @param function The function that generated the message.
-   * @param fullFunction The fully qualified function that generated the message.
-   */
-  static void logMessage(Level level, const std::string& tag,
-                         const std::string& message, const char* file,
-                         unsigned int line, const char* function,
-                         const char* fullFunction);
-};
-
-}  // namespace logging
-}  // namespace olp
+    namespace logging {
+        class Configuration;
+        class FilterGroup;
+
+        /**
+         * @brief Used for disabled logs at compile time.
+         */
+        class NullLogStream {
+        public:
+            template<typename T>
+
+            /**
+             * @brief The stream operator to print or serialize the given log stream.
+             */
+            NullLogStream &operator<<(const T &) {
+                return *this;
+            }
+        };
+
+        /**
+         * @brief A primary interface for log messages.
+         */
+        class CORE_API Log {
+        public:
+            /**
+             * @brief Configures the log system.
+             *
+             * It overrides the previous configuration.
+             *
+             * @return False if the configuration is invalid.
+             * The configuration does not change in this case.
+             */
+            static bool configure(Configuration configuration);
+
+            /**
+             * @brief Gets a copy of the current configuration.
+             *
+             * Use it to add an appender and reconfigure the system.
+             *
+             * @return A copy of the current configuration.
+             */
+            static Configuration getConfiguration();
+
+            /**
+             * @brief Sets the default log level.
+             *
+             * No messages below this level are displayed unless overridden by
+             * specific log tags.
+             *
+             * @param level The log level.
+             */
+            static void setLevel(Level level);
+
+            /**
+             * @brief Gets the default log level.
+             *
+             * @return The log level.
+             */
+            static Level getLevel();
+
+            /**
+             * @brief Sets the log level for a tag.
+             *
+             * It overrides the default configurations.
+             *
+             * @param level The log level.
+             * @param tag The tag for the log component. If empty, it sets the
+             * default level.
+             */
+            static void setLevel(Level level, const std::string &tag);
+
+            /**
+             * @brief Sets the log level for a tag.
+             *
+             * It overrides the default configurations.
+             *
+             * @param level The log level.
+             * @param tag The tag for the log component. If empty, it sets the
+             * default level.
+             */
+            static void setLevel(const std::string &level, const std::string &tag);
+
+            /**
+             * @brief Gets the log level for a tag.
+             *
+             * @param tag The tag for the log component. If empty, it sets the
+             * default level.
+             *
+             * @return The log level for the tag or `core::None` if the log level is unset.
+             */
+            static boost::optional<Level> getLevel(const std::string &tag);
+
+            /**
+             * @brief Clears the log level for a tag and sets it to
+             * the default value.
+             *
+             * @param tag The tag for the log component.
+             */
+            static void clearLevel(const std::string &tag);
+
+            /**
+             * @brief Clears the log levels for all tags and sets them to
+             * the default value.
+             */
+            static void clearLevels();
+
+            /**
+             * @brief Applies a filter group.
+             *
+             * It clears all the log levels for tags and replaces them
+             * with the levels set in the filter group. If the default log level is set in
+             * the filter group, it is also applied.
+             *
+             * @param filters The filter group to apply.
+             */
+            static void applyFilterGroup(const FilterGroup &filters);
+
+            /**
+             * @brief Checks whether a level is enabled by default.
+             *
+             * @param level The log level.
+             *
+             * @return True if the log is enabled; false otherwise.
+             */
+            static bool isEnabled(Level level);
+
+            /**
+             * @brief Checks whether a log tag is enabled for a level.
+             *
+             * @param tag The tag for the log component.
+             * @param level The log level.
+             *
+             * @return True if the log is enabled; false otherwise.
+             */
+            static bool isEnabled(Level level, const std::string &tag);
+
+            /**
+             * @brief Logs a message to the registered appenders.
+             *
+             * Outputting to the appender depends on whether
+             * the appender is enabled for this level.
+             *
+             * @param level The log level.
+             * @param tag The tag for the log component.
+             * @param message The log message.
+             * @param file The file that generated the message.
+             * @param line The line in the file where the message was logged.
+             * @param function The function that generated the message.
+             * @param fullFunction The fully qualified function that generated the message.
+             */
+            static void logMessage(Level level, const std::string &tag,
+                                   const std::string &message, const char *file,
+                                   unsigned int line, const char *function,
+                                   const char *fullFunction);
+        };
+    } // namespace logging
+} // namespace olp