From 4f965cb102d9133d197fd141d587adeb622c86ca Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 23 Jan 2023 02:22:45 +0100 Subject: [PATCH 01/54] setup config file --- xmake.lua | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/xmake.lua b/xmake.lua index 6503b56..f0dbe3a 100644 --- a/xmake.lua +++ b/xmake.lua @@ -12,7 +12,7 @@ option("build_tests") option("use_tl_expected") set_showmenu(true) set_description("Use tl::expected instead of std::expected") - add_defines("GLAP_USE_TL_EXPECTED", {public = true}) + set_configvar("GLAP_USE_TL_EXPECTED", 1) add_deps("enable_std_module") on_check(function (option) if option:dep("enable_std_module"):enabled() then @@ -24,7 +24,7 @@ option("use_tl_expected") option("use_fmt") set_showmenu(true) set_description("Use fmt instead of std::format") - add_defines("GLAP_USE_FMT", {public = true}) + set_configvar("GLAP_USE_FMT", 1) add_deps("enable_module") on_check(function (option) if option:dep("enable_module"):enabled() then @@ -37,7 +37,7 @@ option("enable_module") set_default(false) set_showmenu(true) set_description("Enable C++20 module support") - add_defines("GLAP_USE_MODULE", {public = true}) + set_configvar("GLAP_USE_MODULE", 1) option("enable_std_module") set_default(false) add_deps("enable_module") @@ -55,8 +55,9 @@ target("glap") add_files("src/*.cpp") add_headerfiles("include/(glap/**.h)", "include/(glap/**.inl)") add_includedirs("include", {public = true}) - add_options("use_tl_expected", "use_fmt", "enable_std_module") - add_configfiles("xmake/config/config.h.in") + add_options("use_tl_expected", "use_fmt", "enable_std_module", "enable_module") + add_includedirs("$(buildir)/glap", {public = true}) + add_configfiles("xmake/config/config.h.in", {prefixdir = "glap"}) if has_config("use_tl_expected") then add_packages("tl_expected", {public = true}) end From 4b0f72987f85e7222fda39cdfc2c404afa9636e3 Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 23 Jan 2023 02:23:30 +0100 Subject: [PATCH 02/54] remove glap option deps from programs --- xmake.lua | 4 ---- 1 file changed, 4 deletions(-) diff --git a/xmake.lua b/xmake.lua index f0dbe3a..002b2b2 100644 --- a/xmake.lua +++ b/xmake.lua @@ -83,7 +83,6 @@ target("glap-example") set_default(false) add_deps("glap") add_files("tests/example.cpp") - add_options("use_tl_expected", "use_fmt", "enable_module", "enable_std_module") if has_config("enable_module") then target("glap-module-example") @@ -97,7 +96,6 @@ if has_config("enable_module") then set_default(false) add_deps("glap") add_files("tests/example.cpp") - add_options("use_tl_expected", "use_fmt", "enable_std_module") on_load(function(target) if not has_config("enable_std_modules") then target:data_set("c++.msvc.enable_std_import", false) @@ -117,7 +115,6 @@ if has_config("build_tests") then add_packages("gtest") add_files("tests/tests.cpp") set_warnings("allextra", "error") - add_options("use_tl_expected", "use_fmt") if is_plat("linux", "macosx") then add_cxflags("-Wno-unknown-pragmas") end @@ -140,7 +137,6 @@ if has_config("build_tests") then add_packages("gtest") add_files("tests/tests.cpp") set_warnings("allextra", "error") - add_options("use_tl_expected", "use_fmt", "enable_std_module") add_defines("GLAP_USE_MODULE") if is_plat("linux", "macosx") then add_cxflags("-Wno-unknown-pragmas") From 1967ec2d60bb044fab3f760a0dfdc54de730ce31 Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 23 Jan 2023 02:23:50 +0100 Subject: [PATCH 03/54] options check if std library available --- xmake.lua | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/xmake.lua b/xmake.lua index 002b2b2..a4aca09 100644 --- a/xmake.lua +++ b/xmake.lua @@ -15,11 +15,15 @@ option("use_tl_expected") set_configvar("GLAP_USE_TL_EXPECTED", 1) add_deps("enable_std_module") on_check(function (option) - if option:dep("enable_std_module"):enabled() then - option:enable(false) - else - option:enable(true) - end + import("lib.detect.check_cxsnippets") + local has_expected = check_cxsnippets({[[ + #include + int main() { + std::expected e = 42; + return 0; + } + ]]}, {configs = {languages = "c++latest"}}) + option:enable(not has_expected) end) option("use_fmt") set_showmenu(true) @@ -27,11 +31,15 @@ option("use_fmt") set_configvar("GLAP_USE_FMT", 1) add_deps("enable_module") on_check(function (option) - if option:dep("enable_module"):enabled() then - option:enable(false) - else - option:enable(true) - end + import("lib.detect.check_cxsnippets") + local has_format_lib = check_cxsnippets({[[ + #include + int main() { + std::format("{}", 42); + return 0; + } + ]]}, {configs = {languages = "c++latest"}}) + option:enable(not has_format_lib) end) option("enable_module") set_default(false) From afd5506d0e41ed1508116c2ca83561aa4a8996ed Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 28 Nov 2022 17:18:48 +0100 Subject: [PATCH 04/54] convert_to: impl gcc way for fallback --- include/glap/core/convertible_to.h | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/include/glap/core/convertible_to.h b/include/glap/core/convertible_to.h index 13e5534..7b80271 100644 --- a/include/glap/core/convertible_to.h +++ b/include/glap/core/convertible_to.h @@ -14,11 +14,15 @@ GLAP_EXPORT namespace glap { namespace impl { #if defined(__cpp_lib_concepts) && __cpp_lib_concepts >= 201806L - template - concept convertible_to = std::convertible_to; + template + concept convertible_to = std::convertible_to; #else - template - concept convertible_to = std::is_convertible_v; + template + concept convertible to = + std::is_convertible_v && + requires { + static_cast(std::declval()); + }; #endif } } \ No newline at end of file From 29593714b43ac98bd086852846d0bed6eaa44bb2 Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 28 Nov 2022 23:25:35 +0100 Subject: [PATCH 05/54] add console style unix only for now --- include/glap/generators/style.h | 80 +++++++++++++++++++++++++++++++++ src/style.cpp | 34 ++++++++++++++ 2 files changed, 114 insertions(+) create mode 100644 include/glap/generators/style.h create mode 100644 src/style.cpp diff --git a/include/glap/generators/style.h b/include/glap/generators/style.h new file mode 100644 index 0000000..eb792d6 --- /dev/null +++ b/include/glap/generators/style.h @@ -0,0 +1,80 @@ +#pragma once +#include +namespace glap::generators { + namespace colors { +#ifdef _WIN32 + namespace foreground { + static constexpr int BLACK = 0; + static constexpr int DARK_BLUE = 1; + static constexpr int DARK_GREEN = 2; + static constexpr int DARK_CYAN = 3; + static constexpr int DARK_RED = 4; + static constexpr int DARK_MAGENTA = 5; + static constexpr int DARK_YELLOW = 6; + static constexpr int GRAY = 7; + static constexpr int DARK_GRAY = 8; + static constexpr int BLUE = 9; + static constexpr int GREEN = 10; + static constexpr int CYAN = 11; + static constexpr int RED = 12; + static constexpr int MAGENTA = 13; + static constexpr int YELLOW = 14; + static constexpr int WHITE = 15; + } + namespace background { + static constexpr int BLACK = 0; + static constexpr int DARK_BLUE = 16; + static constexpr int DARK_GREEN = 32; + static constexpr int DARK_CYAN = 48; + static constexpr int DARK_RED = 64; + static constexpr int DARK_MAGENTA = 80; + static constexpr int DARK_YELLOW = 96; + static constexpr int GRAY = 112; + static constexpr int DARK_GRAY = 128; + static constexpr int BLUE = 144; + static constexpr int GREEN = 160; + static constexpr int CYAN = 176; + static constexpr int RED = 192; + static constexpr int MAGENTA = 208; + static constexpr int YELLOW = 224; + static constexpr int WHITE = 240; + } +#else + namespace foreground { + static constexpr int BLACK = 30; + static constexpr int RED = 31; + static constexpr int GREEN = 32; + static constexpr int YELLOW = 33; + static constexpr int BLUE = 34; + static constexpr int MAGENTA = 35; + static constexpr int CYAN = 36; + static constexpr int WHITE = 37; + } + namespace background { + static constexpr int BLACK = 40; + static constexpr int RED = 41; + static constexpr int GREEN = 42; + static constexpr int YELLOW = 43; + static constexpr int BLUE = 44; + static constexpr int MAGENTA = 45; + static constexpr int CYAN = 46; + static constexpr int WHITE = 47; + } +#endif + } + struct Style { + std::optional foreground_color = std::nullopt; + std::optional background_color = std::nullopt; + std::optional bold = std::nullopt; + std::optional underlined = std::nullopt; + std::optional italic = std::nullopt; + void apply() const noexcept; + static void reset() noexcept; + private: + auto is_none() const noexcept -> bool { + return !bold && !underlined && !italic && !foreground_color && !background_color; + } + }; +} + +#include "../impl/style.inl" \ No newline at end of file diff --git a/src/style.cpp b/src/style.cpp new file mode 100644 index 0000000..2fd642a --- /dev/null +++ b/src/style.cpp @@ -0,0 +1,34 @@ +#include + +namespace glap::generators { +#ifdef _WIN32 +#else + void Style::apply() const noexcept + { + std::string style; + auto it = std::back_inserter(style); + if (bold) { + format_to(it, "{};", *bold ? 1 : 22); + } + if (underlined) { + format_to(it, "{};", *underlined ? 4 : 24); + } + if (italic) { + format_to(it, "{};", *italic ? 3 : 23); + } + if (foreground_color) { + format_to(it, "{};", *foreground_color); + } + if (background_color) { + format_to(it, "{};", *background_color); + } + if (!style.empty()) { + style.pop_back(); + } + print("\033[{}m", style); + } + void Style::reset() noexcept { + print("\033[0m"); + } +#endif +} \ No newline at end of file From f325814c6ab6894dabc5b804954b4b369dc0543a Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 28 Nov 2022 23:25:48 +0100 Subject: [PATCH 06/54] add print --- include/glap/core/fmt.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/include/glap/core/fmt.h b/include/glap/core/fmt.h index 99d4f6e..28b0ae3 100644 --- a/include/glap/core/fmt.h +++ b/include/glap/core/fmt.h @@ -18,10 +18,12 @@ GLAP_EXPORT namespace glap { using std::format; using std::format_to; + using std::print; } #else GLAP_EXPORT namespace glap { using fmt::format; using fmt::format_to; + using fmt::print; } #endif \ No newline at end of file From 072ac532dec5e0c76e20e2e1eebe5432c5dd334b Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 28 Nov 2022 23:27:22 +0100 Subject: [PATCH 07/54] move help in generators --- include/glap/{ => generators}/help.h | 0 include/glap/{ => generators}/impl/help.inl | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename include/glap/{ => generators}/help.h (100%) rename include/glap/{ => generators}/impl/help.inl (100%) diff --git a/include/glap/help.h b/include/glap/generators/help.h similarity index 100% rename from include/glap/help.h rename to include/glap/generators/help.h diff --git a/include/glap/impl/help.inl b/include/glap/generators/impl/help.inl similarity index 100% rename from include/glap/impl/help.inl rename to include/glap/generators/impl/help.inl From 1deed38cb88528c5db03e4b2070d6586b2ed3c9d Mon Sep 17 00:00:00 2001 From: Gly Date: Tue, 29 Nov 2022 00:06:32 +0100 Subject: [PATCH 08/54] update help to work with the new model --- include/glap/generators/help.h | 52 +++++++++++++-------------- include/glap/generators/impl/help.inl | 40 +++++++++++---------- 2 files changed, 46 insertions(+), 46 deletions(-) diff --git a/include/glap/generators/help.h b/include/glap/generators/help.h index 58010a8..fc8b39d 100644 --- a/include/glap/generators/help.h +++ b/include/glap/generators/help.h @@ -1,16 +1,14 @@ #pragma once #ifndef GLAP_MODULE -#include "core/base.h" -#include "core/discard.h" -#include "core/utils.h" +#include "../core/base.h" +#include "../core/discard.h" +#include "../core/utils.h" #include #include #include #include -#endif - -GLAP_EXPORT namespace glap { +namespace glap { namespace help { inline constexpr std::string_view INPUTS_NAME = "INPUTS"; inline constexpr int PADDING = 4; @@ -21,29 +19,27 @@ GLAP_EXPORT namespace glap { && std::same_as, std::string_view>; template concept IsInputs = (T::name == INPUTS_NAME); - namespace model - { - template - struct Description { - static constexpr std::string_view short_description = Short; - }; - template - struct FullDescription : Description { - static constexpr std::string_view long_description = Long; - }; - template - struct Argument : Desc { - static constexpr std::string_view name = Name; - }; - template - struct Command : Desc { - static constexpr auto name = Name; - }; - template - struct Program : Desc - {}; - } + template + struct Description { + static constexpr std::string_view short_description = Short; + }; + template + struct FullDescription : Description { + static constexpr std::string_view long_description = Long; + }; + + template + struct Argument : Desc { + static constexpr std::string_view name = Name; + }; + template + struct Command : Desc { + static constexpr auto name = Name; + }; + template + struct Program : Desc + {}; } template struct Help diff --git a/include/glap/generators/impl/help.inl b/include/glap/generators/impl/help.inl index fb68d17..075102f 100644 --- a/include/glap/generators/impl/help.inl +++ b/include/glap/generators/impl/help.inl @@ -1,18 +1,19 @@ #pragma once #ifndef GLAP_MODULE -#include "core/utf8.h" -#include "core/discard.h" -#include "core/utils.h" -#include "help.h" +#include "../../core/utf8.h" +#include "../../core/discard.h" +#include "../../core/utils.h" +#include "../../core/fmt.h" +#include "../help.h" -#include "model.h" -#include "parser.h" +#include "../../model.h" +#include #include #include #endif -namespace glap { +namespace glap::generators { namespace impl { template concept IsHelpInputsCompatible = requires { P::type == glap::model::ArgumentType::Input; } && help::IsInputs; @@ -85,19 +86,22 @@ namespace glap { return it; } }; - template + template + requires (HasLongName || requires { FromParser::name; }) struct BasicHelp { template OutputIt name(OutputIt it) const noexcept { if constexpr(Fullname && HasShortName) return glap::format_to(it, "{}, {}", glap::utils::uni::codepoint_to_utf8(FromParser::shortname.value()), FromParser::longname); - else + else if constexpr(requires { FromParser::name; }) + return glap::format_to(it, "{}", FromParser::name); + else return glap::format_to(it, "{}", FromParser::longname); } template OutputIt description(OutputIt it) const noexcept { - if constexpr(help::IsFullDescription) + if constexpr(FullDescription && help::IsFullDescription) return glap::format_to(it, "{}\n\n{}", FromHelp::short_description, FromHelp::long_description); else return glap::format_to(it, "{}", FromHelp::short_description); @@ -135,11 +139,11 @@ namespace glap { static constexpr auto basic_help = BasicHelp{}; } - template - struct Help, Parser> { - using ProgramHelp = help::model::Program; - using ProgramParser = Parser; - + template + struct Help, model::Program> { + using ProgramHelp = help::Program; + using ProgramParser = model::Program; + [[nodiscard]] constexpr std::string operator()() const noexcept { std::string result; this->operator()(std::back_inserter(result)); @@ -165,8 +169,8 @@ namespace glap { }; template - struct Help, model::Command> { - using CommandHelp = help::model::Command; + struct Help, model::Command> { + using CommandHelp = help::Command; using CommandParser = model::Command; [[nodiscard]] constexpr std::string operator()() const noexcept { std::string result; @@ -185,7 +189,7 @@ namespace glap { if constexpr(model::IsArgumentTyped) { it = glap::format_to(it, " [--"); it = param_basic_help.template name(it); - it = glap::format_to(it, " VALUE]"); + it = glap::format_to(it, "=VALUE]"); } else if constexpr(model::IsArgumentTyped) { it = glap::format_to(it, " [--"); it = param_basic_help.template name(it); From 0282acef0f8a3cd51b0dcb5ea86afa42c479e00a Mon Sep 17 00:00:00 2001 From: Gly Date: Tue, 29 Nov 2022 00:36:44 +0100 Subject: [PATCH 09/54] remove extra newline --- include/glap/generators/impl/help.inl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/include/glap/generators/impl/help.inl b/include/glap/generators/impl/help.inl index 075102f..5fc6908 100644 --- a/include/glap/generators/impl/help.inl +++ b/include/glap/generators/impl/help.inl @@ -153,7 +153,7 @@ namespace glap::generators { constexpr OutputIt operator()(OutputIt it) const noexcept { it = this_basic_help.template identity(it); it = glap::format_to(it, "\n\n"); - it = glap::format_to(it, "Command{}:\n", sizeof...(CommandsParser) > 1 ? "s" : ""); + it = glap::format_to(it, "Command{}:", sizeof...(CommandsParser) > 1 ? "s" : ""); // constexpr auto max_cmd_name_length = impl::max_length(2)+2; ([&] { constexpr auto cmd_basic_help = impl::basic_help::type, CommandsParser>; @@ -200,7 +200,7 @@ namespace glap::generators { }(), ...); it = glap::format_to(it, "\n\n"); } - it = glap::format_to(it, "Argument{}:\n", sizeof...(ParamsParser) > 1 ? "s" : ""); + it = glap::format_to(it, "Argument{}:", sizeof...(ParamsParser) > 1 ? "s" : ""); ([&] { constexpr auto param_basic_help = impl::basic_help::type, ParamsParser>; constexpr auto spacing = param_name_max_length - impl::max_length(2); From 9898848b8c991c1f193d6674c433b850a4f79f8e Mon Sep 17 00:00:00 2001 From: Gly Date: Tue, 29 Nov 2022 00:37:23 +0100 Subject: [PATCH 10/54] Add ability to get help of command from program --- include/glap/generators/impl/help.inl | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/include/glap/generators/impl/help.inl b/include/glap/generators/impl/help.inl index 5fc6908..4935914 100644 --- a/include/glap/generators/impl/help.inl +++ b/include/glap/generators/impl/help.inl @@ -21,15 +21,14 @@ namespace glap::generators { struct FindByName {}; template - requires (HasLongName && FromParser::longname == T::name) || IsHelpInputsCompatible + requires (HasLongName && FromParser::longname == T::name) || (requires {FromParser::name;} && FromParser::name == T::name) || IsHelpInputsCompatible struct FindByName { public: using type = T; }; template - requires ((!HasLongName || Named::longname != T::name) && !IsHelpInputsCompatible) - struct FindByName : FindByName + struct FindByName : FindByName {}; template struct FindByName @@ -213,4 +212,7 @@ namespace glap::generators { static constexpr auto param_name_max_length = impl::max_length(2)+help::PADDING; static constexpr auto this_basic_help = impl::basic_help; }; + template + struct Help, model::Command> : Help::type, model::Command> + {}; } \ No newline at end of file From cc786baa6586156542cb6c245b0e97eb8aa1fb94 Mon Sep 17 00:00:00 2001 From: Gly Date: Tue, 29 Nov 2022 00:37:30 +0100 Subject: [PATCH 11/54] update example --- tests/example.cpp | 193 +++++++++++++++++++++++++++++----------------- 1 file changed, 124 insertions(+), 69 deletions(-) diff --git a/tests/example.cpp b/tests/example.cpp index 6c83208..d42336c 100644 --- a/tests/example.cpp +++ b/tests/example.cpp @@ -29,68 +29,12 @@ namespace format { #include #include #include - -#ifdef GLAP_USE_FMT -#include -using namespace format = fmt; -#else -#include #include -namespace format { - using std::format; - using std::vformat; - using std::format_to; - using std::vformat_to; - template - constexpr auto print(std::format_string format_string, Args&& ... args) - { - std::cout << std::format(format_string, std::forward(args)...); - } -} -#endif -#endif +#include +#include + -template - requires requires { T::type; } -void print(const T& value) { - if constexpr (requires { value.longname; }) { - format::print(" --{}: ", value.longname); - } else { - format::print(" input: "); - } - if constexpr (requires { value.value; }) { // Value based - format::print("\"{}\"", value.value.value()); - } else if constexpr (requires { value.values; }) { // Container based - format::print("[ "); - for (const auto& v : value.values) { - format::print("\"{}\" ", v.value.value()); - } - format::print("]"); - } else if constexpr (requires { value.occurences; }) { // Flag - format::print("{}x", value.occurences); - } - format::print("\n"); -} -template -auto print(const glap::model::Command& command) { - format::print("{}: \n", command.longname); - ([&] { - print(std::get

(command.arguments)); - }(), ...); -} -template -auto print(const glap::model::Program& program) { - format::print("{}\n", program.program); - ([&] { - if (std::holds_alternative(program.command)) { - print(std::get(program.command)); - return true; - } else { - return false; - } - }() || ...); -} using flag_t = glap::model::Flag< glap::Names<"flag", 'f'> @@ -98,7 +42,7 @@ using flag_t = glap::model::Flag< using verbose_t = glap::model::Flag< glap::Names<"verbose", 'v'> >; -using help_t = glap::model::Flag< +using flag_help_t = glap::model::Flag< glap::Names<"help", 'h'> >; using single_param_t = glap::model::Parameter< @@ -125,23 +69,113 @@ using inputs_t = glap::model::Inputs< >; using command1_t = glap::model::Command< - glap::Names<"command1", 'c'>, - flag_t, - verbose_t, - help_t, + glap::Names<"command1", 'c'>, + flag_t, + verbose_t, + flag_help_t, inputs_t >; using command2_t = glap::model::Command< glap::Names<"command2">, // notice that there is no short name here - single_param_t, - single_int_param_t, - multi_param_t, - help_t, + single_param_t, + multi_param_t, + flag_help_t, inputs_t >; using program_t = glap::model::Program<"myprogram", glap::model::DefaultCommand::FirstDefined, command1_t, command2_t>; +using help_flag_t = glap::generators::help::Argument< + "flag", + glap::generators::help::Description<"test flag"> +>; +using help_verbose_t = glap::generators::help::Argument< + "verbose", + glap::generators::help::Description<"test verbose flag"> +>; +using help_single_param_t = glap::generators::help::Argument< + "single_param", + glap::generators::help::Description<"test single param"> +>; +using help_multi_param_t = glap::generators::help::Argument< + "multi_param", + glap::generators::help::Description<"test multi param"> +>; +using help_inputs_t = glap::generators::help::Argument< + "INPUTS", + glap::generators::help::Description<"test inputs"> +>; +using help_command1_t = glap::generators::help::Command< + "command1", + glap::generators::help::FullDescription<"first command", "This is the first command defined in the program">, + help_flag_t, + help_verbose_t, + help_single_param_t, + help_multi_param_t, + help_inputs_t +>; +using help_command2_t = glap::generators::help::Command< + "command2", + glap::generators::help::FullDescription<"second command", "This is the second command defined in the program">, + help_single_param_t, + single_int_param_t, + help_multi_param_t, + help_inputs_t +>; + +using help_program_t = glap::generators::help::Program< + "myprogram", + glap::generators::help::FullDescription<"myprogram", "This is my program">, + help_command1_t, + help_command2_t +>; + +template + requires requires { T::type; } +void print(const T& value) { + if constexpr (requires { value.longname; }) { + fmt::print(" --{}: ", value.longname); + } else { + fmt::print(" input: "); + } + if constexpr (requires { value.value; }) { // Value based + fmt::print("\"{}\"", value.value.value()); + } else if constexpr (requires { value.values; }) { // Container based + fmt::print("[ "); + for (const auto& v : value.values) { + fmt::print("\"{}\" ", v.value.value()); + } + fmt::print("]"); + } else if constexpr (requires { value.occurences; }) { // Flag + fmt::print("{}x", value.occurences); + } + fmt::print("\n"); +} +template +auto print(const glap::model::Command& command) { + fmt::print("{}: \n", command.longname); + ([&] { + print(std::get

(command.arguments)); + }(), ...); +} +template +auto print(const glap::model::Program& program) { + fmt::print("{}\n", program.program); + ([&] { + if (std::holds_alternative(program.command)) { + const auto& command = std::get(program.command); + if (command.template get_argument<"help">().occurences > 0) { + fmt::print("Help:\n\n{}\n", glap::generators::get_help()); + } else { + print(command); + } + return true; + } else { + return false; + } + }() || ...); +} + int main(int argc, char** argv) { using namespace glap::model; @@ -154,8 +188,29 @@ int main(int argc, char** argv) auto& v = *result; print(v); } else { - format::print("{}\n", result.error().to_string()); + fmt::print("{}\n\n", result.error().to_string()); + fmt::print("Help:\n\n{}\n", glap::generators::get_help()); return 1; } return 0; +} +int _main(int argc, char** argv) { + using namespace glap::generators; + Style{ + .foreground_color = colors::foreground::RED, + .bold = true, + .underlined = true, + .italic = true, + }.apply(); + fmt::print("Hello, world!\n"); + Style{ + .foreground_color = colors::foreground::BLACK, + .background_color = colors::background::GREEN, + .bold = true, + .underlined = true, + .italic = true, + }.apply(); + fmt::print("Hello, world!\n"); + Style::reset(); + fmt::print("Hello, world!\n"); } \ No newline at end of file From 5a8f8965485ac68d7be6b52f21e1a53337c94c04 Mon Sep 17 00:00:00 2001 From: Gly Date: Wed, 30 Nov 2022 13:00:11 +0100 Subject: [PATCH 12/54] rename help concepts --- docs/HELP.md | 6 +++--- include/glap/generators/help.h | 10 +++++----- include/glap/generators/impl/help.inl | 18 ++++++++++-------- 3 files changed, 18 insertions(+), 16 deletions(-) diff --git a/docs/HELP.md b/docs/HELP.md index cd861f2..9025bd7 100644 --- a/docs/HELP.md +++ b/docs/HELP.md @@ -15,19 +15,19 @@ struct FullDescription; ## Program description class ```cpp /// In namespace glap::help::model -template +template struct Program; ``` ## Command description class ```cpp /// In namespace glap::help::model -template +template struct Command; ``` ## Argument description class ```cpp /// In namespace glap::help::model -template +template struct Argument; ``` ## Help generator class diff --git a/include/glap/generators/help.h b/include/glap/generators/help.h index fc8b39d..ac0f22b 100644 --- a/include/glap/generators/help.h +++ b/include/glap/generators/help.h @@ -13,9 +13,9 @@ namespace glap { inline constexpr std::string_view INPUTS_NAME = "INPUTS"; inline constexpr int PADDING = 4; template - concept IsDescription = std::same_as, std::string_view>; + concept HasDescription = std::same_as, std::string_view>; template - concept IsFullDescription = IsDescription + concept HasFullDescription = HasDescription && std::same_as, std::string_view>; template concept IsInputs = (T::name == INPUTS_NAME); @@ -29,15 +29,15 @@ namespace glap { static constexpr std::string_view long_description = Long; }; - template + template struct Argument : Desc { static constexpr std::string_view name = Name; }; - template + template struct Command : Desc { static constexpr auto name = Name; }; - template + template struct Program : Desc {}; } diff --git a/include/glap/generators/impl/help.inl b/include/glap/generators/impl/help.inl index 4935914..7033679 100644 --- a/include/glap/generators/impl/help.inl +++ b/include/glap/generators/impl/help.inl @@ -72,7 +72,7 @@ namespace glap::generators { } template OutputIt description(OutputIt it) const noexcept { - if constexpr(help::IsFullDescription) + if constexpr(help::HasFullDescription) return glap::format_to(it, "{}\n\n{}", FromHelp::short_description, FromHelp::long_description); else return glap::format_to(it, "{}", FromHelp::short_description); @@ -85,7 +85,7 @@ namespace glap::generators { return it; } }; - template + template requires (HasLongName || requires { FromParser::name; }) struct BasicHelp { @@ -100,7 +100,7 @@ namespace glap::generators { } template OutputIt description(OutputIt it) const noexcept { - if constexpr(FullDescription && help::IsFullDescription) + if constexpr(FullDescription && help::HasFullDescription) return glap::format_to(it, "{}\n\n{}", FromHelp::short_description, FromHelp::long_description); else return glap::format_to(it, "{}", FromHelp::short_description); @@ -138,13 +138,14 @@ namespace glap::generators { static constexpr auto basic_help = BasicHelp{}; } - template + template struct Help, model::Program> { using ProgramHelp = help::Program; using ProgramParser = model::Program; - [[nodiscard]] constexpr std::string operator()() const noexcept { + [[nodiscard]] std::string operator()() const noexcept { std::string result; + result.reserve(1024); this->operator()(std::back_inserter(result)); return result; } @@ -167,12 +168,13 @@ namespace glap::generators { static constexpr auto this_basic_help = impl::basic_help; }; - template + template struct Help, model::Command> { using CommandHelp = help::Command; using CommandParser = model::Command; - [[nodiscard]] constexpr std::string operator()() const noexcept { + [[nodiscard]] std::string operator()() const noexcept { std::string result; + result.reserve(1024); this->operator()(std::back_inserter(result)); return result; } @@ -212,7 +214,7 @@ namespace glap::generators { static constexpr auto param_name_max_length = impl::max_length(2)+help::PADDING; static constexpr auto this_basic_help = impl::basic_help; }; - template + template struct Help, model::Command> : Help::type, model::Command> {}; } \ No newline at end of file From 28754c67f3749da0104b80d3ce11e88cfb289457 Mon Sep 17 00:00:00 2001 From: Gly Date: Tue, 29 Nov 2022 00:37:30 +0100 Subject: [PATCH 13/54] update example --- _doxygen.conf_ | 2658 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 2658 insertions(+) create mode 100644 _doxygen.conf_ diff --git a/_doxygen.conf_ b/_doxygen.conf_ new file mode 100644 index 0000000..881c99a --- /dev/null +++ b/_doxygen.conf_ @@ -0,0 +1,2658 @@ +# Doxyfile 1.9.3 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "glap" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = "build/docs" + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.l \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /

(command.arguments)); }(), ...); From e13dbe5d876f4ed257996d9937b36edbceb3cf5e Mon Sep 17 00:00:00 2001 From: Gly Date: Wed, 30 Nov 2022 13:10:51 +0100 Subject: [PATCH 17/54] codepoint_to_utf8 now inline --- include/glap/core/utf8.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/glap/core/utf8.h b/include/glap/core/utf8.h index 0e00b03..c1092a6 100644 --- a/include/glap/core/utf8.h +++ b/include/glap/core/utf8.h @@ -76,7 +76,7 @@ GLAP_EXPORT namespace glap::utils::uni { } return codepoint; } - [[nodiscard]] constexpr std::string codepoint_to_utf8(char32_t codepoint) noexcept { + [[nodiscard]] inline std::string codepoint_to_utf8(char32_t codepoint) noexcept { std::string utf8; if (codepoint <= 0x7F) { utf8.push_back(static_cast(codepoint)); From 2cace2e1543d6c8943618f4924a6faccc60f3f5f Mon Sep 17 00:00:00 2001 From: Gly Date: Wed, 30 Nov 2022 13:12:37 +0100 Subject: [PATCH 18/54] add missing header --- src/style.cpp | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/style.cpp b/src/style.cpp index 2fd642a..17d1fd5 100644 --- a/src/style.cpp +++ b/src/style.cpp @@ -1,4 +1,6 @@ #include +#include +#include namespace glap::generators { #ifdef _WIN32 From c2c47c0a7f3214f3368be2d99c9e63bc05af28ce Mon Sep 17 00:00:00 2001 From: Gly Date: Thu, 1 Dec 2022 12:05:26 +0100 Subject: [PATCH 19/54] add gitignore test lua --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 453165b..7724567 100644 --- a/.gitignore +++ b/.gitignore @@ -589,4 +589,5 @@ healthchecksdb builddir-release build -.xmake \ No newline at end of file +.xmake +test.lua \ No newline at end of file From eca4f8f6ce5d0739f1b83f2eac3522bd3352cef5 Mon Sep 17 00:00:00 2001 From: gly Date: Thu, 1 Dec 2022 18:01:19 +0100 Subject: [PATCH 20/54] correct name param --- include/glap/impl/parser2.inl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/glap/impl/parser2.inl b/include/glap/impl/parser2.inl index 9759d59..d06b616 100644 --- a/include/glap/impl/parser2.inl +++ b/include/glap/impl/parser2.inl @@ -406,7 +406,7 @@ namespace glap { if (arg.value.has_value()) [[unlikely]] { return make_unexpected(Error{ - .parameter = OutputType::longname, + .parameter = OutputType::name, .value = value, .type = Error::Type::Parameter, .code = Error::Code::DuplicateParameter From d9058942b662b3d1d4805f1f698625eea23483a2 Mon Sep 17 00:00:00 2001 From: Gly Date: Fri, 2 Dec 2022 01:10:34 +0100 Subject: [PATCH 21/54] update gitignore --- .gitignore | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 7724567..2ecb763 100644 --- a/.gitignore +++ b/.gitignore @@ -590,4 +590,6 @@ healthchecksdb builddir-release build .xmake -test.lua \ No newline at end of file +test.lua + +make_my_glap/output.h \ No newline at end of file From 5f372d92c0baa66b82fb5473502a4b367d254189 Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 23 Jan 2023 02:12:10 +0100 Subject: [PATCH 22/54] add config import in base --- include/glap/core/base.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/include/glap/core/base.h b/include/glap/core/base.h index a8af4b7..f0de80d 100644 --- a/include/glap/core/base.h +++ b/include/glap/core/base.h @@ -1,5 +1,7 @@ #pragma once +#include + #ifndef GLAP_EXPORT #define GLAP_EXPORT #endif \ No newline at end of file From d7f528c64f71ffb2cddb03ae5fe3bf631a970df8 Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 23 Jan 2023 02:12:39 +0100 Subject: [PATCH 23/54] add module and std module in config --- xmake/config/config.h.in | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/xmake/config/config.h.in b/xmake/config/config.h.in index 64c831e..811e02d 100644 --- a/xmake/config/config.h.in +++ b/xmake/config/config.h.in @@ -1,4 +1,6 @@ #pragma once ${define GLAP_USE_TL_EXPECTED} -${define GLAP_USE_FMT} \ No newline at end of file +${define GLAP_USE_FMT} +${define GLAP_USE_MODULE} +${define GLAP_USE_STD_MODULE} \ No newline at end of file From ef7ff32349f0590a24eb80d4b67d904628990b3b Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 23 Jan 2023 02:13:11 +0100 Subject: [PATCH 24/54] add missing endif --- tests/example.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/example.cpp b/tests/example.cpp index f4113ee..5f0859c 100644 --- a/tests/example.cpp +++ b/tests/example.cpp @@ -35,7 +35,7 @@ namespace format { #include #include - +#endif using flag_t = glap::model::Flag< From ad9cba9581ce1de4a38a5a3a57e6a3d3dc05e391 Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 23 Jan 2023 02:13:44 +0100 Subject: [PATCH 25/54] add config in glap module --- modules/public/glap.mpp | 2 ++ 1 file changed, 2 insertions(+) diff --git a/modules/public/glap.mpp b/modules/public/glap.mpp index 82ce32e..e0cc418 100644 --- a/modules/public/glap.mpp +++ b/modules/public/glap.mpp @@ -1,5 +1,7 @@ export module glap; +#include + #ifdef GLAP_USE_FMT import ; #endif From 7099fbd3bb6d681f3f1958c9775f6d9532cd4862 Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 23 Jan 2023 02:13:59 +0100 Subject: [PATCH 26/54] fix fmt import --- modules/public/glap.mpp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/public/glap.mpp b/modules/public/glap.mpp index e0cc418..a5c773c 100644 --- a/modules/public/glap.mpp +++ b/modules/public/glap.mpp @@ -3,7 +3,7 @@ export module glap; #include #ifdef GLAP_USE_FMT -import ; +import ; #endif #ifdef GLAP_USE_TL_EXPECTED @@ -36,6 +36,7 @@ import ; #pragma warning(disable:5244) #define GLAP_MODULE #define GLAP_EXPORT export + #include #include #include From ab4d6740b266cf65e96cee29ea19c6b5aab7b271 Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 23 Jan 2023 02:14:14 +0100 Subject: [PATCH 27/54] add missing character --- include/glap/core/convertible_to.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/glap/core/convertible_to.h b/include/glap/core/convertible_to.h index 7b80271..7bc7e3d 100644 --- a/include/glap/core/convertible_to.h +++ b/include/glap/core/convertible_to.h @@ -18,7 +18,7 @@ GLAP_EXPORT namespace glap concept convertible_to = std::convertible_to; #else template - concept convertible to = + concept convertible_to = std::is_convertible_v && requires { static_cast(std::declval()); From 5042a4253442fe25c32ddb360af98545b8af8b26 Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 23 Jan 2023 02:14:30 +0100 Subject: [PATCH 28/54] fix help header --- include/glap/generators/help.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/include/glap/generators/help.h b/include/glap/generators/help.h index ac0f22b..d06da7c 100644 --- a/include/glap/generators/help.h +++ b/include/glap/generators/help.h @@ -8,7 +8,9 @@ #include #include #include -namespace glap { +#endif + +namespace glap::generators { namespace help { inline constexpr std::string_view INPUTS_NAME = "INPUTS"; inline constexpr int PADDING = 4; From 7f708cf2b2f6352f83859b03f73c4a68c678026a Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 28 Nov 2022 23:27:22 +0100 Subject: [PATCH 29/54] move help in generators --- include/glap/generators/help.h | 54 ++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/include/glap/generators/help.h b/include/glap/generators/help.h index d06da7c..de50618 100644 --- a/include/glap/generators/help.h +++ b/include/glap/generators/help.h @@ -10,6 +10,60 @@ #include #endif +GLAP_EXPORT namespace glap { + namespace help { + inline constexpr std::string_view INPUTS_NAME = "INPUTS"; + inline constexpr int PADDING = 4; + template + concept IsDescription = std::same_as, std::string_view>; + template + concept IsFullDescription = IsDescription + && std::same_as, std::string_view>; + template + concept IsInputs = (T::name == INPUTS_NAME); + namespace model + { + template + struct Description { + static constexpr std::string_view short_description = Short; + }; + template + struct FullDescription : Description { + static constexpr std::string_view long_description = Long; + }; + + template + struct Argument : Desc { + static constexpr std::string_view name = Name; + }; + template + struct Command : Desc { + static constexpr auto name = Name; + }; + template + struct Program : Desc + {}; + } + } + template + struct Help + {}; + + template + inline constexpr auto get_help = Help{}; +} +#pragma once + +#ifndef GLAP_MODULE +#include "../core/base.h" +#include "../core/discard.h" +#include "../core/utils.h" +#include +#include +#include +#include +#endif + namespace glap::generators { namespace help { inline constexpr std::string_view INPUTS_NAME = "INPUTS"; From b3415e7a47f9aecea59189a1c6845c946c6a6f4a Mon Sep 17 00:00:00 2001 From: Gly Date: Tue, 29 Nov 2022 00:06:32 +0100 Subject: [PATCH 30/54] update help to work with the new model --- include/glap/generators/help.h | 46 ++++++++++++++++------------------ 1 file changed, 21 insertions(+), 25 deletions(-) diff --git a/include/glap/generators/help.h b/include/glap/generators/help.h index de50618..7e96321 100644 --- a/include/glap/generators/help.h +++ b/include/glap/generators/help.h @@ -8,9 +8,7 @@ #include #include #include -#endif - -GLAP_EXPORT namespace glap { +namespace glap { namespace help { inline constexpr std::string_view INPUTS_NAME = "INPUTS"; inline constexpr int PADDING = 4; @@ -21,29 +19,27 @@ GLAP_EXPORT namespace glap { && std::same_as, std::string_view>; template concept IsInputs = (T::name == INPUTS_NAME); - namespace model - { - template - struct Description { - static constexpr std::string_view short_description = Short; - }; - template - struct FullDescription : Description { - static constexpr std::string_view long_description = Long; - }; - template - struct Argument : Desc { - static constexpr std::string_view name = Name; - }; - template - struct Command : Desc { - static constexpr auto name = Name; - }; - template - struct Program : Desc - {}; - } + template + struct Description { + static constexpr std::string_view short_description = Short; + }; + template + struct FullDescription : Description { + static constexpr std::string_view long_description = Long; + }; + + template + struct Argument : Desc { + static constexpr std::string_view name = Name; + }; + template + struct Command : Desc { + static constexpr auto name = Name; + }; + template + struct Program : Desc + {}; } template struct Help From fdf4382c08b50e8c4b15d3a17039b3937e30b1c1 Mon Sep 17 00:00:00 2001 From: Gly Date: Tue, 29 Nov 2022 00:37:23 +0100 Subject: [PATCH 31/54] Add ability to get help of command from program --- include/glap/generators/impl/help.inl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/glap/generators/impl/help.inl b/include/glap/generators/impl/help.inl index 6c84ed8..8a75fe4 100644 --- a/include/glap/generators/impl/help.inl +++ b/include/glap/generators/impl/help.inl @@ -21,7 +21,7 @@ namespace glap::generators { struct FindByName {}; template - requires (HasLongName && FromParser::name == T::name) || IsHelpInputsCompatible + requires (HasLongName && FromParser::longname == T::name) || (requires {FromParser::name;} && FromParser::name == T::name) || IsHelpInputsCompatible struct FindByName { public: From c2c2ca35b0f54dd253c2793d57f9cdd6fbe24d1d Mon Sep 17 00:00:00 2001 From: Gly Date: Wed, 30 Nov 2022 13:00:11 +0100 Subject: [PATCH 32/54] rename help concepts --- include/glap/generators/help.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/include/glap/generators/help.h b/include/glap/generators/help.h index 7e96321..536401e 100644 --- a/include/glap/generators/help.h +++ b/include/glap/generators/help.h @@ -13,9 +13,9 @@ namespace glap { inline constexpr std::string_view INPUTS_NAME = "INPUTS"; inline constexpr int PADDING = 4; template - concept IsDescription = std::same_as, std::string_view>; + concept HasDescription = std::same_as, std::string_view>; template - concept IsFullDescription = IsDescription + concept HasFullDescription = HasDescription && std::same_as, std::string_view>; template concept IsInputs = (T::name == INPUTS_NAME); @@ -29,15 +29,15 @@ namespace glap { static constexpr std::string_view long_description = Long; }; - template + template struct Argument : Desc { static constexpr std::string_view name = Name; }; - template + template struct Command : Desc { static constexpr auto name = Name; }; - template + template struct Program : Desc {}; } From e5083fceba0de6dc57e340002b2c9fede7e55469 Mon Sep 17 00:00:00 2001 From: Gly Date: Wed, 30 Nov 2022 13:10:10 +0100 Subject: [PATCH 33/54] rename longname => name --- include/glap/generators/impl/help.inl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/glap/generators/impl/help.inl b/include/glap/generators/impl/help.inl index 8a75fe4..6c84ed8 100644 --- a/include/glap/generators/impl/help.inl +++ b/include/glap/generators/impl/help.inl @@ -21,7 +21,7 @@ namespace glap::generators { struct FindByName {}; template - requires (HasLongName && FromParser::longname == T::name) || (requires {FromParser::name;} && FromParser::name == T::name) || IsHelpInputsCompatible + requires (HasLongName && FromParser::name == T::name) || IsHelpInputsCompatible struct FindByName { public: From 740fb511572a53c7aae91a89052da0b297c78c56 Mon Sep 17 00:00:00 2001 From: Gly Date: Sun, 22 Jan 2023 02:14:10 +0100 Subject: [PATCH 34/54] add missing namespace --- include/glap/generators/help.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/glap/generators/help.h b/include/glap/generators/help.h index 536401e..3a92362 100644 --- a/include/glap/generators/help.h +++ b/include/glap/generators/help.h @@ -8,7 +8,7 @@ #include #include #include -namespace glap { +namespace glap::generators { namespace help { inline constexpr std::string_view INPUTS_NAME = "INPUTS"; inline constexpr int PADDING = 4; From f76f0a60b23e5bafb6e105f4091af124ae70b4d1 Mon Sep 17 00:00:00 2001 From: Gly Date: Sun, 22 Jan 2023 02:14:28 +0100 Subject: [PATCH 35/54] remove preproc --- include/glap/generators/help.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/glap/generators/help.h b/include/glap/generators/help.h index 3a92362..05d0902 100644 --- a/include/glap/generators/help.h +++ b/include/glap/generators/help.h @@ -101,6 +101,6 @@ namespace glap::generators { inline constexpr auto get_help = Help{}; } -#ifndef GLAP_MODULE + #include "impl/help.inl" #endif \ No newline at end of file From 94b7a7f808e8beb3461d38305201e340770721f3 Mon Sep 17 00:00:00 2001 From: Gly Date: Sun, 22 Jan 2023 02:15:51 +0100 Subject: [PATCH 36/54] add missing fonction on windows --- src/style.cpp | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/style.cpp b/src/style.cpp index 17d1fd5..64be2ad 100644 --- a/src/style.cpp +++ b/src/style.cpp @@ -4,6 +4,12 @@ namespace glap::generators { #ifdef _WIN32 + void Style::apply() const noexcept { + + } + void Style::reset() noexcept { + + } #else void Style::apply() const noexcept { From 5ebce4f5c8cdc1ad23389423644a74c8c38dacc7 Mon Sep 17 00:00:00 2001 From: Gly Date: Sun, 22 Jan 2023 02:16:15 +0100 Subject: [PATCH 37/54] use cout instead of print --- src/style.cpp | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/style.cpp b/src/style.cpp index 64be2ad..04a4e00 100644 --- a/src/style.cpp +++ b/src/style.cpp @@ -1,7 +1,7 @@ #include #include #include - +#include namespace glap::generators { #ifdef _WIN32 void Style::apply() const noexcept { @@ -33,10 +33,12 @@ namespace glap::generators { if (!style.empty()) { style.pop_back(); } - print("\033[{}m", style); + std::cout.write("\033[", 2); + std::cout.write(std::data(style), std::size(style)); + std::cout.write("m", 1); } void Style::reset() noexcept { - print("\033[0m"); + std::cout.write("\033[0m", 4); } #endif } \ No newline at end of file From be89d87874e73c910bb9cc3f8ad62a67c48465b1 Mon Sep 17 00:00:00 2001 From: Gly Date: Sun, 22 Jan 2023 02:27:22 +0100 Subject: [PATCH 38/54] remove print from glap fmt --- include/glap/core/fmt.h | 2 -- 1 file changed, 2 deletions(-) diff --git a/include/glap/core/fmt.h b/include/glap/core/fmt.h index 28b0ae3..99d4f6e 100644 --- a/include/glap/core/fmt.h +++ b/include/glap/core/fmt.h @@ -18,12 +18,10 @@ GLAP_EXPORT namespace glap { using std::format; using std::format_to; - using std::print; } #else GLAP_EXPORT namespace glap { using fmt::format; using fmt::format_to; - using fmt::print; } #endif \ No newline at end of file From 3f0324d04f48e0710bcf65fe962e9b0236a407e6 Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 23 Jan 2023 06:38:09 +0100 Subject: [PATCH 39/54] config.h in buildir/include/glap --- include/glap/core/base.h | 2 +- xmake.lua | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/include/glap/core/base.h b/include/glap/core/base.h index f0de80d..c53240e 100644 --- a/include/glap/core/base.h +++ b/include/glap/core/base.h @@ -1,6 +1,6 @@ #pragma once -#include +#include #ifndef GLAP_EXPORT #define GLAP_EXPORT diff --git a/xmake.lua b/xmake.lua index 331b301..08029bb 100644 --- a/xmake.lua +++ b/xmake.lua @@ -66,8 +66,8 @@ target("glap") add_headerfiles("include/(glap/**.h)", "include/(glap/**.inl)") add_includedirs("include", {public = true}) add_options("use_tl_expected", "use_fmt", "enable_std_module", "enable_module") - add_includedirs("$(buildir)/glap", {public = true}) - add_configfiles("xmake/config/config.h.in", {prefixdir = "glap"}) + add_includedirs("$(buildir)/include", {public = true}) + add_configfiles("xmake/config/config.h.in", {prefixdir = "include/glap"}) if has_config("use_tl_expected") then add_packages("tl_expected", {public = true}) end From 4abd171232d07a6d2aaa53fca38cb31e818290aa Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 23 Jan 2023 06:39:20 +0100 Subject: [PATCH 40/54] remove sample from git --- .gitignore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 2ecb763..6b34d27 100644 --- a/.gitignore +++ b/.gitignore @@ -592,4 +592,4 @@ build .xmake test.lua -make_my_glap/output.h \ No newline at end of file +make_my_glap/sample.h \ No newline at end of file From 6ca2292f64e65de016bd3eaa073129ff2436d75b Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 23 Jan 2023 06:43:47 +0100 Subject: [PATCH 41/54] add config.h in core base --- src/glap.cpp | 1 + 1 file changed, 1 insertion(+) diff --git a/src/glap.cpp b/src/glap.cpp index 4303646..7b67e04 100644 --- a/src/glap.cpp +++ b/src/glap.cpp @@ -1,4 +1,5 @@ #ifndef GLAP_MODULE +#include #include #include #include From 1a8a77fa885a52e20fda7770ca6889e8e8760680 Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 23 Jan 2023 22:50:26 +0100 Subject: [PATCH 42/54] glap module : config in glap folder --- modules/public/glap.mpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/public/glap.mpp b/modules/public/glap.mpp index a5c773c..e7259eb 100644 --- a/modules/public/glap.mpp +++ b/modules/public/glap.mpp @@ -1,6 +1,6 @@ export module glap; -#include +#include #ifdef GLAP_USE_FMT import ; From f6a47cd50f3511f0e2811b0748214c31226d2da8 Mon Sep 17 00:00:00 2001 From: Gly Date: Wed, 25 Jan 2023 01:17:55 +0100 Subject: [PATCH 43/54] fix wrong duplication code due to wrong merge --- include/glap/generators/help.h | 54 ---------------------------------- include/glap/glap.h | 3 +- 2 files changed, 1 insertion(+), 56 deletions(-) diff --git a/include/glap/generators/help.h b/include/glap/generators/help.h index 05d0902..e0bdfbf 100644 --- a/include/glap/generators/help.h +++ b/include/glap/generators/help.h @@ -48,59 +48,5 @@ namespace glap::generators { template inline constexpr auto get_help = Help{}; } -#pragma once - -#ifndef GLAP_MODULE -#include "../core/base.h" -#include "../core/discard.h" -#include "../core/utils.h" -#include -#include -#include -#include -#endif - -namespace glap::generators { - namespace help { - inline constexpr std::string_view INPUTS_NAME = "INPUTS"; - inline constexpr int PADDING = 4; - template - concept HasDescription = std::same_as, std::string_view>; - template - concept HasFullDescription = HasDescription - && std::same_as, std::string_view>; - template - concept IsInputs = (T::name == INPUTS_NAME); - - template - struct Description { - static constexpr std::string_view short_description = Short; - }; - template - struct FullDescription : Description { - static constexpr std::string_view long_description = Long; - }; - - template - struct Argument : Desc { - static constexpr std::string_view name = Name; - }; - template - struct Command : Desc { - static constexpr auto name = Name; - }; - template - struct Program : Desc - {}; - } - template - struct Help - {}; - - template - inline constexpr auto get_help = Help{}; -} - - #include "impl/help.inl" #endif \ No newline at end of file diff --git a/include/glap/glap.h b/include/glap/glap.h index 5ee3858..c2b89f3 100644 --- a/include/glap/glap.h +++ b/include/glap/glap.h @@ -1,5 +1,4 @@ #pragma once #include "parser.h" -#include "model.h" -// #include "help.h" \ No newline at end of file +#include "model.h" \ No newline at end of file From 8511a284299dbcfb0e7dd028715ff25b81d3c756 Mon Sep 17 00:00:00 2001 From: Gly Date: Sat, 28 Jan 2023 00:29:38 +0100 Subject: [PATCH 44/54] add mmg rule --- xmake/rules/mmg.lua | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 xmake/rules/mmg.lua diff --git a/xmake/rules/mmg.lua b/xmake/rules/mmg.lua new file mode 100644 index 0000000..946e6dd --- /dev/null +++ b/xmake/rules/mmg.lua @@ -0,0 +1,29 @@ +rule("glap.mmg") + set_extensions(".glap.yaml", ".glap.yml") + on_config(function (target) + -- import("lib.detect.find_tool") + -- local mmg = find_tool("mmg") + local mmg_program = "/home/gly/Projets/glap/build/linux/x86_64/release/mmg" + + if mmg_program then + local mmg_sourcebatches = target:sourcebatches()["glap.mmg"] + if mmg_sourcebatches then + local path_include = path.join(target:configdir(), "mmg_include") + if not os.isdir(path_include) then + os.mkdir(path_include) + end + for _, sourcebatch in ipairs(mmg_sourcebatches.sourcefiles) do + local sourcedir = path.join(path_include, path.directory(sourcebatch)) + print("basename: " .. sourcedir) + if sourcedir ~= "" and not os.isdir(sourcedir) then + os.mkdir(sourcedir) + end + os.runv(mmg_program, {"-t", "header", "-i", sourcebatch, "-o", path.join(path_include, sourcebatch:gsub("%.glap%.ya?ml", "") .. ".h")}) + end + -- path of the target relative to the project directory + local target_relat = path.relative(target:scriptdir(), os.projectdir()) + local path_includes = path.join(path_include, target_relat) + target:add("includedirs", path_includes) + end + end + end) \ No newline at end of file From 47ca2a1fede734e42bb5737cb05e9e2399b83470 Mon Sep 17 00:00:00 2001 From: Gly Date: Sat, 28 Jan 2023 00:58:11 +0100 Subject: [PATCH 45/54] improve mmg rule --- xmake/rules/mmg.lua | 53 ++++++++++++++++++++++++++------------------- 1 file changed, 31 insertions(+), 22 deletions(-) diff --git a/xmake/rules/mmg.lua b/xmake/rules/mmg.lua index 946e6dd..5003dcc 100644 --- a/xmake/rules/mmg.lua +++ b/xmake/rules/mmg.lua @@ -1,29 +1,38 @@ rule("glap.mmg") set_extensions(".glap.yaml", ".glap.yml") on_config(function (target) - -- import("lib.detect.find_tool") - -- local mmg = find_tool("mmg") - local mmg_program = "/home/gly/Projets/glap/build/linux/x86_64/release/mmg" + import("lib.detect.find_program") + local mmg_program = find_program("mmg") + if not mmg_program then + local mmg_program = "/home/gly/Projets/glap/build/linux/x86_64/release/mmg" + end + + if not mmg_program then + raise("mmg not found!") + end + -- mmg source batches of the target + local mmg_sourcebatches = target:sourcebatches()["glap.mmg"] + if mmg_sourcebatches then + return + end + -- path of the mmg configuration directory + local config_path = path.join(target:configdir(), "mmg_include") + if not os.isdir(config_path) then + os.mkdir(config_path) + end - if mmg_program then - local mmg_sourcebatches = target:sourcebatches()["glap.mmg"] - if mmg_sourcebatches then - local path_include = path.join(target:configdir(), "mmg_include") - if not os.isdir(path_include) then - os.mkdir(path_include) - end - for _, sourcebatch in ipairs(mmg_sourcebatches.sourcefiles) do - local sourcedir = path.join(path_include, path.directory(sourcebatch)) - print("basename: " .. sourcedir) - if sourcedir ~= "" and not os.isdir(sourcedir) then - os.mkdir(sourcedir) - end - os.runv(mmg_program, {"-t", "header", "-i", sourcebatch, "-o", path.join(path_include, sourcebatch:gsub("%.glap%.ya?ml", "") .. ".h")}) - end - -- path of the target relative to the project directory - local target_relat = path.relative(target:scriptdir(), os.projectdir()) - local path_includes = path.join(path_include, target_relat) - target:add("includedirs", path_includes) + for _, sourcebatch in ipairs(mmg_sourcebatches.sourcefiles) do + local configdir = path.join(config_path, path.directory(sourcebatch)) + -- create the mmg output directory if it does not exist + if configdir ~= "" and not os.isdir(configdir) then + os.mkdir(configdir) end + -- generate the header file from the mmg configuration file + os.runv(mmg_program, {"-t", "header", "-i", sourcebatch, "-o", path.join(config_path, sourcebatch:gsub("%.glap%.ya?ml", "") .. ".h")}) end + -- path of the target relative to the project directory + local target_relat = path.relative(target:scriptdir(), os.projectdir()) + local includedirs = path.join(config_path, target_relat) + -- add the mmg configuration directory (specific to the target) to the target + target:add("includedirs", includedirs) end) \ No newline at end of file From ad7b0e17a0c1e89620e64c55cdd6335c45bc655c Mon Sep 17 00:00:00 2001 From: Gly Date: Sat, 28 Jan 2023 01:03:44 +0100 Subject: [PATCH 46/54] embed rule in a function --- xmake/rules/mmg.lua | 73 +++++++++++++++++++++++---------------------- 1 file changed, 38 insertions(+), 35 deletions(-) diff --git a/xmake/rules/mmg.lua b/xmake/rules/mmg.lua index 5003dcc..a77a9d5 100644 --- a/xmake/rules/mmg.lua +++ b/xmake/rules/mmg.lua @@ -1,38 +1,41 @@ -rule("glap.mmg") - set_extensions(".glap.yaml", ".glap.yml") - on_config(function (target) - import("lib.detect.find_program") - local mmg_program = find_program("mmg") - if not mmg_program then - local mmg_program = "/home/gly/Projets/glap/build/linux/x86_64/release/mmg" - end +function mmg_update_target (target) + import("lib.detect.find_program") + local mmg_program = find_program("mmg") + if not mmg_program then + mmg_program = "/home/gly/Projets/glap/build/linux/x86_64/release/mmg" + end - if not mmg_program then - raise("mmg not found!") - end - -- mmg source batches of the target - local mmg_sourcebatches = target:sourcebatches()["glap.mmg"] - if mmg_sourcebatches then - return - end - -- path of the mmg configuration directory - local config_path = path.join(target:configdir(), "mmg_include") - if not os.isdir(config_path) then - os.mkdir(config_path) - end + if not mmg_program then + raise("mmg not found!") + end + -- mmg source batches of the target + local mmg_sourcebatches = target:sourcebatches()["glap.mmg"] + if mmg_sourcebatches then + return + end + -- path of the mmg configuration directory + local config_path = path.join(target:configdir(), "mmg_include") + if not os.isdir(config_path) then + os.mkdir(config_path) + end - for _, sourcebatch in ipairs(mmg_sourcebatches.sourcefiles) do - local configdir = path.join(config_path, path.directory(sourcebatch)) - -- create the mmg output directory if it does not exist - if configdir ~= "" and not os.isdir(configdir) then - os.mkdir(configdir) - end - -- generate the header file from the mmg configuration file - os.runv(mmg_program, {"-t", "header", "-i", sourcebatch, "-o", path.join(config_path, sourcebatch:gsub("%.glap%.ya?ml", "") .. ".h")}) + for _, sourcebatch in ipairs(mmg_sourcebatches.sourcefiles) do + local configdir = path.join(config_path, path.directory(sourcebatch)) + -- create the mmg output directory if it does not exist + if configdir ~= "" and not os.isdir(configdir) then + os.mkdir(configdir) end - -- path of the target relative to the project directory - local target_relat = path.relative(target:scriptdir(), os.projectdir()) - local includedirs = path.join(config_path, target_relat) - -- add the mmg configuration directory (specific to the target) to the target - target:add("includedirs", includedirs) - end) \ No newline at end of file + -- generate the header file from the mmg configuration file + os.runv(mmg_program, {"-t", "header", "-i", sourcebatch, "-o", path.join(config_path, sourcebatch:gsub("%.glap%.ya?ml", "") .. ".h")}) + end + -- path of the target relative to the project directory + local target_relat = path.relative(target:scriptdir(), os.projectdir()) + local includedirs = path.join(config_path, target_relat) + -- add the mmg configuration directory (specific to the target) to the target + target:add("includedirs", includedirs) +end + +rule("glap.mmg") + set_extensions(".glap.yaml", ".glap.yml") + on_config(mmg_update_target) + before_build(mmg_update_target) \ No newline at end of file From 35d56fd773e7ca489b201914ceb44f98a7a4d382 Mon Sep 17 00:00:00 2001 From: Gly Date: Sun, 29 Jan 2023 01:12:05 +0100 Subject: [PATCH 47/54] manage lua files --- xmake.lua | 3 +- xmake/rules/mmg.lua | 41 ------------- xmake/rules/mmg/utils.lua | 59 +++++++++++++++++++ xmake/rules/mmg/xmake.lua | 12 ++++ xmake/toolchains/{llvm.lua => llvm/xmake.lua} | 0 5 files changed, 73 insertions(+), 42 deletions(-) delete mode 100644 xmake/rules/mmg.lua create mode 100644 xmake/rules/mmg/utils.lua create mode 100644 xmake/rules/mmg/xmake.lua rename xmake/toolchains/{llvm.lua => llvm/xmake.lua} (100%) diff --git a/xmake.lua b/xmake.lua index 08029bb..53526d0 100644 --- a/xmake.lua +++ b/xmake.lua @@ -1,4 +1,4 @@ -includes("xmake/**.lua") +includes("xmake/**/xmake.lua") add_rules("mode.debug", "mode.release", "mode.asan") add_requires("fmt 9.0.0", {optional = true}) -- required only if stl has not std::format @@ -68,6 +68,7 @@ target("glap") add_options("use_tl_expected", "use_fmt", "enable_std_module", "enable_module") add_includedirs("$(buildir)/include", {public = true}) add_configfiles("xmake/config/config.h.in", {prefixdir = "include/glap"}) + add_installfiles("xmake/rules/(**/*.lua)", {prefixdir = "xmake/rules"}) if has_config("use_tl_expected") then add_packages("tl_expected", {public = true}) end diff --git a/xmake/rules/mmg.lua b/xmake/rules/mmg.lua deleted file mode 100644 index a77a9d5..0000000 --- a/xmake/rules/mmg.lua +++ /dev/null @@ -1,41 +0,0 @@ -function mmg_update_target (target) - import("lib.detect.find_program") - local mmg_program = find_program("mmg") - if not mmg_program then - mmg_program = "/home/gly/Projets/glap/build/linux/x86_64/release/mmg" - end - - if not mmg_program then - raise("mmg not found!") - end - -- mmg source batches of the target - local mmg_sourcebatches = target:sourcebatches()["glap.mmg"] - if mmg_sourcebatches then - return - end - -- path of the mmg configuration directory - local config_path = path.join(target:configdir(), "mmg_include") - if not os.isdir(config_path) then - os.mkdir(config_path) - end - - for _, sourcebatch in ipairs(mmg_sourcebatches.sourcefiles) do - local configdir = path.join(config_path, path.directory(sourcebatch)) - -- create the mmg output directory if it does not exist - if configdir ~= "" and not os.isdir(configdir) then - os.mkdir(configdir) - end - -- generate the header file from the mmg configuration file - os.runv(mmg_program, {"-t", "header", "-i", sourcebatch, "-o", path.join(config_path, sourcebatch:gsub("%.glap%.ya?ml", "") .. ".h")}) - end - -- path of the target relative to the project directory - local target_relat = path.relative(target:scriptdir(), os.projectdir()) - local includedirs = path.join(config_path, target_relat) - -- add the mmg configuration directory (specific to the target) to the target - target:add("includedirs", includedirs) -end - -rule("glap.mmg") - set_extensions(".glap.yaml", ".glap.yml") - on_config(mmg_update_target) - before_build(mmg_update_target) \ No newline at end of file diff --git a/xmake/rules/mmg/utils.lua b/xmake/rules/mmg/utils.lua new file mode 100644 index 0000000..6f696b2 --- /dev/null +++ b/xmake/rules/mmg/utils.lua @@ -0,0 +1,59 @@ +function get_mmg() + import("lib.detect.find_tool") + local mmg = find_tool("mmg") + if not mmg then + mmg = {program = "/home/gly/Projets/glap/build/linux/x86_64/release/mmg"} + end + if not mmg then + raise("mmg not found!") + end + return mmg.program +end + +function mmg_update_file(target, input_file, opt) + import("core.base.option") + local opt = opt or {} + local mmg_program = opt.mmg_program or get_mmg() + local config_dir = opt.config_dir + if not config_dir then + config_dir = path.join(target:configdir(), "mmg_include") + if not os.isdir(config_dir) then + os.mkdir(config_dir) + end + end + + local output_dir = path.join(config_dir, path.directory(input_file)) + if output_dir ~= "" and not os.isdir(output_dir) then + os.mkdir(output_dir) + end + local output_file = path.join(config_dir, input_file:gsub("%.ya?ml$", ""):gsub("%.glap", "") .. ".h") + -- generate the header file from the mmg configuration file + if option.get("verbose") then + cprint("${dim}generating %s to %s ..", input_file, output_file) + end + os.runv(mmg_program, {"-t", "header", "-i", input_file, "-o", output_file}) + + + + return output_file +end +function mmg_update_target(target) + local mmg_program = get_mmg() + local mmg_sourcebatches = target:sourcebatches()["glap.mmg"] + if mmg_sourcebatches then + return + end + local config_dir = path.join(target:configdir(), "mmg_include") + if not os.isdir(config_dir) then + os.mkdir(config_dir) + end + + for _, sourcebatch in ipairs(mmg_sourcebatches.sourcefiles) do + mmg_update_file(target, sourcebatch, {mmg_program = mmg_program, config_dir = config_dir}) + end + -- path of the target relative to the project directory + local target_relat = path.relative(target:scriptdir(), os.projectdir()) + local includedirs = path.join(config_dir, target_relat) + -- add the mmg configuration directory (specific to the target) to the target + target:add("includedirs", includedirs) +end \ No newline at end of file diff --git a/xmake/rules/mmg/xmake.lua b/xmake/rules/mmg/xmake.lua new file mode 100644 index 0000000..5160fb9 --- /dev/null +++ b/xmake/rules/mmg/xmake.lua @@ -0,0 +1,12 @@ + + +rule("glap.mmg") + set_extensions(".glap.yaml", ".glap.yml") + on_config(function(target) import("utils").mmg_update_target(target) end) + -- before_build(import("mmg_utils").mmg_update_target) + before_buildcmd_file(function (target, batchcmds, source_file, opt) + local output_file = import("utils").mmg_update_file(target, source_file) + batchcmds:add_depfiles(source_file) + batchcmds:set_depmtime(os.mtime(output_file)) + batchcmds:set_depcache(target:dependfile(output_file)) + end) \ No newline at end of file diff --git a/xmake/toolchains/llvm.lua b/xmake/toolchains/llvm/xmake.lua similarity index 100% rename from xmake/toolchains/llvm.lua rename to xmake/toolchains/llvm/xmake.lua From ed554fde19cf87702bb3ebb12715b28ad6567c87 Mon Sep 17 00:00:00 2001 From: Gly Date: Sun, 29 Jan 2023 02:19:49 +0100 Subject: [PATCH 48/54] WIP depend glap conf --- xmake/rules/mmg/utils.lua | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/xmake/rules/mmg/utils.lua b/xmake/rules/mmg/utils.lua index 6f696b2..8f0d451 100644 --- a/xmake/rules/mmg/utils.lua +++ b/xmake/rules/mmg/utils.lua @@ -12,6 +12,7 @@ end function mmg_update_file(target, input_file, opt) import("core.base.option") + import("core.project.depend") local opt = opt or {} local mmg_program = opt.mmg_program or get_mmg() local config_dir = opt.config_dir @@ -29,11 +30,15 @@ function mmg_update_file(target, input_file, opt) local output_file = path.join(config_dir, input_file:gsub("%.ya?ml$", ""):gsub("%.glap", "") .. ".h") -- generate the header file from the mmg configuration file if option.get("verbose") then - cprint("${dim}generating %s to %s ..", input_file, output_file) + cprint("${dim}generating %s to %s ..", path.filename(input_file), path.filename(output_file)) end os.runv(mmg_program, {"-t", "header", "-i", input_file, "-o", output_file}) - + depend.on_changed(function() + local mmg = get_mmg() + os.runv(mmg_program, {"-t", "header", "-i", input_file, "-o", output_file}) + cprint("${dim}generating %s to %s ..", path.filename(input_file), path.filename(output_file)) + end, {files = {input_file}}) return output_file end From 735a5696999c4742476abbe1b5d46ffa77a13891 Mon Sep 17 00:00:00 2001 From: Gly Date: Sun, 29 Jan 2023 15:29:24 +0100 Subject: [PATCH 49/54] move mmg rule into its target --- xmake/rules/mmg/utils.lua | 64 --------------------------------------- xmake/rules/mmg/xmake.lua | 12 -------- 2 files changed, 76 deletions(-) delete mode 100644 xmake/rules/mmg/utils.lua delete mode 100644 xmake/rules/mmg/xmake.lua diff --git a/xmake/rules/mmg/utils.lua b/xmake/rules/mmg/utils.lua deleted file mode 100644 index 8f0d451..0000000 --- a/xmake/rules/mmg/utils.lua +++ /dev/null @@ -1,64 +0,0 @@ -function get_mmg() - import("lib.detect.find_tool") - local mmg = find_tool("mmg") - if not mmg then - mmg = {program = "/home/gly/Projets/glap/build/linux/x86_64/release/mmg"} - end - if not mmg then - raise("mmg not found!") - end - return mmg.program -end - -function mmg_update_file(target, input_file, opt) - import("core.base.option") - import("core.project.depend") - local opt = opt or {} - local mmg_program = opt.mmg_program or get_mmg() - local config_dir = opt.config_dir - if not config_dir then - config_dir = path.join(target:configdir(), "mmg_include") - if not os.isdir(config_dir) then - os.mkdir(config_dir) - end - end - - local output_dir = path.join(config_dir, path.directory(input_file)) - if output_dir ~= "" and not os.isdir(output_dir) then - os.mkdir(output_dir) - end - local output_file = path.join(config_dir, input_file:gsub("%.ya?ml$", ""):gsub("%.glap", "") .. ".h") - -- generate the header file from the mmg configuration file - if option.get("verbose") then - cprint("${dim}generating %s to %s ..", path.filename(input_file), path.filename(output_file)) - end - os.runv(mmg_program, {"-t", "header", "-i", input_file, "-o", output_file}) - - depend.on_changed(function() - local mmg = get_mmg() - os.runv(mmg_program, {"-t", "header", "-i", input_file, "-o", output_file}) - cprint("${dim}generating %s to %s ..", path.filename(input_file), path.filename(output_file)) - end, {files = {input_file}}) - - return output_file -end -function mmg_update_target(target) - local mmg_program = get_mmg() - local mmg_sourcebatches = target:sourcebatches()["glap.mmg"] - if mmg_sourcebatches then - return - end - local config_dir = path.join(target:configdir(), "mmg_include") - if not os.isdir(config_dir) then - os.mkdir(config_dir) - end - - for _, sourcebatch in ipairs(mmg_sourcebatches.sourcefiles) do - mmg_update_file(target, sourcebatch, {mmg_program = mmg_program, config_dir = config_dir}) - end - -- path of the target relative to the project directory - local target_relat = path.relative(target:scriptdir(), os.projectdir()) - local includedirs = path.join(config_dir, target_relat) - -- add the mmg configuration directory (specific to the target) to the target - target:add("includedirs", includedirs) -end \ No newline at end of file diff --git a/xmake/rules/mmg/xmake.lua b/xmake/rules/mmg/xmake.lua deleted file mode 100644 index 5160fb9..0000000 --- a/xmake/rules/mmg/xmake.lua +++ /dev/null @@ -1,12 +0,0 @@ - - -rule("glap.mmg") - set_extensions(".glap.yaml", ".glap.yml") - on_config(function(target) import("utils").mmg_update_target(target) end) - -- before_build(import("mmg_utils").mmg_update_target) - before_buildcmd_file(function (target, batchcmds, source_file, opt) - local output_file = import("utils").mmg_update_file(target, source_file) - batchcmds:add_depfiles(source_file) - batchcmds:set_depmtime(os.mtime(output_file)) - batchcmds:set_depcache(target:dependfile(output_file)) - end) \ No newline at end of file From f9018863f36a4e8235d9d5b95f05b6088527248b Mon Sep 17 00:00:00 2001 From: Gly Date: Sun, 29 Jan 2023 21:59:36 +0100 Subject: [PATCH 50/54] remove mmg from glap xmake includes --- xmake.lua | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/xmake.lua b/xmake.lua index 53526d0..0751f70 100644 --- a/xmake.lua +++ b/xmake.lua @@ -53,8 +53,6 @@ option("enable_std_module") set_description("Enable C++23 std module support") add_defines("GLAP_USE_STD_MODULE", {public = true}) -includes("make_my_glap") - target("glap") set_kind("$(kind)") if has_config("enable_std_module") or not has_config("use_tl_expected") then @@ -68,7 +66,8 @@ target("glap") add_options("use_tl_expected", "use_fmt", "enable_std_module", "enable_module") add_includedirs("$(buildir)/include", {public = true}) add_configfiles("xmake/config/config.h.in", {prefixdir = "include/glap"}) - add_installfiles("xmake/rules/(**/*.lua)", {prefixdir = "xmake/rules"}) + add_headerfiles("$(buildir)/(include/**.h)") + if has_config("use_tl_expected") then add_packages("tl_expected", {public = true}) end From b26443e6dc5b9c9685c1d2cfb029ffa3909a623e Mon Sep 17 00:00:00 2001 From: Gly Date: Sun, 29 Jan 2023 22:19:06 +0100 Subject: [PATCH 51/54] add xmake repo for test --- .gitmodules | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 .gitmodules diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..f9bb45b --- /dev/null +++ b/.gitmodules @@ -0,0 +1,4 @@ +[submodule "test_mmg/test-xmake-repo"] + path = test_mmg/test-xmake-repo + url = https://github.com/glcraft/xmake-repo.git + branch = mmg-test From a36d42323a1f4b901808f00b8fcafbef0f3cd8db Mon Sep 17 00:00:00 2001 From: Gly Date: Sun, 29 Jan 2023 22:19:17 +0100 Subject: [PATCH 52/54] git ignore install folder --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 6b34d27..4cea3f8 100644 --- a/.gitignore +++ b/.gitignore @@ -592,4 +592,5 @@ build .xmake test.lua -make_my_glap/sample.h \ No newline at end of file +make_my_glap/sample.h +install/ \ No newline at end of file From bc0beb45e9e85fa90cf98423bb4d21f059d59a3a Mon Sep 17 00:00:00 2001 From: Gly Date: Mon, 30 Jan 2023 00:43:07 +0100 Subject: [PATCH 53/54] glap add config in header files --- xmake.lua | 2 ++ 1 file changed, 2 insertions(+) diff --git a/xmake.lua b/xmake.lua index 0751f70..16ddaab 100644 --- a/xmake.lua +++ b/xmake.lua @@ -78,6 +78,8 @@ target("glap") add_files("modules/**.mpp") end on_load(function(target) + import("core.project.config") + target:add("headerfiles", config.buildir() .. "/include/glap/config.h", {prefixdir = "glap"}) if not has_config("enable_std_module") then -- target:data_set("c++.msvc.enable_std_import", false) end From 1af8a59813ae725d9aeb68fe9312d8d0f0035548 Mon Sep 17 00:00:00 2001 From: gly Date: Tue, 14 Feb 2023 14:24:14 +0100 Subject: [PATCH 54/54] Update HELP doc file --- docs/HELP.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/HELP.md b/docs/HELP.md index 9025bd7..1255195 100644 --- a/docs/HELP.md +++ b/docs/HELP.md @@ -1,6 +1,6 @@ # Help text generator -It is currently in development, not usable. +It is still in development, usable but not yet documented. ## Utils