Merge pull request #1001 from redboltz/minimal_support_for_no_boost

Minimall supported build without boost.

Author: redboltz

.github/workflows/gha.yml

@@ -149,6 +149,7 @@ jobs:
           4)
             export CXX="clang++-10"
             export MSGPACK_CXX_VERSION="MSGPACK_CXX20=ON"
+            export NO_BOOST="-DMSGPACK_NO_BOOST"
             ;;
           5)
             export CXX="g++-10"
@@ -183,7 +184,7 @@ jobs:
         esac
 
         # build and test
-        CMAKE_CXX_COMPILER="$CXX" CXXFLAGS="-Werror -g ${SANITIZE}" ci/build_cmake.sh || exit 1
+        CMAKE_CXX_COMPILER="$CXX" CXXFLAGS="-Werror -g ${SANITIZE} ${NO_BOOST}" ci/build_cmake.sh || exit 1
         cat Files.cmake| grep ".*\.[h|hpp]" | perl -pe 's/ //g' | sort > tmp1  && find include -name "*.h" -o -name "*.hpp" | sort > tmp2 && diff tmp1 tmp2
 
   windows:

CMakeLists.txt

@@ -22,6 +22,7 @@ OPTION (MSGPACK_CXX17 "Using c++17 compiler" OFF)
 OPTION (MSGPACK_CXX20 "Using c++20 compiler" OFF)
 
 OPTION (MSGPACK_32BIT            "32bit compile"                        OFF)
+OPTION (MSGPACK_USE_BOOST        "Use Boost libraried"                  ON)
 OPTION (MSGPACK_USE_X3_PARSE     "Use Boost X3 parse"                   OFF)
 OPTION (MSGPACK_BUILD_TESTS      "Build tests"                          OFF)
 OPTION (MSGPACK_BUILD_DOCS       "Build Doxygen documentation"          ON)
@@ -62,14 +63,20 @@ IF (MSGPACK_32BIT)
     ENDIF ()
 ENDIF ()
 
-SET (Boost_USE_MULTITHREADED ON)
+IF (MSGPACK_USE_BOOST)
+    SET (Boost_USE_MULTITHREADED ON)
 
-IF (MSGPACK_USE_STATIC_BOOST)
-    MESSAGE (STATUS "Staticly linking with Boost")
-    SET (Boost_USE_STATIC_LIBS TRUE)
+    IF (MSGPACK_USE_STATIC_BOOST)
+        MESSAGE (STATUS "Staticly linking with Boost")
+        SET (Boost_USE_STATIC_LIBS TRUE)
+    ELSE ()
+        MESSAGE (STATUS "Dynamically linking with Boost")
+        SET (Boost_USE_STATIC_LIBS FALSE)
+    ENDIF ()
+
+    FIND_PACKAGE (Boost REQUIRED)
 ELSE ()
-    MESSAGE (STATUS "Dynamically linking with Boost")
-    SET (Boost_USE_STATIC_LIBS FALSE)
+    SET (CMAKE_CXX_FLAGS "-DMSGPACK_NO_BOOST ${CMAKE_CXX_FLAGS}")
 ENDIF ()
 
 IF (MSGPACK_CHAR_SIGN)
@@ -100,7 +107,6 @@ int main(int argc, char * argv[])
     ENDIF ()
 ENDIF ()
 
-FIND_PACKAGE (Boost REQUIRED)
 
 INCLUDE (Files.cmake)
 
@@ -113,7 +119,9 @@ TARGET_INCLUDE_DIRECTORIES (msgpackc-cxx
         $<INSTALL_INTERFACE:include>
 )
 
-TARGET_LINK_LIBRARIES (msgpackc-cxx INTERFACE Boost::boost)
+IF (MSGPACK_USE_BOOST)
+    TARGET_LINK_LIBRARIES (msgpackc-cxx INTERFACE Boost::boost)
+ENDIF ()
 
 IF (MSGPACK_GEN_COVERAGE)
     IF (NOT MSGPACK_BUILD_TESTS)
@@ -131,6 +139,9 @@ IF (MSGPACK_GEN_COVERAGE)
 ENDIF ()
 
 IF (MSGPACK_BUILD_TESTS)
+    IF (NOT MSGPACK_USE_BOOST)
+        MESSAGE(FATAL_ERROR "Test requires -DMSGPACK_USE_BOOST=ON")
+    ENDIF ()
     ENABLE_TESTING ()
     # MEMORYCHECK_COMMAND_OPTIONS needs to place prior to CTEST_MEMORYCHECK_COMMAND
     SET (MEMORYCHECK_COMMAND_OPTIONS "--leak-check=full --show-leak-kinds=definite,possible --error-exitcode=1")

Files.cmake

@@ -71,6 +71,23 @@ C++ version of msgpack-c itself is a header-only library and depends only on
 boost headers. Tests depend on boost unit test framework and are linked with
 it, so if you want to build them, you need to have this dependency installed.
 
+Experimental support for removing boost dependency
+
+For cmake:
+
+```
+cmake -DMSGPACK_USE_BOOST=OFF ..
+```
+
+NOTE: `-DMSGPACK_BUILD_TESTS=ON` doesn't work with `-DMSGPACK_USE_BOOST=OFF`.
+
+For C++ compiler
+
+```
+clang++ -DMSGPACK_NO_BOOST your_code.cpp
+```
+
+
 Usage
 -----
 

README.md

@@ -13,14 +13,13 @@
 #include "msgpack/versioning.hpp"
 #include "msgpack/cpp_config.hpp"
 #include "msgpack/zone_decl.hpp"
+#include "msgpack/assert.hpp"
 
 #include <stdint.h>
 #include <cstdlib>
 #include <memory>
 #include <vector>
 
-#include <boost/assert.hpp>
-
 <% GENERATION_LIMIT = 15 %>
 namespace msgpack {
 
@@ -201,7 +200,7 @@ inline zone::zone(size_t chunk_size) /* throw() */ :m_chunk_size(chunk_size), m_
 
 inline char* zone::get_aligned(char* ptr, size_t align)
 {
-    BOOST_ASSERT(align != 0 && (align & (align - 1)) == 0); // align must be 2^n (n >= 0)
+    MSGPACK_ASSERT(align != 0 && (align & (align - 1)) == 0); // align must be 2^n (n >= 0)
     return
         reinterpret_cast<char*>(
             reinterpret_cast<uintptr_t>(ptr + (align - 1)) & ~static_cast<uintptr_t>(align - 1)

erb/v1/cpp03_zone.hpp.erb

@@ -1,4 +1,9 @@
 ADD_SUBDIRECTORY (cpp03)
 ADD_SUBDIRECTORY (cpp11)
-ADD_SUBDIRECTORY (boost)
-ADD_SUBDIRECTORY (x3)
+
+IF (MSGPACK_USE_BOOST)
+    ADD_SUBDIRECTORY (boost)
+    IF (MSGPACK_USE_X3_PARSE)
+        ADD_SUBDIRECTORY (x3)
+    ENDIF ()
+ENDIF ()

example/CMakeLists.txt

@@ -26,12 +26,15 @@ IF (NOT MSVC)
     )
 ENDIF ()
 
-if (Boost_TIMER_LIBRARY)
-    LIST (APPEND with_boost_lib_PROGRAMS
-        speed_test.cpp
-        speed_test_nested_array.cpp
-    )
-endif()
+
+IF (MSGPACK_USE_BOOST)
+    IF (Boost_TIMER_LIBRARY)
+        LIST (APPEND with_boost_lib_PROGRAMS
+            speed_test.cpp
+            speed_test_nested_array.cpp
+        )
+    ENDIF ()
+ENDIF ()
 
 FOREACH (source_file ${exec_PROGRAMS})
     GET_FILENAME_COMPONENT (source_file_we ${source_file} NAME_WE)

example/cpp03/CMakeLists.txt

@@ -10,37 +10,74 @@
 #ifndef MSGPACK_DEFINE_DECL_HPP
 #define MSGPACK_DEFINE_DECL_HPP
 
-// BOOST_PP_VARIADICS is defined in boost/preprocessor/config/config.hpp
+#if defined(MSGPACK_NO_BOOST)
+
+// MSGPACK_PP_VARIADICS is defined in msgpack/preprocessor/config/config.hpp
 // http://www.boost.org/libs/preprocessor/doc/ref/variadics.html
 // However, supporting compiler detection is not complete. msgpack-c requires
-// variadic macro arguments support. So BOOST_PP_VARIADICS is defined here explicitly.
-#if !defined(BOOST_PP_VARIADICS)
-#define BOOST_PP_VARIADICS
+// variadic macro arguments support. So MSGPACK_PP_VARIADICS is defined here explicitly.
+#if !defined(MSGPACK_PP_VARIADICS)
+#define MSGPACK_PP_VARIADICS
 #endif
 
-#include <boost/preprocessor.hpp>
+#include <msgpack/preprocessor.hpp>
 
-#include "msgpack/versioning.hpp"
+#define MSGPACK_BASE_ARRAY(base) (*const_cast<base *>(static_cast<base const*>(this)))
+#define MSGPACK_NVP(name, value) (name) (value)
 
-// for MSGPACK_ADD_ENUM
-#include "msgpack/adaptor/int.hpp"
+#define MSGPACK_DEFINE_MAP_EACH_PROC(r, data, elem) \
+    MSGPACK_PP_IF( \
+        MSGPACK_PP_IS_BEGIN_PARENS(elem), \
+        elem, \
+        (MSGPACK_PP_STRINGIZE(elem))(elem) \
+    )
 
-#define MSGPACK_DEFINE_ARRAY(...) \
+#define MSGPACK_DEFINE_MAP_IMPL(...) \
+    MSGPACK_PP_SEQ_TO_TUPLE( \
+        MSGPACK_PP_SEQ_FOR_EACH( \
+            MSGPACK_DEFINE_MAP_EACH_PROC, \
+            0, \
+            MSGPACK_PP_VARIADIC_TO_SEQ(__VA_ARGS__) \
+        ) \
+    )
+
+#define MSGPACK_DEFINE_MAP(...) \
     template <typename Packer> \
     void msgpack_pack(Packer& msgpack_pk) const \
     { \
-        msgpack::type::make_define_array(__VA_ARGS__).msgpack_pack(msgpack_pk); \
+        msgpack::type::make_define_map \
+            MSGPACK_DEFINE_MAP_IMPL(__VA_ARGS__) \
+            .msgpack_pack(msgpack_pk); \
     } \
     void msgpack_unpack(msgpack::object const& msgpack_o) \
     { \
-        msgpack::type::make_define_array(__VA_ARGS__).msgpack_unpack(msgpack_o); \
+        msgpack::type::make_define_map \
+            MSGPACK_DEFINE_MAP_IMPL(__VA_ARGS__) \
+            .msgpack_unpack(msgpack_o); \
     }\
     template <typename MSGPACK_OBJECT> \
     void msgpack_object(MSGPACK_OBJECT* msgpack_o, msgpack::zone& msgpack_z) const \
     { \
-        msgpack::type::make_define_array(__VA_ARGS__).msgpack_object(msgpack_o, msgpack_z); \
+        msgpack::type::make_define_map \
+            MSGPACK_DEFINE_MAP_IMPL(__VA_ARGS__) \
+            .msgpack_object(msgpack_o, msgpack_z); \
     }
 
+#define MSGPACK_BASE_MAP(base) \
+    (MSGPACK_PP_STRINGIZE(base))(*const_cast<base *>(static_cast<base const*>(this)))
+
+#else  // defined(MSGPACK_NO_BOOST)
+
+// BOOST_PP_VARIADICS is defined in boost/preprocessor/config/config.hpp
+// http://www.boost.org/libs/preprocessor/doc/ref/variadics.html
+// However, supporting compiler detection is not complete. msgpack-c requires
+// variadic macro arguments support. So BOOST_PP_VARIADICS is defined here explicitly.
+#if !defined(BOOST_PP_VARIADICS)
+#define BOOST_PP_VARIADICS
+#endif
+
+#include <boost/preprocessor.hpp>
+
 #define MSGPACK_BASE_ARRAY(base) (*const_cast<base *>(static_cast<base const*>(this)))
 #define MSGPACK_NVP(name, value) (name) (value)
 
@@ -85,6 +122,29 @@
 #define MSGPACK_BASE_MAP(base) \
     (BOOST_PP_STRINGIZE(base))(*const_cast<base *>(static_cast<base const*>(this)))
 
+#endif // defined(MSGPACK_NO_BOOST)
+
+#include "msgpack/versioning.hpp"
+
+// for MSGPACK_ADD_ENUM
+#include "msgpack/adaptor/int.hpp"
+
+#define MSGPACK_DEFINE_ARRAY(...) \
+    template <typename Packer> \
+    void msgpack_pack(Packer& msgpack_pk) const \
+    { \
+        msgpack::type::make_define_array(__VA_ARGS__).msgpack_pack(msgpack_pk); \
+    } \
+    void msgpack_unpack(msgpack::object const& msgpack_o) \
+    { \
+        msgpack::type::make_define_array(__VA_ARGS__).msgpack_unpack(msgpack_o); \
+    }\
+    template <typename MSGPACK_OBJECT> \
+    void msgpack_object(MSGPACK_OBJECT* msgpack_o, msgpack::zone& msgpack_z) const \
+    { \
+        msgpack::type::make_define_array(__VA_ARGS__).msgpack_object(msgpack_o, msgpack_z); \
+    }
+
 // MSGPACK_ADD_ENUM must be used in the global namespace.
 #define MSGPACK_ADD_ENUM(enum_name) \
   namespace msgpack { \

include/msgpack/adaptor/define_decl.hpp

@@ -0,0 +1,26 @@
+//
+// MessagePack for C++ static resolution routine
+//
+// Copyright (C) 2022 KONDO Takatoshi
+//
+//    Distributed under the Boost Software License, Version 1.0.
+//    (See accompanying file LICENSE_1_0.txt or copy at
+//    http://www.boost.org/LICENSE_1_0.txt)
+//
+
+#ifndef MSGPACK_ASSERT_HPP
+#define MSGPACK_ASSERT_HPP
+
+#if defined(MSGPACK_NO_BOOST)
+
+#include <cassert>
+#define MSGPACK_ASSERT assert
+
+#else  // defined(MSGPACK_NO_BOOST)
+
+#include <boost/assert.hpp>
+#define MSGPACK_ASSERT BOOST_ASSERT
+
+#endif // defined(MSGPACK_NO_BOOST)
+
+#endif // MSGPACK_ASSERT_HPP

include/msgpack/assert.hpp

@@ -0,0 +1,24 @@
+/*
+Copyright Rene Rivera 2008-2015
+Distributed under the Boost Software License, Version 1.0.
+(See accompanying file LICENSE_1_0.txt or copy at
+http://www.boost.org/LICENSE_1_0.txt)
+*/
+
+#if !defined(MSGPACK_PREDEF_H) || defined(MSGPACK_PREDEF_INTERNAL_GENERATE_TESTS)
+#ifndef MSGPACK_PREDEF_H
+#define MSGPACK_PREDEF_H
+#endif
+
+#include <msgpack/predef/language.h>
+#include <msgpack/predef/architecture.h>
+#include <msgpack/predef/compiler.h>
+#include <msgpack/predef/library.h>
+#include <msgpack/predef/os.h>
+#include <msgpack/predef/other.h>
+#include <msgpack/predef/platform.h>
+#include <msgpack/predef/hardware.h>
+
+#include <msgpack/predef/version.h>
+
+#endif