首页 > 代码库 > cmdline —— 轻量级的C++命令行解析库

cmdline —— 轻量级的C++命令行解析库

2024-07-29 09:45:40   224人阅读

平时用C++写一些命令行工具，需要解析命令行的输入参数，这是一项繁琐并且容易出错的工作，我们不应该将主要精力放在这上面，可以考虑使用开源的库，下面的cmdline就是其中非常好用的一款。

cmdline介绍

cmdline 是一个非常简单好用的C++命令行解析库，其基于模板，所以使用很简单，写出的代码也很优雅。由于其只包含一个头文件，所以很容易集成到自己的项目中。

cmdline项目托管地址Github：https://github.com/tanakh/cmdline

cmdline使用

下面是cmdline项目首页给出的示例代码，我将其中的注释翻译成了中文，同时添加了一些自己使用经验和理解。

  1. #include "cmdline.h"
  3. int main(int argc, char *argv[])
  4. {
  5.     // 创建一个命令行解析器
  6.     cmdline::parser a;
  8.     // 添加指定类型的输入参数
  9.     // 第一个参数：长名称
  10.     // 第二个参数：短名称（‘\0‘表示没有短名称）
  11.     // 第三个参数：参数描述
  12.     // 第四个参数：bool值，表示该参数是否必须存在（可选，默认值是false）
  13.     // 第五个参数：参数的默认值（可选，当第四个参数为false时该参数有效）
  14.     a.add<string>("host", ‘h‘, "host name", true, "");
  16.     // 第六个参数用来对参数添加额外的限制
  17.     // 这里端口号被限制为必须是1到65535区间的值，通过cmdline::range(1, 65535)进行限制 
  18.     a.add<int>("port", ‘p‘, "port number", false, 80, cmdline::range(1, 65535));
  20.     // cmdline::oneof() 可以用来限制参数的可选值
  21.     a.add<string>("type", ‘t‘, "protocol type", false, "http", cmdline::oneof<string>("http", "https", "ssh", "ftp"));
  23.     // 也可以定义bool值
  24.     // 通过调用不带类型的add方法
  25.     a.add("gzip", ‘\0‘, "gzip when transfer");
  27.     // 运行解析器
  28.     // 只有当所有的参数都有效时他才会返回
  29.     //  如果有无效参数，解析器会输出错误消息，然后退出程序
  30.     // 如果有‘--help‘或-?‘这样的帮助标识被指定，解析器输出帮助信息，然后退出程序
  31.     a.parse_check(argc, argv);
  33.     // 获取输入的参数值
  34.     cout << a.get<string>("type") << "://"
  35.          << a.get<string>("host") << ":"
  36.          << a.get<int>("port") << endl;
  38.     // bool值可以通过调用exsit()方法来判断
  39.     if (a.exist("gzip")) cout << "gzip" << endl;
  40. }


使用测试

只输入程序名，默认会输出帮助信息。选项后面的括号中显示了其类型和默认值（中括号）

  1. $ ./test
  2. usage: ./test --host=string [options] ...
  3. options:
  4.   -h, --host    host name (string)
  5.   -p, --port    port number (int [=80])
  6.   -t, --type    protocol type (string [=http])
  7.       --gzip    gzip when transfer
  8.   -?, --help    print this message

通过下面方式显示的输出帮助信息

  1. $ ./test -?
  2. usage: ./test --host=string [options] ...
  3. options:
  4.   -h, --host    host name (string)
  5.   -p, --port    port number (int [=80])
  6.   -t, --type    protocol type (string [=http])
  7.      --gzip    gzip when transfer
  8.   -?, --help    print this message

输入必选字段主机名，其他参数是可选的，当不缺省时使用默认值，这里使用了默认协议http和默认端口号80

  1. $ ./test --host=github.com
  2. http://github.com:80

输入-t参数，使用ftp覆盖默认值http

  1. $ ./test --host=github.com -t ftp
  2. ftp://github.com:80

由于-t参数限制为只能取cmdline::oneof<string>("http", "https", "ssh", "ftp")中的某一个，这里输入的-t ttp不在其中，因此被视为无效参数，程序输入帮助信息然后退出。

  1. $ ./test --host=github.com -t ttp
  2. option value is invalid: --type=ttp
  3. usage: ./test --host=string [options] ...
  4. options:
  5.   -h, --host    host name (string)
  6.   -p, --port    port number (int [=80])
  7.   -t, --type    protocol type (string [=http])
  8.       --gzip    gzip when transfer
  9.   -?, --help    print this message
  10.   ```
  11. 使用bool型参数
  12. ```
  13. $ ./test --host=github.com --gzip
  14. http://github.com:80
  15. gzip

其他选项

× footer 脚注
footer() 方法用来在帮助信息后面添加自定义文本，例如：

  1. a.footer("user define information...");

运行结果：

  1. $ ./test
  2. usage: ./test --host=string [options] ... filename ...
  3. options:
  4.   -h, --host    host name (string)
  5.   -p, --port    port number (int [=80])
  6.   -t, --type    protocol type (string [=http])
  7.       --gzip    gzip when transfer
  8.   -?, --help    print this message

× pragram name 应用程序名

通过argv[0].set_program_name()可以设置帮助信息中的应用程序显示的名称

cmdline —— 轻量级的C++命令行解析库


联系
我们