一个高效的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)


相关文章
|
27天前
|
存储 算法 程序员
C语言:库函数
C语言的库函数是预定义的函数,用于执行常见的编程任务,如输入输出、字符串处理、数学运算等。使用库函数可以简化编程工作,提高开发效率。C标准库提供了丰富的函数,满足各种需求。
ly~
|
1月前
|
数据可视化 BI API
除了 OpenGL,还有哪些常用的图形库可以在 C 语言中使用?
除了OpenGL,C语言中还有多个常用的图形库:SDL,适合初学者,用于2D游戏和多媒体应用;Allegro,高性能,支持2D/3D图形,广泛应用于游戏开发;Cairo,矢量图形库,支持高质量图形输出,适用于数据可视化;SFML,提供简单接口,用于2D/3D游戏及多媒体应用;GTK+,开源窗口工具包,用于创建图形用户界面。这些库各有特色,适用于不同的开发需求。
ly~
228 4
|
1月前
|
SQL Oracle 关系型数据库
SQL整库导出语录:全面解析与高效执行策略
在数据库管理和维护过程中,整库导出是一项常见的需求,无论是为了备份、迁移还是数据分析,掌握如何高效、准确地导出整个数据库至关重要
|
2月前
|
Python
命令行解析工具 argparse
命令行解析工具 argparse
51 14
|
2月前
|
XML JSON 网络协议
超级好用的C++实用库之字节流解析器
超级好用的C++实用库之字节流解析器
33 3
|
1月前
|
存储 安全 编译器
深入C语言库:字符与字符串函数模拟实现
深入C语言库:字符与字符串函数模拟实现
|
2月前
|
数据采集 存储 JSON
从零到一构建网络爬虫帝国:HTTP协议+Python requests库深度解析
在网络数据的海洋中,网络爬虫遵循HTTP协议,穿梭于互联网各处,收集宝贵信息。本文将从零开始,使用Python的requests库,深入解析HTTP协议,助你构建自己的网络爬虫帝国。首先介绍HTTP协议基础,包括请求与响应结构;然后详细介绍requests库的安装与使用,演示如何发送GET和POST请求并处理响应;最后概述爬虫构建流程及挑战,帮助你逐步掌握核心技术,畅游数据海洋。
72 3
|
1月前
|
程序员 编译器 数据处理
【C语言】深度解析:动态内存管理的机制与实践
【C语言】深度解析:动态内存管理的机制与实践
|
1月前
|
Serverless 编译器 C语言
【C语言】指针篇- 深度解析Sizeof和Strlen:热门面试题探究(5/5)
【C语言】指针篇- 深度解析Sizeof和Strlen:热门面试题探究(5/5)
|
2月前
|
缓存 网络协议 分布式数据库
超级好用的C++实用库之DNS解析
超级好用的C++实用库之DNS解析
58 0
下一篇
无影云桌面