_cqpoption Struct Reference

A CQPOption represents a single configuration option for CQP. More...

#include <options.h>

Data Fields
char *	opt_abbrev
	Short version of this option's name. More...
char *	opt_name
	Name of this option as referred to in the interactive control syntax. More...
OptType	type
	Data type of this configuration option. More...
void *	address
	Pointer to the actual variable that contains this config option. More...
char *	cdefault
	Default value fo rthis option (string value) More...
int	idefault
	Default value fo rthis option (integer value) More...
char *	envvar
	The environment variable from which CQP will take a value for this option. More...
int	side_effect
	Ref number of the side effect that changing this option has. More...
int	flags
	Flags for this option: can include PUBLIC, CQP. More...

Detailed Description

A CQPOption represents a single configuration option for CQP.

It does not actually contain the config-option itself; that is held as a global variable somewhere. Instead, it holds metadata about the config-option, including a pointer to the actual variable.

Note it's possible to have wo CQPOption objects referring to the same actual variable - in this case the two option names in question would be synonymous.

Field Documentation

void* address

Pointer to the actual variable that contains this config option.

char* cdefault

Default value fo rthis option (string value)

char* envvar

The environment variable from which CQP will take a value for this option.

int flags

Flags for this option: can include PUBLIC, CQP.

int idefault

Default value fo rthis option (integer value)

Referenced by parse_options(), and set_default_option_values().

char* opt_abbrev

Short version of this option's name.

char* opt_name

Name of this option as referred to in the interactive control syntax.

Referenced by find_option(), print_option_values(), and set_default_option_values().

int side_effect

Ref number of the side effect that changing this option has.

See also

execute_side_effects

OptType type

Data type of this configuration option.

---

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

• cqp/options.h