cxxopts位置参数示例

cxxopts 可以方便地处理位置参数（即不带有选项名，按顺序出现的参数）。下面详细介绍其位置参数的用法，包含代码示例、代码解释和注意事项。

示例代码

#include <iostream>
#include "cxxopts.hpp"

int main(int argc, char* argv[]) {
    try {
        // 创建 cxxopts::Options 对象，指定程序名称和简要描述
        cxxopts::Options options("MyApp", "A program that uses positional arguments");

        // 定义普通选项
        options.add_options()
            // 帮助选项，使用 -h 或 --help 触发，无参数
            ("h,help", "Print help")
            // 输出文件选项，使用 -o 或 --output 触发，需要一个字符串参数
            ("o,output", "Output file", cxxopts::value<std::string>());

        // 定义位置参数
        std::vector<std::string> positionalArgs;
        options.add_options()
            // 位置参数，接收多个字符串，将存储在 positionalArgs 中
            ("positional", "Positional arguments", cxxopts::value<std::vector<std::string>>(positionalArgs));

        // 设置位置参数的名称，用于帮助信息显示
        options.parse_positional({"positional"});

        // 解析命令行参数
        auto result = options.parse(argc, argv);

        // 如果用户指定了 --help 或 -h 选项，打印帮助信息并退出程序
        if (result.count("help")) {
            std::cout << options.help() << std::endl;
            return 0;
        }

        // 处理输出文件选项
        if (result.count("output")) {
            std::cout << "Output file: " << result["output"].as<std::string>() << std::endl;
        }

        // 处理位置参数
        if (!positionalArgs.empty()) {
            std::cout << "Positional arguments:" << std::endl;
            for (const auto& arg : positionalArgs) {
                std::cout << "  " << arg << std::endl;
            }
        }
    }
    catch (const cxxopts::exceptions::exception& e) {
        // 处理解析选项时可能出现的异常
        std::cerr << "Error parsing options: " << e.what() << std::endl;
        return 1;
    }

    return 0;
}

代码解释

1. 创建 cxxopts::Options 对象：

   cxxopts::Options options("MyApp", "A program that uses positional arguments");
   

   此代码创建了一个 Options 对象，用于管理命令行选项，并指定了程序的名称和简要描述。

2. 定义普通选项：

   options.add_options()
       ("h,help", "Print help")
       ("o,output", "Output file", cxxopts::value<std::string>());
   

   这里添加了两个普通选项：--help 用于打印帮助信息，--output 用于指定输出文件。

3. 定义位置参数：

   std::vector<std::string> positionalArgs;
   options.add_options()
       ("positional", "Positional arguments", cxxopts::value<std::vector<std::string>>(positionalArgs));
   

   • 首先创建一个 std::vector<std::string> 类型的变量 positionalArgs，用于存储位置参数。
   • 然后添加一个名为 positional 的选项，它将接收多个字符串类型的位置参数，并将其存储在 positionalArgs 中。

4. 设置位置参数名称：

   options.parse_positional({"positional"});
   

   parse_positional 方法指定了位置参数对应的选项名称，这样 cxxopts 就能正确地将位置参数分配到相应的选项中。

5. 解析命令行参数：

   auto result = options.parse(argc, argv);
   

   调用 parse 方法对传入的命令行参数进行解析，解析结果存储在 result 对象中。

6. 处理解析结果：

   • 帮助选项：如果用户指定了 --help 选项，打印帮助信息并退出程序。

   if (result.count("help")) {
       std::cout << options.help() << std::endl;
       return 0;
   }
   

   • 输出文件选项：如果用户指定了 --output 选项，输出指定的输出文件名。

   if (result.count("output")) {
       std::cout << "Output file: " << result["output"].as<std::string>() << std::endl;
   }
   

   • 位置参数：如果存在位置参数，遍历并输出每个位置参数。

   if (!positionalArgs.empty()) {
       std::cout << "Positional arguments:" << std::endl;
       for (const auto& arg : positionalArgs) {
           std::cout << "  " << arg << std::endl;
       }
   }
   

注意事项

• 位置参数顺序：位置参数是按照在命令行中出现的顺序依次解析的。
• 选项与位置参数混合：cxxopts 会自动区分选项和位置参数，但要注意避免选项和位置参数的混淆。例如，确保选项以 - 或 -- 开头，而位置参数则直接跟在命令后面。
• 错误处理：在解析过程中可能会出现异常，如选项格式错误等，因此需要进行异常处理，以保证程序的健壮性。

通过以上步骤，你可以在 cxxopts 中方便地处理位置参数。