Boost parse_config_file,空键值

时间:2013-02-26 15:17:30

标签: c++ boost boost-program-options

我使用Boost program_options以标准方式解析配置文件为
显示在program_options的multiple_sources.cpp示例文件中。

    ifstream ini_file("config.ini");  
    po::store(po::parse_config_file(ini_file, desc, true), vm);  
    po::notify(vm);

然而,config.ini文件具有空键=值对,例如:

key1=value1  
key2=value2  
key3=  
key4=  
key5=value5  

尝试读取此文件会导致Boost错误:

boost::program_options::invalid_option_value

boost :: program_options中是否有任何机制来读取这些带有空的entires的配置文件?

非常感谢任何帮助。


由于问题尚未解决,我正在编辑此问题。我将引用Boost(1.53)的例子。

这是完整的multiple_sources.cpp文件:

#include <boost/program_options.hpp>
namespace po = boost::program_options;


#include <iostream>
#include <fstream>
#include <iterator>
using namespace std;

// A helper function to simplify the main part.
template<class T>
ostream& operator<<(ostream& os, const vector<T>& v)
{
    copy(v.begin(), v.end(), ostream_iterator<T>(os, " ")); 
    return os;
}


int main(int ac, char* av[])
{
    try {
        int opt;
        string config_file;

        // Declare a group of options that will be 
        // allowed only on command line
        po::options_description generic("Generic options");
        generic.add_options()
            ("version,v", "print version string")
            ("help", "produce help message")
            //("optimization","optimization level")      
            ("config,c", po::value<string>(&config_file)->default_value("multiple_sources.cfg"),
                  "name of a file of a configuration.")
            ;

        // Declare a group of options that will be 
        // allowed both on command line and in
        // config file
        po::options_description config("Configuration");
        config.add_options()
            ("optimization", po::value<int>(&opt)->default_value(10), 
                  "optimization level")
            ("include-path,I", po::value< vector<string> >()->composing(), 
                 "include path")
            ;

        // Hidden options, will be allowed both on command line and
        // in config file, but will not be shown to the user.
        po::options_description hidden("Hidden options");
        hidden.add_options()
            ("input-file", po::value< vector<string> >(), "input file")
            ;

        po::options_description cmdline_options;
        cmdline_options.add(generic).add(config).add(hidden);

        po::options_description config_file_options;
        config_file_options.add(config).add(hidden);

        po::options_description visible("Allowed options");
        visible.add(generic).add(config);

        po::positional_options_description p;
        p.add("input-file", -1);

        po::variables_map vm;
        store(po::command_line_parser(ac, av).
              options(cmdline_options).positional(p).run(), vm);
        notify(vm);

        ifstream ifs(config_file.c_str());
        if (!ifs)
        {
            cout << "can not open config file: " << config_file << "\n";
            return 0;
        }
        else
        {
            store(parse_config_file(ifs, config_file_options), vm);
            notify(vm);
        }

        if (vm.count("help")) {
            cout << visible << "\n";
            return 0;
        }

        if (vm.count("version")) {
            cout << "Multiple sources example, version 1.0\n";
            return 0;
        }

        if (vm.count("include-path"))
        {
            cout << "Include paths are: " 
                 << vm["include-path"].as< vector<string> >() << "\n";
        }

        if (vm.count("input-file"))
        {
            cout << "Input files are: " 
                 << vm["input-file"].as< vector<string> >() << "\n";
        }

        cout << "Optimization level is " << opt << "\n";                
    }
    catch(exception& e)
    {
        cout << e.what() << "\n";
        return 1;
    }    
    return 0;
}

相应的配置文件(multiple_sources.cfg)是:

#
# Comment out this line to use hard-coded default value of 10
# 
optimization = 1
include-path = /opt

如果此文件现在已修改为:

#
# Comment out this line to use hard-coded default value of 10
# 
optimization = 
include-path = /opt

抛出以下错误消息:

the argument for option 'optimization' is invalid

带有验证重载等的建议解决方案似乎不必要地复杂化,特别是因为可能必须为每种数据类型编写验证函数,并且可以识别'\ n'其他空白区域。

有什么建议吗?谢谢大家抽出时间。


根据Aditya的建议,我已取代以下一行:

            ("optimization", po::value<int>(&opt)->default_value(10), 
                  "optimization level")

以下内容:

            ("optimization", po::value<int>(&opt)->zero_tokens(), 
                  "optimization level")

和:

            ("optimization", po::value<int>(&opt)->implicit_value(10), 
                  "optimization level")

并且它们都没有读取空白选项。 Boost示例程序“parser_test.cpp”通过将键值对读入向量来绕过使用zero_tokens()或implicit_value(),如下所示:

void test_config_file(const char* config_file)
{
    options_description desc;
    desc.add_options()
        ("gv1", new untyped_value)
        ("gv2", new untyped_value)
        ("empty_value", new untyped_value)
        ("plug*", new untyped_value)
        ("m1.v1", new untyped_value)
        ("m1.v2", new untyped_value)
        ("b", bool_switch())
    ;

    const char content1[] =
    " gv1 = 0#asd\n"
    "empty_value = \n"
    "plug3 = 7\n"
    "b = true\n"
    "[m1]\n"
    "v1 = 1\n"
    "\n"
    "v2 = 2\n"    
    ;

    vector<option> a2 = parse_config_file<char>(config_file, desc).options;
    BOOST_REQUIRE(a2.size() == 6);
    check_value(a2[0], "gv1", "0");
    check_value(a2[1], "empty_value", "");
    check_value(a2[2], "plug3", "7");
    check_value(a2[3], "b", "true");
    check_value(a2[4], "m1.v1", "1");
    check_value(a2[5], "m1.v2", "2");
}

3 个答案:

答案 0 :(得分:1)

我建议您使用try / catch这个异常进行环绕,并仅为那些对您的程序非常必要且不能为空的字段抛出错误,否则该字段将被忽略。

答案 1 :(得分:1)

不,目前无法在boost :: program_options中处理此问题。在INI文件中具有空键:值对与在命令行上指定选项而不提供参数相同。编写ypnos建议的自定义验证器的方法可能有效但似乎不切实际,因为您需要将它应用于您希望可能留空的每个选项。你必须编写自己的po :: parse_config_file实现,它会忽略没有值的行(除非相应的选项标记为zero_token)以获得你想要的结果。

答案 2 :(得分:0)

我几次无意中发现了这个问题,最后通过将初始INI文件中的无效行删除然后再传递给program_options::parse_config_file来解决了这个问题。 可以通过在文件系统上创建一个临时的修改后的INI文件或将整个原始INI文件读取到内存中并在其中进行修改,然后创建istringstream并传递给parse_config_file来完成。

我个人为此创建了boost::iostreams过滤流类,以动态过滤ifstream。这不会创建任何新的依赖项,因为我已经使用了Boost,并且在我的情况下boost::iostreams仅可用于标头。

这是它的用法:

#include <fstream>
#include <boost/iostreams/filtering_stream.hpp>
#include <boost/program_options.hpp>
#include "inifilefilter.h" // IniFileInputFilter
...
std::ifstream file("config.ini");
if (file)
{
   // filtering out empty values, i.e. name=
   boost::iostreams::filtering_istream filteredIniFile; 
   filteredIniFile.push(IniFileInputFilter());
   filteredIniFile.push(file);
   po::parsed_options parsedFileOpts =
         po::parse_config_file(filteredIniFile, configFileOptions, true);
   ...
}

在这里,我不会显示inifilefilter.h中的代码,因为它在所有检查和极端情况下都有些冗长,但是同时,它的想法非常简单。 IniFileInputFilter的{​​{1}}方法会缓冲每条输入行,然后在行尾仅在行有效时才进一步传递该行。 “有效”表示它是read()行,或者在第一个[section]与行尾之间有一些非空格字符。