feat: Add CPLIB_STARTUP_TEXT macro

rindag-devs · Aug 3, 2024 · cfe5ce6 · cfe5ce6
1 parent 44c4dfc
commit cfe5ce6
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 13 deletions.
diff --git a/docs/pages/user-guide/advanced/initializer.en.mdx b/docs/pages/user-guide/advanced/initializer.en.mdx
@@ -127,3 +127,7 @@ If the `<name>` type is Reader, an additional parameter representing the Reader'
 <Callout type="warning">
   Do not report errors by calling the `cplib::panic` function when implementing `Reporter::report`. This is because CPLib programs modify the panic implementation during initialization to call `Reporter::report` with `INTERNAL_ERROR` as the status, which will cause an infinite recursion.
 </Callout>
+
+<Callout type="warning">
+According to the LGPL license requirements, when you distribute software that uses CPLib, you need to indicate somewhere that the software uses CPLib, and that CPLib is licensed under the LGPL. Our recommended approach is to output relevant information when the command line argument contains `--help`. This tutorial has not been implemented to keep the code short. In actual projects, please be sure to strictly abide by the open source license.
+</Callout>
diff --git a/docs/pages/user-guide/advanced/initializer.zh.mdx b/docs/pages/user-guide/advanced/initializer.zh.mdx
@@ -127,3 +127,7 @@ Initializer 需继承自 `cplib::<work-modeInitializerReporter` 并实现 `auto
 <Callout type="warning">
   不要在实现 `Reporter::report` 的时候通过调用 `cplib::panic` 函数报告错误．因为 CPLib 程序在初始化的时候会将 panic 实现修改为以 INTERNAL_ERROR 作为 status 调用 `Reporter::report`．这会引起无限递归．
 </Callout>
+
+<Callout type="warning">
+  根据 LGPL 许可证要求，当你分发使用 CPLib 的软件时，你需要在某处说明该软件使用 CPLib，并且 CPLib 是 LGPL 许可的．我们推荐的方式是在命令行参数包含 `--help` 时输出有关信息．本教程为保证代码简短并未做出实现，在实际项目中请务必注意严格遵守开源许可证．
+</Callout>
diff --git a/include/checker.i.hpp b/include/checker.i.hpp
@@ -205,9 +205,7 @@ constexpr std::string_view ARGS_USAGE =
 
 inline auto print_help_message(std::string_view program_name) -> void {
   std::string msg =
-      format("cplib (CPLib) " CPLIB_VERSION
-             "\n"
-             "https://github.com/rindag-devs/cplib/ by Rindag Devs, copyright(c) 2023\n"
+      format(CPLIB_STARTUP_TEXT
              "\n"
              "Usage:\n"
              "  %s %s\n"

diff --git a/include/generator.i.hpp b/include/generator.i.hpp
@@ -118,9 +118,7 @@ inline auto parse_arg(std::string_view arg) -> std::pair<std::string, std::optio
 
 inline auto print_help_message(std::string_view program_name, std::string_view args_usage) -> void {
   std::string msg =
-      format("cplib (CPLib) " CPLIB_VERSION
-             "\n"
-             "https://github.com/rindag-devs/cplib/ by Rindag Devs, copyright(c) 2023\n"
+      format(CPLIB_STARTUP_TEXT
              "\n"
              "Usage:\n"
              "  %s %s\n"

diff --git a/include/interactor.i.hpp b/include/interactor.i.hpp
@@ -180,9 +180,7 @@ constexpr std::string_view ARGS_USAGE = "<input_file> [--report-format={auto|jso
 
 inline auto print_help_message(std::string_view program_name) -> void {
   std::string msg =
-      format("cplib (CPLib) " CPLIB_VERSION
-             "\n"
-             "https://github.com/rindag-devs/cplib/ by Rindag Devs, copyright(c) 2023\n"
+      format(CPLIB_STARTUP_TEXT
              "\n"
              "Usage:\n"
              "  %s %s\n"

diff --git a/include/macros.hpp b/include/macros.hpp
@@ -18,6 +18,11 @@
 
 #define CPLIB_VERSION "0.0.1-SNAPSHOT"
 
+#define CPLIB_STARTUP_TEXT       \
+  "cplib (CPLib) " CPLIB_VERSION \
+  "\n"                           \
+  "https://github.com/rindag-devs/cplib/ by Rindag Devs, copyright(c) 2023-2024\n"
+
 #if (_WIN32 || __WIN32__ || __WIN32 || _WIN64 || __WIN64__ || __WIN64 || WINNT || __WINNT || \
      __WINNT__ || __CYGWIN__)
 #if !defined(_MSC_VER) || _MSC_VER > 1400

diff --git a/include/validator.i.hpp b/include/validator.i.hpp
@@ -286,10 +286,7 @@ constexpr std::string_view ARGS_USAGE = "[<input_file>] [--report-format={auto|j
 
 inline auto print_help_message(std::string_view program_name) -> void {
   std::string msg =
-      format("cplib (CPLib) " CPLIB_VERSION
-             "\n"
-             "https://github.com/rindag-devs/cplib/ by Rindag Devs, copyright(c) 2023\n"
-             "\n"
+      format(CPLIB_STARTUP_TEXT
              "Usage:\n"
              "  %s %s\n"
              "\n"