caps_arg_parser Struct Reference

Data Fields
size_t	parameter_cnt
const struct caps_arg_parameter *	parameter_list
void *	object
const char *	header
const char *	footer
const char *	domain

Detailed Description

Frame information about one parser

While the most information herein is static/const, the object member is special. It is intended for run-time to carry some kind of pointer where the keyword callback functions should store their data.

When generating the help text output, the header text will be printed on top of the parameter list and the footer text below the parameter list. The domain member can provide the translation domain in order to show the help text of this parser in a local language. For autotools based build systems, you can use the PACKAGE macro to initialize the domain member. If you want to make use of NLS, don't forget to include your texts into the pot file.

Field Documentation

parameter_cnt

size_t parameter_cnt

Count of entries in parameter_list

parameter_list

const struct caps_arg_parameter* parameter_list

Array of parameters this parser will deal with

object

void* object

Private data used in the callbacks

header

const char* header

Header description of this parser's parameters (help text).

Note

Mark for NLS

footer

const char* footer

Footer description of this parser's parameters (help text).

Note

Mark for NLS

domain

const char* domain

NLS domain for this parser (on demand)

---

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

• libcapsbase/src/libcapscmdparser.h