Added support for the cereal format (#643)

Author: liuzicheng1987

.github/workflows/linux.yaml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        format: ["JSON", "AVRO", "CAPNPROTO", "CBOR", "FLEXBUFFERS", "MSGPACK", "PARQUET", "TOML", "UBJSON", "XML", "YAML", "benchmarks", "headers"]
+        format: ["JSON", "AVRO", "CAPNPROTO", "CBOR", "CEREAL", "FLEXBUFFERS", "MSGPACK", "PARQUET", "TOML", "UBJSON", "XML", "YAML", "benchmarks", "headers"]
         compiler: [llvm, gcc]
         compiler-version: [11, 12, 13, 14, 16, 17, 18]
         cxx: [20, 23]

.github/workflows/windows.yaml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        format: ["JSON", "AVRO", "CAPNPROTO", "CBOR", "FLEXBUFFERS", "MSGPACK", "PARQUET", "TOML", "UBJSON", "XML", "YAML", "benchmarks"]
+        format: ["JSON", "AVRO", "CAPNPROTO", "CBOR", "CEREAL", "FLEXBUFFERS", "MSGPACK", "PARQUET", "TOML", "UBJSON", "XML", "YAML", "benchmarks"]
     name: "windows-msvc (${{ matrix.format }})"
     concurrency:
       group: "windows-${{ github.ref }}-${{ github.job }}-${{ matrix.format }}"

.gitignore

@@ -45,6 +45,7 @@
 *.bson
 *.capnproto
 *.cbor
+*.cereal
 *.csv
 *.json
 *.fb

CMakeLists.txt

@@ -12,6 +12,7 @@ option(REFLECTCPP_AVRO "Enable AVRO support" ${REFLECTCPP_ALL_FORMATS})
 option(REFLECTCPP_BSON "Enable BSON support" ${REFLECTCPP_ALL_FORMATS})
 option(REFLECTCPP_CAPNPROTO "Enable Cap’n Proto support" ${REFLECTCPP_ALL_FORMATS})
 option(REFLECTCPP_CBOR "Enable CBOR support" ${REFLECTCPP_ALL_FORMATS})
+option(REFLECTCPP_CEREAL "Enable Cereal support" ${REFLECTCPP_ALL_FORMATS})
 option(REFLECTCPP_CSV "Enable CSV support" ${REFLECTCPP_ALL_FORMATS})
 option(REFLECTCPP_FLEXBUFFERS "Enable flexbuffers support" ${REFLECTCPP_ALL_FORMATS})
 option(REFLECTCPP_MSGPACK "Enable msgpack support" ${REFLECTCPP_ALL_FORMATS})
@@ -49,6 +50,7 @@ if(REFLECTCPP_BUILD_BENCHMARKS)
     set(REFLECTCPP_BSON ON CACHE BOOL "" FORCE)
     set(REFLECTCPP_CAPNPROTO ON CACHE BOOL "" FORCE)
     set(REFLECTCPP_CBOR ON CACHE BOOL "" FORCE)
+    set(REFLECTCPP_CEREAL ON CACHE BOOL "" FORCE)
     set(REFLECTCPP_FLEXBUFFERS ON CACHE BOOL "" FORCE)
     set(REFLECTCPP_MSGPACK ON CACHE BOOL "" FORCE)
     set(REFLECTCPP_XML ON CACHE BOOL "" FORCE)
@@ -57,11 +59,25 @@ if(REFLECTCPP_BUILD_BENCHMARKS)
     set(REFLECTCPP_YAML ON CACHE BOOL "" FORCE)
 endif()
 
-if (REFLECTCPP_BUILD_TESTS OR REFLECTCPP_BUILD_BENCHMARKS OR REFLECTCPP_CHECK_HEADERS OR
-    (REFLECTCPP_JSON AND NOT REFLECTCPP_USE_BUNDLED_DEPENDENCIES) OR REFLECTCPP_AVRO OR
-    REFLECTCPP_BSON OR REFLECTCPP_CAPNPROTO OR REFLECTCPP_CBOR OR REFLECTCPP_CSV OR
-    REFLECTCPP_FLEXBUFFERS OR REFLECTCPP_MSGPACK OR REFLECTCPP_PARQUET OR REFLECTCPP_XML OR 
-    REFLECTCPP_TOML OR REFLECTCPP_UBJSON OR REFLECTCPP_YAML)
+if (
+    REFLECTCPP_BUILD_TESTS OR
+    REFLECTCPP_BUILD_BENCHMARKS OR
+    REFLECTCPP_CHECK_HEADERS OR
+    (REFLECTCPP_JSON AND NOT REFLECTCPP_USE_BUNDLED_DEPENDENCIES) OR
+    REFLECTCPP_AVRO OR
+    REFLECTCPP_BSON OR
+    REFLECTCPP_CAPNPROTO OR
+    REFLECTCPP_CBOR OR
+    REFLECTCPP_CEREAL OR
+    REFLECTCPP_CSV OR
+    REFLECTCPP_FLEXBUFFERS OR
+    REFLECTCPP_MSGPACK OR
+    REFLECTCPP_PARQUET OR
+    REFLECTCPP_XML OR
+    REFLECTCPP_TOML OR
+    REFLECTCPP_UBJSON OR
+    REFLECTCPP_YAML
+)
     # enable vcpkg per default if features other than JSON are required
     set(REFLECTCPP_USE_VCPKG_DEFAULT ON)
 endif()
@@ -98,7 +114,11 @@ if (REFLECTCPP_USE_VCPKG)
     if (REFLECTCPP_CBOR OR REFLECTCPP_CHECK_HEADERS)
         list(APPEND VCPKG_MANIFEST_FEATURES "cbor")
     endif()
-    
+
+    if (REFLECTCPP_CEREAL OR REFLECTCPP_CHECK_HEADERS)
+	list(APPEND VCPKG_MANIFEST_FEATURES "cereal")
+    endif()
+
     if (REFLECTCPP_CSV OR REFLECTCPP_CHECK_HEADERS)
         list(APPEND VCPKG_MANIFEST_FEATURES "csv")
     endif()
@@ -172,10 +192,6 @@ else()
         target_compile_options(reflectcpp PRIVATE 
             $<$<CONFIG:Debug>:
                 -Wall -Wextra -Wpedantic -Wshadow -Wconversion
-                #-Wnull-dereference -Wold-style-cast
-                #-g3 -fno-omit-frame-pointer
-                #-fsanitize=address,undefined
-                #-fno-sanitize-recover=undefined
             >
         )
     endif()
@@ -312,6 +328,16 @@ if (REFLECTCPP_CBOR OR REFLECTCPP_CHECK_HEADERS)
     include_directories(PUBLIC ${jsoncons_INCLUDE_DIRS})
 endif ()
 
+if (REFLECTCPP_CEREAL OR REFLECTCPP_CHECK_HEADERS)
+    list(APPEND REFLECT_CPP_SOURCES
+	src/reflectcpp_cereal.cpp
+    )
+    if (NOT TARGET cereal::cereal)
+	find_package(cereal CONFIG REQUIRED)
+    endif ()
+    target_link_libraries(reflectcpp PUBLIC cereal::cereal)
+endif()
+
 if (REFLECTCPP_CSV OR REFLECTCPP_CHECK_HEADERS)
     if (NOT TARGET Arrow)
         find_package(Arrow CONFIG REQUIRED)

README.md

@@ -69,6 +69,7 @@ The following table lists the serialization formats currently supported by refle
 | 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         | [jsoncons](https://github.com/danielaparker/jsoncons)| >= 0.176.0   | BSL 1.0    | JSON-like binary format                              |
+| Cereal       | [Cereal](https://uscilab.github.io/cereal/)          | >= 1.3.2     | BSD        | C++ serialization library with multiple formats      |
 | CSV          | [Apache Arrow](https://arrow.apache.org/)            | >= 21.0.0    | Apache 2.0 | Tabular textual 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                              |
@@ -155,6 +156,7 @@ rfl::avro::write(homer);
 rfl::bson::write(homer);
 rfl::capnproto::write(homer);
 rfl::cbor::write(homer);
+rfl::cereal::write(homer);
 rfl::flexbuf::write(homer);
 rfl::msgpack::write(homer);
 rfl::toml::write(homer);
@@ -165,6 +167,7 @@ rfl::avro::read<Person>(avro_bytes);
 rfl::bson::read<Person>(bson_bytes);
 rfl::capnproto::read<Person>(capnproto_bytes);
 rfl::cbor::read<Person>(cbor_bytes);
+rfl::cereal::read<Person>(cereal_bytes);
 rfl::flexbuf::read<Person>(flexbuf_bytes);
 rfl::msgpack::read<Person>(msgpack_bytes);
 rfl::toml::read<Person>(toml_string);

benchmarks/all/canada_read.cpp

@@ -4,6 +4,7 @@
 #include <rfl/bson.hpp>
 #include <rfl/capnproto.hpp>
 #include <rfl/cbor.hpp>
+#include <rfl/cereal.hpp>
 #include <rfl/flexbuf.hpp>
 #include <rfl/json.hpp>
 #include <rfl/msgpack.hpp>
@@ -104,6 +105,17 @@ static void BM_canada_read_reflect_cpp_cbor_without_field_names(
 }
 BENCHMARK(BM_canada_read_reflect_cpp_cbor_without_field_names);
 
+static void BM_canada_read_reflect_cpp_cereal(benchmark::State &state) {
+  const auto data = rfl::cereal::write(load_data());
+  for (auto _ : state) {
+    const auto res = rfl::cereal::read<FeatureCollection>(data);
+    if (!res) {
+      std::cout << res.error().what() << std::endl;
+    }
+  }
+}
+BENCHMARK(BM_canada_read_reflect_cpp_cereal);
+
 static void BM_canada_read_reflect_cpp_flexbuf(benchmark::State &state) {
   const auto data = rfl::flexbuf::write(load_data());
   for (auto _ : state) {

benchmarks/all/canada_write.cpp

@@ -4,6 +4,7 @@
 #include <rfl/bson.hpp>
 #include <rfl/capnproto.hpp>
 #include <rfl/cbor.hpp>
+#include <rfl/cereal.hpp>
 #include <rfl/flexbuf.hpp>
 #include <rfl/json.hpp>
 #include <rfl/msgpack.hpp>
@@ -103,6 +104,17 @@ static void BM_canada_write_reflect_cpp_cbor_without_field_names(
 }
 BENCHMARK(BM_canada_write_reflect_cpp_cbor_without_field_names);
 
+static void BM_canada_write_reflect_cpp_cereal(benchmark::State &state) {
+  const auto data = load_data();
+  for (auto _ : state) {
+    const auto output = rfl::cereal::write(data);
+    if (output.size() == 0) {
+      std::cout << "No output" << std::endl;
+    }
+  }
+}
+BENCHMARK(BM_canada_write_reflect_cpp_cereal);
+
 static void BM_canada_write_reflect_cpp_flexbuf_without_field_names(
     benchmark::State &state) {
   const auto data = load_data();

benchmarks/all/licenses_read.cpp

@@ -5,6 +5,7 @@
 #include <rfl/bson.hpp>
 #include <rfl/capnproto.hpp>
 #include <rfl/cbor.hpp>
+#include <rfl/cereal.hpp>
 #include <rfl/flexbuf.hpp>
 #include <rfl/json.hpp>
 #include <rfl/msgpack.hpp>
@@ -120,6 +121,17 @@ static void BM_licenses_read_reflect_cpp_cbor_without_field_names(
 }
 BENCHMARK(BM_licenses_read_reflect_cpp_cbor_without_field_names);
 
+static void BM_licenses_read_reflect_cpp_cereal(benchmark::State &state) {
+  const auto data = rfl::cereal::write(load_data());
+  for (auto _ : state) {
+    const auto res = rfl::cereal::read<Licenses>(data);
+    if (!res) {
+      std::cout << res.error().what() << std::endl;
+    }
+  }
+}
+BENCHMARK(BM_licenses_read_reflect_cpp_cereal);
+
 static void BM_licenses_read_reflect_cpp_flexbuf(benchmark::State &state) {
   const auto data = rfl::flexbuf::write(load_data());
   for (auto _ : state) {

benchmarks/all/licenses_write.cpp

@@ -5,6 +5,7 @@
 #include <rfl/bson.hpp>
 #include <rfl/capnproto.hpp>
 #include <rfl/cbor.hpp>
+#include <rfl/cereal.hpp>
 #include <rfl/flexbuf.hpp>
 #include <rfl/json.hpp>
 #include <rfl/msgpack.hpp>
@@ -120,6 +121,17 @@ static void BM_licenses_write_reflect_cpp_cbor_without_field_names(
 }
 BENCHMARK(BM_licenses_write_reflect_cpp_cbor_without_field_names);
 
+static void BM_licenses_write_reflect_cpp_cereal(benchmark::State &state) {
+  const auto data = load_data();
+  for (auto _ : state) {
+    const auto output = rfl::cereal::write(data);
+    if (output.size() == 0) {
+      std::cout << "No output" << std::endl;
+    }
+  }
+}
+BENCHMARK(BM_licenses_write_reflect_cpp_cereal);
+
 static void BM_licenses_write_reflect_cpp_flexbuf(benchmark::State &state) {
   const auto data = load_data();
   for (auto _ : state) {

benchmarks/all/person_read.cpp

@@ -4,6 +4,7 @@
 #include <rfl/bson.hpp>
 #include <rfl/capnproto.hpp>
 #include <rfl/cbor.hpp>
+#include <rfl/cereal.hpp>
 #include <rfl/flexbuf.hpp>
 #include <rfl/json.hpp>
 #include <rfl/msgpack.hpp>
@@ -98,6 +99,17 @@ static void BM_person_read_reflect_cpp_cbor_without_field_names(
 }
 BENCHMARK(BM_person_read_reflect_cpp_cbor_without_field_names);
 
+static void BM_person_read_reflect_cpp_cereal(benchmark::State &state) {
+  const auto data = rfl::cereal::write(load_data());
+  for (auto _ : state) {
+    const auto res = rfl::cereal::read<Person>(data);
+    if (!res) {
+      std::cout << res.error().what() << std::endl;
+    }
+  }
+}
+BENCHMARK(BM_person_read_reflect_cpp_cereal);
+
 static void BM_person_read_reflect_cpp_flexbuf(benchmark::State &state) {
   const auto data = rfl::flexbuf::write(load_data());
   for (auto _ : state) {