argpar

#include <argpar.h>

Collaboration diagram for argpar:

Public Attributes
const argpar_option *	options
argpar_parser	parser
const char *	args_doc
const char *	doc
const argpar_child *	children
help_filter	help_filter
unsigned	parfile_buffer_count
char **	parfile_buffer

Detailed Description

Master structure containing options, document strings, child parsers, and text filters. Everything needed to parse options and arguments and print help documentation.

Definition at line 398 of file argpar.h.

Member Data Documentation

args_doc

const char* args_doc

A string defining the desired arguments to the program, printed as part of the usage documentation.

Definition at line 406 of file argpar.h.

children

const argpar_child* children

Array of argpar_child structures containing parsers to nest within this one. All options and arguments are passed to parent parsers first, then to children in the order in which they're listed.

Definition at line 413 of file argpar.h.

doc

const char* doc

A string printed before and/or after the options. To display text after options, use a vertical-tab (\v) to separate the text.

Definition at line 409 of file argpar.h.

help_filter

help_filter help_filter

A function passed all documentation to print.

Definition at line 415 of file argpar.h.

options

const argpar_option* options

Array of option structures, terminated by an empty entry (IE: {0}).

Definition at line 400 of file argpar.h.

parfile_buffer

char** parfile_buffer

Used internally to store the parfiles. Initialize to NULL.

Definition at line 419 of file argpar.h.

parfile_buffer_count

unsigned parfile_buffer_count

Used internally to store the number of parfiles parsed. Initialize to zero.

Definition at line 417 of file argpar.h.

parser

argpar_parser parser

Parser function handed all options and arguments, as well as various ARGPAR_KEY_ keys for events such as initialization, successful parsing, etc.

Definition at line 403 of file argpar.h.

---

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

• /gfs-oceanweb/web/ocssw/ocssw_src/oel_util/libgenutils/argpar.h