用序列容器解析命令行选项？

Posted 2023-03-07

【中文标题】用序列容器解析命令行选项？

【英文标题】：parsing command-line options with sequence containers?

【发布时间】：2015-01-15 13:12:45

【问题描述】：

这个问题以前也出现过，但似乎没有一个答案提供boost风格的泛型编程的替代方案。

像许多人一样，我使用 boost:program_options 来解析命令行选项。我目前的项目是一个使用顺序不可互换的运算符来操作数据（例如图像）的程序，例如

加 3 然后乘以 2$ manipulate -in someimage.tif -a 3 -m 2

一般不一样

乘以 2 然后加 3$ manipulate -in someimage.tif -m 2 -a 3

-in 选项将文件内容加载到向量current_image 中，命令行上的每个选项都会修改current_image。

但variable_map 容器不保留添加选项的顺序。至少没有明确表示。 this post 中的答案最接近我的想法，但 extra parsing code needed 的数量与 getopt() 的数量大致相同。

有谁知道将程序选项的顺序存储在 boost 提供的容器中的方法吗？根本不可能吗？或者是否有可能（甚至可能实现）使用序列容器？

编辑 1 我确实找到了这个 really old post，它似乎仍然有效，说明是的，你可以只遍历 variables_map。当然，实际上并没有将顺序指定为与命令行上的顺序相同（留给编译器编写者），所以我猜它仍然归类为 hack。EDIT 2这还不够，因为选项是按选项字符串排序的，因此迭代顺序与插入顺序不同。

【参考方案1】：

实际上，您所拥有的更类似于表达式语法。我建议为此编写一个语法/解析器，而不是（ab？）为此使用 program_options。

如果您的程序采用选项：使用程序选项。

如果您的程序采用表达式：使用表达式解析器。

一个例子：

Live On Coliru

// #define BOOST_SPIRIT_DEBUG
#include <boost/fusion/adapted/struct.hpp>
#include <boost/fusion/include/io.hpp>
#include <boost/spirit/include/qi.hpp>

namespace qi  = boost::spirit::qi;

struct Operation 
    enum Kind  add, multiply  kind;
    double operand;

    friend std::ostream& operator<<(std::ostream& os, Kind k) 
        switch (k) 
            case add:      return os << "--add";
            case multiply: return os << "--multiply";
        ;
        return os << "??";
    
;

BOOST_FUSION_ADAPT_STRUCT(Operation, (Operation::Kind,kind)(double,operand))

template <typename It, typename Skipper = qi::blank_type> 
   struct expression_grammar : qi::grammar<It, std::vector<Operation>(), Skipper> 
       expression_grammar() : expression_grammar::base_type(start) 
           using namespace qi;

           opkinds.add
               ("-a",         Operation::add)
               ("--add",      Operation::add)
               ("-m",         Operation::multiply)
               ("--multiply", Operation::multiply)
               ;

           option = opkinds > eol > double_;

           start  = *(option > eol);

           BOOST_SPIRIT_DEBUG_NODES((start)(option))
       
     private:
       qi::symbols<char, Operation::Kind> opkinds;
       qi::rule<It, Operation(), Skipper> option;
       qi::rule<It, std::vector<Operation>(), Skipper> start;
   ;

int main(int argc, char const** argv) 
    std::stringstream iss;
    if (argc)
        std::copy(argv+1, argv+argc, std::ostream_iterator<const char*>(iss, "\n"));

    typedef boost::spirit::istream_iterator It;
    expression_grammar<It> grammar;

    It first(iss >> std::noskipws), last;
    std::vector<Operation> operations;
    bool ok = qi::phrase_parse(first, last, grammar, qi::blank, operations);

    if (ok)
    
        std::cout << "Parse success\n";
        for (auto const& op : operations)
            std::cout << boost::fusion::as_vector(op) << "\n";
     else
        std::cout << "Parse failed\n";

    if (first!=last)
       std::cout << "Remaining input: '" << std::string(first,last) << "'\n";

注意

我无偿选择使用eol 作为选项分隔符。您可能想改用'\0'。这是最简单的，因为 blank 跳过程序已经跳过了空格 /except/ eol。我很懒:)

您可能需要混合匹配（不要将所有参数都视为表达式的一部分）。一个常见的模式是

myprogram -x option1 -v -o filename -- my expression grammar follows

一种常见的替代模式是使表达式成为单个参数：

myprogram -e 'add 5; multiply 32;' -x option1

也看到这种方法Live on Coliru

我又懒得打印“解析成功”了（我不想为Operation 类型实现operator<<）

使用#define BOOST_SPIRIT_DEBUG 启用调试信息（取消注释第一行）

<start>
  <try>-a\n8\n-m\n7\n-a\n32\n</try>
  <option>
    <try>-a\n8\n-m\n7\n-a\n32\n</try>
    <success>\n-m\n7\n-a\n32\n</success>
    <attributes>[[--add, 8]]</attributes>
  </option>
  <option>
    <try>-m\n7\n-a\n32\n</try>
    <success>\n-a\n32\n</success>
    <attributes>[[--multiply, 7]]</attributes>
  </option>
  <option>
    <try>-a\n32\n</try>
    <success>\n</success>
    <attributes>[[--add, 32]]</attributes>
  </option>
  <option>
    <try></try>
    <fail/>
  </option>
  <success></success>
  <attributes>[[[--add, 8], [--multiply, 7], [--add, 32]]]</attributes>
</start>
Parse success
(--add 8)
(--multiply 7)
(--add 32)

【讨论】：

也添加了单参数表达式方法 (coliru)

漂亮！您的观点是，当顺序（上下文）很重要时，将操作序列视为表达式而不是程序选项是很好的。即使这样，program_options 也支持多次出现（例如 --verbose on --verbose off），如果顺序未知，则其结果是不可预测的。如果保留顺序并且解析保持不变（不允许使用括号），则将这些操作视为程序选项不会有问题。不过，非常感谢这个例子！