如何为非字符串的自定义选项值类型处理 Boost::program_options 配置文件中的空格？

Question

此问题涉及 Boost::program_options 配置文件中值的解析。

我有一个简单的自定义数据结构：

struct Vector {
    double x, y, z;
};

我有一个格式为“(x, y, z)”的 istream 反序列化器，我从另一个 SO post:

那里借来的

// https://codereview.stackexchange.com/a/93811/186081
struct Expect {
    char expected;
    Expect(char expected) : expected(expected) {}
    friend std::istream& operator>>(std::istream& is, Expect const& e) {
        char actual;
        if ((is >> actual) && (actual != e.expected)) {
            is.setstate(std::ios::failbit);
        }
        return is;
    }
};

template<typename CharT>
std::basic_istream<CharT> &
operator>>(std::basic_istream<CharT> &in, Vector &v) {
    in >> Expect('(') >> v.x
       >> Expect(',') >> v.y
       >> Expect(',') >> v.z
       >> Expect(')');
    return in;
}

我正在使用 Vector 的实例作为 Boost::program_options 的值存储：

Vector vector {0.0, 0.0, 0.0};
po::options_description opts("Usage");
opts.add_options()
      ("vector", po::value(&vector), "The vector");

po::variables_map vm;
po::store(po::parse_config_file("config.cfg", opts, true), vm);
po::notify(vm);

问题是如果向量 value 表示包含空格，则配置文件格式不起作用。例如，此配置文件正确解析：

vector = (0.0,1.1,2.2)

然而，这个，带空格，不解析：

vector = (0.0, 1.1, 2.2)

相反，program_options 抛出：

the argument ('(0.0, 1.1, 2.2)') for option 'vector' is invalid

但是，对于声明为 std::string 的选项，空格似乎没问题：

some_string = this is a string

我发现一些 post 提到使用引号，但这似乎不起作用（同样的错误）：

vector = "(0.0, 1.1, 2.2)"

其他一些 post 建议使用自定义解析器，但是我不确定我将如何实现它，而且处理一些空格似乎需要做很多工作。

我假设此行为来自命令行选项的解析方式，即使这是配置文件解析。在这种情况下，像 --vector (0.0, 1.1, 2.2) 这样的命令行没有多大意义（暂时忽略 shell 保留字符 ( & ) 的使用）

请问有什么好方法可以解决吗？

Answer 1

~~不，你不能..~~

编辑：经过深思熟虑，我认为您可以尝试修改分隔符，如 https://en.cppreference.com/w/cpp/locale/ctype

program_options 使用 lexical_cast ，这需要在 operator>> 之后消耗全部内容。当存在 space 时，内容永远不会被一个 >> 消耗，默认情况下会出现错误。

因此你可以这样做：

    struct Optional {
        char optional;
        Optional(char optional):optional(optional){}
        friend std::istream& operator>>(std::istream& is, Optional const& o) {
            char next;
            do{
                next = is.peek();
            }while(next == o.optional && is.get());
            return is;
        }
    };

    struct vector_ctype : std::ctype<wchar_t> {
        bool do_is(mask m, char_type c) const {   
            if ((m & space) && c == L' ') {
                return false; // space will NOT be classified as whitespace
            }
            return ctype::do_is(m, c); // leave the rest to the parent class
        } 
    };


    template<typename CharT>
    std::basic_istream<CharT> &
    operator>>(std::basic_istream<CharT> &in, Vector &v) {    
        std::locale default_locale = in.getloc();
        in.imbue(std::locale(default_locale, new vector_ctype()));
        in >> Expect('(') >> Optional(' ') >> v.x >> Optional(' ')
           >> Expect(',') >> Optional(' ') >> v.y >> Optional(' ')
           >> Expect(',') >> Optional(' ') >> v.z >> Optional(' ')
           >> Expect(')');
        in.imbue(default_locale);
        return in;
    }

int main()
{
    Vector v  = boost::lexical_cast<Vector>("(1,  2,  3)");
    std::cout << v.x <<"," <<v.y <<"," << v.z <<std::endl;
}

输出：

1,2,3

这应该会在 program_options

中为您提供正确的输出

Answer 2

您可以编写一个例程来过滤输入文件中不需要的字符，然后将其传递给 boost::program_options 进行解析，而不是编写自定义解析器。

使用 SO answer to Remove spaces from std::string in C++，这是一个基于您的代码的工作示例：

#include <iostream>
#include <sstream>
#include <fstream>
#include <string>
#include <boost/program_options/options_description.hpp>
#include <boost/program_options/parsers.hpp>
#include <boost/program_options/variables_map.hpp>

struct Vector {
  double x, y, z;
};

// https://codereview.stackexchange.com/a/93811/186081
struct Expect {
    char expected;
    Expect(char expected) : expected(expected) {}
    friend std::istream& operator>>(std::istream& is, Expect const& e) {
        char actual;
        if ((is >> actual) && (actual != e.expected)) {
            is.setstate(std::ios::failbit);
        }
        return is;
    }
};

template<typename CharT>
std::basic_istream<CharT> &
operator>>(std::basic_istream<CharT> &in, Vector &v) {
    in >> Expect('(') >> v.x
       >> Expect(',') >> v.y
       >> Expect(',') >> v.z
       >> Expect(')');
    return in;
}

std::stringstream filter(const std::string& filename)
{
  std::ifstream inputfile(filename);

  std::stringstream s;
  std::string line;
  while (std::getline(inputfile, line))
    {
      auto end_pos = std::remove(line.begin(), line.end(), ' ');
      line.erase(end_pos, line.end());
      s << line << '\n';
    }
  s.seekg(0, std::ios_base::beg);

  return s;
}

int main()
{
  namespace po = boost::program_options;

  po::options_description opts("Usage");
  opts.add_options()
    ("vector", po::value<Vector>(), "The vector");

  auto input = filter("config.cfg");
  po::variables_map vm;
  po::store(po::parse_config_file(input, opts, true), vm);
  po::notify(vm);

  auto read_vec = vm["vector"].as<Vector>();
  std::cout << "vector is : {" << read_vec.x << ", " << read_vec.y << ", " << read_vec.z << "}" << std::endl;

  return 0;
}

要测试程序，您必须创建一个文件 config.cfg 包含，例如：

vector = (1,  2, 3)

（额外的间距是故意的，以测试例程）。

有了这个，程序的输出就是

vector is : {1, 2, 3}

如何为非字符串的自定义选项值类型处理 Boost::program_options 配置文件中的空格？

How to handle spaces in Boost::program_options config files for custom option value types that are not strings?

c++

config

whitespace

istream

boost-program-options