Merge pull request #1623 from contour-terminal/improvement/generate_c…

…onfig_info Generate configuration documentation from ci
contour-terminal · Oct 22, 2024 · ba85243 · ba85243
2 parents d2ab5c0 + db36b81
commit ba85243
Show file tree

Hide file tree

Showing 15 changed files with 959 additions and 544 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -42,6 +42,8 @@ jobs:
         run: cmake --build build
       - name: "create vt-sequence directory"
         run: mkdir docs/vt-sequence
+      - name: "Generate documentation about global config"
+        run: ./build/src/contour/contour documentation configuration global > docs/configuration/index.md
       - name: "Generate vt documentation"
         run: ./build/src/contour/contour documentation vt > docs/vt-sequence/index.md
       - name: "Generate key mapping documentation"

diff --git a/cmake/ContourThirdParties.cmake b/cmake/ContourThirdParties.cmake
@@ -123,11 +123,17 @@ if(COMMAND ContourThirdParties_Embed_boxed_cpp)
     if(NOT DEFINED boxed_cpp_version OR boxed_cpp_version VERSION_LESS BOXED_CPP_MINIMAL_VERSION)
         message(FATAL_ERROR "Embedded boxed-cpp version must be at least ${BOXED_CPP_MINIMAL_VERSION}, but found ${boxed_cpp_version}")
     endif()
-    set(THIRDPARTY_BUILTIN_boxed_cpp "embedded")
+    set(THIRDPARTY_BUILTIN_boxed-cpp "embedded")
 else()
     HandleThirdparty(boxed-cpp "gh:contour-terminal/boxed-cpp#v${BOXED_CPP_MINIMAL_VERSION}")
 endif()
 
+if(COMMAND ContourThirdParties_Embed_reflection_cpp)
+    ContourThirdParties_Embed_reflection_cpp()
+    set(THIRDPARTY_BUILTIN_reflection-cpp "embedded")
+else()
+    HandleThirdparty(reflection-cpp "gh:contour-terminal/reflection-cpp#master")
+endif()
 
 macro(ContourThirdPartiesSummary2)
     message(STATUS "==============================================================================")
@@ -140,11 +146,12 @@ macro(ContourThirdPartiesSummary2)
     message(STATUS "range-v3            ${THIRDPARTY_BUILTIN_range-v3}")
     message(STATUS "yaml-cpp            ${THIRDPARTY_BUILTIN_yaml-cpp}")
     message(STATUS "termbench-pro       ${THIRDPARTY_BUILTIN_termbench}")
+    message(STATUS "reflection-cpp      ${THIRDPARTY_BUILTIN_reflection-cpp}")
     if(CONTOUR_USE_CPM)
         message(STATUS "libunicode          ${THIRDPARTY_BUILTIN_libunicode}")
     else()
         message(STATUS "libunicode          ${THIRDPARTY_BUILTIN_unicode_core}")
     endif()
-    message(STATUS "boxed-cpp           ${THIRDPARTY_BUILTIN_boxed_cpp}")
+    message(STATUS "boxed-cpp           ${THIRDPARTY_BUILTIN_boxed-cpp}")
     message(STATUS "------------------------------------------------------------------------------")
 endmacro()
diff --git a/docs/configuration/index.md b/docs/configuration/index.md
diff --git a/scripts/install-deps.ps1 b/scripts/install-deps.ps1
@@ -11,10 +11,17 @@ class ThirdParty {
 }
 
 $libunicode_git_sha="817cb5900acdf6f60e2344a4c8f1f39262878a4b"
+$reflection_cpp_git_sha="02484cd9ec16d7efc252ab8fd1f85d7264192418"
 
 # Take care, order matters, at least as much as dependencies are of concern.
 $ThirdParties =
 @(
+    [ThirdParty]@{
+        Folder  = "reflection-cpp-${reflection_cpp_git_sha}";
+        Archive = "reflection-cpp-${reflection_cpp_git_sha}.zip";
+        URI     = "https://github.com/contour-terminal/reflection-cpp/archive/${reflection_cpp_git_sha}.zip";
+        Macro   = "reflection_cpp"
+    };
     [ThirdParty]@{
         Folder  = "libunicode-${libunicode_git_sha}";
         Archive = "libunicode-${libunicode_git_sha}.zip";

diff --git a/scripts/install-deps.sh b/scripts/install-deps.sh
@@ -127,6 +127,16 @@ fetch_and_unpack_libunicode()
     fi
 }
 
+fetch_and_unpack_reflection_cpp()
+{
+    local reflection_cpp_git_sha="02484cd9ec16d7efc252ab8fd1f85d7264192418"
+    fetch_and_unpack \
+        reflection-cpp-$reflection_cpp_git_sha \
+        reflection-cpp-$reflection_cpp_git_sha.tar.gz \
+        https://github.com/contour-terminal/reflection-cpp/archive/$reflection_cpp_git_sha.tar.gz \
+        reflection_cpp
+}
+
 fetch_and_unpack_yaml_cpp()
 {
     fetch_and_unpack \
@@ -596,6 +606,7 @@ main()
 
     fetch_and_unpack_boxed
     fetch_and_unpack_termbenchpro
+    fetch_and_unpack_reflection_cpp
 }
 
 main $*