opt.h File Reference

#include "common.h"
#include "bu/defines.h"
#include "bu/ptbl.h"
#include "bu/vls.h"

Include dependency graph for opt.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	bu_opt_desc
	"Option description" structure. More...
struct	bu_opt_desc_opts

Macros
#define	BU_OPT_CHECK_ARGV0(_msg, _argc, _argv, _opt_name)
#define	BU_OPT_DESC_NULL   {NULL, NULL, NULL, NULL, NULL, NULL}
#define	BU_OPT(_desc, _so, _lo, _ahelp, _aprocess, _var, _help)
#define	BU_OPT_NULL(_desc)
#define	BU_OPT_DESC_OPTS_INIT_ZERO   { BU_OPT_ASCII, 2, 28, 50, NULL, NULL, NULL, 1, NULL, NULL }
#define	BRLCAD_MAN_SECTIONS   {'1', '3', '5', 'n', '\0'}

Typedefs
typedef int(*	bu_opt_arg_process_t) (struct bu_vls *msg, size_t argc, const char **argv, void *set_var)

Enumerations
enum	bu_opt_format_t { BU_OPT_ASCII , BU_OPT_DOCBOOK }

Functions
int	bu_opt_parse (struct bu_vls *msgs, size_t ac, const char **argv, const struct bu_opt_desc *ds)
char *	bu_opt_describe (const struct bu_opt_desc *ds, struct bu_opt_desc_opts *settings)
int	bu_opt_bool (struct bu_vls *msg, size_t argc, const char **argv, void *set_var)
int	bu_opt_int (struct bu_vls *msg, size_t argc, const char **argv, void *set_var)
int	bu_opt_long (struct bu_vls *msg, size_t argc, const char **argv, void *set_var)
int	bu_opt_long_hex (struct bu_vls *msg, size_t argc, const char **argv, void *set_var)
int	bu_opt_fastf_t (struct bu_vls *msg, size_t argc, const char **argv, void *set_var)
int	bu_opt_str (struct bu_vls *msg, size_t argc, const char **argv, void *set_var)
int	bu_opt_vls (struct bu_vls *msg, size_t argc, const char **argv, void *set_var)
int	bu_opt_color (struct bu_vls *msg, size_t argc, const char **argv, void *set_var)
int	bu_opt_vect_t (struct bu_vls *msg, size_t argc, const char **argv, void *set_var)
int	bu_opt_incr_long (struct bu_vls *msg, size_t argc, const char **argv, void *set_var)
int	bu_opt_lang (struct bu_vls *msg, size_t argc, const char **argv, void *set_var)
int	bu_opt_man_section (struct bu_vls *msg, size_t argc, const char **argv, void *set_var)

Macro Definition Documentation

BRLCAD_MAN_SECTIONS

#define BRLCAD_MAN_SECTIONS   {'1', '3', '5', 'n', '\0'}

Look for a valid man page section identifier (for BRL-CAD purposes valid choices are 1, 3, 5, n)

Definition at line 443 of file opt.h.

Function Documentation

bu_opt_incr_long()

int bu_opt_incr_long	(	struct bu_vls *	msg,
		size_t	argc,
		const char **	argv,
		void *	set_var
	)

Process 0 arguments, incrementing the value held by a long. This is useful for situations where multiple specifications of identical options are intended to change output, such as multiple -v options to increase verbosity.

bu_opt_lang()

int bu_opt_lang	(	struct bu_vls *	msg,
		size_t	argc,
		const char **	argv,
		void *	set_var
	)

Looking for a string that defines a language per ISO 639-1 language codes.

bu_opt_man_section()

int bu_opt_man_section	(	struct bu_vls *	msg,
		size_t	argc,
		const char **	argv,
		void *	set_var
	)