Generate completion files and CLIOptions array at compile time

Author: skusel

.clang-format-ignore

@@ -1,2 +1,3 @@
 # ignore vendored libraries:
 ./external/**/*
+./resources/completion.*.in

application/CMakeLists.txt

@@ -183,12 +183,27 @@ f3d_embed_file(
 configure_file("${CMAKE_CURRENT_SOURCE_DIR}/F3DConfig.h.in"
     "${CMAKE_CURRENT_BINARY_DIR}/F3DConfig.h")
 
+set(_ENABLED_CONDITIONALS)
+if(F3D_MODULE_RAYTRACING)
+  list(APPEND _ENABLED_CONDITIONALS "F3D_MODULE_RAYTRACING")
+endif()
+if(F3D_MODULE_DMON)
+  list(APPEND _ENABLED_CONDITIONALS "F3D_MODULE_DMON")
+endif()
+if(F3D_MODULE_UI)
+  list(APPEND _ENABLED_CONDITIONALS "F3D_MODULE_UI")
+endif()
+
 add_custom_command(
   OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/F3DCLIOptions.h"
-  COMMAND ${CMAKE_COMMAND} -D srcDir=${CMAKE_SOURCE_DIR} -D binaryDir=${CMAKE_CURRENT_BINARY_DIR} -P ${CMAKE_SOURCE_DIR}/cmake/f3dCLIOpts.cmake
+  COMMAND ${CMAKE_COMMAND}
+    -D "F3D_SOURCE_DIR=${CMAKE_SOURCE_DIR}"
+    -D "F3D_BINARY_DIR=${CMAKE_BINARY_DIR}"
+    -D "ENABLED_CONDITIONALS=${_ENABLED_CONDITIONALS}"
+    -P "${CMAKE_SOURCE_DIR}/cmake/f3dCLIOptions.cmake"
   DEPENDS
-    ${CMAKE_SOURCE_DIR}/resources/cli-options.schema.json
-    ${CMAKE_SOURCE_DIR}/resources/cli-options.json
+    "${CMAKE_SOURCE_DIR}/resources/cli-options.schema.json"
+    "${CMAKE_SOURCE_DIR}/resources/cli-options.json"
   VERBATIM
 )
 
@@ -333,13 +348,13 @@ if(UNIX AND NOT APPLE AND NOT ANDROID)
     DESTINATION "${f3d_resources_dir}"
     COMPONENT shellext
   )
-  install(FILES "${F3D_SOURCE_DIR}/resources/completion.bash"
+  install(FILES "${CMAKE_BINARY_DIR}/completion.bash"
     DESTINATION "share/bash-completion/completions" COMPONENT shellext
     RENAME "f3d")
-  install(FILES "${F3D_SOURCE_DIR}/resources/completion.zsh"
+  install(FILES "${CMAKE_BINARY_DIR}/completion.zsh"
     DESTINATION "share/zsh/site-functions" COMPONENT shellext
     RENAME "_f3d")
-  install(FILES "${F3D_SOURCE_DIR}/resources/completion.fish"
+  install(FILES "${CMAKE_BINARY_DIR}/completion.fish"
     DESTINATION "share/fish/vendor_completions.d" COMPONENT shellext
     RENAME "f3d.fish")
   install(FILES "${F3D_SOURCE_DIR}/resources/app.f3d.F3D.metainfo.xml"

application/F3DCLIOptions.h.in

@@ -2,10 +2,40 @@
 #define F3DCLIOptions_h
 
 #include <string_view>
+#include <vector>
 
 namespace F3D
 {
-constexpr std::string_view CLI_OPTIONS_JSON = R"END(@CLI_OPTIONS_JSON@)END";
+/**
+ * A struct to configure a complete cxxopts CLI options
+ * F3D uses exclusively string options except for a few true boolean option (eg: `--version`)
+ * LongName: The long name, eg: `axis`
+ * ShortName: The short name, eg: `x`
+ * HelpText: The help text, for display only when using `--help`
+ * ValueHelper: Used in help but also to discrimate between boolean option or not
+ * ImplicitValue: The implicit value when option is provided without a value
+ */
+struct CLIOption
+{
+  std::string_view LongName;
+  std::string_view ShortName;
+  std::string_view HelpText;
+  std::string_view ValueHelper;
+  std::string_view ImplicitValue;
+};
+
+/**
+ * A struct to group option into categories
+ */
+struct CLIGroup
+{
+  std::string_view GroupName;
+  std::vector<CLIOption> Options;
+};
+
+// clang-format off
+@F3D_CLI_OPTIONS_CPP@
+// clang-format on
 }
 
 #endif

application/F3DOptionsTools.cxx

@@ -25,96 +25,6 @@ namespace fs = std::filesystem;
 
 namespace
 {
-/**
- * A struct to configure a complete cxxopts CLI options
- * F3D uses exclusively string options except for a few true boolean option (eg: `--version`)
- * LongName: The long name, eg: `axis`
- * ShortName: The short name, eg: `x`
- * HelpText: The help text, for display only when using `--help`
- * ValueHelper: Used in help but also to discrimate between boolean option or not
- * ImplicitValue: The implicit value when option is provided without a value
- */
-struct CLIOption
-{
-  std::string LongName;
-  std::string ShortName;
-  std::string HelpText;
-  std::string ValueHelper;
-  std::string ImplicitValue;
-};
-
-/**
- * A struct to group option into categories
- */
-struct CLIGroup
-{
-  std::string GroupName;
-  std::vector<CLIOption> Options;
-};
-
-//----------------------------------------------------------------------------
-/**
- * Get all F3D CLI options except `--input`, `--define`, and `--reset`.
- * Order of groups (in JSON) matters in the context of `--help`.
- */
-[[nodiscard]] std::vector<CLIGroup> GetAllCLIOptions()
-{
-  const auto cliOptionsJson = nlohmann::json::parse(F3D::CLI_OPTIONS_JSON);
-
-  auto parseCliOptionJson = [](const nlohmann::json& cliOptionJson) -> CLIOption
-  {
-    CLIOption cliOption;
-    cliOption.LongName = cliOptionJson["longName"];
-    cliOption.ShortName = cliOptionJson["shortName"];
-    cliOption.HelpText = cliOptionJson["helpText"];
-    cliOption.ValueHelper = cliOptionJson["valueHelper"];
-    cliOption.ImplicitValue = cliOptionJson["implicitValue"];
-    return cliOption;
-  };
-
-  auto parseCliGroupJson = [&parseCliOptionJson](const nlohmann::json& cliGroupJson) -> CLIGroup
-  {
-    CLIGroup cliGroup;
-    cliGroup.GroupName = cliGroupJson["name"];
-    for (const auto& cliOptionJson : cliGroupJson["options"])
-    {
-#ifndef F3D_MODULE_DMON
-      if (cliOptionJson.value("conditional", "") == "F3D_MODULE_DMON")
-      {
-        continue;
-      }
-#endif
-#ifndef F3D_MODULE_UI
-      if (cliGroupJson.value("conditional", "") == "F3D_MODULE_UI")
-      {
-        continue;
-      }
-#endif
-      if (cliGroup.GroupName == "Applicative" &&
-        std::set<std::string>{ "input", "define", "reset" }.count(cliOptionJson["longName"]) != 0)
-      {
-        continue;
-      }
-      cliGroup.Options.push_back(parseCliOptionJson(cliOptionJson));
-    }
-    return cliGroup;
-  };
-
-  std::vector<CLIGroup> cliOptions;
-  for (const auto& cliGroupJson : cliOptionsJson["groups"])
-  {
-#ifndef F3D_MODULE_RAYTRACING
-    if (cliGroupJson.value("conditional", "") == "F3D_MODULE_RAYTRACING")
-    {
-      continue;
-    }
-#endif
-    cliOptions.push_back(parseCliGroupJson(cliGroupJson));
-  }
-
-  return cliOptions;
-}
-
 /**
  * True boolean options need to be filtered out in ParseCLIOptions
  * Also filter out special options like `define` and `reset`
@@ -139,8 +49,7 @@ std::string CollapseName(const std::string_view& longName, const std::string_vie
 }
 
 //----------------------------------------------------------------------------
-void PrintHelp(const std::string& execName, const cxxopts::Options& cxxOptions,
-  const std::vector<CLIGroup>& cliOptions)
+void PrintHelp(const std::string& execName, const cxxopts::Options& cxxOptions)
 {
   const std::array<std::pair<std::string, std::string>, 4> examples = { {
     { execName + " file.vtu -xtgans",
@@ -153,9 +62,9 @@ void PrintHelp(const std::string& execName, const cxxopts::Options& cxxOptions,
   } };
 
   f3d::log::setUseColoring(false);
-  std::vector<std::string> orderedCLIGroupNames(cliOptions.size());
-  std::transform(cliOptions.cbegin(), cliOptions.cend(), orderedCLIGroupNames.begin(),
-    [](const ::CLIGroup& cliGroup) { return cliGroup.GroupName; });
+  std::vector<std::string> orderedCLIGroupNames(F3D::CLIOptions.size());
+  std::transform(F3D::CLIOptions.cbegin(), F3D::CLIOptions.cend(), orderedCLIGroupNames.begin(),
+    [](const F3D::CLIGroup& cliGroup) { return cliGroup.GroupName; });
   f3d::log::info(cxxOptions.help(orderedCLIGroupNames));
   f3d::log::info("\nExamples:");
   for (const auto& [cmd, desc] : examples)
@@ -372,14 +281,12 @@ F3DOptionsTools::OptionsDict F3DOptionsTools::ParseCLIOptions(
   std::vector<std::string> resets;
   auto cxxoptsResets = cxxopts::value<std::vector<std::string>>(resets);
 
-  auto CLIOptions = GetAllCLIOptions();
-
   try
   {
     cxxopts::Options cxxOptions(execName, F3D::AppTitle);
     cxxOptions.custom_help("[OPTIONS...]");
 
-    for (const ::CLIGroup& optionGroup : CLIOptions)
+    for (const F3D::CLIGroup& optionGroup : F3D::CLIOptions)
     {
       auto group = cxxOptions.add_options(std::string(optionGroup.GroupName));
 
@@ -392,7 +299,7 @@ F3DOptionsTools::OptionsDict F3DOptionsTools::ParseCLIOptions(
       }
 
       // Add each option to cxxopts
-      for (const ::CLIOption& cliOption : optionGroup.Options)
+      for (const F3D::CLIOption& cliOption : optionGroup.Options)
       {
         if (cliOption.ValueHelper.empty())
         {
@@ -468,7 +375,7 @@ F3DOptionsTools::OptionsDict F3DOptionsTools::ParseCLIOptions(
     // Check boolean options and log them if any
     if (result.count("help") > 0)
     {
-      ::PrintHelp(execName, cxxOptions, CLIOptions);
+      ::PrintHelp(execName, cxxOptions);
       throw F3DExNoProcess("help requested");
     }
     if (result.count("version") > 0)