dx::parser::dispatch Struct Reference

one command: what it runs, how it reads in the help, and the commands nested under it. A word of parameter consumes the arguments that follow it before this one's own function runs, which is what makes the CLI hierarchical More...

#include <dx_parser.h>

Collaboration diagram for dx::parser::dispatch:

Public Member Functions
void	help_parameter () const
void	list_parameter () const
void	operator<< (args &args) const
std::string	usage () const
	the help with its required arguments marked <..>

Public Attributes
std::string	desc
	function description
struct {
bool   all:1{}
	forward all following paramters to the dispatch::function More...
uint8_t   required:3{}
	leading arguments the function needs: <..> in its usage More...
}	flags
std::function< void(args &)>	function
	function handler
std::string	help
	the function's arguments, its required ones first
std::map< std::deque< std::string >, dispatch >	parameter {}
	parameters

Detailed Description

one command: what it runs, how it reads in the help, and the commands nested under it. A word of parameter consumes the arguments that follow it before this one's own function runs, which is what makes the CLI hierarchical

Member Function Documentation

help_parameter()

void dx::parser::dispatch::help_parameter ( ) const

inline

list_parameter()

void dx::parser::dispatch::list_parameter ( ) const

inline

Here is the call graph for this function:

Here is the caller graph for this function:

operator<<()

void dx::parser::dispatch::operator<< ( args & args ) const

inline

Here is the call graph for this function:

usage()

std::string dx::parser::dispatch::usage ( ) const

inline

the help with its required arguments marked <..>

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

all

bool dx::parser::dispatch::all

forward all following paramters to the dispatch::function

desc

std::string dx::parser::dispatch::desc

function description

[struct]

struct { ... } dx::parser::dispatch::flags

function

std::function<void(args&)> dx::parser::dispatch::function

function handler

help

std::string dx::parser::dispatch::help

the function's arguments, its required ones first

parameter

std::map<std::deque<std::string>, dispatch> dx::parser::dispatch::parameter {}

parameters

required

uint8_t dx::parser::dispatch::required

leading arguments the function needs: <..> in its usage

---

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

• dx_parser.h