dxd - dynax driver framework 3.0.1d223
cross platform open source driver development framework
Loading...
Searching...
No Matches
dx::parser Class Reference

cmd line parser More...

#include <dx_parser.h>

Inheritance diagram for dx::parser:
Collaboration diagram for dx::parser:

Classes

struct  dispatch
 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...

Public Types

typedef std::deque< std::string > args

Public Member Functions

virtual void operator<< (args &args)
virtual void operator<< (const args &args)
 parser (const char *name, const decltype(dictionary)&dictionary={})
virtual void quiet (const args &={}) noexcept
virtual ~parser ()=default

Protected Member Functions

virtual bool head () const noexcept
virtual void help (args &args)
virtual void help_head () const noexcept
virtual void indent (args &args)
virtual void no_args (const args &args)
auto select (const std::string &id)
virtual void version (const args &args={})

Protected Attributes

std::map< std::deque< std::string >, dispatch > dictionary
const char * name {}
struct { 
   struct { 
      bool   ignore 
   }   error
   struct { 
      union { 
         struct { 
            bool   err:1 
            bool   log:1 
            bool   out:1 
         } 
         uint32_t   mask 
      } 
   }   log
   bool   quiet 
} parameter

Detailed Description

cmd line parser

Member Typedef Documentation

◆ args

typedef std::deque<std::string> dx::parser::args

Constructor & Destructor Documentation

◆ parser()

dx::parser::parser ( const char * name,
const decltype(dictionary)& dictionary = {} )
inline
Here is the caller graph for this function:

◆ ~parser()

virtual dx::parser::~parser ( )
virtualdefault
Here is the call graph for this function:

Member Function Documentation

◆ head()

virtual bool dx::parser::head ( ) const
inlineprotectedvirtualnoexcept

Reimplemented in dx::service::parser, and dx::test::driver< super_device_t, device_t, driver_t >.

Here is the caller graph for this function:

◆ help()

virtual void dx::parser::help ( args & args)
inlineprotectedvirtual
Here is the call graph for this function:
Here is the caller graph for this function:

◆ help_head()

virtual void dx::parser::help_head ( ) const
inlineprotectedvirtualnoexcept

Reimplemented in dx::select< parsers_t >, and dx::test::driver< super_device_t, device_t, driver_t >.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ indent()

virtual void dx::parser::indent ( args & args)
inlineprotectedvirtual
Here is the call graph for this function:
Here is the caller graph for this function:

◆ no_args()

virtual void dx::parser::no_args ( const args & args)
inlineprotectedvirtual
Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator<<() [1/2]

virtual void dx::parser::operator<< ( args & args)
inlinevirtual

Reimplemented in dx::select< parsers_t >, and dx::test::driver< super_device_t, device_t, driver_t >.

Here is the call graph for this function:

◆ operator<<() [2/2]

virtual void dx::parser::operator<< ( const args & args)
inlinevirtual
Here is the caller graph for this function:

◆ quiet()

virtual void dx::parser::quiet ( const args & = {})
inlinevirtualnoexcept

◆ select()

auto dx::parser::select ( const std::string & id)
inlineprotected
Here is the call graph for this function:
Here is the caller graph for this function:

◆ version()

virtual void dx::parser::version ( const args & args = {})
inlineprotectedvirtual
Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ dictionary

std::map<std::deque<std::string>, dispatch> dx::parser::dictionary
protected
Initial value:
{
{{"--continue", "--no-error", "--ignore", "--ignore-error"},
{[this](args& args){parameter.error.ignore= true; no_args(args);}, "ignore errors and continue"}},
{{"--indent", "--tab"}, {std::bind(&parser::indent, this, std::placeholders::_1), "set/get indention width and pattern", "[width [pattern]]", {},{
{{"err", "stderr"}, {[this](args&){this->parameter.log.err= true;}, "select std error"}},
{{"log", "stdlog"}, {[this](args&){this->parameter.log.log= true;}, "select std log"}},
{{"out", "stdout"}, {[this](args&){this->parameter.log.out= true;}, "select std out"}},
}}},
{{"--quiet", "-q"}, {std::bind(&parser::quiet, this, std::placeholders::_1), "quiet!"}},
{{"--version", "-v"}, {std::bind(&parser::version, this, std::placeholders::_1), std::string{"display "}+ name+ " version"}},
}
virtual void indent(args &args)
Definition dx_parser.h:235
virtual void no_args(const args &args)
Definition dx_parser.h:228
const char * name
Definition dx_parser.h:64
bool quiet
Definition dx_parser.h:66
std::deque< std::string > args
Definition dx_parser.h:60
struct dx::parser::@046247176025362246310022157273031025265032273157 parameter
virtual void version(const args &args={})
Definition dx_parser.h:261

◆ err

bool dx::parser::err

◆ [struct]

struct { ... } dx::parser::error

◆ ignore

bool dx::parser::ignore

◆ [struct] [1/2]

struct { ... } dx::parser::log

◆ log [2/2]

bool dx::parser::log

◆ mask

uint32_t dx::parser::mask

◆ name

const char* dx::parser::name {}
protected

◆ out

bool dx::parser::out

◆ [struct]

struct { ... } dx::parser::parameter

◆ quiet

bool dx::parser::quiet

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

(c) copyright 2009 dynamic acoustics e.U. generated on

a closed source license may be obtained by requesting a written permission from dynamic acoustics e.U.
however - governmental use generally and military use especially is strictly prohibited though.