Add XmlFileLogger

Author: florianbecker

README.md

@@ -14,3 +14,4 @@ make -j`nproc`
 - **Logger** - General definition and logging to /dev/null.
 - **LoggerFactory** - Loggin to all possible types, as configured.
 - **StdLogger** - Loggin to stdout.
+- **XmlFileLogger** - Loggin to a file as xml.

examples/logger/main.cpp

@@ -34,9 +34,10 @@
 
 /* modern.cpp.logger */
 //#include <FileLogger.h>
-#include <LoggerFactory.h>
+//#include <LoggerFactory.h>
 //#include <Logger.h>
 //#include <StdLogger.h>
+#include <XmlFileLogger.h>
 
 using namespace vx;
 
@@ -93,8 +94,13 @@ int main() {
   FileLogger logger( configuration );
   logger.log( logMessage, Severity::Fatal ); */
 
+  /* Log to file */
+  std::unordered_map<std::string, std::string> configuration = { { "color", "" }, {"filename", "logger.xml"} };
+  XmlFileLogger logger( configuration );
+  logger.log( logMessage, Severity::Fatal );
+
   /* Log with logging factory */
-  vx::LogFatal( logMessage );
+//  vx::LogFatal( logMessage );
 
   return EXIT_SUCCESS;
 }

source/CMakeLists.txt

@@ -44,6 +44,9 @@ add_library(${PROJECT_NAME}
   LoggerFactory.h
   StdLogger.cpp
   StdLogger.h
+  StdLogger.cpp
+  XmlFileLogger.cpp
+  XmlFileLogger.h
 )
 
 target_include_directories(${PROJECT_NAME} PUBLIC ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}../3rdparty)

source/XmlFileLogger.cpp

@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2020 Florian Becker <[email protected]> (VX APPS).
+ * 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.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its
+ *    contributors may be used to endorse or promote products derived from
+ *    this software without specific prior written permission.
+ *
+ * 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.
+ */
+
+/* magic enum */
+#include <magic_enum.hpp>
+
+/* local header */
+#include "XmlFileLogger.h"
+
+namespace vx {
+
+  XmlFileLogger::XmlFileLogger( const std::unordered_map<std::string, std::string> &_config )
+    : FileLogger( _config ) {}
+
+  void XmlFileLogger::log( const std::string &_message, const Severity _severity ) {
+
+    if ( avoidLogAbove > _severity ) {
+
+      return;
+    }
+
+    std::string output;
+    output.reserve( _message.length() + 64 );
+    output.append( "<entry>" );
+    output.append( "<timestamp>" );
+    output.append( timestamp() );
+    output.append( "</timestamp>" );
+
+    std::string severity = std::string( magic_enum::enum_name( _severity ) );
+    std::transform( severity.begin(), severity.end(), severity.begin(), []( unsigned char c ) { return std::toupper( c ); } );
+    output.append( "<severity>" );
+    output.append( severity );
+    output.append( "</severity>" );
+    output.append( "<message>" );
+    output.append( _message );
+    output.append( "</message>" );
+    output.append( "</entry>\n" );
+    FileLogger::log( output );
+  }
+}

source/XmlFileLogger.h

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2020 Florian Becker <[email protected]> (VX APPS).
+ * 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.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its
+ *    contributors may be used to endorse or promote products derived from
+ *    this software without specific prior written permission.
+ *
+ * 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.
+ */
+
+#pragma once
+
+/* stl header */
+#include <string>
+#include <unordered_map>
+
+/* local header */
+#include "FileLogger.h"
+
+/**
+ * @brief vx (VX Apps) namespace.
+ */
+namespace vx {
+
+  /**
+   * @brief The FileLogger class for writing messages to file.
+   * @author Florian Becker <fb\@vxapps.com> (VX APPS)
+   */
+  class XmlFileLogger : public FileLogger {
+
+  public:
+    /**
+     * @brief Default constructor for XmlFileLogger.
+     * @param _configuration   Logger configuration.
+     */
+    explicit XmlFileLogger( const std::unordered_map<std::string, std::string> &_config );
+
+    /**
+     * @brief Build the log message.
+     * @param _message   Message to log.
+     * @param _severity   Severity level of the message.
+     */
+    virtual void log( const std::string &_message, const Severity _severity ) override;
+  };
+}