argagg
 All Classes Namespaces Files Functions Variables Macros Pages
Public Member Functions | Public Attributes | List of all members
argagg::parser Struct Reference

A list of option definitions used to inform how to parse arguments. More...

#include <argagg.hpp>

Public Member Functions

parser_results parse (int argc, const char **argv) const
 Parses the provided command line arguments and returns the results as parser_results. More...
 
parser_results parse (int argc, char **argv) const
 Through strict interpretation of pointer casting rules, despite this being a safe operation, C++ doesn't allow implicit casts from char** to const char** so here's an overload that performs a const_cast, which is typically frowned upon but is safe here. More...
 

Public Attributes

std::vector< definitiondefinitions
 Vector of the option definitions which inform this parser how to parse the command line arguments. More...
 

Detailed Description

A list of option definitions used to inform how to parse arguments.

Definition at line 536 of file argagg.hpp.

Member Function Documentation

parser_results argagg::parser::parse ( int  argc,
const char **  argv 
) const
inline

Parses the provided command line arguments and returns the results as parser_results.

Note
This method is not thread-safe and assumes that no modifications are made to the definitions member field during the extent of this method call.

Definition at line 1061 of file argagg.hpp.

parser_results argagg::parser::parse ( int  argc,
char **  argv 
) const
inline

Through strict interpretation of pointer casting rules, despite this being a safe operation, C++ doesn't allow implicit casts from char** to const char** so here's an overload that performs a const_cast, which is typically frowned upon but is safe here.

Definition at line 1291 of file argagg.hpp.

Member Data Documentation

std::vector<definition> argagg::parser::definitions

Vector of the option definitions which inform this parser how to parse the command line arguments.

Definition at line 543 of file argagg.hpp.


The documentation for this struct was generated from the following file: