option_info Union Reference

Instructions for registering an option, and storage for the option itself. More...

#include <options.h>

Collaboration diagram for option_info:

Data Fields
struct option_init	init
	How to initialize and register option.
struct option	option
	register_options() constructs the option here, based on the instructions in init.

Related Symbols
(Note that these are not member symbols.)
void	register_options (union option_info info[], struct option *tree)
void	unregister_options (union option_info info[], struct option *tree)
#define	NULL_OPTION_INFO
#define	INIT_OPT_BOOL(path, capt, name, flags, def, desc)
#define	INIT_OPT_INT(path, capt, name, flags, min, max, def, desc)
#define	INIT_OPT_LONG(path, capt, name, flags, min, max, def, desc)
#define	INIT_OPT_STRING(path, capt, name, flags, def, desc)
#define	INIT_OPT_CODEPAGE(path, capt, name, flags, def, desc)
#define	INIT_OPT_COLOR(path, capt, name, flags, def, desc)
#define	INIT_OPT_LANGUAGE(path, capt, name, flags, desc)
#define	INIT_OPT_COMMAND(path, capt, name, flags, cmd, desc)
#define	INIT_OPT_CMDALIAS(path, capt, name, flags, def, desc)
#define	INIT_OPT_ALIAS(path, name, flags, def)
#define	INIT_OPT_TREE(path, capt, name, flags, desc)

Detailed Description

Instructions for registering an option, and storage for the option itself.

Friends And Related Symbol Documentation

INIT_OPT_ALIAS

#define INIT_OPT_ALIAS (   path,   name,   flags,   def  )

related

Value:

   {{ path, name, NULL, NULL, flags, \
      OPT_ALIAS, 0, sizeof(def) - 1,  0, def, NULL }}

INIT_OPT_BOOL

#define INIT_OPT_BOOL (   path,   capt,   name,   flags,   def,   desc  )

related

Value:

   {{ path, name, capt, DESC(desc), flags, \
      OPT_BOOL, 0, 1,  def, NULL, NULL }}

INIT_OPT_CMDALIAS

#define INIT_OPT_CMDALIAS (   path,   capt,   name,   flags,   def,   desc  )

related

Value:

   {{ path, name, capt, DESC(desc), flags, \
      OPT_ALIAS, 0, sizeof(def) - 1,  0, def, NULL }}

INIT_OPT_CODEPAGE

#define INIT_OPT_CODEPAGE (   path,   capt,   name,   flags,   def,   desc  )

related

Value:

   {{ path, name, capt, DESC(desc), flags, \
      OPT_CODEPAGE, 0, 0,  0, def, NULL }}

INIT_OPT_COLOR

#define INIT_OPT_COLOR (   path,   capt,   name,   flags,   def,   desc  )

related

Value:

   {{ path, name, capt, DESC(desc), flags, \
      OPT_COLOR, 0, 0,  0, def, NULL }}

INIT_OPT_COMMAND

#define INIT_OPT_COMMAND (   path,   capt,   name,   flags,   cmd,   desc  )

related

Value:

   {{ path, name, capt, DESC(desc), flags, \
      OPT_COMMAND, 0, 0,  0, NULL, cmd }}

INIT_OPT_INT

#define INIT_OPT_INT (   path,   capt,   name,   flags,   min,   max,   def,   desc  )

related

Value:

   {{ path, name, capt, DESC(desc), flags, \
      OPT_INT, min, max,  def, NULL, NULL }}

INIT_OPT_LANGUAGE

#define INIT_OPT_LANGUAGE (   path,   capt,   name,   flags,   desc  )

related

Value:

   {{ path, name, capt, DESC(desc), flags, \
      OPT_LANGUAGE, 0, 0,  0, NULL, NULL }}

INIT_OPT_LONG

#define INIT_OPT_LONG (   path,   capt,   name,   flags,   min,   max,   def,   desc  )

related

Value:

   {{ path, name, capt, DESC(desc), flags, \
      OPT_LONG, min, max,  def, NULL, NULL }}

INIT_OPT_STRING

#define INIT_OPT_STRING (   path,   capt,   name,   flags,   def,   desc  )

related

Value:

   {{ path, name, capt, DESC(desc), flags, \
      OPT_STRING, 0, MAX_STR_LEN,  0, def, NULL }}

INIT_OPT_TREE

#define INIT_OPT_TREE (   path,   capt,   name,   flags,   desc  )

related

Value:

   {{ path, name, capt, DESC(desc), flags, \
      OPT_TREE, 0, 0,  0, NULL, NULL }}

NULL_OPTION_INFO

#define NULL_OPTION_INFO

related

Value:

   {{ NULL, NULL, NULL, NULL, OPT_ZERO, \
      OPT_BOOL, 0, 0,  0, NULL, NULL }}

register_options()

void register_options ( union option_info  info[], struct option *  tree  )

related

unregister_options()

void unregister_options ( union option_info  info[], struct option *  tree  )

related

Field Documentation

init

struct option_init option_info::init

How to initialize and register option.

This must be the first member of the union, to let C89 compilers initialize it.

option

struct option option_info::option

register_options() constructs the option here, based on the instructions in init.

By doing so, it of course overwrites init. Thus, only option can be used afterwards.

---

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

• config/options.h
• config/options.c