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

本文涉及的产品
云解析 DNS,旗舰版 1个月
全局流量管理 GTM,标准版 1个月
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
简介: 一个高效的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)


相关文章
|
2月前
|
存储 网络协议 编译器
【C语言】深入解析C语言结构体:定义、声明与高级应用实践
通过根据需求合理选择结构体定义和声明的放置位置,并灵活结合动态内存分配、内存优化和数据结构设计,可以显著提高代码的可维护性和运行效率。在实际开发中,建议遵循以下原则: - **模块化设计**:尽可能封装实现细节,减少模块间的耦合。 - **内存管理**:明确动态分配与释放的责任,防止资源泄漏。 - **优化顺序**:合理排列结构体成员以减少内存占用。
196 14
|
2月前
|
存储 网络协议 算法
【C语言】进制转换无难事:二进制、十进制、八进制与十六进制的全解析与实例
进制转换是计算机编程中常见的操作。在C语言中,了解如何在不同进制之间转换数据对于处理和显示数据非常重要。本文将详细介绍如何在二进制、十进制、八进制和十六进制之间进行转换。
94 5
|
2月前
|
存储 算法 C语言
【C语言】深入浅出:C语言链表的全面解析
链表是一种重要的基础数据结构,适用于频繁的插入和删除操作。通过本篇详细讲解了单链表、双向链表和循环链表的概念和实现,以及各类常用操作的示例代码。掌握链表的使用对于理解更复杂的数据结构和算法具有重要意义。
776 6
|
2月前
|
C语言 开发者
【C语言】断言函数 -《深入解析C语言调试利器 !》
断言(assert)是一种调试工具,用于在程序运行时检查某些条件是否成立。如果条件不成立,断言会触发错误,并通常会终止程序的执行。断言有助于在开发和测试阶段捕捉逻辑错误。
63 5
|
2月前
|
存储 编译器 C语言
【C语言】数据类型全解析:编程效率提升的秘诀
在C语言中,合理选择和使用数据类型是编程的关键。通过深入理解基本数据类型和派生数据类型,掌握类型限定符和扩展技巧,可以编写出高效、稳定、可维护的代码。无论是在普通应用还是嵌入式系统中,数据类型的合理使用都能显著提升程序的性能和可靠性。
78 8
|
1月前
|
存储 编译器 C语言
【C语言程序设计——函数】分数数列求和2(头歌实践教学平台习题)【合集】
函数首部:按照 C 语言语法,函数的定义首部表明这是一个自定义函数,函数名为fun,它接收一个整型参数n,用于指定要求阶乘的那个数,并且函数的返回值类型为float(在实际中如果阶乘结果数值较大,用float可能会有精度损失,也可以考虑使用double等更合适的数据类型,这里以float为例)。例如:// 函数体代码将放在这里函数体内部变量定义:在函数体中,首先需要定义一些变量来辅助完成阶乘的计算。比如需要定义一个变量(通常为float或double类型,这里假设用float。
36 3
|
1月前
|
存储 算法 安全
【C语言程序设计——函数】分数数列求和1(头歌实践教学平台习题)【合集】
if 语句是最基础的形式,当条件为真时执行其内部的语句块;switch 语句则适用于针对一个表达式的多个固定值进行判断,根据表达式的值与各个 case 后的常量值匹配情况,执行相应 case 分支下的语句,直到遇到 break 语句跳出 switch 结构,若没有匹配值则执行 default 分支(可选)。例如,在判断一个数是否大于 10 的场景中,条件表达式为 “num> 10”,这里的 “num” 是程序中的变量,通过比较其值与 10 的大小关系来确定条件的真假。常量的值必须是唯一的,且在同一个。
20 2
|
1月前
|
存储 C语言
【C语言程序设计——函数】递归求斐波那契数列的前n项(头歌实践教学平台习题)【合集】
本关任务是编写递归函数求斐波那契数列的前n项。主要内容包括: 1. **递归的概念**:递归是一种函数直接或间接调用自身的编程技巧,通过“俄罗斯套娃”的方式解决问题。 2. **边界条件的确定**:边界条件是递归停止的条件,确保递归不会无限进行。例如,计算阶乘时,当n为0或1时返回1。 3. **循环控制与跳转语句**:介绍`for`、`while`循环及`break`、`continue`语句的使用方法。 编程要求是在右侧编辑器Begin--End之间补充代码,测试输入分别为3和5,预期输出为斐波那契数列的前几项。通关代码已给出,需确保正确实现递归逻辑并处理好边界条件,以避免栈溢出或结果
65 16
|
1月前
|
存储 编译器 C语言
【C语言程序设计——函数】回文数判定(头歌实践教学平台习题)【合集】
算术运算于 C 语言仿若精密 “齿轮组”,驱动着数值处理流程。编写函数求区间[100,500]中所有的回文数,要求每行打印10个数。根据提示在右侧编辑器Begin--End之间的区域内补充必要的代码。如果操作数是浮点数,在 C 语言中是不允许直接进行。的结果是 -1,因为 -7 除以 3 商为 -2,余数为 -1;注意:每一个数据输出格式为 printf("%4d", i);的结果是 1,因为 7 除以 -3 商为 -2,余数为 1。取余运算要求两个操作数必须是整数类型,包括。开始你的任务吧,祝你成功!
52 1
|
1月前
|
C语言
【C语言程序设计——函数】亲密数判定(头歌实践教学平台习题)【合集】
本文介绍了通过编程实现打印3000以内的全部亲密数的任务。主要内容包括: 1. **任务描述**:实现函数打印3000以内的全部亲密数。 2. **相关知识**: - 循环控制和跳转语句(for、while循环,break、continue语句)的使用。 - 亲密数的概念及历史背景。 - 判断亲密数的方法:计算数A的因子和存于B,再计算B的因子和存于sum,最后比较sum与A是否相等。 3. **编程要求**:根据提示在指定区域内补充代码。 4. **测试说明**:平台对代码进行测试,预期输出如220和284是一组亲密数。 5. **通关代码**:提供了完整的C语言代码实现
61 24

热门文章

最新文章

推荐镜像

更多