FireSTARR
Loading...
Searching...
No Matches
fs::settings::MainArgumentParser Class Reference
Inheritance diagram for fs::settings::MainArgumentParser:
Collaboration diagram for fs::settings::MainArgumentParser:

Public Member Functions

 MainArgumentParser (const int argc, const char *const argv[])
 
Settings & parse_args () override
 Parse arguments that were given to constructor.
 
- Public Member Functions inherited from fs::settings::SettingsArgumentParser
Settings & parse_args () override
 Parse arguments that were given to constructor.
 
 ArgumentParser (const vector< Usage > usages, const vector< string > arguments, const PositionalArgumentsRequired require_positional)
 
 ArgumentParser (const vector< Usage > usages, const vector< string > arguments, const string binary_directory, const string binary_name, const PositionalArgumentsRequired require_positional)
 
 ArgumentParser (const Usage usage, const int argc, const char *const argv[], const PositionalArgumentsRequired require_positional=PositionalArgumentsRequired::Required)
 
 ArgumentParser (const vector< Usage > usages, const int argc, const char *const argv[], const PositionalArgumentsRequired require_positional=PositionalArgumentsRequired::Required)
 
 ArgumentParser (const ArgumentParser &rhs)=delete
 
 ArgumentParser (ArgumentParser &rhs)=delete
 
 ArgumentParser (const vector< Usage > usages, const vector< string > arguments, const pair< string, string > binary, const PositionalArgumentsRequired require_positional)
 
- Public Member Functions inherited from fs::settings::ArgumentParser
 ArgumentParser (const vector< Usage > usages, const vector< string > arguments, const PositionalArgumentsRequired require_positional)
 
 ArgumentParser (const vector< Usage > usages, const vector< string > arguments, const string binary_directory, const string binary_name, const PositionalArgumentsRequired require_positional)
 
 ArgumentParser (const Usage usage, const int argc, const char *const argv[], const PositionalArgumentsRequired require_positional=PositionalArgumentsRequired::Required)
 
 ArgumentParser (const vector< Usage > usages, const int argc, const char *const argv[], const PositionalArgumentsRequired require_positional=PositionalArgumentsRequired::Required)
 
 ArgumentParser (const ArgumentParser &rhs)=delete
 
 ArgumentParser (ArgumentParser &rhs)=delete
 
ArgumentParser & operator= (const ArgumentParser &rhs)=delete
 
ArgumentParser & operator= (ArgumentParser &rhs)=delete
 
string cur_arg ()
 Indicate positional arguments should all be used by now and error if not.
 
string get_args ()
 
string get_arg () noexcept
 
bool help_requested ()
 
void mark_parsed (const string arg)
 
bool was_parsed (const string arg)
 
string format_args ()
 
void show_args ()
 
void log_args ()
 
void show_usage_and_exit (int exit_code)
 
void show_usage_and_exit ()
 
void show_help_and_exit ()
 
size_t argc () const
 

Additional Inherited Members

- Protected Member Functions inherited from fs::settings::ArgumentParser
 ArgumentParser (const vector< Usage > usages, const vector< string > arguments, const pair< string, string > binary, const PositionalArgumentsRequired require_positional)
 
bool has_positional () const
 If any more positional arguments are available.
 
string get_positional ()
 Get next positional argument.
 
void done_positional ()
 
vector< string > & args_expanded ()
 
- Protected Attributes inherited from fs::settings::ArgumentParser
size_t cur_arg_ {0}
 
size_t skipped_args_ {0}
 
vector< string > arguments_ {}
 
vector< string > arguments_expanded_ {}
 
string binary_directory_ {}
 
string binary_name_ {}
 

Member Function Documentation

◆ parse_args()

Settings & fs::settings::MainArgumentParser::parse_args ( )
overridevirtual

Parse arguments that were given to constructor.

Returns
string Positional arguments

Reimplemented from fs::settings::ArgumentParser.

Here is the call graph for this function:

The documentation for this class was generated from the following files: