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

本文涉及的产品
全局流量管理 GTM,标准版 1个月
云解析 DNS,旗舰版 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)


相关文章
|
1月前
|
存储 网络协议 编译器
【C语言】深入解析C语言结构体:定义、声明与高级应用实践
通过根据需求合理选择结构体定义和声明的放置位置,并灵活结合动态内存分配、内存优化和数据结构设计,可以显著提高代码的可维护性和运行效率。在实际开发中,建议遵循以下原则: - **模块化设计**:尽可能封装实现细节,减少模块间的耦合。 - **内存管理**:明确动态分配与释放的责任,防止资源泄漏。 - **优化顺序**:合理排列结构体成员以减少内存占用。
160 14
|
1月前
|
存储 编译器 C语言
【C语言】数据类型全解析:编程效率提升的秘诀
在C语言中,合理选择和使用数据类型是编程的关键。通过深入理解基本数据类型和派生数据类型,掌握类型限定符和扩展技巧,可以编写出高效、稳定、可维护的代码。无论是在普通应用还是嵌入式系统中,数据类型的合理使用都能显著提升程序的性能和可靠性。
59 8
|
1月前
|
存储 算法 C语言
【C语言】深入浅出:C语言链表的全面解析
链表是一种重要的基础数据结构,适用于频繁的插入和删除操作。通过本篇详细讲解了单链表、双向链表和循环链表的概念和实现,以及各类常用操作的示例代码。掌握链表的使用对于理解更复杂的数据结构和算法具有重要意义。
644 6
|
1月前
|
存储 网络协议 算法
【C语言】进制转换无难事:二进制、十进制、八进制与十六进制的全解析与实例
进制转换是计算机编程中常见的操作。在C语言中,了解如何在不同进制之间转换数据对于处理和显示数据非常重要。本文将详细介绍如何在二进制、十进制、八进制和十六进制之间进行转换。
55 5
|
1月前
|
C语言 开发者
【C语言】断言函数 -《深入解析C语言调试利器 !》
断言(assert)是一种调试工具,用于在程序运行时检查某些条件是否成立。如果条件不成立,断言会触发错误,并通常会终止程序的执行。断言有助于在开发和测试阶段捕捉逻辑错误。
51 5
|
2月前
|
监控 Java 应用服务中间件
高级java面试---spring.factories文件的解析源码API机制
【11月更文挑战第20天】Spring Boot是一个用于快速构建基于Spring框架的应用程序的开源框架。它通过自动配置、起步依赖和内嵌服务器等特性,极大地简化了Spring应用的开发和部署过程。本文将深入探讨Spring Boot的背景历史、业务场景、功能点以及底层原理,并通过Java代码手写模拟Spring Boot的启动过程,特别是spring.factories文件的解析源码API机制。
107 2
|
3月前
|
缓存 Java 程序员
Map - LinkedHashSet&Map源码解析
Map - LinkedHashSet&Map源码解析
91 0
|
3月前
|
算法 Java 容器
Map - HashSet & HashMap 源码解析
Map - HashSet & HashMap 源码解析
77 0
|
24天前
|
存储 设计模式 算法
【23种设计模式·全精解析 | 行为型模式篇】11种行为型模式的结构概述、案例实现、优缺点、扩展对比、使用场景、源码解析
行为型模式用于描述程序在运行时复杂的流程控制,即描述多个类或对象之间怎样相互协作共同完成单个对象都无法单独完成的任务,它涉及算法与对象间职责的分配。行为型模式分为类行为模式和对象行为模式,前者采用继承机制来在类间分派行为,后者采用组合或聚合在对象间分配行为。由于组合关系或聚合关系比继承关系耦合度低,满足“合成复用原则”,所以对象行为模式比类行为模式具有更大的灵活性。 行为型模式分为: • 模板方法模式 • 策略模式 • 命令模式 • 职责链模式 • 状态模式 • 观察者模式 • 中介者模式 • 迭代器模式 • 访问者模式 • 备忘录模式 • 解释器模式
【23种设计模式·全精解析 | 行为型模式篇】11种行为型模式的结构概述、案例实现、优缺点、扩展对比、使用场景、源码解析
|
24天前
|
设计模式 存储 安全
【23种设计模式·全精解析 | 创建型模式篇】5种创建型模式的结构概述、实现、优缺点、扩展、使用场景、源码解析
结构型模式描述如何将类或对象按某种布局组成更大的结构。它分为类结构型模式和对象结构型模式,前者采用继承机制来组织接口和类,后者釆用组合或聚合来组合对象。由于组合关系或聚合关系比继承关系耦合度低,满足“合成复用原则”,所以对象结构型模式比类结构型模式具有更大的灵活性。 结构型模式分为以下 7 种: • 代理模式 • 适配器模式 • 装饰者模式 • 桥接模式 • 外观模式 • 组合模式 • 享元模式
【23种设计模式·全精解析 | 创建型模式篇】5种创建型模式的结构概述、实现、优缺点、扩展、使用场景、源码解析

热门文章

最新文章

推荐镜像

更多