Merge pull request #988 from redboltz/cpp_4.0.3

Updated the version to 4.0.3.

.github/workflows/gha.yml

@@ -210,7 +210,7 @@ jobs:
       run: |
         vcpkg update
         vcpkg install zlib:x64-windows
-        vcpkg install boost:x64-windows
+        vcpkg install boost-assert:x64-windows boost-numeric-conversion:x64-windows boost-variant:x64-windows boost-utility:x64-windows boost-fusion:x64-windows boost-optional:x64-windows boost-predef:x64-windows boost-preprocessor:x64-windows boost-timer:x64-windows boost-test:x64-windows
 
     - name: Build and test
       shell: powershell

CHANGELOG.md

@@ -1,3 +1,14 @@
+# 2021-10-23 version 4.0.3 for C++
+  * Remove Enabler2 template parameter from object adaptor (#987)
+  * Add MSGPACK_BUILD_DOCS cmake option (#983, #984)
+
+# 2021-08-31 version 4.0.2 for C++
+  * Fix fuzzer interface function name (#972)
+  * Fix boost test link error and support both dynamin(default) and static link boost (#971)
+
+# 2021-08-30 version 4.0.1 for C++
+  * Fix release tarball and its generation script (#967)
+
 # 2021-08-29 version 4.0.0 for C++
   * Improve zone alignment logic (#965)
   * Fix v1 unpack logic for STR and BIN (#957, #951)

CMakeLists.txt

@@ -21,12 +21,15 @@ OPTION (MSGPACK_CXX14 "Using c++14 compiler" OFF)
 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_X3_PARSE    "Use Boost X3 parse"        OFF)
-OPTION (MSGPACK_BUILD_TESTS     "Build tests"               OFF)
-OPTION (MSGPACK_FUZZ_REGRESSION "Enable regression testing" OFF)
-OPTION (MSGPACK_BUILD_EXAMPLES  "Build msgpack examples"    OFF)
-OPTION (MSGPACK_GEN_COVERAGE    "Generate coverage report"  OFF)
+OPTION (MSGPACK_32BIT            "32bit compile"                        OFF)
+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)
+OPTION (MSGPACK_FUZZ_REGRESSION  "Enable regression testing"            OFF)
+OPTION (MSGPACK_BUILD_EXAMPLES   "Build msgpack examples"               OFF)
+OPTION (MSGPACK_GEN_COVERAGE     "Generate coverage report"             OFF)
+OPTION (MSGPACK_USE_STATIC_BOOST "Statically link with boost libraries" OFF)
+OPTION (MSGPACK_CHAR_SIGN        "Char sign to use (signed or unsigned)")
 
 SET (CMAKE_CXX_STANDARD_REQUIRED ON)
 
@@ -59,8 +62,15 @@ IF (MSGPACK_32BIT)
     ENDIF ()
 ENDIF ()
 
-SET (Boost_USE_MULTITHREADED      ON)
-SET (Boost_USE_STATIC_RUNTIME    OFF)
+SET (Boost_USE_MULTITHREADED ON)
+
+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 ()
 
 IF (MSGPACK_CHAR_SIGN)
     SET (CMAKE_CXX_FLAGS "-f${MSGPACK_CHAR_SIGN}-char ${CMAKE_CXX_FLAGS}")
@@ -69,6 +79,7 @@ ENDIF ()
 IF (MSGPACK_DEFAULT_API_VERSION)
     SET (CMAKE_CXX_FLAGS "-DMSGPACK_DEFAULT_API_VERSION=${MSGPACK_DEFAULT_API_VERSION} ${CMAKE_CXX_FLAGS}")
 ELSE ()
+    SET (MSGPACK_DEFAULT_API_VERSION 3)
     SET (CMAKE_CXX_FLAGS "-DMSGPACK_DEFAULT_API_VERSION=3 ${CMAKE_CXX_FLAGS}")
 ENDIF ()
 
@@ -143,28 +154,30 @@ IF (MSGPACK_BUILD_EXAMPLES)
 ENDIF ()
 
 # Doxygen
-FIND_PACKAGE (Doxygen)
-IF (DOXYGEN_FOUND)
-    LIST (APPEND Doxyfile_cpp_CONTENT
-        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
-        COMMAND ${CMAKE_COMMAND} -E echo "FILE_PATTERNS      = *.hpp" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
-        COMMAND ${CMAKE_COMMAND} -E echo "OUTPUT_DIRECTORY   = doc_cpp" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
-        COMMAND ${CMAKE_COMMAND} -E echo "INPUT              = ${CMAKE_CURRENT_SOURCE_DIR}/include" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
-        COMMAND ${CMAKE_COMMAND} -E echo "EXTRACT_ALL        = YES" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
-        COMMAND ${CMAKE_COMMAND} -E echo "STRIP_FROM_PATH    = ${CMAKE_CURRENT_SOURCE_DIR}/include" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
-    )
-    IF (DOXYGEN_DOT_FOUND)
+IF (MSGPACK_BUILD_DOCS)
+    FIND_PACKAGE (Doxygen)
+    IF (DOXYGEN_FOUND)
         LIST (APPEND Doxyfile_cpp_CONTENT
-            COMMAND ${CMAKE_COMMAND} -E echo "HAVE_DOT       = YES" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
+            COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
+            COMMAND ${CMAKE_COMMAND} -E echo "FILE_PATTERNS      = *.hpp" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
+            COMMAND ${CMAKE_COMMAND} -E echo "OUTPUT_DIRECTORY   = doc_cpp" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
+            COMMAND ${CMAKE_COMMAND} -E echo "INPUT              = ${CMAKE_CURRENT_SOURCE_DIR}/include" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
+            COMMAND ${CMAKE_COMMAND} -E echo "EXTRACT_ALL        = YES" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
+            COMMAND ${CMAKE_COMMAND} -E echo "STRIP_FROM_PATH    = ${CMAKE_CURRENT_SOURCE_DIR}/include" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
+        )
+        IF (DOXYGEN_DOT_FOUND)
+            LIST (APPEND Doxyfile_cpp_CONTENT
+                COMMAND ${CMAKE_COMMAND} -E echo "HAVE_DOT       = YES" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
+            )
+        ENDIF ()
+        ADD_CUSTOM_TARGET (
+            doxygen
+            ${Doxyfile_cpp_CONTENT}
+            COMMAND ${CMAKE_COMMAND} -E echo "PROJECT_NAME       = \"MessagePack for C++\"" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
+            COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
+            VERBATIM
         )
     ENDIF ()
-    ADD_CUSTOM_TARGET (
-        doxygen
-        ${Doxyfile_cpp_CONTENT}
-        COMMAND ${CMAKE_COMMAND} -E echo "PROJECT_NAME       = \"MessagePack for C++\"" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
-        COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
-        VERBATIM
-    )
 ENDIF ()
 
 # Install library.

README.md

@@ -1,7 +1,7 @@
 `msgpack` for C++
 ===================
 
-Version 4.0.0 [![Build Status](https://github.com/msgpack/msgpack-c/workflows/CI/badge.svg?branch=cpp_master)](https://github.com/msgpack/msgpack-c/actions) [![Build status](https://ci.appveyor.com/api/projects/status/8kstcgt79qj123mw/branch/cpp_master?svg=true)](https://ci.appveyor.com/project/redboltz/msgpack-c/branch/cpp_master)
+Version 4.0.3 [![Build Status](https://github.com/msgpack/msgpack-c/workflows/CI/badge.svg?branch=cpp_master)](https://github.com/msgpack/msgpack-c/actions) [![Build status](https://ci.appveyor.com/api/projects/status/8kstcgt79qj123mw/branch/cpp_master?svg=true)](https://ci.appveyor.com/project/redboltz/msgpack-c/branch/cpp_master)
 [![codecov](https://codecov.io/gh/msgpack/msgpack-c/branch/cpp_master/graph/badge.svg)](https://codecov.io/gh/msgpack/msgpack-c/branch/cpp_master)
 
 It's like JSON but smaller and faster.
@@ -153,6 +153,8 @@ Other useful options:
 - `MSGPACK_32BIT` (default `OFF`): 32bit compile
 - `MSGPACK_USE_X3_PARSE` (default `OFF`): use Boost X3 parse
   (note that it requires C++14 or newer)
+- `MSGPACK_CHAR_SIGN` (not set explicitly by default): char sign to use (signed or unsigned)
+- `MSGPACK_USE_STATIC_BOOST` (default `OFF`): statically link with boost libraries
 
 #### GUI on Windows
 

appveyor.yml

@@ -1,4 +1,4 @@
-version: 4.0.0.{build}
+version: 4.0.3.{build}
 
 branches:
   only:

cmake/CodeCoverage.cmake

@@ -4,52 +4,52 @@ FIND_PROGRAM(LCOV_PATH lcov)
 FIND_PROGRAM(GENHTML_PATH genhtml)
 
 IF(NOT GCOV_PATH)
-	MESSAGE(FATAL_ERROR "gcov not found! Aborting...")
+    MESSAGE(FATAL_ERROR "gcov not found! Aborting...")
 ENDIF()
 
 IF(NOT CMAKE_COMPILER_IS_GNUCC AND NOT CMAKE_COMPILER_IS_GNUCXX)
-	# Clang version 3.0.0 and greater now supports gcov as well.
-	MESSAGE(STATUS "Compiler is not GNU gcc! Clang Version 3.0.0 and greater supports gcov as well, but older versions don't.")
-	IF(NOT "${CMAKE_C_COMPILER_ID}" MATCHES "Clang" AND NOT "${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang")
-		MESSAGE(FATAL_ERROR "Compiler is not GNU gcc! Aborting...")
-	ENDIF()
+    # Clang version 3.0.0 and greater now supports gcov as well.
+    MESSAGE(STATUS "Compiler is not GNU gcc! Clang Version 3.0.0 and greater supports gcov as well, but older versions don't.")
+    IF(NOT "${CMAKE_C_COMPILER_ID}" MATCHES "Clang" AND NOT "${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang")
+        MESSAGE(FATAL_ERROR "Compiler is not GNU gcc! Aborting...")
+    ENDIF()
 ENDIF()
 
 SET(COVERAGE_FLAGS "-g -O0 --coverage")
 
 FUNCTION(SETUP_TARGET_FOR_COVERAGE _targetname _testrunner _outputname)
 
-	IF(NOT LCOV_PATH)
-		MESSAGE(FATAL_ERROR "lcov not found! Aborting...")
-	ENDIF()
+    IF(NOT LCOV_PATH)
+        MESSAGE(FATAL_ERROR "lcov not found! Aborting...")
+    ENDIF()
 
-	IF(NOT GENHTML_PATH)
-		MESSAGE(FATAL_ERROR "genhtml not found! Aborting...")
-	ENDIF()
+    IF(NOT GENHTML_PATH)
+        MESSAGE(FATAL_ERROR "genhtml not found! Aborting...")
+    ENDIF()
 
-	# Setup target
-	ADD_CUSTOM_TARGET(${_targetname}
+    # Setup target
+    ADD_CUSTOM_TARGET(${_targetname}
 
-		# Cleanup lcov
-		${LCOV_PATH} --directory . --zerocounters
+        # Cleanup lcov
+        ${LCOV_PATH} --directory . --zerocounters
 
-		# Run tests
-		COMMAND ${_testrunner} ${ARGV3}
+        # Run tests
+        COMMAND ${_testrunner} ${ARGV3}
 
-		# Capturing lcov counters and generating report
-		COMMAND ${LCOV_PATH} --directory . --capture --output-file ${_outputname}.info --base-directory ${CMAKE_SOURCE_DIR} --no-external --quiet
-		COMMAND ${LCOV_PATH} --remove ${_outputname}.info '*/test/*' '*/fuzz/*' --output-file ${_outputname}.info.cleaned --quiet
-		COMMAND ${GENHTML_PATH} -o ${_outputname} ${_outputname}.info.cleaned --prefix ${CMAKE_SOURCE_DIR}
-		# COMMAND ${CMAKE_COMMAND} -E remove ${_outputname}.info ${_outputname}.info.cleaned
+        # Capturing lcov counters and generating report
+        COMMAND ${LCOV_PATH} --directory . --capture --output-file ${_outputname}.info --base-directory ${CMAKE_SOURCE_DIR} --no-external --quiet
+        COMMAND ${LCOV_PATH} --remove ${_outputname}.info '*/test/*' '*/fuzz/*' --output-file ${_outputname}.info.cleaned --quiet
+        COMMAND ${GENHTML_PATH} -o ${_outputname} ${_outputname}.info.cleaned --prefix ${CMAKE_SOURCE_DIR}
+        # COMMAND ${CMAKE_COMMAND} -E remove ${_outputname}.info ${_outputname}.info.cleaned
 
-		WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
-		COMMENT "Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report."
-	)
+        WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+        COMMENT "Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report."
+    )
 
-	# Show info where to find the report
-	ADD_CUSTOM_COMMAND(TARGET ${_targetname} POST_BUILD
-		COMMAND ;
-		COMMENT "Open ./${_outputname}/index.html in your browser to view the coverage report."
-	)
+    # Show info where to find the report
+    ADD_CUSTOM_COMMAND(TARGET ${_targetname} POST_BUILD
+        COMMAND ;
+        COMMENT "Open ./${_outputname}/index.html in your browser to view the coverage report."
+    )
 
 ENDFUNCTION()

example/x3/CMakeLists.txt

@@ -1,5 +1,5 @@
 IF (MSGPACK_USE_X3_PARSE AND MSGPACK_DEFAULT_API_VERSION VERSION_GREATER 1)
-    FIND_PACKAGE (Boost REQUIRED COMPONENTS context system unit_test_framework)
+    FIND_PACKAGE (Boost REQUIRED COMPONENTS context system)
     FIND_PACKAGE (Threads REQUIRED)
 
     LIST (APPEND exec_PROGRAMS
@@ -43,7 +43,6 @@ IF (MSGPACK_USE_X3_PARSE AND MSGPACK_DEFAULT_API_VERSION VERSION_GREATER 1)
             msgpackc-cxx
             Boost::context
             Boost::system
-            Boost::unit_test_framework
             Threads::Threads
         )
         IF ("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang" OR "${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")

fuzz/CMakeLists.txt

@@ -11,6 +11,10 @@ FOREACH (source_file ${check_PROGRAMS})
         ${source_file_we}
         ${source_file}
     )
+
+    TARGET_COMPILE_DEFINITIONS (${source_file_we} PRIVATE
+        $<IF:$<BOOL:${MSGPACK_USE_STATIC_BOOST}>,,BOOST_TEST_DYN_LINK>)
+
     TARGET_LINK_LIBRARIES (${source_file_we}
         msgpackc-cxx
         Threads::Threads
@@ -18,7 +22,9 @@ FOREACH (source_file ${check_PROGRAMS})
         Boost::system
         Boost::unit_test_framework
     )
+
     ADD_TEST (${source_file_we} ${source_file_we})
+
     IF ("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang")
       SET_PROPERTY (TARGET ${source_file_we} APPEND_STRING PROPERTY COMPILE_FLAGS "-Wall -Wextra -Wno-mismatched-tags -g")
         IF ("${MSGPACK_SAN}" STREQUAL "ASAN")

fuzz/regression_runner.cpp

@@ -38,7 +38,7 @@ void UnpackPackFuzzerRegressionTest(const std::string& fpath) {
   std::vector<char> bytes(length);
   in.read(bytes.data(), bytes.size());
   BOOST_REQUIRE(in);
-  BOOST_REQUIRE_EQUAL(0, FuzzerTestOneInput(reinterpret_cast<const uint8_t *>(bytes.data()), bytes.size()));
+  BOOST_REQUIRE_EQUAL(0, LLVMFuzzerTestOneInput(reinterpret_cast<const uint8_t *>(bytes.data()), bytes.size()));
 }
 
 boost::unit_test::test_suite* init_unit_test_suite(int /*argc*/, char* /*argv*/[])

fuzz/unpack_pack_fuzzer.cpp

@@ -1,6 +1,10 @@
 #include <msgpack.hpp>
 
-extern "C" int FuzzerTestOneInput(const uint8_t *data, size_t size) {
+// The function's signature must NOT be changed since other projects rely on it:
+// - libFuzzer
+// - AFL++
+// - Google's oss-fuzz (uses the previous two ones)
+extern "C" int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) {
   try {
     // NOTE(derwolfe): by default the limits are set at 2^32-1 length. I'm
     // setting these at far smaller values to avoid OOMs

include/msgpack/v3/adaptor/adaptor_base.hpp

@@ -32,14 +32,15 @@ struct pack : v2::adaptor::pack<T, Enabler> {
 };
 
 template <typename T, typename Enabler>
-struct object<
-    T,
-    Enabler,
-    typename msgpack::enable_if<
-        !msgpack::is_same<T, std::string>::value &&
-        !msgpack::is_array<T>::value
-    >::type>
-    : v2::adaptor::object<T, Enabler> {
+struct object
+    : v2::adaptor::object<
+        T,
+        typename msgpack::enable_if<
+            !msgpack::is_same<T, std::string>::value &&
+            !msgpack::is_array<T>::value,
+            Enabler
+        >::type
+      > {
 };
 
 template <typename T, typename Enabler>

include/msgpack/v3/adaptor/adaptor_base_decl.hpp

@@ -30,7 +30,7 @@ struct convert;
 template <typename T, typename Enabler = void>
 struct pack;
 
-template <typename T, typename Enabler = void, typename Enabler2 = void>
+template <typename T, typename Enabler = void>
 struct object;
 
 template <typename T, typename Enabler = void>

include/msgpack/version_master.hpp

@@ -1,3 +1,3 @@
 #define MSGPACK_VERSION_MAJOR    4
 #define MSGPACK_VERSION_MINOR    0
-#define MSGPACK_VERSION_REVISION 0
+#define MSGPACK_VERSION_REVISION 3

makedist.sh

@@ -19,6 +19,7 @@ tar --append --file=$filename $prefix/test
 tar --append --file=$filename $prefix/include
 tar --append --file=$filename $prefix/erb
 tar --append --file=$filename $prefix/fuzz
+tar --append --file=$filename $prefix/cmake
 
 tar --append --file=$filename $prefix/CMakeLists.txt
 tar --append --file=$filename $prefix/Files.cmake
@@ -31,7 +32,7 @@ tar --append --file=$filename $prefix/ChangeLog
 tar --append --file=$filename $prefix/NEWS
 tar --append --file=$filename $prefix/COPYING
 tar --append --file=$filename $prefix/README
-
+tar --append --file=$filename $prefix/msgpack-config.cmake.in
 rm -f $prefix
 
 gzip -f $filename

test/CMakeLists.txt

@@ -74,6 +74,9 @@ FOREACH (source_file ${check_PROGRAMS})
         ${source_file}
     )
 
+    TARGET_COMPILE_DEFINITIONS (${source_file_we} PRIVATE
+        $<IF:$<BOOL:${MSGPACK_USE_STATIC_BOOST}>,,BOOST_TEST_DYN_LINK>)
+
     TARGET_LINK_LIBRARIES (${source_file_we}
         msgpackc-cxx
         Boost::system
@@ -81,6 +84,7 @@ FOREACH (source_file ${check_PROGRAMS})
         Threads::Threads
         ZLIB::ZLIB
     )
+
     ADD_TEST (NAME ${source_file_we} COMMAND ${source_file_we})
 
     IF ("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang" OR "${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")

test/fuzz_unpack_pack_fuzzer_cpp11.cpp

@@ -5,5 +5,5 @@
 
 BOOST_AUTO_TEST_CASE(works)
 {
-  BOOST_CHECK_EQUAL(0, FuzzerTestOneInput(MSGPACK_NULLPTR, 0));
+  BOOST_CHECK_EQUAL(0, LLVMFuzzerTestOneInput(MSGPACK_NULLPTR, 0));
 }

test/msgpack_basic.cpp

@@ -214,7 +214,7 @@ BOOST_AUTO_TEST_CASE_TEMPLATE(simple_buffer, TypeParam, IntegerToFloatingPointTe
     if (numeric_limits<integer_type>::is_signed) v.push_back(static_cast<integer_type>(-1));
     else v.push_back(2);
     for (unsigned int i = 0; i < kLoop; i++) {
-        v.push_back(rand() % 0x7FFFFF);
+        v.push_back(static_cast<integer_type>(rand() % 0x7FFFFF));
     }
     for (unsigned int i = 0; i < v.size() ; i++) {
         msgpack::sbuffer sbuf;