Feat/286/std expected

.github/workflows/linux.yaml → .github/workflows/linux-cxx20.yaml

@@ -1,4 +1,4 @@
-name: linux
+name: linux-cxx20
 
 on: [ pull_request, workflow_dispatch ]
 
@@ -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_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 -S . -B build -G Ninja -DCMAKE_CXX_STANDARD=20 -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/linux-cxx23.yaml

@@ -0,0 +1,84 @@
+name: linux-cxx23
+
+on: [ pull_request, workflow_dispatch ]
+
+env: 
+    VCPKG_BINARY_SOURCES: "clear;x-gha,readwrite"
+
+jobs:
+  linux:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - compiler: gcc
+            compiler-version: 13
+          - compiler: gcc
+            compiler-version: 14
+    name: "${{ github.job }} (${{ matrix.compiler }}-${{ matrix.compiler-version }})"
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - name: Export GitHub Actions cache environment variables
+        uses: actions/github-script@v7
+        with:
+          script: |
+            core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || '');
+            core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
+      - name: Setup ccache
+        uses: hendrikmuhs/ccache-action@v1
+        with:
+          key: "${{ github.job }}-${{ matrix.compiler }}-${{ matrix.compiler-version }}"
+          max-size: "2G"
+      - name: Run vcpkg
+        uses: lukka/run-vcpkg@v11
+      - name: Install dependencies
+        run: |
+          sudo apt update
+          sudo apt install -y ninja-build ${{ matrix.additional-dep }}
+      - name: Install Conan
+        run: |
+          sudo apt install -y pipx
+          pipx install conan
+          conan profile detect
+      - name: Make sure the library compiles with Conan
+        run: conan build . --build=missing -s compiler.cppstd=gnu23 -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
+            export CC=clang-${{ matrix.compiler-version }}
+            export CXX=clang++-${{ matrix.compiler-version }}
+          elif [[ "${{ matrix.compiler }}" == "gcc" ]]; then
+            export CC=gcc-${{ matrix.compiler-version }}
+            export CXX=g++-${{ matrix.compiler-version }}
+          fi
+          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 -DCMAKE_CXX_STANDARD=23 -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 -DREFLECTCPP_USE_STD_EXPECTED=ON
+          cmake --build build
+      - name: Run tests
+        run: |
+          ctest --test-dir build --output-on-failure
+      - name: Run benchmarks
+        run: |
+          echo '# Benchmarks' >> $GITHUB_STEP_SUMMARY 
+          echo '## Benchmarks across different formats' >> $GITHUB_STEP_SUMMARY 
+          echo '```' >> $GITHUB_STEP_SUMMARY
+          ./build/benchmarks/all/reflect-cpp-all-format-benchmarks --benchmark_filter=canada_read >> $GITHUB_STEP_SUMMARY
+          ./build/benchmarks/all/reflect-cpp-all-format-benchmarks --benchmark_filter=canada_write >> $GITHUB_STEP_SUMMARY
+          ./build/benchmarks/all/reflect-cpp-all-format-benchmarks --benchmark_filter=licenses_read >> $GITHUB_STEP_SUMMARY
+          ./build/benchmarks/all/reflect-cpp-all-format-benchmarks --benchmark_filter=licenses_write >> $GITHUB_STEP_SUMMARY
+          ./build/benchmarks/all/reflect-cpp-all-format-benchmarks --benchmark_filter=person_read >> $GITHUB_STEP_SUMMARY
+          ./build/benchmarks/all/reflect-cpp-all-format-benchmarks --benchmark_filter=person_write >> $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY
+          echo '## Benchmarks for JSON' >> $GITHUB_STEP_SUMMARY 
+          echo '```' >> $GITHUB_STEP_SUMMARY
+          ./build/benchmarks/json/reflect-cpp-json-benchmarks --benchmark_filter=person_read >> $GITHUB_STEP_SUMMARY
+          ./build/benchmarks/json/reflect-cpp-json-benchmarks --benchmark_filter=canada >> $GITHUB_STEP_SUMMARY
+          ./build/benchmarks/json/reflect-cpp-json-benchmarks --benchmark_filter=licenses >> $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY

.github/workflows/macos-clang.yaml → .github/workflows/macos-cxx20.yaml

@@ -1,4 +1,4 @@
-name: macos-clang
+name: macos-cxx20
 
 on: [ pull_request, workflow_dispatch ]
 
@@ -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_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 -S . -B build -DCMAKE_CXX_STANDARD=20 -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 → .github/workflows/windows-cxx20.yaml

@@ -1,4 +1,4 @@
-name: windows-msvc 
+name: windows-cxx20 
 
 on: [ pull_request, workflow_dispatch ]
 
@@ -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_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 -S . -B build -DCMAKE_CXX_STANDARD=20 -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

@@ -10,7 +10,7 @@
 # Precompiled Headers
 *.gch
 *.pch
-
+.cache
 # Compiled Dynamic libraries
 *.so
 *.dylib

CMakeLists.txt

@@ -19,6 +19,21 @@ option(REFLECTCPP_BUILD_TESTS "Build tests" OFF)
 
 option(REFLECTCPP_USE_BUNDLED_DEPENDENCIES "Use the bundled dependencies" ON)
 
+option(REFLECTCPP_USE_STD_EXPECTED "Use std::expected instead of the built-in Result type (requires C++-23)" OFF)
+
+if(REFLECTCPP_USE_STD_EXPECTED)
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DREFLECTCPP_USE_STD_EXPECTED")
+    if(NOT DEFINED CMAKE_CXX_STANDARD)
+        set(CMAKE_CXX_STANDARD 23)
+    endif()
+else()
+    if(NOT DEFINED CMAKE_CXX_STANDARD)
+        set(CMAKE_CXX_STANDARD 20)
+    endif()
+endif()
+
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
 set(REFLECTCPP_USE_VCPKG_DEFAULT OFF)
 
 if(REFLECTCPP_BUILD_BENCHMARKS)
@@ -51,8 +66,6 @@ endif ()
 
 project(reflectcpp VERSION 0.17.0 LANGUAGES CXX)
 
-set(CMAKE_CXX_STANDARD 20)
-
 if (REFLECTCPP_BUILD_SHARED)
     add_library(reflectcpp SHARED)
     set_target_properties(reflectcpp PROPERTIES SOVERSION ${PROJECT_VERSION})

README.md

@@ -554,7 +554,7 @@ https://conan.io/center/recipes/reflect-cpp
 This will compile reflect-cpp with JSON support only. You can then include reflect-cpp in your project and link to the binary.
 
 ```bash
-cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
+cmake -S . -B build -DCMAKE_CXX_STANDARD=20 -DCMAKE_BUILD_TYPE=Release
 cmake --build build -j 4  # gcc, clang
 cmake --build build --config Release -j 4  # MSVC
 ```

benchmarks/README.md

@@ -19,7 +19,7 @@ this repository to learn how to install vcpkg.
 To compile the benchmarks, do the following:
 
 ```bash
-cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DREFLECTCPP_BUILD_BENCHMARKS=ON
+cmake -S . -B build -DCMAKE_CXX_STANDARD=20 -DCMAKE_BUILD_TYPE=Release -DREFLECTCPP_BUILD_BENCHMARKS=ON
 cmake --build build -j 4 # gcc, clang
 cmake --build build --config Release -j 4 # MSVC
 ```

benchmarks/all/canada_read.cpp

@@ -55,7 +55,7 @@ static void BM_canada_read_reflect_cpp_avro(benchmark::State &state) {
   for (auto _ : state) {
     const auto res = rfl::avro::read<FeatureCollection>(data, schema);
     if (!res) {
-      std::cout << res.error()->what() << std::endl;
+      std::cout << res.error().what() << std::endl;
     }
   }
 }
@@ -66,7 +66,7 @@ static void BM_canada_read_reflect_cpp_bson(benchmark::State &state) {
   for (auto _ : state) {
     const auto res = rfl::bson::read<FeatureCollection>(data);
     if (!res) {
-      std::cout << res.error()->what() << std::endl;
+      std::cout << res.error().what() << std::endl;
     }
   }
 }
@@ -78,7 +78,7 @@ static void BM_canada_read_reflect_cpp_capnproto(benchmark::State &state) {
   for (auto _ : state) {
     const auto res = rfl::capnproto::read<FeatureCollection>(data, schema);
     if (!res) {
-      std::cout << res.error()->what() << std::endl;
+      std::cout << res.error().what() << std::endl;
     }
   }
 }
@@ -89,7 +89,7 @@ static void BM_canada_read_reflect_cpp_cbor(benchmark::State &state) {
   for (auto _ : state) {
     const auto res = rfl::cbor::read<FeatureCollection>(data);
     if (!res) {
-      std::cout << res.error()->what() << std::endl;
+      std::cout << res.error().what() << std::endl;
     }
   }
 }
@@ -102,7 +102,7 @@ static void BM_canada_read_reflect_cpp_cbor_without_field_names(
     const auto res =
         rfl::cbor::read<FeatureCollection, rfl::NoFieldNames>(data);
     if (!res) {
-      std::cout << res.error()->what() << std::endl;
+      std::cout << res.error().what() << std::endl;
     }
   }
 }
@@ -113,7 +113,7 @@ static void BM_canada_read_reflect_cpp_flexbuf(benchmark::State &state) {
   for (auto _ : state) {
     const auto res = rfl::flexbuf::read<FeatureCollection>(data);
     if (!res) {
-      std::cout << res.error()->what() << std::endl;
+      std::cout << res.error().what() << std::endl;
     }
   }
 }
@@ -126,7 +126,7 @@ static void BM_canada_read_reflect_cpp_flexbuf_without_field_names(
     const auto res =
         rfl::flexbuf::read<FeatureCollection, rfl::NoFieldNames>(data);
     if (!res) {
-      std::cout << res.error()->what() << std::endl;
+      std::cout << res.error().what() << std::endl;
     }
   }
 }
@@ -137,7 +137,7 @@ static void BM_canada_read_reflect_cpp_json(benchmark::State &state) {
   for (auto _ : state) {
     const auto res = rfl::json::read<FeatureCollection>(data);
     if (!res) {
-      std::cout << res.error()->what() << std::endl;
+      std::cout << res.error().what() << std::endl;
     }
   }
 }
@@ -150,7 +150,7 @@ static void BM_canada_read_reflect_cpp_json_without_field_names(
     const auto res =
         rfl::json::read<FeatureCollection, rfl::NoFieldNames>(data);
     if (!res) {
-      std::cout << res.error()->what() << std::endl;
+      std::cout << res.error().what() << std::endl;
     }
   }
 }
@@ -161,7 +161,7 @@ static void BM_canada_read_reflect_cpp_msgpack(benchmark::State &state) {
   for (auto _ : state) {
     const auto res = rfl::msgpack::read<FeatureCollection>(data);
     if (!res) {
-      std::cout << res.error()->what() << std::endl;
+      std::cout << res.error().what() << std::endl;
     }
   }
 }
@@ -174,7 +174,7 @@ static void BM_canada_read_reflect_cpp_msgpack_without_field_names(
     const auto res =
         rfl::msgpack::read<FeatureCollection, rfl::NoFieldNames>(data);
     if (!res) {
-      std::cout << res.error()->what() << std::endl;
+      std::cout << res.error().what() << std::endl;
     }
   }
 }
@@ -185,7 +185,7 @@ static void BM_canada_read_reflect_cpp_toml(benchmark::State &state) {
   for (auto _ : state) {
     const auto res = rfl::toml::read<FeatureCollection>(data);
     if (!res) {
-      std::cout << res.error()->what() << std::endl;
+      std::cout << res.error().what() << std::endl;
     }
   }
 }
@@ -196,7 +196,7 @@ static void BM_canada_read_reflect_cpp_ubjson(benchmark::State &state) {
   for (auto _ : state) {
     const auto res = rfl::ubjson::read<FeatureCollection>(data);
     if (!res) {
-      std::cout << res.error()->what() << std::endl;
+      std::cout << res.error().what() << std::endl;
     }
   }
 }
@@ -209,7 +209,7 @@ static void BM_canada_read_reflect_cpp_ubjson_without_field_names(
     const auto res =
         rfl::ubjson::read<FeatureCollection, rfl::NoFieldNames>(data);
     if (!res) {
-      std::cout << res.error()->what() << std::endl;
+      std::cout << res.error().what() << std::endl;
     }
   }
 }
@@ -220,7 +220,7 @@ static void BM_canada_read_reflect_cpp_yaml(benchmark::State &state) {
   for (auto _ : state) {
     const auto res = rfl::yaml::read<FeatureCollection>(data);
     if (!res) {
-      std::cout << res.error()->what() << std::endl;
+      std::cout << res.error().what() << std::endl;
     }
   }
 }