C++命令行解析器cmdline使用文档

1. 安装指南

由于cmdline只有一个头文件，因此安装非常简单。您只需将cmdline.h文件复制到您的项目目录中即可。

// include cmdline.h
#include "cmdline.h"

确保您的编译器能够找到cmdline.h文件，可能需要设置包含目录。

2. 项目使用说明

cmdline是一个简单的命令行解析器，它能够帮助您轻松解析命令行参数。以下是基本的使用步骤：

1. 创建一个cmdline::parser对象。
2. 使用add方法添加参数。
3. 调用parse_check方法解析命令行参数。
4. 使用get方法获取参数值，使用exist方法检查布尔标志。

cmdline::parser a;
a.add<string>("host", 'h', "host name", true, "");
a.add<int>("port", 'p', "port number", false, 80, cmdline::range(1, 65535));
a.add<string>("type", 't', "protocol type", false, "http", cmdline::oneof<string>("http", "https", "ssh", "ftp"));
a.add("gzip", '\0', "gzip when transfer");
a.parse_check(argc, argv);

解析完成后，您可以通过get方法获取参数值：

cout << a.get<string>("type") << "://"
     << a.get<string>("host") << ":"
     << a.get<int>("port") << endl;

如果存在gzip标志，可以通过exist方法进行检查：

if (a.exist("gzip")) cout << "gzip" << endl;

3. 项目API使用文档

以下是cmdline的一些主要API：

• add<T>：添加一个命令行参数，T是参数的类型。
• parse_check：解析命令行参数，并检查错误和帮助标志。
• get<T>：获取参数值。
• exist：检查布尔标志是否存在。

add方法

add方法的原型是：

void add(const string& long_name, char short_name, const string& description, bool mandatory, const T& default_value, const Constraint& constraint = Constraint());

• long_name：参数的长名称。
• short_name：参数的短名称，如果没有则使用'\0'。
• description：参数的描述。
• mandatory：参数是否必须。
• default_value：参数的默认值（仅当mandatory为false时使用）。
• constraint：参数的约束条件（可选）。

parse_check方法

parse_check方法的原型是：

void parse_check(int argc, char* argv[]);

• argc：参数数量。
• argv：参数数组。

get方法

get方法的原型是：

T get(const string& option_name);

• option_name：要获取值的参数名称。

exist方法

exist方法的原型是：

bool exist(const string& option_name);

• option_name：要检查的布尔标志名称。

4. 项目安装方式

如前所述，由于cmdline只有一个头文件，因此安装方式非常简单。只需将cmdline.h复制到您的项目目录中，并在您的编译器中设置相应的包含目录即可。无需其他复杂的安装步骤。