Add availability to build Jinja2C++ as a shared library

Author: flexferrum

.github/workflows/linux-build.yml

@@ -23,6 +23,7 @@ jobs:
         compiler: [gcc-8, gcc-6, gcc-7, gcc-5, gcc-9]
         base-flags: ["", -DJINJA2CPP_CXX_STANDARD=17]
         build-config: [Release, Debug]
+        build-shared: [TRUE, FALSE]
 
         include:
           - compiler: gcc-8
@@ -62,9 +63,11 @@ jobs:
         export EXTRA_FLAGS="${INPUT_BASE_FLAGS} ${INPUT_EXTRA_FLAGS}"
 
     - name: Build
+      env:
+        INPUT_BUILD_SHARED: ${{ matrix.build-shared }}
       run: |
         mkdir -p .build && cd .build
-        cmake $CMAKE_OPTS -DCMAKE_BUILD_TYPE=$BUILD_CONFIG -DCMAKE_CXX_FLAGS=$CMAKE_CXX_FLAGS -DJINJA2CPP_DEPS_MODE=internal $EXTRA_FLAGS .. && cmake --build . --config $BUILD_CONFIG --target all -- -j4
+        cmake $CMAKE_OPTS -DCMAKE_BUILD_TYPE=$BUILD_CONFIG -DCMAKE_CXX_FLAGS=$CMAKE_CXX_FLAGS -DJINJA2CPP_DEPS_MODE=internal -DJINJA2CPP_BUILD_SHARED=$INPUT_BUILD_SHARED  $EXTRA_FLAGS .. && cmake --build . --config $BUILD_CONFIG --target all -- -j4
 
     - name: Test
       run: |

.github/workflows/windows-build.yml

@@ -24,6 +24,7 @@ jobs:
         build-config: [Release, Debug]
         build-platform: [x86, x64]
         build-runtime: ["", /MT, /MD]
+        build-shared: [TRUE, FALSE]
 
         include:
           - compiler: msvc-2017
@@ -57,6 +58,7 @@ jobs:
         INPUT_COMPILER: ${{ matrix.compiler }}
         INPUT_BASE_FLAGS: ${{ matrix.base-flags }}
         INPUT_BUILD_CONFIG: ${{ matrix.build-config }}
+        INPUT_BUILD_SHARED: ${{ matrix.build-shared }}
         INPUT_EXTRA_FLAGS: ${{ matrix.extra_flags }}
         INPUT_BUILD_PLATFORM: ${{ matrix.build-platform }}
         INPUT_BUILD_RUNTIME: ${{ matrix.build-runtime }}
@@ -66,7 +68,7 @@ jobs:
         call "%VC_VARS%"
         mkdir -p .build
         cd .build
-        cmake .. -G "%INPUT_GENERATOR%" -DCMAKE_BUILD_TYPE=%INPUT_BUILD_CONFIG% -DJINJA2CPP_MSVC_RUNTIME_TYPE="%INPUT_BUILD_RUNTIME%" -DJINJA2CPP_DEPS_MODE=external-boost %INPUT_BASE_FLAGS% %INPUT_EXTRA_FLAGS%
+        cmake .. -G "%INPUT_GENERATOR%" -DCMAKE_BUILD_TYPE=%INPUT_BUILD_CONFIG% -DJINJA2CPP_MSVC_RUNTIME_TYPE="%INPUT_BUILD_RUNTIME%" -DJINJA2CPP_DEPS_MODE=external-boost -DJINJA2CPP_BUILD_SHARED=%INPUT_BUILD_SHARED% %INPUT_BASE_FLAGS% %INPUT_EXTRA_FLAGS%
         cmake --build . --config %INPUT_BUILD_CONFIG%
 
     - name: Test

CMakeLists.txt

@@ -21,6 +21,10 @@ option(JINJA2CPP_STRICT_WARNINGS "Enable additional warnings and treat them as e
 option(JINJA2CPP_BUILD_SHARED "Build shared linkage version of Jinja2Cpp" OFF)
 option(JINJA2CPP_PIC "Control -fPIC option for library build" OFF)
 
+if (DEFINED BUILD_SHARED_LIBS)
+    set(JINJA2CPP_BUILD_SHARED BUILD_SHARED_LIBS)
+endif ()
+
 if (NOT JINJA2CPP_DEPS_MODE)
     set (JINJA2CPP_DEPS_MODE "internal")
 endif ()
@@ -70,10 +74,15 @@ if(NOT ${JINJA2CPP_WITH_SANITIZERS} STREQUAL "none")
 endif()
 
 if (UNIX)
-	if (JINJA2CPP_PIC OR CONAN_CMAKE_POSITION_INDEPENDENT_CODE)
-		set(GCC_CXX_FLAGS ${GCC_CXX_FLAGS} -fPIC)
-		set(CLANG_CXX_FLAGS ${CLANG_CXX_FLAGS} -fPIC)
-	endif ()
+    if (JINJA2CPP_PIC OR CONAN_CMAKE_POSITION_INDEPENDENT_CODE)
+        set(GCC_CXX_FLAGS ${GCC_CXX_FLAGS} -fPIC)
+        set(CLANG_CXX_FLAGS ${CLANG_CXX_FLAGS} -fPIC)
+    endif ()
+
+    if (DEFINED CONAN_SHARED_LINKER_FLAGS)
+        set(GCC_CXX_FLAGS ${GCC_CXX_FLAGS} -Wl,${CONAN_SHARED_LINKER_FLAGS})
+        set(CLANG_CXX_FLAGS ${CLANG_CXX_FLAGS} -Wl,${CONAN_SHARED_LINKER_FLAGS})
+    endif ()
 else ()
     set(GCC_CXX_FLAGS ${GCC_CXX_FLAGS} "-Wa,-mbig-obj" -O1)
     if (${CMAKE_CXX_COMPILER_ID} MATCHES "GNU")
@@ -113,8 +122,10 @@ endif()
 
 if (JINJA2CPP_BUILD_SHARED)
     set(LIB_LINK_TYPE SHARED)
+    message(STATUS "Jinja2C++ library type: SHARED")
 else()
     set(LIB_LINK_TYPE STATIC)
+    message(STATUS "Jinja2C++ library type: STATIC")
 endif()
 
 include(collect_sources)
@@ -186,7 +197,11 @@ elseif (${CMAKE_CXX_COMPILER_ID} MATCHES "MSVC")
     target_compile_options(${LIB_TARGET_NAME} PRIVATE ${MSVC_CXX_FLAGS})
 endif ()
 
-target_compile_definitions(${LIB_TARGET_NAME} PUBLIC BOOST_SYSTEM_NO_DEPRECATED BOOST_ERROR_CODE_HEADER_ONLY)
+target_compile_definitions(${LIB_TARGET_NAME} PUBLIC -DBOOST_SYSTEM_NO_DEPRECATED -DBOOST_ERROR_CODE_HEADER_ONLY)
+
+if (JINJA2CPP_BUILD_SHARED)
+    target_compile_definitions(${LIB_TARGET_NAME} PRIVATE -DJINJA2CPP_BUILD_AS_SHARED PUBLIC -DJINJA2CPP_LINK_AS_SHARED)
+endif ()
 
 set_target_properties(${LIB_TARGET_NAME} PROPERTIES
         VERSION ${PROJECT_VERSION}

cmake/public/jinja2cpp-config.cmake.in

@@ -57,6 +57,11 @@ set_target_properties(jinja2cpp PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES "${_IMPORT_PREFIX}/include"
 )
 
+if (JINJA2CPP_BUILD_SHARED)
+    target_compile_definitions(jinja2cpp PUBLIC -DJINJA2CPP_LINK_AS_SHARED)
+else()
+
+
 # INTERFACE_LINK_LIBRARIES "nonstd::expected-lite;nonstd::variant-lite;nonstd::value_ptr-lite;nonstd::optional-lite;\$<LINK_ONLY:boost::variant>;\$<LINK_ONLY:boost::filesystem>;\$<LINK_ONLY:boost::algorithm>"
 
 if(CMAKE_VERSION VERSION_LESS 2.8.12)

include/jinja2cpp/config.h

@@ -0,0 +1,27 @@
+#ifndef JINJA2CPP_CONFIG_H
+#define JINJA2CPP_CONFIG_H
+
+// The Jinja2C++ library version in the form major * 10000 + minor * 100 + patch.
+#define JINJA2CPP_VERSION 10100
+
+#ifdef _WIN32
+#define JINJA2_DECLSPEC(S) __declspec(S)
+#if _MSC_VER
+#pragma warning(disable : 4251)
+#endif
+#else
+#define JINJA2_DECLSPEC(S)
+#endif
+
+#ifdef JINJA2CPP_BUILD_AS_SHARED
+#define JINJA2CPP_EXPORT JINJA2_DECLSPEC(dllexport)
+#define JINJA2CPP_SHARED_LIB
+#elif JINJA2CPP_LINK_AS_SHARED
+#define JINJA2CPP_EXPORT JINJA2_DECLSPEC(dllimport)
+#define JINJA2CPP_SHARED_LIB
+#else
+#define JINJA2CPP_EXPORT
+#define JINJA2CPP_STATIC_LIB
+#endif
+
+#endif // JINJA2CPP_CONFIG_H

include/jinja2cpp/error_info.h

@@ -1,11 +1,12 @@
 #ifndef JINJA2CPP_ERROR_INFO_H
 #define JINJA2CPP_ERROR_INFO_H
 
+#include "config.h"
 #include "value.h"
 
 #include <iostream>
-#include <vector>
 #include <type_traits>
+#include <vector>
 
 namespace jinja2
 {
@@ -165,13 +166,10 @@ class ErrorInfoTpl
      *
      * @return Vector with extra error params
      */
-    auto& GetExtraParams() const
-    {
-        return m_errorData.extraParams;
-    }
+    auto& GetExtraParams() const { return m_errorData.extraParams; }
 
     //! Convert error to the detailed string representation
-    std::basic_string<CharT> ToString() const;
+    JINJA2CPP_EXPORT std::basic_string<CharT> ToString() const;
 
 private:
     Data m_errorData;
@@ -180,8 +178,8 @@ class ErrorInfoTpl
 using ErrorInfo = ErrorInfoTpl<char>;
 using ErrorInfoW = ErrorInfoTpl<wchar_t>;
 
-std::ostream& operator << (std::ostream& os, const ErrorInfo& res);
-std::wostream& operator << (std::wostream& os, const ErrorInfoW& res);
+JINJA2CPP_EXPORT std::ostream& operator<<(std::ostream& os, const ErrorInfo& res);
+JINJA2CPP_EXPORT std::wostream& operator<<(std::wostream& os, const ErrorInfoW& res);
 } // jinja2
 
 #endif // JINJA2CPP_ERROR_INFO_H

include/jinja2cpp/filesystem_handler.h

@@ -1,14 +1,16 @@
 #ifndef JINJA2CPP_FILESYSTEM_HANDLER_H
 #define JINJA2CPP_FILESYSTEM_HANDLER_H
 
-#include <nonstd/variant.hpp>
+#include "config.h"
+
 #include <nonstd/optional.hpp>
+#include <nonstd/variant.hpp>
 
+#include <chrono>
 #include <iostream>
 #include <memory>
 #include <string>
 #include <unordered_map>
-#include <chrono>
 
 namespace jinja2
 {
@@ -26,7 +28,7 @@ using WCharFileStreamPtr = FileStreamPtr<wchar_t>;
  * So, the exact type (ex. `ifstream`, `istringstream` etc.) of input stream is unspecified. In order to delete stream object correctly returned pointer
  * provide the custom deleter which should properly delete the stream object.
  */
-class IFilesystemHandler
+class JINJA2CPP_EXPORT IFilesystemHandler
 {
 public:
     //! Destructor
@@ -73,7 +75,7 @@ using FilesystemHandlerPtr = std::shared_ptr<IFilesystemHandler>;
  * This filesystem handler implements the simple dictionary object which maps name of the file to it's content. New files can be added by \ref AddFile
  * methods. Content of the files automatically converted to narrow/wide strings representation if necessary.
  */
-class MemoryFileSystem : public IFilesystemHandler
+class JINJA2CPP_EXPORT MemoryFileSystem : public IFilesystemHandler
 {
 public:
     /*!
@@ -114,7 +116,7 @@ class MemoryFileSystem : public IFilesystemHandler
  * This filesystem handler is an interface to the real file system. Root directory for file name mapping provided as a constructor argument. Each name (path) of
  * the file to open is appended to the root directory path and then passed to the stream open methods.
  */
-class RealFileSystem : public IFilesystemHandler
+class JINJA2CPP_EXPORT RealFileSystem : public IFilesystemHandler
 {
 public:
     /*!

include/jinja2cpp/template.h

@@ -1,20 +1,22 @@
 #ifndef JINJA2_TEMPLATE_H
 #define JINJA2_TEMPLATE_H
 
+#include "config.h"
 #include "error_info.h"
 #include "value.h"
 
 #include <nonstd/expected.hpp>
 
-#include <string>
 #include <iostream>
 #include <memory>
+#include <string>
 
 namespace jinja2
 {
-class ITemplateImpl;
-class TemplateEnv;
-template<typename CharT> class TemplateImpl;
+class JINJA2CPP_EXPORT ITemplateImpl;
+class JINJA2CPP_EXPORT TemplateEnv;
+template<typename CharT>
+class TemplateImpl;
 template<typename U>
 using Result = nonstd::expected<U, ErrorInfo>;
 template<typename U>
@@ -43,13 +45,16 @@ struct MetadataInfo
  * std::string result = tpl.RenderAsString(ValuesMap{}).value();
  * ```
  */
-class Template
+class JINJA2CPP_EXPORT Template
 {
 public:
     /*!
      * \brief Default constructor
      */
-    Template() : Template(nullptr) {}
+    Template()
+        : Template(nullptr)
+    {
+    }
     /*!
      * \brief Initializing constructor
      *
@@ -165,13 +170,16 @@ class Template
  * std::string result = tpl.RenderAsString(ValuesMap{}).value();
  * ```
 */
-class TemplateW
+class JINJA2CPP_EXPORT TemplateW
 {
 public:
     /*!
      * \brief Default constructor
      */
-    TemplateW() : TemplateW(nullptr) {}
+    TemplateW()
+        : TemplateW(nullptr)
+    {
+    }
     /*!
      * \brief Initializing constructor
      *

include/jinja2cpp/template_env.h

@@ -1,13 +1,13 @@
 #ifndef JINJA2CPP_TEMPLATE_ENV_H
 #define JINJA2CPP_TEMPLATE_ENV_H
 
+#include "config.h"
 #include "error_info.h"
-
 #include "filesystem_handler.h"
 #include "template.h"
 
-#include <unordered_map>
 #include <shared_mutex>
+#include <unordered_map>
 
 namespace jinja2
 {
@@ -59,7 +59,7 @@ struct Settings
  * It's possible to load templates from the environment via \ref LoadTemplate or \ref LoadTemplateW methods
  * or to pass instance of the environment directly to the \ref Template via constructor.
  */
-class TemplateEnv
+class JINJA2CPP_EXPORT TemplateEnv
 {
 public:
     using TimePoint = std::chrono::system_clock::time_point;

test/rapid_json_serializer_test.cpp

@@ -1,3 +1,5 @@
+#include <jinja2cpp/config.h>
+#ifndef JINJA2CPP_SHARED_LIB
 #include "../src/rapid_json_serializer.h"
 #include "gtest/gtest.h"
 
@@ -56,11 +58,12 @@ TEST(RapidJsonSerializerTest, SerializeComplexTypesWithIndention)
     const auto jsonValue = document.CreateValue(CreateMapAdapter(std::move(params)));
 
     auto indentedDocument =
-R"({
+      R"({
     "map": {
         "array": [1, 2, 3]
     }
 })";
 
     EXPECT_EQ(indentedDocument, jsonValue.AsString(4));
 }
+#endif