Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
parsers.hpp File Reference
#include <boost/program_options/config.hpp>
#include <boost/program_options/option.hpp>
#include <boost/program_options/detail/cmdline.hpp>
#include <boost/function/function1.hpp>
#include <iosfwd>
#include <vector>
#include <utility>
#include "boost/program_options/detail/parsers.hpp"
Include dependency graph for parsers.hpp:
This graph shows which files directly or indirectly include this file:

Classes

singleton  boost::program_options::basic_parsed_options< charT >
 Results of parsing an input source. More...
 
class  boost::program_options::basic_parsed_options< wchar_t >
 Specialization of basic_parsed_options which: More...
 
class  boost::program_options::basic_command_line_parser< charT >
 Command line parser. More...
 

Namespaces

 boost
 Duration formatting facet for input.
 
 boost::program_options
 Namespace for the library.
 

Typedefs

typedef basic_parsed_options
< char > 
boost::program_options::parsed_options
 
typedef basic_parsed_options
< wchar_t > 
boost::program_options::wparsed_options
 
typedef function1< std::pair
< std::string, std::string >
, const std::string & > 
boost::program_options::ext_parser
 Augments basic_parsed_options<wchar_t> with conversion from 'parsed_options'. More...
 
typedef
basic_command_line_parser
< char > 
boost::program_options::command_line_parser
 
typedef
basic_command_line_parser
< wchar_t > 
boost::program_options::wcommand_line_parser
 

Enumerations

enum  boost::program_options::collect_unrecognized_mode {
  boost::program_options::include_positional,
  boost::program_options::exclude_positional
}
 Controls if the 'collect_unregistered' function should include positional options, or not. More...
 

Functions

template<class charT >
basic_parsed_options< charT > boost::program_options::parse_command_line (int argc, const charT *const argv[], const options_description &, int style=0, function1< std::pair< std::string, std::string >, const std::string & > ext=ext_parser())
 Creates instance of 'command_line_parser', passes parameters to it, and returns the result of calling the 'run' method. More...
 
template<class charT >
BOOST_PROGRAM_OPTIONS_DECL
basic_parsed_options< charT > 
boost::program_options::parse_config_file (std::basic_istream< charT > &, const options_description &, bool allow_unregistered=false)
 Parse a config file. More...
 
template<class charT >
BOOST_PROGRAM_OPTIONS_DECL
basic_parsed_options< charT > 
boost::program_options::parse_config_file (const char *filename, const options_description &, bool allow_unregistered=false)
 Parse a config file. More...
 
template<class charT >
std::vector< std::basic_string
< charT > > 
boost::program_options::collect_unrecognized (const std::vector< basic_option< charT > > &options, enum collect_unrecognized_mode mode)
 Collects the original tokens for all named options with 'unregistered' flag set. More...
 
BOOST_PROGRAM_OPTIONS_DECL
parsed_options 
boost::program_options::parse_environment (const options_description &, const function1< std::string, std::string > &name_mapper)
 Parse environment. More...
 
BOOST_PROGRAM_OPTIONS_DECL
parsed_options 
boost::program_options::parse_environment (const options_description &, const std::string &prefix)
 Parse environment. More...
 
BOOST_PROGRAM_OPTIONS_DECL
parsed_options 
boost::program_options::parse_environment (const options_description &, const char *prefix)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function exists to resolve ambiguity between the two above functions when second argument is of 'char*' type. More...
 
BOOST_PROGRAM_OPTIONS_DECL
std::vector< std::string > 
boost::program_options::split_unix (const std::string &cmdline, const std::string &seperator=" \t", const std::string &quote="'\"", const std::string &escape="\\")
 Splits a given string to a collection of single strings which can be passed to command_line_parser. More...
 
BOOST_PROGRAM_OPTIONS_DECL
std::vector< std::wstring > 
boost::program_options::split_unix (const std::wstring &cmdline, const std::wstring &seperator=L" \t", const std::wstring &quote=L"'\"", const std::wstring &escape=L"\\")