diff -r 000000000000 -r e4d67989cc36 ossrv_pub/boost_apis/boost/program_options/parsers.hpp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ossrv_pub/boost_apis/boost/program_options/parsers.hpp Tue Feb 02 02:01:42 2010 +0200 @@ -0,0 +1,228 @@ +// Copyright Vladimir Prus 2002-2004. +// Distributed under the Boost Software License, Version 1.0. +// (See accompanying file LICENSE_1_0.txt +// or copy at http://www.boost.org/LICENSE_1_0.txt) + + +#ifndef BOOST_PARSERS_VP_2003_05_19 +#define BOOST_PARSERS_VP_2003_05_19 + +#include +#include +#include + +#include + +#include +#include +#include + +namespace boost { namespace program_options { + + class options_description; + class positional_options_description; + + + /** Results of parsing an input source. + The primary use of this class is passing information from parsers + component to value storage component. This class does not makes + much sense itself. + */ + template + class basic_parsed_options { + public: + explicit basic_parsed_options(const options_description* description) + : description(description) {} + /** Options found in the source. */ + std::vector< basic_option > options; + /** Options description that was used for parsing. + Parsers should return pointer to the instance of + option_description passed to them, and issues of lifetime are + up to the caller. Can be NULL. + */ + const options_description* description; + }; + + /** Specialization of basic_parsed_options which: + - provides convenient conversion from basic_parsed_options + - stores the passed char-based options for later use. + */ + template<> + class BOOST_PROGRAM_OPTIONS_DECL basic_parsed_options { + public: + /** Constructs wrapped options from options in UTF8 encoding. */ + explicit basic_parsed_options(const basic_parsed_options& po); + + std::vector< basic_option > options; + const options_description* description; + + /** Stores UTF8 encoded options that were passed to constructor, + to avoid reverse conversion in some cases. */ + basic_parsed_options utf8_encoded_options; + }; + + typedef basic_parsed_options parsed_options; + typedef basic_parsed_options wparsed_options; + + /** Augments basic_parsed_options with conversion from + 'parsed_options' */ + + + typedef function1, const std::string&> ext_parser; + + /** Command line parser. + + The class allows one to specify all the information needed for parsing + and to parse the command line. It is primarily needed to + emulate named function parameters -- a regular function with 5 + parameters will be hard to use and creating overloads with a smaller + nuber of parameters will be confusing. + + For the most common case, the function parse_command_line is a better + alternative. + + There are two typedefs -- command_line_parser and wcommand_line_parser, + for charT == char and charT == wchar_t cases. + */ + template + class basic_command_line_parser : private detail::cmdline { + public: + /** Creates a command line parser for the specified arguments + list. The 'args' parameter should not include program name. + */ + basic_command_line_parser(const std::vector< + std::basic_string >& args); + /** Creates a command line parser for the specified arguments + list. The parameters should be the same as passed to 'main'. + */ + basic_command_line_parser(int argc, charT* argv[]); + + /** Sets options descriptions to use. */ + basic_command_line_parser& options(const options_description& desc); + /** Sets positional options description to use. */ + basic_command_line_parser& positional( + const positional_options_description& desc); + + /** Sets the command line style. */ + basic_command_line_parser& style(int); + /** Sets the extra parsers. */ + basic_command_line_parser& extra_parser(ext_parser); + + /** Parses the options and returns the result of parsing. + Throws on error. + */ + basic_parsed_options run(); + + /** Specifies that unregistered options are allowed and should + be passed though. For each command like token that looks + like an option but does not contain a recognized name, an + instance of basic_option will be added to result, + with 'unrecognized' field set to 'true'. It's possible to + collect all unrecognized options with the 'collect_unrecognized' + funciton. + */ + basic_command_line_parser& allow_unregistered(); + + using detail::cmdline::style_parser; + + basic_command_line_parser& extra_style_parser(style_parser s); + + private: + const options_description* m_desc; + }; + + typedef basic_command_line_parser command_line_parser; + typedef basic_command_line_parser wcommand_line_parser; + + /** Creates instance of 'command_line_parser', passes parameters to it, + and returns the result of calling the 'run' method. + */ + template + basic_parsed_options + parse_command_line(int argc, charT* argv[], + const options_description&, + int style = 0, + function1, + const std::string&> ext + = ext_parser()); + + /** Parse a config file. + */ + template +#if ! BOOST_WORKAROUND(__ICL, BOOST_TESTED_AT(700)) + BOOST_PROGRAM_OPTIONS_DECL +#endif + basic_parsed_options + parse_config_file(std::basic_istream&, const options_description&); + + /** Controls if the 'collect_unregistered' function should + include positional options, or not. */ + enum collect_unrecognized_mode + { include_positional, exclude_positional }; + + /** Collects the original tokens for all named options with + 'unregistered' flag set. If 'mode' is 'include_positional' + also collects all positional options. + Returns the vector of origianl tokens for all collected + options. + */ + template + std::vector< std::basic_string > + collect_unrecognized(const std::vector< basic_option >& options, + enum collect_unrecognized_mode mode); + + /** Parse environment. + + For each environment variable, the 'name_mapper' function is called to + obtain the option name. If it returns empty string, the variable is + ignored. + + This is done since naming of environment variables is typically + different from the naming of command line options. + */ + BOOST_PROGRAM_OPTIONS_DECL parsed_options + parse_environment(const options_description&, + const function1& name_mapper); + + /** Parse environment. + + Takes all environment variables which start with 'prefix'. The option + name is obtained from variable name by removing the prefix and + converting the remaining string into lower case. + */ + BOOST_PROGRAM_OPTIONS_DECL parsed_options + parse_environment(const options_description&, const std::string& prefix); + + /** @overload + This function exists to resolve ambiguity between the two above + functions when second argument is of 'char*' type. There's implicit + conversion to both function1 and string. + */ + BOOST_PROGRAM_OPTIONS_DECL parsed_options + parse_environment(const options_description&, const char* prefix); + + #ifdef _WIN32 + /** Parses the char* string which is passed to WinMain function on + windows. This function is provided for convenience, and because it's + not clear how to portably access split command line string from + runtime library and if it always exists. + This function is available only on Windows. + */ + BOOST_PROGRAM_OPTIONS_DECL std::vector + split_winmain(const std::string& cmdline); + +#ifndef BOOST_NO_STD_WSTRING + /** @overload */ + BOOST_PROGRAM_OPTIONS_DECL std::vector + split_winmain(const std::wstring& cmdline); + #endif +#endif + + +}} + +#undef DECL + +#include "boost/program_options/detail/parsers.hpp" + +#endif