Added support for Cap'n Proto

.github/workflows/linux.yaml

@@ -53,7 +53,7 @@ jobs:
           pipx install conan
           conan profile detect
       - name: Make sure the library compiles with Conan
-        run: conan build . --build=missing -s compiler.cppstd=gnu20 -o *:with_cbor=True -o *:with_flatbuffers=True -o *:with_msgpack=True -o *:with_toml=True -o *:with_ubjson=True -o *:with_xml=True -o *:with_yaml=True      
+        run: conan build . --build=missing -s compiler.cppstd=gnu20 -o *:with_capnproto=True -o *:with_cbor=True -o *:with_flatbuffers=True -o *:with_msgpack=True -o *:with_toml=True -o *:with_ubjson=True -o *:with_xml=True -o *:with_yaml=True      
       - name: Compile
         run: |
           if [[ "${{ matrix.compiler }}" == "llvm" ]]; then
@@ -66,7 +66,7 @@ jobs:
           sudo ln -s $(which ccache) /usr/local/bin/$CC
           sudo ln -s $(which ccache) /usr/local/bin/$CXX
           $CXX --version
-          cmake -S . -B build -G Ninja -DREFLECTCPP_BUILD_TESTS=ON -DREFLECTCPP_BUILD_BENCHMARKS=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 -S . -B build -G Ninja -DREFLECTCPP_BUILD_TESTS=ON -DREFLECTCPP_BUILD_BENCHMARKS=ON -DREFLECTCPP_BSON=ON -DREFLECTCPP_CAPNPROTO=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
       - name: Run tests
         run: |

.github/workflows/macos-clang.yaml

@@ -44,7 +44,7 @@ jobs:
         env:
           CC: clang
           CXX: clang++
-        run: conan build . --build=missing -s compiler.cppstd=gnu20 -o *:with_cbor=True -o *:with_flatbuffers=True -o *:with_msgpack=True -o *:with_toml=True -o *:with_ubjson=True -o *:with_xml=True -o *:with_yaml=True            
+        run: conan build . --build=missing -s compiler.cppstd=gnu20 -o *:with_capnproto=True -o *:with_cbor=True -o *:with_flatbuffers=True -o *:with_msgpack=True -o *:with_toml=True -o *:with_ubjson=True -o *:with_xml=True -o *:with_yaml=True            
       - name: Compile
         env:
           CC: clang
@@ -55,7 +55,7 @@ jobs:
             export CMAKE_GENERATOR=Ninja
           fi
           $CXX --version
-          cmake -S . -B build -DREFLECTCPP_BUILD_TESTS=ON -DREFLECTCPP_BUILD_BENCHMARKS=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 -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++
+          cmake -S . -B build -DREFLECTCPP_BUILD_TESTS=ON -DREFLECTCPP_BUILD_BENCHMARKS=ON -DREFLECTCPP_BSON=ON -DREFLECTCPP_CAPNPROTO=ON -DREFLECTCPP_CBOR=ON -DREFLECTCPP_FLEXBUFFERS=ON -DREFLECTCPP_MSGPACK=ON -DREFLECTCPP_TOML=ON -DREFLECTCPP_XML=ON -DREFLECTCPP_YAML=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++
           cmake --build build -j 4
       - name: Run tests
         run: |

.github/workflows/windows-msvc.yaml

@@ -24,7 +24,7 @@ jobs:
       - uses: lukka/run-vcpkg@v11
       - name: Compile
         run: |
-          cmake -S . -B build -DREFLECTCPP_BUILD_TESTS=ON -DREFLECTCPP_BUILD_BENCHMARKS=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 -S . -B build -DREFLECTCPP_BUILD_TESTS=ON -DREFLECTCPP_BUILD_BENCHMARKS=ON -DREFLECTCPP_BSON=ON -DREFLECTCPP_CAPNPROTO=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 
       - name: Run tests
         run: |

.gitignore

@@ -43,6 +43,7 @@
 # Output files
 *.avro
 *.bson
+*.capnproto
 *.cbor
 *.json
 *.fb

CMakeLists.txt

@@ -5,6 +5,7 @@ option(REFLECTCPP_BUILD_SHARED "Build shared library" ${BUILD_SHARED_LIBS})
 option(REFLECTCPP_JSON "Enable JSON support" ON) # enabled by default
 option(REFLECTCPP_AVRO "Enable AVRO support" OFF)
 option(REFLECTCPP_BSON "Enable BSON support" OFF)
+option(REFLECTCPP_CAPNPROTO "Enable Cap’n Proto support" OFF)
 option(REFLECTCPP_CBOR "Enable CBOR support" OFF)
 option(REFLECTCPP_FLEXBUFFERS "Enable flexbuffers support" OFF)
 option(REFLECTCPP_MSGPACK "Enable msgpack support" OFF)
@@ -24,6 +25,7 @@ if(REFLECTCPP_BUILD_BENCHMARKS)
     set(REFLECTCPP_JSON ON CACHE BOOL "" FORCE)
     set(REFLECTCPP_AVRO ON CACHE BOOL "" FORCE)
     set(REFLECTCPP_BSON ON CACHE BOOL "" FORCE)
+    set(REFLECTCPP_CAPNPROTO ON CACHE BOOL "" FORCE)
     set(REFLECTCPP_CBOR ON CACHE BOOL "" FORCE)
     set(REFLECTCPP_FLEXBUFFERS ON CACHE BOOL "" FORCE)
     set(REFLECTCPP_MSGPACK ON CACHE BOOL "" FORCE)
@@ -35,7 +37,8 @@ endif()
 
 if (REFLECTCPP_BUILD_TESTS OR REFLECTCPP_BUILD_BENCHMARKS OR
     (REFLECTCPP_JSON AND NOT REFLECTCPP_USE_BUNDLED_DEPENDENCIES) OR REFLECTCPP_AVRO OR
-    REFLECTCPP_BSON OR REFLECTCPP_CBOR OR REFLECTCPP_FLEXBUFFERS OR REFLECTCPP_MSGPACK OR REFLECTCPP_XML OR REFLECTCPP_TOML OR REFLECTCPP_UBJSON OR REFLECTCPP_YAML)
+    REFLECTCPP_BSON OR REFLECTCPP_CAPNPROTO OR REFLECTCPP_CBOR OR REFLECTCPP_FLEXBUFFERS OR 
+    REFLECTCPP_MSGPACK OR REFLECTCPP_XML OR REFLECTCPP_TOML OR REFLECTCPP_UBJSON OR REFLECTCPP_YAML)
     # enable vcpkg per default if require features other than JSON
     set(REFLECTCPP_USE_VCPKG_DEFAULT ON)
 endif()
@@ -130,6 +133,16 @@ if (REFLECTCPP_BSON)
     target_link_libraries(reflectcpp PUBLIC $<IF:$<TARGET_EXISTS:mongo::bson_static>,mongo::bson_static,mongo::bson_shared>)
 endif ()
 
+if (REFLECTCPP_CAPNPROTO)
+    list(APPEND REFLECT_CPP_SOURCES
+        src/reflectcpp_capnproto.cpp
+    )
+    if (NOT TARGET CapnProto)
+        find_package(CapnProto CONFIG REQUIRED)
+    endif ()
+     target_link_libraries(reflectcpp PUBLIC CapnProto::kj CapnProto::capnp CapnProto::capnpc CapnProto::kj-gzip)
+endif ()
+
 if (REFLECTCPP_CBOR)
     list(APPEND REFLECT_CPP_SOURCES
         src/reflectcpp_cbor.cpp

README.md

@@ -65,6 +65,7 @@ The following table lists the serialization formats currently supported by refle
 | JSON         | [yyjson](https://github.com/ibireme/yyjson)          | >= 0.8.0     | MIT        | out-of-the-box support, included in this repository  |
 | Avro         | [avro-c](https://avro.apache.org/docs/1.11.1/api/c/) | >= 1.11.3    | Apache 2.0 | Schemaful binary format                              |
 | BSON         | [libbson](https://github.com/mongodb/mongo-c-driver) | >= 1.25.1    | Apache 2.0 | JSON-like binary format                              |
+| Cap'n Proto  | [capnproto](https://capnproto.org)                   | >= 1.0.2     | MIT        | Schemaful 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                              |
@@ -512,7 +513,7 @@ In addition, it supports the following custom containers:
 
 - `rfl::Binary`: Used to express numbers in binary format.
 - `rfl::Box`: Similar to `std::unique_ptr`, but (almost) guaranteed to never be null.
-- `rfl::Bytestring`: An alias for `std::basic_string<std::byte>`. Supported by BSON, CBOR, flexbuffers, msgpack and UBJSON. 
+- `rfl::Bytestring`: An alias for `std::basic_string<std::byte>`. Supported by Avro, BSON, Cap'n Proto, CBOR, flexbuffers, msgpack and UBJSON. 
 - `rfl::Generic`: A catch-all type that can represent (almost) anything.
 - `rfl::Hex`: Used to express numbers in hex format.
 - `rfl::Literal`: An explicitly enumerated string.

benchmarks/all/canada_read.cpp

@@ -5,6 +5,7 @@
 #include <optional>
 #include <rfl/avro.hpp>
 #include <rfl/bson.hpp>
+#include <rfl/capnproto.hpp>
 #include <rfl/cbor.hpp>
 #include <rfl/flexbuf.hpp>
 #include <rfl/json.hpp>
@@ -71,6 +72,18 @@ static void BM_canada_read_reflect_cpp_bson(benchmark::State &state) {
 }
 BENCHMARK(BM_canada_read_reflect_cpp_bson);
 
+static void BM_canada_read_reflect_cpp_capnproto(benchmark::State &state) {
+  const auto schema = rfl::capnproto::to_schema<FeatureCollection>();
+  const auto data = rfl::capnproto::write(load_data(), schema);
+  for (auto _ : state) {
+    const auto res = rfl::capnproto::read<FeatureCollection>(data, schema);
+    if (!res) {
+      std::cout << res.error()->what() << std::endl;
+    }
+  }
+}
+BENCHMARK(BM_canada_read_reflect_cpp_capnproto);
+
 static void BM_canada_read_reflect_cpp_cbor(benchmark::State &state) {
   const auto data = rfl::cbor::write(load_data());
   for (auto _ : state) {

benchmarks/all/canada_write.cpp

@@ -5,6 +5,7 @@
 #include <optional>
 #include <rfl/avro.hpp>
 #include <rfl/bson.hpp>
+#include <rfl/capnproto.hpp>
 #include <rfl/cbor.hpp>
 #include <rfl/flexbuf.hpp>
 #include <rfl/json.hpp>
@@ -71,6 +72,18 @@ static void BM_canada_write_reflect_cpp_bson(benchmark::State &state) {
 }
 BENCHMARK(BM_canada_write_reflect_cpp_bson);
 
+static void BM_canada_write_reflect_cpp_capnproto(benchmark::State &state) {
+  const auto schema = rfl::capnproto::to_schema<FeatureCollection>();
+  const auto data = load_data();
+  for (auto _ : state) {
+    const auto output = rfl::capnproto::write(data, schema);
+    if (output.size() == 0) {
+      std::cout << "No output" << std::endl;
+    }
+  }
+}
+BENCHMARK(BM_canada_write_reflect_cpp_capnproto);
+
 static void BM_canada_write_reflect_cpp_cbor(benchmark::State &state) {
   const auto data = load_data();
   for (auto _ : state) {

benchmarks/all/licenses_read.cpp

@@ -5,6 +5,7 @@
 #include <optional>
 #include <rfl/avro.hpp>
 #include <rfl/bson.hpp>
+#include <rfl/capnproto.hpp>
 #include <rfl/cbor.hpp>
 #include <rfl/flexbuf.hpp>
 #include <rfl/json.hpp>
@@ -87,6 +88,18 @@ static void BM_licenses_read_reflect_cpp_bson(benchmark::State &state) {
 }
 BENCHMARK(BM_licenses_read_reflect_cpp_bson);
 
+static void BM_licenses_read_reflect_cpp_capnproto(benchmark::State &state) {
+  const auto schema = rfl::capnproto::to_schema<Licenses>();
+  const auto data = rfl::capnproto::write(load_data(), schema);
+  for (auto _ : state) {
+    const auto res = rfl::capnproto::read<Licenses>(data, schema);
+    if (!res) {
+      std::cout << res.error()->what() << std::endl;
+    }
+  }
+}
+BENCHMARK(BM_licenses_read_reflect_cpp_capnproto);
+
 static void BM_licenses_read_reflect_cpp_cbor(benchmark::State &state) {
   const auto data = rfl::cbor::write(load_data());
   for (auto _ : state) {

benchmarks/all/licenses_write.cpp

@@ -5,6 +5,7 @@
 #include <optional>
 #include <rfl/avro.hpp>
 #include <rfl/bson.hpp>
+#include <rfl/capnproto.hpp>
 #include <rfl/cbor.hpp>
 #include <rfl/flexbuf.hpp>
 #include <rfl/json.hpp>
@@ -87,6 +88,18 @@ static void BM_licenses_write_reflect_cpp_bson(benchmark::State &state) {
 }
 BENCHMARK(BM_licenses_write_reflect_cpp_bson);
 
+static void BM_licenses_write_reflect_cpp_capnproto(benchmark::State &state) {
+  const auto schema = rfl::capnproto::to_schema<Licenses>();
+  const auto data = load_data();
+  for (auto _ : state) {
+    const auto output = rfl::capnproto::write(data, schema);
+    if (output.size() == 0) {
+      std::cout << "No output" << std::endl;
+    }
+  }
+}
+BENCHMARK(BM_licenses_write_reflect_cpp_capnproto);
+
 static void BM_licenses_write_reflect_cpp_cbor(benchmark::State &state) {
   const auto data = load_data();
   for (auto _ : state) {

benchmarks/all/person_read.cpp

@@ -5,6 +5,7 @@
 #include <optional>
 #include <rfl/avro.hpp>
 #include <rfl/bson.hpp>
+#include <rfl/capnproto.hpp>
 #include <rfl/cbor.hpp>
 #include <rfl/flexbuf.hpp>
 #include <rfl/json.hpp>
@@ -66,6 +67,18 @@ static void BM_person_read_reflect_cpp_bson(benchmark::State &state) {
 }
 BENCHMARK(BM_person_read_reflect_cpp_bson);
 
+static void BM_person_read_reflect_cpp_capnproto(benchmark::State &state) {
+  const auto schema = rfl::capnproto::to_schema<Person>();
+  const auto data = rfl::capnproto::write(load_data(), schema);
+  for (auto _ : state) {
+    const auto res = rfl::capnproto::read<Person>(data, schema);
+    if (!res) {
+      std::cout << res.error()->what() << std::endl;
+    }
+  }
+}
+BENCHMARK(BM_person_read_reflect_cpp_capnproto);
+
 static void BM_person_read_reflect_cpp_cbor(benchmark::State &state) {
   const auto data = rfl::cbor::write(load_data());
   for (auto _ : state) {

benchmarks/all/person_write.cpp

@@ -5,6 +5,7 @@
 #include <optional>
 #include <rfl/avro.hpp>
 #include <rfl/bson.hpp>
+#include <rfl/capnproto.hpp>
 #include <rfl/cbor.hpp>
 #include <rfl/flexbuf.hpp>
 #include <rfl/json.hpp>
@@ -67,6 +68,18 @@ static void BM_person_write_reflect_cpp_bson(benchmark::State &state) {
 }
 BENCHMARK(BM_person_write_reflect_cpp_bson);
 
+static void BM_person_write_reflect_cpp_capnproto(benchmark::State &state) {
+  const auto schema = rfl::capnproto::to_schema<Person>();
+  const auto data = load_data();
+  for (auto _ : state) {
+    const auto output = rfl::capnproto::write(data, schema);
+    if (output.size() == 0) {
+      std::cout << "No output" << std::endl;
+    }
+  }
+}
+BENCHMARK(BM_person_write_reflect_cpp_capnproto);
+
 static void BM_person_write_reflect_cpp_cbor(benchmark::State &state) {
   const auto data = load_data();
   for (auto _ : state) {

conanfile.py

@@ -23,6 +23,7 @@ class ReflectCppConan(ConanFile):
         "reflection",
         "serialization",
         "memory",
+        "Cap'n Proto",
         "cbor",
         "flatbuffers",
         "json",
@@ -37,6 +38,7 @@ class ReflectCppConan(ConanFile):
     options = {
         "shared": [True, False],
         "fPIC": [True, False],
+        "with_capnproto": [True, False],
         "with_cbor": [True, False],
         "with_flatbuffers": [True, False],
         "with_msgpack": [True, False],
@@ -48,6 +50,7 @@ class ReflectCppConan(ConanFile):
     default_options = {
         "shared": False,
         "fPIC": True,
+        "with_capnproto": False,
         "with_cbor": False,
         "with_flatbuffers": False,
         "with_msgpack": False,
@@ -68,6 +71,8 @@ def configure(self):
     def requirements(self):
         self.requires("ctre/3.9.0", transitive_headers=True)
         self.requires("yyjson/0.10.0", transitive_headers=True)
+        if self.options.with_capnproto:
+            self.requires("capnproto/1.1.0", transitive_headers=True)
         if self.options.with_cbor:
             self.requires("tinycbor/0.6.0", transitive_headers=True)
         if self.options.with_flatbuffers:
@@ -105,6 +110,7 @@ def generate(self):
         tc.cache_variables["REFLECTCPP_BUILD_SHARED"] = self.options.shared
         tc.cache_variables["REFLECTCPP_USE_BUNDLED_DEPENDENCIES"] = False
         tc.cache_variables["REFLECTCPP_USE_VCPKG"] = False
+        tc.cache_variables["REFLECTCPP_CAPNPROTO"] = self.options.with_capnproto
         tc.cache_variables["REFLECTCPP_CBOR"] = self.options.with_cbor
         tc.cache_variables["REFLECTCPP_FLEXBUFFERS"] = self.options.with_flatbuffers
         tc.cache_variables["REFLECTCPP_MSGPACK"] = self.options.with_msgpack

docs/supported_formats/avro.md

@@ -36,7 +36,7 @@ However, Avro is a schemaful format, so before you serialize or
 deserialize, you have to declare a schema. In the two function calls
 above, this is abstracted away.
 
-But if you are repeated serializing or deserializing the same struct,
+But if you are repeatedly serializing or deserializing the same struct,
 it is more efficient to generate the schema explicitly:
 
 ```cpp