Resolved merge conflicts

getml · Apr 28, 2024 · 04ce783 · 04ce783
2 parents bc70be4 + bb3dc34
commit 04ce783
Show file tree

Hide file tree

Showing 657 changed files with 5,438 additions and 4,018 deletions.
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -20,12 +20,14 @@ jobs:
       - name: Run test
         run: |
           g++ --version
-          cmake -S . -B build -DREFLECTCPP_BUILD_TESTS=ON -DREFLECTCPP_BSON=ON -DREFLECTCPP_CBOR=ON -DREFLECTCPP_FLEXBUFFERS=ON -DREFLECTCPP_XML=ON -DREFLECTCPP_YAML=ON -DCMAKE_BUILD_TYPE=Release
+          cmake -S . -B build -DREFLECTCPP_BUILD_TESTS=ON -DREFLECTCPP_BSON=ON -DREFLECTCPP_CBOR=ON -DREFLECTCPP_FLEXBUFFERS=ON -DREFLECTCPP_MSGPACK=ON -DREFLECTCPP_TOML=ON -DREFLECTCPP_XML=ON -DREFLECTCPP_YAML=ON -DCMAKE_BUILD_TYPE=Release
           cmake --build build -j 4
           ./build/tests/bson/reflect-cpp-bson-tests
           ./build/tests/cbor/reflect-cpp-cbor-tests
           ./build/tests/flexbuffers/reflect-cpp-flexbuffers-tests
           ./build/tests/json/reflect-cpp-json-tests
+          ./build/tests/msgpack/reflect-cpp-msgpack-tests
+          ./build/tests/toml/reflect-cpp-toml-tests
           ./build/tests/xml/reflect-cpp-xml-tests
           ./build/tests/yaml/reflect-cpp-yaml-tests
 
@@ -53,30 +55,36 @@ jobs:
           CXX: clang++
         run: |
           clang --version
-          cmake -S . -B build -DREFLECTCPP_BUILD_TESTS=ON -DREFLECTCPP_BSON=ON -DREFLECTCPP_CBOR=ON -DREFLECTCPP_FLEXBUFFERS=ON -DREFLECTCPP_XML=ON -DREFLECTCPP_YAML=ON -DCMAKE_BUILD_TYPE=Release
+          cmake -S . -B build -DREFLECTCPP_BUILD_TESTS=ON -DREFLECTCPP_BSON=ON -DREFLECTCPP_CBOR=ON -DREFLECTCPP_FLEXBUFFERS=ON -DREFLECTCPP_MSGPACK=ON -DREFLECTCPP_TOML=ON -DREFLECTCPP_XML=ON -DREFLECTCPP_YAML=ON -DCMAKE_BUILD_TYPE=Release
           cmake --build build -j 4
           ./build/tests/bson/reflect-cpp-bson-tests
           ./build/tests/cbor/reflect-cpp-cbor-tests
           ./build/tests/flexbuffers/reflect-cpp-flexbuffers-tests
           ./build/tests/json/reflect-cpp-json-tests
+          ./build/tests/msgpack/reflect-cpp-msgpack-tests
+          ./build/tests/toml/reflect-cpp-toml-tests
           ./build/tests/xml/reflect-cpp-xml-tests
           ./build/tests/yaml/reflect-cpp-yaml-tests
 
-
-#  The latest MSVC version on GitHub Actions has a bug, and it's difficult to switch to another version.
-#  Re-enable this when the bug is fixed.
-
-#  windows-msvc:
-#    runs-on: windows-latest
-#    steps:
-#      - uses: actions/checkout@v3
-#        with:
-#          submodules: true
-#      - uses: ilammy/msvc-dev-cmd@v1
-#      - uses: lukka/run-vcpkg@v11
-#      - name: Run test
-#        run: |
-#          cmake -S . -B build -DREFLECTCPP_BUILD_TESTS=ON -DREFLECTCPP_FLEXBUFFERS=ON
-#          cmake --build build -j 4
-#          .\build\tests\flexbuffers\Release\reflect-cpp-flexbuffers-tests.exe
-#          .\build\tests\json\Release\reflect-cpp-json-tests.exe
+  windows-msvc:
+    runs-on: windows-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - uses: ilammy/msvc-dev-cmd@v1
+      - uses: lukka/run-vcpkg@v11
+      - name: Run test
+        run: |
+          cmake -S . -B build -DREFLECTCPP_BUILD_TESTS=ON -DREFLECTCPP_BSON=ON -DREFLECTCPP_CBOR=ON -DREFLECTCPP_FLEXBUFFERS=ON -DREFLECTCPP_MSGPACK=ON -DREFLECTCPP_XML=ON -DREFLECTCPP_TOML=ON -DREFLECTCPP_YAML=ON -DCMAKE_BUILD_TYPE=Release
+          cmake --build build --config Release -j4 
+          .\build\tests\json\Release\reflect-cpp-json-tests.exe
+          .\build\tests\bson\Release\reflect-cpp-bson-tests.exe
+          .\build\tests\cbor\Release\reflect-cpp-cbor-tests.exe
+          .\build\tests\flexbuffers\Release\reflect-cpp-flexbuffers-tests.exe
+          .\build\tests\msgpack\Release\reflect-cpp-msgpack-tests.exe
+          .\build\tests\toml\Release\reflect-cpp-toml-tests.exe
+          .\build\tests\xml\Release\reflect-cpp-xml-tests.exe
+          .\build\tests\yaml\Release\reflect-cpp-yaml-tests.exe
diff --git a/.gitignore b/.gitignore
@@ -45,8 +45,15 @@
 *.cbor
 *.json
 *.fb
+*.flexbuf
+*.msgpack
+*.toml
 *.xml
 *.yml
 *.yaml
 
 !vcpkg.json
+
+# clangd
+compile_flags.txt
+compile_commands.json
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,16 +1,25 @@
-cmake_minimum_required(VERSION 3.15)
+cmake_minimum_required(VERSION 3.23)
 
-option(REFLECTCPP_BUILD_SHARED "Build shared library" OFF)
+option(REFLECTCPP_BUILD_SHARED "Build shared library" ${BUILD_SHARED_LIBS})
 option(REFLECTCPP_BSON "Enable BSON support" OFF)
 option(REFLECTCPP_CBOR "Enable CBOR support" OFF)
 option(REFLECTCPP_FLEXBUFFERS "Enable flexbuffers support" OFF)
+option(REFLECTCPP_MSGPACK "Enable msgpack support" OFF)
 option(REFLECTCPP_XML "Enable XML support" OFF)
+option(REFLECTCPP_TOML "Enable TOML support" OFF)
 option(REFLECTCPP_YAML "Enable YAML support" OFF)
 
 option(REFLECTCPP_BUILD_TESTS "Build tests" OFF)
 
-# enable vcpkg if require features other than JSON
-if (REFLECTCPP_BSON OR REFLECTCPP_CBOR OR REFLECTCPP_FLEXBUFFERS OR REFLECTCPP_XML OR REFLECTCPP_YAML)
+set(REFLECTCPP_USE_VCPKG_DEFAULT OFF)
+if (REFLECTCPP_BUILD_TESTS OR REFLECTCPP_BSON OR REFLECTCPP_CBOR OR REFLECTCPP_FLEXBUFFERS OR REFLECTCPP_MSGPACK OR REFLECTCPP_XML OR REFLECTCPP_TOML OR REFLECTCPP_YAML)
+    # enable vcpkg per default if require features other than JSON
+    set(REFLECTCPP_USE_VCPKG_DEFAULT ON)
+endif()
+
+option(REFLECTCPP_USE_VCPKG "Use VCPKG to download and build dependencies" ${REFLECTCPP_USE_VCPKG_DEFAULT})
+
+if (REFLECTCPP_USE_VCPKG)
     set(CMAKE_TOOLCHAIN_FILE ${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/scripts/buildsystems/vcpkg.cmake CACHE STRING "Vcpkg toolchain file")
 endif ()
 
@@ -24,7 +33,9 @@ else ()
     add_library(reflectcpp STATIC src/yyjson.c)
 endif ()
 
-target_include_directories(reflectcpp PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
+target_compile_features(reflectcpp PUBLIC cxx_std_20)
+
+target_include_directories(reflectcpp PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include> $<INSTALL_INTERFACE:include> )
 
 if (REFLECTCPP_BSON)
     find_package(bson-1.0 CONFIG REQUIRED)
@@ -44,6 +55,23 @@ if (REFLECTCPP_FLEXBUFFERS)
     target_link_libraries(reflectcpp INTERFACE flatbuffers::flatbuffers)
 endif ()
 
+if (REFLECTCPP_MSGPACK)
+    find_package(msgpack-c CONFIG REQUIRED)
+    if (MSVC)
+        target_link_libraries(reflectcpp PRIVATE "${VCPKG_INSTALLED_DIR}/${VCPKG_TARGET_TRIPLET}/lib/msgpack-c${CMAKE_STATIC_LIBRARY_SUFFIX}")
+    else ()
+        target_link_libraries(reflectcpp PRIVATE "${VCPKG_INSTALLED_DIR}/${VCPKG_TARGET_TRIPLET}/lib/libmsgpack-c${CMAKE_STATIC_LIBRARY_SUFFIX}")
+    endif ()
+endif ()
+
+if (REFLECTCPP_TOML)
+    if (MSVC)
+        target_link_libraries(reflectcpp PRIVATE "${VCPKG_INSTALLED_DIR}/${VCPKG_TARGET_TRIPLET}/lib/tomlplusplus${CMAKE_STATIC_LIBRARY_SUFFIX}")
+    else ()
+        target_link_libraries(reflectcpp PRIVATE "${VCPKG_INSTALLED_DIR}/${VCPKG_TARGET_TRIPLET}/lib/libtomlplusplus${CMAKE_STATIC_LIBRARY_SUFFIX}")
+    endif ()
+endif()
+
 if (REFLECTCPP_XML)
     find_package(pugixml CONFIG REQUIRED)
     target_link_libraries(reflectcpp INTERFACE pugixml::pugixml)
@@ -57,5 +85,44 @@ endif ()
 target_compile_options(reflectcpp PRIVATE -Wall)
 
 if (REFLECTCPP_BUILD_TESTS)
+    if (MSVC)
+        set(REFLECT_CPP_GTEST_LIB "${VCPKG_INSTALLED_DIR}/${VCPKG_TARGET_TRIPLET}/lib/gtest${CMAKE_STATIC_LIBRARY_SUFFIX}")
+    else ()
+        set(REFLECT_CPP_GTEST_LIB "${VCPKG_INSTALLED_DIR}/${VCPKG_TARGET_TRIPLET}/lib/libgtest${CMAKE_STATIC_LIBRARY_SUFFIX}")
+    endif ()
     add_subdirectory(tests)
 endif ()
+
+include(GNUInstallDirs)
+include(CMakePackageConfigHelpers)
+
+configure_package_config_file(reflectcpp-config.cmake.in
+  ${CMAKE_CURRENT_BINARY_DIR}/reflectcpp-config.cmake
+  INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/reflectcpp  
+  )
+
+install(
+    FILES "${CMAKE_CURRENT_BINARY_DIR}/reflectcpp-config.cmake"
+    DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/reflectcpp"
+)
+
+file(GLOB_RECURSE RFL_HEADERS RELATIVE ${CMAKE_CURRENT_LIST_DIR} "${CMAKE_CURRENT_LIST_DIR}/include/*" )
+
+target_sources(reflectcpp
+    PUBLIC
+    FILE_SET reflectcpp_headers    
+    TYPE HEADERS
+    BASE_DIRS $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include> $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/include>
+    FILES ${RFL_HEADERS})
+
+install(
+    TARGETS reflectcpp
+    EXPORT reflectcpp-exports
+    FILE_SET reflectcpp_headers DESTINATION ${INCLUDE_INSTALL_DIR}
+    )
+
+install(
+    EXPORT reflectcpp-exports
+    DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/reflectcpp
+    NAMESPACE reflectcpp::
+)
diff --git a/README.md b/README.md
@@ -34,6 +34,8 @@ The following table lists the serialization formats currently supported by refle
 | BSON         | [libbson](https://github.com/mongodb/libbson)        | >= 1.25.1    | Apache 2.0 | JSON-like binary format                              |
 | CBOR         | [tinycbor](https://github.com/intel/tinycbor)        | >= 0.6.0     | MIT        | JSON-like binary format                              |
 | flexbuffers  | [flatbuffers](https://github.com/google/flatbuffers) | >= 23.5.26   | Apache 2.0 | Schema-less version of flatbuffers, binary format    |
+| msgpack      | [msgpack-c](https://github.com/msgpack/msgpack-c)    | >= 6.0.0     | BSL 1.0    | JSON-like binary format                              |
+| TOML         | [toml++](https://github.com/marzer/tomlplusplus)     | >= 3.4.0     | MIT        | Textual format with an emphasis on readability       |
 | XML          | [pugixml](https://github.com/zeux/pugixml)           | >= 1.14      | MIT        | Textual format used in many legacy projects          |
 | YAML         | [yaml-cpp](https://github.com/jbeder/yaml-cpp)       | >= 0.8.0     | MIT        | Textual format with an emphasis on readability       |
 
@@ -89,17 +91,21 @@ age: 45
 ```
 
 This will work for just about any example in the entire documentation 
-and any supported format:
+and any supported format, except where explicitly noted otherwise:
 
 ```cpp
 rfl::bson::write(homer);
 rfl::cbor::write(homer);
 rfl::flexbuf::write(homer);
+rfl::msgpack::write(homer);
+rfl::toml::write(homer);
 rfl::xml::write(homer);
 
 rfl::bson::read<Person>(bson_bytes);
 rfl::cbor::read<Person>(cbor_bytes);
 rfl::flexbuf::read<Person>(flexbuf_bytes);
+rfl::msgpack::read<Person>(msgpack_bytes);
+rfl::toml::read<Person>(toml_string);
 rfl::xml::read<Person>(xml_string);
 ```
 
@@ -197,6 +203,35 @@ Found 5 errors:
 5) Field named 'children' not found.
 ```
 
+## JSON schema
+
+reflect-cpp also supports generating JSON schemata:
+
+```cpp
+struct Person {
+  std::string first_name;
+  std::string last_name;
+  rfl::Description<"Must be a proper email in the form xxx@xxx.xxx.",
+                   rfl::Email>
+      email;
+  rfl::Description<
+      "The person's children. Pass an empty array for no children.",
+      std::vector<Person>>
+      children;
+  float salary;
+};
+
+const std::string json_schema = rfl::json::to_schema<Person>();
+```
+
+The resulting JSON schema looks like this:
+
+```json
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$ref":"#/definitions/Person","definitions":{"Person":{"type":"object","properties":{"children":{"type":"array","description":"The person's children. Pass an empty array for no children.","items":{"$ref":"#/definitions/Person"}},"email":{"type":"string","description":"Must be a proper email in the form xxx@xxx.xxx.","pattern":"^[a-zA-Z0-9._%+\\-]+@[a-zA-Z0-9.\\-]+\\.[a-zA-Z]{2,}$"},"first_name":{"type":"string"},"last_name":{"type":"string"},"salary":{"type":"number"}},"required":["children","email","first_name","last_name","salary"]}}}
+```
+
+Note that this is currently supported for JSON only, since most other formats do not support schemata in the first place.
+
 ## Enums
 
 reflect-cpp supports scoped enumerations:
@@ -388,6 +423,7 @@ reflect-cpp supports the following containers from the C++ standard library:
 - `std::unordered_set`
 - `std::variant`
 - `std::vector`
+- `std::wstring`
 
 ### Additional containers
 
@@ -474,6 +510,8 @@ add_subdirectory(reflect-cpp) # Add this project as a subdirectory
 set(REFLECTCPP_BSON ON) # Optional
 set(REFLECTCPP_CBOR ON) # Optional
 set(REFLECTCPP_FLEXBUFFERS ON) # Optional
+set(REFLECTCPP_MSGPACK ON) # Optional
+set(REFLECTCPP_TOML ON) # Optional
 set(REFLECTCPP_XML ON) # Optional
 set(REFLECTCPP_YAML ON) # Optional
 
@@ -492,6 +530,17 @@ vcpkg is a great, but very ambitious and complex project (just like C++ is a gre
 
 ## Compiling and running the tests
 
+reflect-cpp uses vcpkg for dependency management, including
+gtest, which is required for the tests.
+
+```bash
+# bootstrap vcpkg if you haven't done so already 
+git submodule update --init
+./vcpkg/bootstrap-vcpkg.sh # Linux, macOS
+./vcpkg/bootstrap-vcpkg.bat # Windows
+# You may be prompted to install additional dependencies.
+```
+
 ### JSON only
 
 To compile the tests, do the following:
@@ -513,13 +562,7 @@ To run the tests, do the following:
 To compile the tests with serialization formats other than JSON, do the following:
 
 ```bash
-# bootstrap vcpkg if you haven't done so already 
-git submodule update --init
-./vcpkg/bootstrap-vcpkg.sh # Linux, macOS
-./vcpkg/bootstrap-vcpkg.bat # Windows
-# You may be prompted to install additional dependencies.
-
-cmake -S . -B build -DREFLECTCPP_BUILD_TESTS=ON -DREFLECTCPP_BSON=ON -DREFLECTCPP_CBOR=ON -DREFLECTCPP_FLEXBUFFERS=ON -DREFLECTCPP_XML=ON -DREFLECTCPP_YAML=ON -DCMAKE_BUILD_TYPE=Release
+cmake -S . -B build -DREFLECTCPP_BUILD_TESTS=ON -DREFLECTCPP_BSON=ON -DREFLECTCPP_CBOR=ON -DREFLECTCPP_FLEXBUFFERS=ON -DREFLECTCPP_MSGPACK=ON -DREFLECTCPP_XML=ON -DREFLECTCPP_TOML=ON -DREFLECTCPP_YAML=ON -DCMAKE_BUILD_TYPE=Release
 cmake --build build -j 4 # gcc, clang
 cmake --build build --config Release -j 4 # MSVC
 ```
@@ -530,9 +573,11 @@ To run the tests, do the following:
 ./build/tests/bson/reflect-cpp-bson-tests
 ./build/tests/cbor/reflect-cpp-cbor-tests
 ./build/tests/flexbuffers/reflect-cpp-flexbuffers-tests
+./build/tests/msgpack/reflect-cpp-msgpack-tests
 ./build/tests/json/reflect-cpp-json-tests
+./build/tests/toml/reflect-cpp-toml-tests
 ./build/tests/xml/reflect-cpp-xml-tests
-./build/tests/xml/reflect-cpp-yaml-tests
+./build/tests/yaml/reflect-cpp-yaml-tests
 ```
 
 ## How to contribute

diff --git a/docs/README.md b/docs/README.md
@@ -36,6 +36,8 @@
 
 2.4) [Size validation](https://github.com/getml/reflect-cpp/blob/main/docs/size_validation.md) - For imposing size constraints on containers such as `std::vector` or `std::string`.
 
+2.5) [JSON schema](https://github.com/getml/reflect-cpp/blob/main/docs/json_schema.md) - For validating your schema before you even send it to your C++ backend.
+
 ## 3) Custom classes
 
 3.1) [Custom classes](https://github.com/getml/reflect-cpp/blob/main/docs/custom_classes.md) - For custom classes with private fields.
@@ -62,9 +64,13 @@
 
 5.4) [flexbuffers](https://github.com/getml/reflect-cpp/blob/main/docs/flexbuffers.md)
 
-5.5) [XML](https://github.com/getml/reflect-cpp/blob/main/docs/xml.md)
+5.5) [msgpack](https://github.com/getml/reflect-cpp/blob/main/docs/msgpack.md)
+
+5.6) [TOML](https://github.com/getml/reflect-cpp/blob/main/docs/toml.md)
+
+5.7) [XML](https://github.com/getml/reflect-cpp/blob/main/docs/xml.md)
 
-5.6) [YAML](https://github.com/getml/reflect-cpp/blob/main/docs/yaml.md)
+5.8) [YAML](https://github.com/getml/reflect-cpp/blob/main/docs/yaml.md)
 
 ## 6) Advanced topics
 

diff --git a/docs/json.md b/docs/json.md
@@ -21,7 +21,7 @@ You can parse JSON strings like this:
 const rfl::Result<Person> result = rfl::json::read<Person>(json_string);
 ```
 
-A `Person` struct can be written into a JSON string like this:
+A `Person` struct can be serialized like this:
 
 ```cpp
 const auto person = Person{...};