一个高效的C语言命令行解析库

简介: 一个高效的C语言命令行解析库

之前写了一篇python中argparse的使用方法,觉得这个库的使用体验很好,最近实现了一个具有类似功能的在C语言中进行命令行解析的库。内部实现有点乱,后期会进行变量隐藏以及代码拆分。


argparse

一个支持子命令的C语言命令行解析库

github地址:https://github.com/dwpeng/argparse

定义参数

参数定义使用结构体数据进行定义,每个参数的首字母不允许重复,结构体中的具体定义方法如下:

typedef struct CommandArg {
  /* 参数名
   * 1. 使用--或者-作为前缀的参数
   * 2. 位置参数
   */
  char *flag;
  /* 参数是否为必须参数 */
  int required;
  /* 参数是否需要跟值 */
  int no_value;
  /* 参数的初始值 */
  void *init;
  /* 用于存放参数的真值 */
  void *value;
  /* 对参数的说明 */
  char *help;
} CommandArg;
  • char* flag: 参数名,可以为-s--sizesize,其中以-开头的参数默认为可选参数,没有以-开头的参数为位置参数
  • int required: 是否为必须参数,使用可选值0/1,默认0
  • int no_value: 参数后是否跟随参数值,默认为0
  • void* init: 参数的默认值
  • void* value: 参数的值(重构:需要进行变量隐藏)
  • char* help: 对该参数值的说明

函数原型

/* 回调函数 */
typedef void (*callback_t)(void);
/* 添加一个命令 */
/* 当command_name为一个空字符串或者为NULL时,为通用命令
 * 否则为一个子命令
 * 每个解析器只能包含一个通用命令
 */
void *argparse_add_command(char *command_name, char *description, char *usage,
                           callback_t callback, CommandArg *args);
/**
 * 初始化解析器
 * prog:解析器名
 * description: 解析器描述
 * usage: 使用方法
 */
void argparse_init_parser(char *prog, char *description, char *usage);
void argparse_parse_args(int argc, char *argv[]);
/**
 * 获取一个参数的值,如果找不到就返回NULL
 */
void* get_arg(char* name);
/* 打印解析器以及所有的子命令参数 */
void argparse_print_parser();
/**
 * 打印一个子命令的参数
 * 传递的值为NULL时,打印当前子命令
 * 最好是在回调函数里面进行使用
 */
void argparse_print_command(Command *cmd);

使用方法

#include "argparse.h"
/* 定义参数 */
/* 一定要在最后加一个空的结构体 */
static CommandArg list_args[] = {
    {.flag = "file"},
    {.flag = "kmer"},
    {.flag = "--help", .required = 1, .no_value = 1},
    {.flag = "--size", .no_value = 1},
    {0}
};
/* 定义回调函数 */
/* 回调函数原型为 */
// void callback(void);
void callback(void){
    /* 解析参数 */
    void* help_value = get_arg("help");
    /* something else */
    // 
}
/*创建解析器*/
int main(int argc, char* argv[]){
    /* 初始化一个解析器 */
    argparse_init_parser("Parser name\n", "This is a description\n", "This is a usage\n");
    /* 添加子命令 */
    argparse_add_command("list", "This is a list command.", "This is a usage.",
                    handle_list, list_args);
    /* 添加通用命令 */
    argparse_add_command("", "22222222222222This is a list command.",
                       "This is a usage.", handle_list, NULL);
    /* 解析参数 */
    argparse_parse_args(argc, argv);
}

一个小例子

#include "argparse.h"
static CommandArg list_args[] = {
    {.flag = "file", .help="file help"},
    {.flag = "kmer", .help="kmer help"},
    {.flag = "--help", .required = 1, .no_value = 1, .help="--help arg does not need value"},
    {.flag = "--size", .no_value = 1, .init = "ssss", .help="--size arg does not need value"},
    {0}};
static CommandArg global_args[] = {
    {.flag="-k", .help="kmer size"},
    {.flag="-s", .help="the size"},
    {0}
};
void handle_list() {
  printf("%s\n", get_arg("file"));
  printf("%s\n", get_arg("kmer"));
  printf("%s\n", get_arg("help"));
  printf("%s\n", get_arg("size"));
}
int main(int argc, char *argv[]) {
  argparse_init_parser("Test\n", "This is a test\n", "This is a usage\n");
  argparse_add_command("list", "This is a subcommand.\n", "This is a usage.",
                       handle_list, list_args);
  argparse_add_command("", "This is a list command.\n",
                       "This is a usage.", NULL, global_args);
  argparse_parse_args(argc, argv);
}

命令行传参方式

使用首字母进行传参

定义时使用了--size作为参数名,那么传参时既可以使用-s也可以使用--size进行传参

特殊命令

支持-h--help来打印命令行的帮助

./a.out -h       # 调用argparse_print_parser()
./a.out list -h  # 调用argparse_print_command(NULL)


相关文章
|
1月前
|
监控 网络协议 安全
基于标准C语言实现的跨平台Modbus协议库
基于标准C语言实现的跨平台Modbus协议库
|
7月前
|
算法 测试技术 C语言
深入理解HTTP/2:nghttp2库源码解析及客户端实现示例
通过解析nghttp2库的源码和实现一个简单的HTTP/2客户端示例,本文详细介绍了HTTP/2的关键特性和nghttp2的核心实现。了解这些内容可以帮助开发者更好地理解HTTP/2协议,提高Web应用的性能和用户体验。对于实际开发中的应用,可以根据需要进一步优化和扩展代码,以满足具体需求。
721 29
|
10月前
|
存储 网络协议 编译器
【C语言】深入解析C语言结构体:定义、声明与高级应用实践
通过根据需求合理选择结构体定义和声明的放置位置,并灵活结合动态内存分配、内存优化和数据结构设计,可以显著提高代码的可维护性和运行效率。在实际开发中,建议遵循以下原则: - **模块化设计**:尽可能封装实现细节,减少模块间的耦合。 - **内存管理**:明确动态分配与释放的责任,防止资源泄漏。 - **优化顺序**:合理排列结构体成员以减少内存占用。
819 14
|
10月前
|
存储 编译器 C语言
【C语言】数据类型全解析:编程效率提升的秘诀
在C语言中,合理选择和使用数据类型是编程的关键。通过深入理解基本数据类型和派生数据类型,掌握类型限定符和扩展技巧,可以编写出高效、稳定、可维护的代码。无论是在普通应用还是嵌入式系统中,数据类型的合理使用都能显著提升程序的性能和可靠性。
475 8
|
10月前
|
存储 算法 C语言
【C语言】深入浅出:C语言链表的全面解析
链表是一种重要的基础数据结构,适用于频繁的插入和删除操作。通过本篇详细讲解了单链表、双向链表和循环链表的概念和实现,以及各类常用操作的示例代码。掌握链表的使用对于理解更复杂的数据结构和算法具有重要意义。
3191 6
|
10月前
|
存储 网络协议 算法
【C语言】进制转换无难事:二进制、十进制、八进制与十六进制的全解析与实例
进制转换是计算机编程中常见的操作。在C语言中,了解如何在不同进制之间转换数据对于处理和显示数据非常重要。本文将详细介绍如何在二进制、十进制、八进制和十六进制之间进行转换。
1454 5
|
10月前
|
C语言 开发者
【C语言】断言函数 -《深入解析C语言调试利器 !》
断言(assert)是一种调试工具,用于在程序运行时检查某些条件是否成立。如果条件不成立,断言会触发错误,并通常会终止程序的执行。断言有助于在开发和测试阶段捕捉逻辑错误。
255 5
|
1月前
|
存储 C语言
`scanf`是C语言中用于按格式读取标准输入的函数
`scanf`是C语言中用于按格式读取标准输入的函数,通过格式字符串解析输入并存入指定变量。需注意输入格式严格匹配,并建议检查返回值以确保读取成功,提升程序健壮性。
766 0
|
3月前
|
安全 C语言
C语言中的字符、字符串及内存操作函数详细讲解
通过这些函数的正确使用,可以有效管理字符串和内存操作,它们是C语言编程中不可或缺的工具。
263 15
|
9月前
|
存储 算法 C语言
【C语言程序设计——函数】素数判定(头歌实践教学平台习题)【合集】
本内容介绍了编写一个判断素数的子函数的任务,涵盖循环控制与跳转语句、算术运算符(%)、以及素数的概念。任务要求在主函数中输入整数并输出是否为素数的信息。相关知识包括 `for` 和 `while` 循环、`break` 和 `continue` 语句、取余运算符 `%` 的使用及素数定义、分布规律和应用场景。编程要求根据提示补充代码,测试说明提供了输入输出示例,最后给出通关代码和测试结果。 任务核心:编写判断素数的子函数并在主函数中调用,涉及循环结构和条件判断。
422 23

推荐镜像

更多
  • DNS