Merge branch 'main' of ssh://gitea.youmetme.wang:9122/youmetme/CArgParse

Reviewed-on: #5

README.md

@@ -34,7 +34,7 @@ conan create .
 
 
 ## 示例程序
-构建简单的命令行程序
+构建简单的命令行程序,更多示例请参考`example`目录
 ```c
 #include "ArgParse.h"
 #include <stdbool.h>
@@ -42,11 +42,11 @@ conan create .
 #include <string.h>
 
 ArgParse *Init() {
-    ArgParse *ap = argParseInit("简单的命令行工具示例");
+    ArgParse *ap = argParseInit("简单的命令行工具示例",ArgParseNOVALUE);
 
     // 添加第一个命令
     Command *cmd = argParseAddCommand(
-        ap, "list", "列出文件列表", NULL, NULL, NULL, SINGLEVALUE);
+        ap, "list", "列出文件列表", NULL, NULL, NULL, ArgParseSINGLEVALUE);
 
     // 添加第一个命令的参数
     argParseAddArg(cmd,
@@ -56,7 +56,7 @@ ArgParse *Init() {
                    NULL,
                    NULL,
                    false,
-                   NOVALUE);
+                   ArgParseNOVALUE);
 
     return ap;
 }

conanfile.py

@@ -4,12 +4,12 @@ from conan.tools.files import copy
 import os
 
 
-class loggingRecipe(ConanFile):
+class CArgParseRecipe(ConanFile):
     name = "cargparse"
-    version = "0.3.0"
+    version = "0.3.2"
     license = "MIT"
     author = "321640253@qq.com"
-    url = "https://gitea.youmetme.wang/youmetme/logging"
+    url = "https://gitea.youmetme.wang/youmetme/CArgParse"
     description = "C语言命令行参数解析器"
     topics = (
         "argparse",

examples/simple.c

@@ -4,11 +4,11 @@
 #include <string.h>
 
 ArgParse *Init() {
-    ArgParse *ap = argParseInit("简单的命令行工具示例",NOVALUE);
+    ArgParse *ap = argParseInit("简单的命令行工具示例",ArgParseNOVALUE);
 
     // 添加第一个命令
     Command *cmd = argParseAddCommand(
-        ap, "list", "列出文件列表", NULL, NULL, NULL, SINGLEVALUE);
+        ap, "list", "列出文件列表", NULL, NULL, NULL, ArgParseSINGLEVALUE);
 
     // 添加第一个命令的参数
     argParseAddArg(cmd,
@@ -18,7 +18,7 @@ ArgParse *Init() {
                    NULL,
                    NULL,
                    false,
-                   NOVALUE);
+                   ArgParseNOVALUE);
 
     return ap;
 }

include/ArgParse.h

@@ -7,6 +7,12 @@
 extern "C" {
 #endif
 
+#ifdef _MSC_VER
+#define NORETURN __declspec(noreturn)
+#else
+#define NORETURN _Noreturn
+#endif
+
 #define ARG_DEFAULT_HELP_FLAG "--help"
 
 typedef struct ArgParse ArgParse; // 解析器
@@ -16,10 +22,10 @@ typedef int (*ArgParseCallback)(ArgParse *argParse,
                                 int       val_len); // 回调函数
 
 typedef enum {
-    NOVALUE = 0,     // 无值
-    SINGLEVALUE,     // 单值 例如： -i https://www.baidu.com
-    MULTIVALUE,      // 多值 例如: -s a b c 或 -s a -s b -s c等
-} ArgParseValueType; // 值类型
+    ArgParseNOVALUE = 0, // 无值
+    ArgParseSINGLEVALUE, // 单值 例如： -i https://www.baidu.com
+    ArgParseMULTIVALUE,  // 多值 例如: -s a b c 或 -s a -s b -s c等
+} ArgParseValueType;     // 值类型
 
 typedef struct CommandArgs {
     /* 构造属性 */
@@ -69,7 +75,7 @@ typedef struct ArgParse {
     struct CommandArgs **global_args;     // 全局参数
     int                  global_args_len; // 全局参数个数
     char                *documentation;   // 帮助文档
-    ArgParseValueType value_type; // 值类型 程序默认需要的值例如 gcc main.c
+    ArgParseValueType    value_type; // 值类型 程序默认需要的值例如 gcc main.c
 
     /* 解析所用到的属性*/
     struct Command *current_command; // 当前解析到的命令
@@ -112,9 +118,9 @@ void argParseAutoHelp(ArgParse *argParse);
  * @return Command* 命令指针
  */
 Command *argParseAddCommand(ArgParse         *argParse,
-                            char             *name,
-                            char             *help,
-                            char             *default_val, // 默认值
+                            const char       *name,
+                            const char       *help,
+                            const char       *default_val, // 默认值
                             ArgParseCallback  callback,
                             CommandGroup     *group,
                             ArgParseValueType value_type);
@@ -129,9 +135,9 @@ Command *argParseAddCommand(ArgParse         *argParse,
  * @return Command* 子命令指针
  */
 Command *argParseAddSubCommand(Command          *Parent,
-                               char             *name,
-                               char             *help,
-                               char             *default_val,
+                               const char       *name,
+                               const char       *help,
+                               const char       *default_val,
                                ArgParseCallback  callback,
                                CommandGroup     *group,
                                ArgParseValueType value_type);
@@ -148,10 +154,10 @@ Command *argParseAddSubCommand(Command          *Parent,
  * @return CommandArgs* 参数指针
  */
 CommandArgs *argParseAddArg(Command          *command,
-                            char             *short_opt,
-                            char             *long_opt,
-                            char             *help,
-                            char             *default_val,
+                            const char       *short_opt,
+                            const char       *long_opt,
+                            const char       *help,
+                            const char       *default_val,
                             ArgParseCallback  callback,
                             bool              required,
                             ArgParseValueType value_type);
@@ -168,10 +174,10 @@ CommandArgs *argParseAddArg(Command          *command,
  * @return
  */
 CommandArgs *argParseAddGlobalArg(ArgParse         *argParse,
-                                  char             *short_opt,
-                                  char             *long_opt,
-                                  char             *help,
-                                  char             *default_val,
+                                  const char       *short_opt,
+                                  const char       *long_opt,
+                                  const char       *help,
+                                  const char       *default_val,
                                   ArgParseCallback  callback,
                                   bool              required,
                                   ArgParseValueType value_type);
@@ -222,7 +228,7 @@ char **argParseGetCurCommandValues(ArgParse *argParse, int *len);
  * @return char* 选项值
  * @return
  */
-char *argParseGetCurArg(ArgParse *argParse, char *opt);
+char *argParseGetCurArg(ArgParse *argParse, const char *opt);
 
 /**
  * @brief 获取当前解析到的命令参数列表,仅适用于多值参数
@@ -231,7 +237,7 @@ char *argParseGetCurArg(ArgParse *argParse, char *opt);
  * @param len 参数个数buffer
  * @return char** 参数列表
  */
-char **argParseGetCurArgList(ArgParse *argParse, char *opt, int *len);
+char **argParseGetCurArgList(ArgParse *argParse, const char *opt, int *len);
 
 /**
  * @brief 获取全局参数
@@ -239,7 +245,7 @@ char **argParseGetCurArgList(ArgParse *argParse, char *opt, int *len);
  * @param opt 选项名
  * @return char* 选项值
  */
-char *argParseGetGlobalArg(ArgParse *argParse, char *opt);
+char *argParseGetGlobalArg(ArgParse *argParse, const char *opt);
 
 /**
  * @brief 获取全局参数列表,仅适用于多值参数
@@ -248,7 +254,7 @@ char *argParseGetGlobalArg(ArgParse *argParse, char *opt);
  * @param len 参数个数buffer
  * @return char** 参数列表
  */
-char **argParseGetGlobalArgList(ArgParse *argParse, char *opt, int *len);
+char **argParseGetGlobalArgList(ArgParse *argParse, const char *opt, int *len);
 
 /**
  * @brief 检查当前解析到的命令的某个参数是否被触发
@@ -256,7 +262,7 @@ char **argParseGetGlobalArgList(ArgParse *argParse, char *opt, int *len);
  * @param opt 选项名
  * @return bool 是否被触发
  */
-bool argParseCheckCurArgTriggered(ArgParse *argParse, char *opt);
+bool argParseCheckCurArgTriggered(ArgParse *argParse, const char *opt);
 
 /**
  * @brief 检查当前解析到的命令是否被触发
@@ -264,7 +270,8 @@ bool argParseCheckCurArgTriggered(ArgParse *argParse, char *opt);
  * @param command_name 命令名
  * @return bool 是否被触发
  */
-bool argParseCheckCommandTriggered(ArgParse *argParse, char *command_name);
+bool argParseCheckCommandTriggered(ArgParse   *argParse,
+                                   const char *command_name);
 
 /**
  * @brief 检查全局参数是否被触发
@@ -272,7 +279,7 @@ bool argParseCheckCommandTriggered(ArgParse *argParse, char *command_name);
  * @param   opt 选项名
  * @return bool 是否被触发
  */
-bool argParseCheckGlobalTriggered(ArgParse *argParse, char *opt);
+bool argParseCheckGlobalTriggered(ArgParse *argParse, const char *opt);
 
 char  *argParseGetVal(ArgParse *argParse);
 char **argParseGetValList(ArgParse *argParse, int *len);
@@ -300,13 +307,14 @@ char *argParseGenerateHelp(ArgParse *argParse);
  * @param short_flag 是否为短选项
  * @return char* 选项错误信息
  */
-char *
-argParseGenerateArgErrorMsg(ArgParse *argParse, char *name, bool short_flag);
+char *argParseGenerateArgErrorMsg(ArgParse   *argParse,
+                                  const char *name,
+                                  bool        short_flag);
 
-_Noreturn void argParseError(ArgParse   *argParse,
-                             Command    *lastCommand,
-                             const char *prefix,
-                             const char *suffix);
+NORETURN void argParseError(ArgParse   *argParse,
+                            Command    *lastCommand,
+                            const char *prefix,
+                            const char *suffix);
 
 #ifdef __cplusplus
 }

src/ArgParse.c

@@ -7,6 +7,10 @@
 #include <stdlib.h>
 #include <string.h>
 
+#define RED   "\033[0;31m"
+#define BLUE  "\033[0;34m"
+#define RESET "\033[0m"
+
 static bool _AutoHelp = true; // 是否自动添加帮助信息
 static bool _COLOR    = true; // 是否启用颜色
 
@@ -37,15 +41,20 @@ ArgParse *argParseInit(char *documentation, ArgParseValueType value_type) {
 
 /**
  * @brief 自动帮助信息回调函数
+ * @param argParse ArgParse结构体指针
+ * @param val 参数值
+ * @param val_len 参数值长度
+ * @return 无返回值，将直接结束程序
  */
-int __helpCallback(ArgParse *argParse, char **val, int val_len) {
+NORETURN int __helpCallback(ArgParse *argParse, char **val, int val_len) {
     if (argParse == NULL) {
-        return -1;
+        exit(1);
     }
     char *help_doc = argParseGenerateHelp(argParse);
     printf("%s\n", help_doc);
     free(help_doc);
-    return 0;
+    argParseFree(argParse);
+    exit(0);
 }
 
 /**
@@ -67,7 +76,7 @@ void argParseAutoHelp(ArgParse *argParse) {
                          NULL,
                          __helpCallback,
                          false,
-                         NOVALUE);
+                         ArgParseNOVALUE);
 }
 
 int __commandHelpCallback(ArgParse *argParse, char **val, int val_len) {
@@ -96,13 +105,13 @@ void argParseCommandAutoHelp(Command *command) {
                    NULL,
                    __commandHelpCallback,
                    false,
-                   NOVALUE);
+                   ArgParseNOVALUE);
 }
 
 Command *argParseAddCommand(ArgParse         *argParse,
-                            char             *name,
-                            char             *help,
-                            char             *default_val,
+                            const char       *name,
+                            const char       *help,
+                            const char       *default_val,
                             ArgParseCallback  callback,
                             CommandGroup     *group,
                             ArgParseValueType value_type) {
@@ -139,9 +148,9 @@ Command *argParseAddCommand(ArgParse         *argParse,
  * @return
  */
 Command *argParseAddSubCommand(Command          *Parent,
-                               char             *name,
-                               char             *help,
-                               char             *default_val,
+                               const char       *name,
+                               const char       *help,
+                               const char       *default_val,
                                ArgParseCallback  callback,
                                CommandGroup     *group,
                                ArgParseValueType value_type) {
@@ -170,10 +179,10 @@ Command *argParseAddSubCommand(Command          *Parent,
 }
 
 CommandArgs *argParseAddArg(Command          *command,
-                            char             *short_opt,
-                            char             *long_opt,
-                            char             *help,
-                            char             *default_val,
+                            const char       *short_opt,
+                            const char       *long_opt,
+                            const char       *help,
+                            const char       *default_val,
                             ArgParseCallback  callback,
                             bool              required,
                             ArgParseValueType value_type) {
@@ -200,10 +209,10 @@ CommandArgs *argParseAddArg(Command          *command,
 }
 
 CommandArgs *argParseAddGlobalArg(ArgParse         *argParse,
-                                  char             *short_opt,
-                                  char             *long_opt,
-                                  char             *help,
-                                  char             *default_val,
+                                  const char       *short_opt,
+                                  const char       *long_opt,
+                                  const char       *help,
+                                  const char       *default_val,
                                   ArgParseCallback  callback,
                                   bool              required,
                                   ArgParseValueType value_type) {
@@ -314,7 +323,7 @@ int __processArgs(ArgParse *argParse, CommandArgs *arg, int arg_index) {
 
     int current_index = arg_index;
 
-    if (arg->value_type == MULTIVALUE) {
+    if (arg->value_type == ArgParseMULTIVALUE) {
         for (int i = arg_index + 1; i < argParse->argc; i++) {
             if (checkArgType(argParse->argv[i]) ==
                 COMMAND) { // COMMAND是无--或-开头的字符串，也可认定为参数值
@@ -325,12 +334,12 @@ int __processArgs(ArgParse *argParse, CommandArgs *arg, int arg_index) {
                 break;
             }
         }
-    } else if (arg->value_type == SINGLEVALUE) {
+    } else if (arg->value_type == ArgParseSINGLEVALUE) {
         if (arg_index + 1 < argParse->argc) {
             argParseSetArgVal(arg, argParse->argv[arg_index + 1]);
             current_index = arg_index + 1;
         }
-    } else if (arg->value_type == NOVALUE) {
+    } else if (arg->value_type == ArgParseNOVALUE) {
         current_index = arg_index;
     }
 
@@ -437,7 +446,7 @@ int __processCommand(ArgParse *argParse, char *name, int command_index) {
 
     command              = argParseFindCommand(argParse, name); // 查找命令
 
-    if (command == NULL && argParse->value_type == NOVALUE) {
+    if (command == NULL && argParse->value_type == ArgParseNOVALUE) {
         char *msg = NULL;
         if (name != NULL) {
             msg = stringNewCopy("\033[1;31mERROR\033[0m:");
@@ -449,7 +458,7 @@ int __processCommand(ArgParse *argParse, char *name, int command_index) {
         return -1;
     }
 
-    if (command == NULL && argParse->value_type != NOVALUE) {
+    if (command == NULL && argParse->value_type != ArgParseNOVALUE) {
         return __processVal(argParse, command_index);
     }
 
@@ -463,7 +472,7 @@ int __processCommand(ArgParse *argParse, char *name, int command_index) {
         switch (argType) {
         case COMMAND: {
             // 命令无值则处理子命令
-            if (command->value_type == NOVALUE) {
+            if (command->value_type == ArgParseNOVALUE) {
                 __processSubCommand(argParse, command, argParse->argv[i], i);
                 return argParse->argc - 1;
             } else {
@@ -523,6 +532,7 @@ int __processCommand(ArgParse *argParse, char *name, int command_index) {
 
 /**
  * @brief 解析命令行参数
+ * @errors: 错误信息字符串统一又调用方申请，处理函数释放
  * @param argParse 解析器指针
  * @param argc 参数个数
  * @param argv 参数列表
@@ -574,6 +584,47 @@ void argParseParse(ArgParse *argParse, int argc, char *argv[]) {
                                             argParse->current_command->val,
                                             argParse->current_command->val_len);
     }
+
+    // 检查全局参数必填参数是否已设置
+    for (int i = 0; i < argParse->global_args_len; i++) {
+        if (argParse->global_args[i]->required &&
+            argParse->global_args[i]->is_trigged == false) {
+            // 错误处理，必填全局参数未设置
+            char *msg =
+                stringNewCopy(RED "ERROR" RESET ": Global Option " BLUE);
+            if (argParse->global_args[i]->short_opt != NULL) {
+                __catStr(&msg, 1, argParse->global_args[i]->short_opt);
+            } else {
+                __catStr(&msg, 1, argParse->global_args[i]->long_opt);
+            }
+            __catStr(&msg, 1, RESET " is required");
+            argParseError(argParse, NULL, msg,
+                          NULL); // 错误处理
+        }
+    }
+
+    // 检查当前命令的必填参数是否已设置
+    if (argParse->current_command != NULL) {
+        for (int i = 0; i < argParse->current_command->args_len; i++) {
+            if (argParse->current_command->args[i]->required &&
+                argParse->current_command->args[i]->is_trigged == false) {
+                // 错误处理，必填参数未设置
+                char *msg = stringNewCopy(RED "ERROR" RESET ": Command " BLUE);
+                __catStr(&msg, 1, argParse->current_command->name);
+                __catStr(&msg, 1, RESET " Option " BLUE);
+                if (argParse->current_command->args[i]->short_opt != NULL) {
+                    __catStr(
+                        &msg, 1, argParse->current_command->args[i]->short_opt);
+                } else {
+                    __catStr(
+                        &msg, 1, argParse->current_command->args[i]->long_opt);
+                }
+                __catStr(&msg, 1, RESET " is required");
+                argParseError(
+                    argParse, argParse->current_command, msg, NULL); // 错误处理
+            }
+        }
+    }
 }
 
 /**
@@ -598,7 +649,7 @@ char *argParseGetCurCommandName(ArgParse *argParse) {
  * @return char* 选项值
  * @return
  */
-char *argParseGetCurArg(ArgParse *argParse, char *opt) {
+char *argParseGetCurArg(ArgParse *argParse, const char *opt) {
     CommandArgs *arg = NULL;
     // 尝试获取当前命令的长选项参数
     arg = argParseFindCommandArgs(argParse->current_command, opt, false);
@@ -624,7 +675,7 @@ char *argParseGetCurArg(ArgParse *argParse, char *opt) {
  * @param len 参数个数buffer
  * @return char** 参数列表
  */
-char **argParseGetCurArgList(ArgParse *argParse, char *opt, int *len) {
+char **argParseGetCurArgList(ArgParse *argParse, const char *opt, int *len) {
     CommandArgs *arg = NULL;
     arg = argParseFindCommandArgs(argParse->current_command, opt, false);
 
@@ -645,7 +696,7 @@ char **argParseGetCurArgList(ArgParse *argParse, char *opt, int *len) {
  * @param opt 选项名
  * @return char* 选项值
  */
-char *argParseGetGlobalArg(ArgParse *argParse, char *opt) {
+char *argParseGetGlobalArg(ArgParse *argParse, const char *opt) {
     CommandArgs *arg = NULL;
     arg              = argParseFindGlobalArgs(argParse, opt, false);
 
@@ -699,7 +750,7 @@ char **argParseGetCurCommandValues(ArgParse *argParse, int *len) {
  * @param len 参数个数buffer
  * @return char** 参数列表
  */
-char **argParseGetGlobalArgList(ArgParse *argParse, char *opt, int *len) {
+char **argParseGetGlobalArgList(ArgParse *argParse, const char *opt, int *len) {
     CommandArgs *arg = NULL;
     arg              = argParseFindGlobalArgs(argParse, opt, false);
 
@@ -751,12 +802,12 @@ char *argParseGenerateHelpForCommand(Command *command) {
     __catStr(&help_msg, 2, "\033[1;33mUsage\033[0m: ", command->name);
 
     switch (command->value_type) {
-    case NOVALUE:
+    case ArgParseNOVALUE:
         break;
-    case SINGLEVALUE:
+    case ArgParseSINGLEVALUE:
         __catStr(&help_msg, 1, " <value>");
         break;
-    case MULTIVALUE:
+    case ArgParseMULTIVALUE:
         __catStr(&help_msg, 1, " <value>...");
     }
 
@@ -782,7 +833,7 @@ char *argParseGenerateHelpForCommand(Command *command) {
 }
 
 //  检查全局参数是否被触发
-bool argParseCheckGlobalTriggered(ArgParse *argParse, char *opt) {
+bool argParseCheckGlobalTriggered(ArgParse *argParse, const char *opt) {
     CommandArgs *arg = NULL;
     arg              = argParseFindGlobalArgs(argParse, opt, false);
 
@@ -796,7 +847,7 @@ bool argParseCheckGlobalTriggered(ArgParse *argParse, char *opt) {
     return arg->is_trigged;
 }
 // 检测当前命令的某项参数是否被触发
-bool argParseCheckCurArgTriggered(ArgParse *argParse, char *opt) {
+bool argParseCheckCurArgTriggered(ArgParse *argParse, const char *opt) {
     CommandArgs *arg = NULL;
     arg = argParseFindCommandArgs(argParse->current_command, opt, false);
 
@@ -810,7 +861,8 @@ bool argParseCheckCurArgTriggered(ArgParse *argParse, char *opt) {
     return arg->is_trigged;
 }
 // 检测指定命令是否被触发
-bool argParseCheckCommandTriggered(ArgParse *argParse, char *command_name) {
+bool argParseCheckCommandTriggered(ArgParse   *argParse,
+                                   const char *command_name) {
     Command *command = argParseFindCommand(argParse, command_name);
     if (command == NULL) {
         return false;
@@ -818,10 +870,10 @@ bool argParseCheckCommandTriggered(ArgParse *argParse, char *command_name) {
     return command->is_trigged;
 }
 
-_Noreturn void argParseError(ArgParse   *argParse,
-                             Command    *lastCommand,
-                             const char *prefix,
-                             const char *suffix) {
+NORETURN void argParseError(ArgParse   *argParse,
+                            Command    *lastCommand,
+                            const char *prefix,
+                            const char *suffix) {
     if (argParse == NULL) {
         printf("ERROR: Parse is NULL\n");
         exit(1);
@@ -841,7 +893,6 @@ _Noreturn void argParseError(ArgParse   *argParse,
             __catStr(&mgs, 2, "\n", suffix);
         }
 
-        // printf("\033[1;31mERROR\033[0m: Last command is unknown\n");
         printf("%s\n", mgs);
         free(mgs);
         free(help);
@@ -873,8 +924,9 @@ _Noreturn void argParseError(ArgParse   *argParse,
     exit(1);
 }
 
-char *
-argParseGenerateArgErrorMsg(ArgParse *argParse, char *name, bool short_flag) {
+char *argParseGenerateArgErrorMsg(ArgParse   *argParse,
+                                  const char *name,
+                                  bool        short_flag) {
     if (argParse == NULL) {
         return NULL;
     }

src/ArgParseTools.c

@@ -11,7 +11,7 @@
  * @param str 字符串
  * @return 复制后的字符串内存指针
  */
-char *stringNewCopy(char *str) {
+char *stringNewCopy(const char *str) {
     if (str == NULL) {
         return NULL;
     }
@@ -24,9 +24,9 @@ char *stringNewCopy(char *str) {
 }
 
 // 构造命令
-Command *createCommand(char             *name,
-                       char             *help,
-                       char             *default_val,
+Command *createCommand(const char       *name,
+                       const char       *help,
+                       const char       *default_val,
                        ArgParseCallback  callback,
                        CommandGroup     *group,
                        ArgParseValueType value_typ) {
@@ -83,7 +83,7 @@ ArgType checkArgType(char *arg) {
 }
 
 // 寻找命令
-Command *argParseFindCommand(ArgParse *argParse, char *name) {
+Command *argParseFindCommand(ArgParse *argParse, const char *name) {
     for (size_t i = 0; i < argParse->commands_len; i++) {
         if (strcmp(argParse->commands[i]->name, name) == 0) {
             return argParse->commands[i];
@@ -92,7 +92,7 @@ Command *argParseFindCommand(ArgParse *argParse, char *name) {
     return NULL;
 }
 
-Command *argParseFindSubCommand(Command *command, char *name) {
+Command *argParseFindSubCommand(Command *command, const char *name) {
     for (size_t i = 0; i < command->sub_commands_len; i++) {
         if (strcmp(command->sub_commands[i]->name, name) == 0) {
             return command->sub_commands[i];
@@ -101,10 +101,10 @@ Command *argParseFindSubCommand(Command *command, char *name) {
     return NULL;
 }
 
-CommandArgs *createCommandArgs(char             *short_opt,
-                               char             *long_opt,
-                               char             *default_val,
-                               char             *help,
+CommandArgs *createCommandArgs(const char       *short_opt,
+                               const char       *long_opt,
+                               const char       *default_val,
+                               const char       *help,
                                ArgParseCallback  callback,
                                bool              required,
                                ArgParseValueType value_type) {
@@ -133,7 +133,7 @@ CommandArgs *createCommandArgs(char             *short_opt,
 }
 
 CommandArgs *
-argParseFindCommandArgs(Command *command, char *name, bool short_flag) {
+argParseFindCommandArgs(Command *command, const char *name, bool short_flag) {
     if (command == NULL) {
         return NULL;
     }
@@ -155,7 +155,7 @@ argParseFindCommandArgs(Command *command, char *name, bool short_flag) {
 }
 
 CommandArgs *
-argParseFindGlobalArgs(ArgParse *argParse, char *name, bool short_flag) {
+argParseFindGlobalArgs(ArgParse *argParse, const char *name, bool short_flag) {
     for (size_t i = 0; i < argParse->global_args_len; i++) {
         if (short_flag) {
             if (argParse->global_args[i]->short_opt != NULL &&
@@ -178,8 +178,8 @@ argParseFindGlobalArgs(ArgParse *argParse, char *name, bool short_flag) {
  * @param val 值
  * @return 成功返回true，失败返回false
  */
-bool argParseSetArgVal(CommandArgs *args, char *val) {
-    if (args->value_type == MULTIVALUE) { // 多值
+bool argParseSetArgVal(CommandArgs *args, const char *val) {
+    if (args->value_type == ArgParseMULTIVALUE) { // 多值
         args->val = realloc(args->val, (args->val_len + 1) * sizeof(char *));
         if (args->val == NULL) {
             return false;
@@ -190,7 +190,7 @@ bool argParseSetArgVal(CommandArgs *args, char *val) {
         }
         args->val_len++;
         return true;
-    } else if (args->value_type == SINGLEVALUE) { // 单值
+    } else if (args->value_type == ArgParseSINGLEVALUE) { // 单值
         if (args->val != NULL) {
             free(args->val);
         }
@@ -205,15 +205,15 @@ bool argParseSetArgVal(CommandArgs *args, char *val) {
         }
         args->val_len = 1;
         return true;
-    } else if (args->value_type == NOVALUE) { // 无值
+    } else if (args->value_type == ArgParseNOVALUE) { // 无值
         return true;
     }
 
     return false;
 }
 
-bool argParseSetCommandVal(Command *command, char *val) {
-    if (command->value_type == MULTIVALUE) { // 多值
+bool argParseSetCommandVal(Command *command, const char *val) {
+    if (command->value_type == ArgParseMULTIVALUE) { // 多值
         command->val =
             realloc(command->val, (command->val_len + 1) * sizeof(char *));
         if (command->val == NULL) {
@@ -225,7 +225,7 @@ bool argParseSetCommandVal(Command *command, char *val) {
         }
         command->val_len++;
         return true;
-    } else if (command->value_type == SINGLEVALUE) { // 单值
+    } else if (command->value_type == ArgParseSINGLEVALUE) { // 单值
         if (command->val != NULL) {
             free(command->val);
         }
@@ -240,7 +240,7 @@ bool argParseSetCommandVal(Command *command, char *val) {
         }
         command->val_len = 1;
         return true;
-    } else if (command->value_type == NOVALUE) { // 无值
+    } else if (command->value_type == ArgParseNOVALUE) { // 无值
         return true;
     }
     return false;
@@ -252,9 +252,9 @@ bool argParseSetCommandVal(Command *command, char *val) {
  * @param val 值
  * @return 成功返回true，失败返回false
  */
-bool argParseSetVal(ArgParse *argParse, char *val) {
+bool argParseSetVal(ArgParse *argParse, const char *val) {
 
-    if (argParse->value_type == MULTIVALUE) { // 多值
+    if (argParse->value_type == ArgParseMULTIVALUE) { // 多值
         argParse->val =
             realloc(argParse->val, (argParse->val_len + 1) * sizeof(char *));
         if (argParse->val == NULL) {
@@ -266,7 +266,7 @@ bool argParseSetVal(ArgParse *argParse, char *val) {
         }
         argParse->val_len++;
         return true;
-    } else if (argParse->value_type == SINGLEVALUE) { // 单值
+    } else if (argParse->value_type == ArgParseSINGLEVALUE) { // 单值
         if (argParse->val != NULL) {
             free(argParse->val);
         }
@@ -281,13 +281,13 @@ bool argParseSetVal(ArgParse *argParse, char *val) {
         }
         argParse->val_len = 1;
         return true;
-    } else if (argParse->value_type == NOVALUE) { // 无值
+    } else if (argParse->value_type == ArgParseNOVALUE) { // 无值
         return true;
     }
     return false;
 }
 
-size_t __getStrlen(char *str) {
+size_t __getStrlen(const char *str) {
     if (str == NULL) {
         return 0;
     }

src/ArgParseTools.h

@@ -16,24 +16,25 @@ typedef enum {
     BAD,       // 错误
 } ArgType;
 
-Command *createCommand(char             *name,
-                       char             *help,
-                       char             *default_val,
+Command *createCommand(const char       *name,
+                       const char       *help,
+                       const char       *default_val,
                        ArgParseCallback  callback,
                        CommandGroup     *group,
                        ArgParseValueType value_type); // 创建命令
 
-CommandGroup *createCommandGroup(char *name, char *help); // 创建命令组
+CommandGroup *createCommandGroup(const char *name,
+                                 const char *help); // 创建命令组
 
 CommandGroup *addCommandToGroup(CommandGroup *group,
-                                Command *command); // 添加命令到命令组
+                                Command      *command); // 添加命令到命令组
 
-CommandArgs *createCommandArgs(char            *short_opt,
-                               char            *long_opt,
-                               char            *default_val,
-                               char            *help,
-                               ArgParseCallback callback,
-                               bool             required,
+CommandArgs *createCommandArgs(const char       *short_opt,
+                               const char       *long_opt,
+                               const char       *default_val,
+                               const char       *help,
+                               ArgParseCallback  callback,
+                               bool              required,
                                ArgParseValueType value_type); // 创建命令参数
 
 /**
@@ -42,29 +43,30 @@ CommandArgs *createCommandArgs(char            *short_opt,
  * @param val 值
  * @return 成功返回true，失败返回false
  */
-bool argParseSetArgVal(CommandArgs *args, char *val); // 设置命令参数值
+bool argParseSetArgVal(CommandArgs *args, const char *val); // 设置命令参数值
 
-bool argParseSetCommandVal(Command *command, char *val); // 设置命令值
+bool argParseSetCommandVal(Command *command, const char *val); // 设置命令值
 
-bool argParseSetVal(ArgParse *argParse, char *val); // 设置值
+bool argParseSetVal(ArgParse *argParse, const char *val); // 设置值
 
 ArgType checkArgType(char *arg); // 检查参数类型
 
-Command *argParseFindCommand(ArgParse *argParse, char *name); // 查找命令
+Command *argParseFindCommand(ArgParse *argParse, const char *name); // 查找命令
 
-Command *argParseFindSubCommand(Command *command, char *name); // 查找子命令
+Command *argParseFindSubCommand(Command    *command,
+                                const char *name); // 查找子命令
 
-CommandArgs *argParseFindCommandArgs(Command *command,
-                                     char    *name,
-                                     bool     short_flag); // 查找命令参数
+CommandArgs *argParseFindCommandArgs(Command    *command,
+                                     const char *name,
+                                     bool        short_flag); // 查找命令参数
 
-CommandArgs *argParseFindGlobalArgs(ArgParse *argParse,
-                                    char     *name,
-                                    bool      short_flag); // 查找全局参数
+CommandArgs *argParseFindGlobalArgs(ArgParse   *argParse,
+                                    const char *name,
+                                    bool        short_flag); // 查找全局参数
 
-char  *stringNewCopy(char *str);             // 创建字符串副本
+char  *stringNewCopy(const char *str);       // 创建字符串副本
 void   __catStr(char **dst, int count, ...); // 字符串拼接
-size_t __getStrlen(char *str);               // 获取字符串长度
+size_t __getStrlen(const char *str);         // 获取字符串长度
 
 #ifdef __cplusplus
 }

tests/CMakeLists.txt

@@ -36,4 +36,13 @@ set_tests_properties(${PROJECT_NAME}unknow_command_arg PROPERTIES WILL_FAIL TRUE
 # 未知命令选项测试,预期打印该命令的帮助信息
 add_executable(${PROJECT_NAME}val test_val.c)
 target_link_libraries(${PROJECT_NAME}val CArgParse)
-add_test(${PROJECT_NAME}val ${PROJECT_NAME}val file1.txt file2.txt file3.txt -v -q)
+add_test(${PROJECT_NAME}val ${PROJECT_NAME}val file1.txt file2.txt file3.txt -v -q)
+
+# 必填参数测试
+add_executable(${PROJECT_NAME}required test_required.c)
+target_link_libraries(${PROJECT_NAME}required CArgParse)
+add_test(${PROJECT_NAME}required_1 ${PROJECT_NAME}required -f)
+add_test(${PROJECT_NAME}required_2 ${PROJECT_NAME}required)
+set_tests_properties(${PROJECT_NAME}required_2 PROPERTIES WILL_FAIL TRUE)
+add_test(${PROJECT_NAME}required_3 ${PROJECT_NAME}required -h)
+add_test(${PROJECT_NAME}required_4 ${PROJECT_NAME}required -f install -h)

tests/initArgParse.h

@@ -4,7 +4,7 @@
 #include <string.h>
 
 ArgParse *initArgParse() {
-    ArgParse *argparse    = argParseInit("测试程序",NOVALUE);
+    ArgParse *argparse    = argParseInit("测试程序", ArgParseNOVALUE);
     Command  *command     = NULL;
     Command  *sub_command = NULL;
 
@@ -16,13 +16,24 @@ ArgParse *initArgParse() {
                          NULL,
                          NULL,
                          false,
-                         NOVALUE);
-    argParseAddGlobalArg(
-        argparse, "-q", "--quiet", "Quiet mode", NULL, NULL, false, NOVALUE);
+                         ArgParseNOVALUE);
+    argParseAddGlobalArg(argparse,
+                         "-q",
+                         "--quiet",
+                         "Quiet mode",
+                         NULL,
+                         NULL,
+                         false,
+                         ArgParseNOVALUE);
 
     // add arguments
-    command = argParseAddCommand(
-        argparse, "install", "Install the package", NULL, NULL, NULL, NOVALUE);
+    command = argParseAddCommand(argparse,
+                                 "install",
+                                 "Install the package",
+                                 NULL,
+                                 NULL,
+                                 NULL,
+                                 ArgParseNOVALUE);
     argParseAddArg(command,
                    "-i",
                    "--index",
@@ -30,7 +41,7 @@ ArgParse *initArgParse() {
                    "https://example.com",
                    NULL,
                    false,
-                   SINGLEVALUE);
+                   ArgParseSINGLEVALUE);
     argParseAddArg(command,
                    "-f",
                    "--file",
@@ -38,7 +49,7 @@ ArgParse *initArgParse() {
                    "package.json",
                    NULL,
                    false,
-                   MULTIVALUE);
+                   ArgParseMULTIVALUE);
     argParseAddArg(command,
                    "-p",
                    "--package",
@@ -46,10 +57,15 @@ ArgParse *initArgParse() {
                    "package.json",
                    NULL,
                    false,
-                   MULTIVALUE);
+                   ArgParseMULTIVALUE);
 
-    sub_command = argParseAddSubCommand(
-        command, "tools", "Install tools", NULL, NULL, NULL, MULTIVALUE);
+    sub_command = argParseAddSubCommand(command,
+                                        "tools",
+                                        "Install tools",
+                                        NULL,
+                                        NULL,
+                                        NULL,
+                                        ArgParseMULTIVALUE);
 
     argParseAddArg(sub_command,
                    "-t",
@@ -58,9 +74,14 @@ ArgParse *initArgParse() {
                    "Tool name",
                    NULL,
                    true,
-                   MULTIVALUE);
-    sub_command = argParseAddSubCommand(
-        command, "tools_sub", "Install tools", NULL, NULL, NULL, MULTIVALUE);
+                   ArgParseMULTIVALUE);
+    sub_command = argParseAddSubCommand(command,
+                                        "tools_sub",
+                                        "Install tools",
+                                        NULL,
+                                        NULL,
+                                        NULL,
+                                        ArgParseMULTIVALUE);
 
     argParseAddArg(sub_command,
                    "-s",
@@ -69,7 +90,7 @@ ArgParse *initArgParse() {
                    "tools subcommand test",
                    NULL,
                    true,
-                   MULTIVALUE);
+                   ArgParseMULTIVALUE);
 
     command = argParseAddCommand(argparse,
                                  "uninstall",
@@ -77,7 +98,7 @@ ArgParse *initArgParse() {
                                  NULL,
                                  NULL,
                                  NULL,
-                                 SINGLEVALUE);
+                                 ArgParseSINGLEVALUE);
     argParseAddArg(command,
                    "-p",
                    "--package",
@@ -85,7 +106,7 @@ ArgParse *initArgParse() {
                    "Package name",
                    NULL,
                    true,
-                   MULTIVALUE);
+                   ArgParseMULTIVALUE);
 
     return argparse;
 }

tests/test_mult_arg.c

@@ -10,12 +10,11 @@ int main(int argc, char *argv[]) {
 
     const char *testv[3] = {"testpackge1", "testpackge2", "testpackge3"};
 
-
     // Test -p
-    char *val = argParseGetCurArg(argparse, "-p");
+    char *val            = argParseGetCurArg(argparse, "-p");
 
-    int len = 0;
-    char **vals = argParseGetCurArgList(argparse, "-p", &len);
+    int    len           = 0;
+    char **vals          = argParseGetCurArgList(argparse, "-p", &len);
 
     for (int i = 0; i < len; i++) {
         printf("-p Value: %s\n", vals[i]);
@@ -27,18 +26,15 @@ int main(int argc, char *argv[]) {
     printf("-i Value: %s\n", val_i);
     assert(strcmp(val_i, "www.test.com") == 0);
 
-
-
     // Test -f
-    len = 0;
+    len                  = 0;
     const char *testf[2] = {"file1.txt", "file2.txt"};
-    char **val_f = argParseGetCurArgList(argparse, "-f", &len);
+    char      **val_f    = argParseGetCurArgList(argparse, "-f", &len);
     for (int i = 0; i < len; i++) {
         printf("-f Value: %s\n", val_f[i]);
         assert(strcmp(val_f[i], testf[i]) == 0);
     }
 
-
     argParseFree(argparse);
 
     return 0;

tests/test_required.c

@@ -0,0 +1,144 @@
+#include "ArgParse.h"
+#include <assert.h>
+#include <stdbool.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+ArgParse *initArgParse() {
+    ArgParse *argparse    = argParseInit("测试程序", ArgParseNOVALUE);
+    Command  *command     = NULL;
+    Command  *sub_command = NULL;
+
+    // add global arguments
+    argParseAddGlobalArg(argparse,
+                         "-v",
+                         "--version",
+                         "Show version",
+                         NULL,
+                         NULL,
+                         false,
+                         ArgParseNOVALUE);
+    argParseAddGlobalArg(argparse,
+                         "-f",
+                         "--file",
+                         "File name",
+                         NULL,
+                         NULL,
+                         true,
+                         ArgParseNOVALUE);
+
+    // add arguments
+    command = argParseAddCommand(argparse,
+                                 "install",
+                                 "Install the package",
+                                 NULL,
+                                 NULL,
+                                 NULL,
+                                 ArgParseNOVALUE);
+    argParseAddArg(command,
+                   "-i",
+                   "--index",
+                   "Index URL",
+                   "https://example.com",
+                   NULL,
+                   false,
+                   ArgParseSINGLEVALUE);
+    argParseAddArg(command,
+                   "-f",
+                   "--file",
+                   "Package file",
+                   "package.json",
+                   NULL,
+                   true,
+                   ArgParseMULTIVALUE);
+    argParseAddArg(command,
+                   "-p",
+                   "--package",
+                   "Package file",
+                   "package.json",
+                   NULL,
+                   false,
+                   ArgParseMULTIVALUE);
+
+    sub_command = argParseAddSubCommand(command,
+                                        "tools",
+                                        "Install tools",
+                                        NULL,
+                                        NULL,
+                                        NULL,
+                                        ArgParseMULTIVALUE);
+
+    argParseAddArg(sub_command,
+                   "-t",
+                   "--tool",
+                   "Tool name",
+                   "Tool name",
+                   NULL,
+                   true,
+                   ArgParseMULTIVALUE);
+    sub_command = argParseAddSubCommand(command,
+                                        "tools_sub",
+                                        "Install tools",
+                                        NULL,
+                                        NULL,
+                                        NULL,
+                                        ArgParseMULTIVALUE);
+
+    argParseAddArg(sub_command,
+                   "-s",
+                   "--source",
+                   "test_source",
+                   "tools subcommand test",
+                   NULL,
+                   true,
+                   ArgParseMULTIVALUE);
+
+    command = argParseAddCommand(argparse,
+                                 "uninstall",
+                                 "Uninstall the package",
+                                 NULL,
+                                 NULL,
+                                 NULL,
+                                 ArgParseSINGLEVALUE);
+    argParseAddArg(command,
+                   "-p",
+                   "--package",
+                   "Package name",
+                   "Package name",
+                   NULL,
+                   true,
+                   ArgParseMULTIVALUE);
+
+    return argparse;
+}
+
+int main(int argc, char *argv[]) {
+    ArgParse *argparse = initArgParse();
+
+    argParseParse(argparse, argc, argv);
+
+    char *val = argParseGetVal(argparse);
+    if (val) {
+        printf("val: %s\n", val);
+    }
+
+    // int    len        = 0;
+    // char **vals       = argParseGetValList(argparse, &len);
+
+    // char *test_val[3] = {"file1.txt", "file2.txt", "file3.txt"};
+
+    // if (vals) {
+    //     for (int i = 0; i < len; i++) {
+    //         printf("vals: %s\n", vals[i]);
+    //         assert(strcmp(vals[i], test_val[i]) == 0);
+    //     }
+    // }
+
+    // assert(argParseCheckGlobalTriggered(argparse, "-v"));
+    // assert(argParseCheckGlobalTriggered(argparse, "-f"));
+
+    argParseFree(argparse);
+
+    return 0;
+}

tests/test_single_arg.c

@@ -10,10 +10,10 @@ int main(int argc, char *argv[]) {
 
     const char *testv[3] = {"testpackge1", "testpackge2", "testpackge3"};
 
-    char *val = argParseGetCurArg(argparse, "-p");
+    char *val            = argParseGetCurArg(argparse, "-p");
 
-    int len = 0;
-    char **vals = argParseGetCurArgList(argparse, "-p", &len);
+    int    len           = 0;
+    char **vals          = argParseGetCurArgList(argparse, "-p", &len);
 
     for (int i = 0; i < len; i++) {
         printf("-p Value: %s\n", vals[i]);

tests/test_subcommand.c

@@ -8,12 +8,11 @@ int main(int argc, char *argv[]) {
 
     argParseParse(argparse, argc, argv);
 
-    
     char *command_name = argParseGetCurCommandName(argparse);
     printf("command name: %s\n", command_name);
     assert(strcmp(command_name, "tools") == 0);
 
-    char * val = argParseGetCurArg(argparse, "-t");
+    char *val = argParseGetCurArg(argparse, "-t");
     printf("tools -t: %s\n", val);
 
     argParseFree(argparse);

tests/test_unknow_command.c

@@ -7,7 +7,6 @@ int main(int argc, char *argv[]) {
 
     argParseParse(argparse, argc, argv);
 
-
     argParseFree(argparse);
 
     return 0;

tests/test_val.c

@@ -5,7 +5,7 @@
 #include <string.h>
 
 ArgParse *initArgParse() {
-    ArgParse *argparse    = argParseInit("测试程序", MULTIVALUE);
+    ArgParse *argparse    = argParseInit("测试程序", ArgParseMULTIVALUE);
     Command  *command     = NULL;
     Command  *sub_command = NULL;
 
@@ -17,13 +17,24 @@ ArgParse *initArgParse() {
                          NULL,
                          NULL,
                          false,
-                         NOVALUE);
-    argParseAddGlobalArg(
-        argparse, "-q", "--quiet", "Quiet mode", NULL, NULL, false, NOVALUE);
+                         ArgParseNOVALUE);
+    argParseAddGlobalArg(argparse,
+                         "-q",
+                         "--quiet",
+                         "Quiet mode",
+                         NULL,
+                         NULL,
+                         false,
+                         ArgParseNOVALUE);
 
     // add arguments
-    command = argParseAddCommand(
-        argparse, "install", "Install the package", NULL, NULL, NULL, NOVALUE);
+    command = argParseAddCommand(argparse,
+                                 "install",
+                                 "Install the package",
+                                 NULL,
+                                 NULL,
+                                 NULL,
+                                 ArgParseNOVALUE);
     argParseAddArg(command,
                    "-i",
                    "--index",
@@ -31,7 +42,7 @@ ArgParse *initArgParse() {
                    "https://example.com",
                    NULL,
                    false,
-                   SINGLEVALUE);
+                   ArgParseSINGLEVALUE);
     argParseAddArg(command,
                    "-f",
                    "--file",
@@ -39,7 +50,7 @@ ArgParse *initArgParse() {
                    "package.json",
                    NULL,
                    false,
-                   MULTIVALUE);
+                   ArgParseMULTIVALUE);
     argParseAddArg(command,
                    "-p",
                    "--package",
@@ -47,10 +58,15 @@ ArgParse *initArgParse() {
                    "package.json",
                    NULL,
                    false,
-                   MULTIVALUE);
+                   ArgParseMULTIVALUE);
 
-    sub_command = argParseAddSubCommand(
-        command, "tools", "Install tools", NULL, NULL, NULL, MULTIVALUE);
+    sub_command = argParseAddSubCommand(command,
+                                        "tools",
+                                        "Install tools",
+                                        NULL,
+                                        NULL,
+                                        NULL,
+                                        ArgParseMULTIVALUE);
 
     argParseAddArg(sub_command,
                    "-t",
@@ -59,9 +75,14 @@ ArgParse *initArgParse() {
                    "Tool name",
                    NULL,
                    true,
-                   MULTIVALUE);
-    sub_command = argParseAddSubCommand(
-        command, "tools_sub", "Install tools", NULL, NULL, NULL, MULTIVALUE);
+                   ArgParseMULTIVALUE);
+    sub_command = argParseAddSubCommand(command,
+                                        "tools_sub",
+                                        "Install tools",
+                                        NULL,
+                                        NULL,
+                                        NULL,
+                                        ArgParseMULTIVALUE);
 
     argParseAddArg(sub_command,
                    "-s",
@@ -70,7 +91,7 @@ ArgParse *initArgParse() {
                    "tools subcommand test",
                    NULL,
                    true,
-                   MULTIVALUE);
+                   ArgParseMULTIVALUE);
 
     command = argParseAddCommand(argparse,
                                  "uninstall",
@@ -78,7 +99,7 @@ ArgParse *initArgParse() {
                                  NULL,
                                  NULL,
                                  NULL,
-                                 SINGLEVALUE);
+                                 ArgParseSINGLEVALUE);
     argParseAddArg(command,
                    "-p",
                    "--package",
@@ -86,7 +107,7 @@ ArgParse *initArgParse() {
                    "Package name",
                    NULL,
                    true,
-                   MULTIVALUE);
+                   ArgParseMULTIVALUE);
 
     return argparse;
 }
@@ -101,8 +122,8 @@ int main(int argc, char *argv[]) {
         printf("val: %s\n", val);
     }
 
-    int    len  = 0;
-    char **vals = argParseGetValList(argparse, &len);
+    int    len        = 0;
+    char **vals       = argParseGetValList(argparse, &len);
 
     char *test_val[3] = {"file1.txt", "file2.txt", "file3.txt"};