提升程序选项:自定义验证程序是否需要重载运算符>>?

时间:2012-11-21 13:20:10

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

example(regex.cpp)中,库的作者为此结构创建了一个自定义结构(magic_number)和一个验证函数,以显示如何将自定义结构集成到程序选项中。我按照他的例子为自定义类(MyClass)创建了一个验证函数。编译器抱怨lecical_cast不适用于MyClass。然后我实现了std::istream& operator>>(std::istream& in, MyClass& d),删除了void validate(.., MyClass*, ..),代码编译。任何人都可以解释为什么该示例不需要operator>>,而我的不需要validate

编辑:

#include <MyLib/MyClass.h>

std::istream& operator>>(std::istream& in, MyClass& obj) {
    // some code to populate obj
    return in;
}


po::variables_map parseCommandLine(int argc, char* argv[]) {

    po::options_description options("Options");
    options.add_options()
        ("help", "produce help message")
        ("obj", po::value<MyClass>(), "")
        ;
    po::variables_map vm;
    store(po::command_line_parser(argc, argv)
        .options(options).run(), vm);
    notify(vm);

    return vm;
}

int main(int argc, char* argv[]) {

    try {
        po::variables_map vm = parseCommandLine(argc, argv);

        MyClass obj = vm["my"].as<MyClass>();

        cout << obj << endl;
    } catch(std::exception& e) {
        cout << e.what() << "\n";
        return 1;
    }   
    return 0;
}
  • 代码在没有验证的情况下编译。

我也试过对regex.cpp进行最小的更改:

  1. 删除magic_number
  2. 添加#include <MyLib/MyClass.h>
  3. 用MyClass替换所有出现的magic_number。
  4. 注释掉验证中的所有代码。
  5. 这不会编译。
  6. 编辑:添加validate。他们都没有解决编译错误。

    void validate(boost::any& v, 
                  const std::vector<std::string>& values,
                  std::vector<MyClass>*, int)
    {
    }
    
    void validate(boost::any& v, 
                  const std::vector<std::string>& values,
                  MyClass*, long)
    {
    }
    
    void validate(boost::any& v, 
                  const std::vector<std::string>& values,
                  MyClass*, int)
    {      
    }
    

    编辑:它可能与命名空间有关。

    在我通过namespace boost { namespace program_options { }}包围验证函数后,编译的代码没有重载op&gt;&gt;。如果将validate放入与MyClass相同的命名空间中,它也可以工作。谁能解释一下呢?

1 个答案:

答案 0 :(得分:5)

您面临的基本问题是C ++没有提供将字符串转换为任意用户对象的任何工具(我的意思是不编写任何代码)。

为了解决这个问题,program_options提供了两种可能性:

  • 您实现operator>>,这是标准的C ++方式,但可能会对其他一些方面产生影响(即您可能希望以特定方式解析对象,但命令行除外)。在内部,boost::lexical_cast用于实现转换,如果找不到op>>则会抛出错误。
  • 您实现了validate函数,该函数特定于program_options但在选项管理之外没有任何影响。

我猜它会使用模板元编程来确定您是否提供了validate,或者它将默认为lexical_cast

我无法帮助您为什么validate尝试失败,因为您没有为其提供代码。

以下是一个工作示例:

#include <boost/program_options.hpp>
#include <vector>
#include <string>

namespace po = boost::program_options;

namespace lib {
   class MyClass
    {
    public:
        int a;
    };

    void validate(boost::any& v,
                  const std::vector<std::string>& values,
                  MyClass*, int)
    {
        po::validators::check_first_occurrence(v);
        const string& s = po::validators::get_single_string(values);
        v = boost::any(MyClass { boost::lexical_cast<int>(s) } );
    }
}


po::variables_map parseCommandLine(int argc, char* argv[])
{
    po::options_description options("Options");
    options.add_options()
        ("help", "produce help message")
        ("obj", po::value<lib::MyClass>(), "")
        ;
    po::variables_map vm;
    store(po::command_line_parser(argc, argv)
        .options(options).run(), vm);
    notify(vm);

    return vm;
}

int main(int argc, char* argv[])
{
    try {
        po::variables_map vm = parseCommandLine(argc, argv);
        lib::MyClass obj = vm["obj"].as<lib::MyClass>();
        cout << obj.a << endl;
    } catch(std::exception& e) {
        cout << e.what() << "\n";
        return 1;
    }
    return 0;
}
  • 更新

使用命名空间,类和validate都必须属于同一个命名空间。

相关问题