popt.h File Reference

Classes
struct	poptOption
struct	poptAlias

Macros
#define	POPT_OPTION_DEPTH   10
#define	POPT_ARG_NONE   0
#define	POPT_ARG_STRING   1
#define	POPT_ARG_INT   2
#define	POPT_ARG_LONG   3
#define	POPT_ARG_INCLUDE_TABLE   4 /* arg points to table */
#define	POPT_ARG_CALLBACK
#define	POPT_ARG_INTL_DOMAIN
#define	POPT_ARG_VAL   7 /* arg should take value val */
#define	POPT_ARG_MASK   0x0000FFFF
#define	POPT_ARGFLAG_ONEDASH   0x80000000 /* allow -longoption */
#define	POPT_ARGFLAG_DOC_HIDDEN   0x40000000 /* don't show in help/usage */
#define	POPT_ARGFLAG_STRIP   0x20000000 /* strip this arg from argv (only applies to long args) */
#define	POPT_CBFLAG_PRE   0x80000000 /* call the callback before parse */
#define	POPT_CBFLAG_POST   0x40000000 /* call the callback after parse */
#define	POPT_CBFLAG_INC_DATA
#define	POPT_ERROR_NOARG   -10
#define	POPT_ERROR_BADOPT   -11
#define	POPT_ERROR_OPTSTOODEEP   -13
#define	POPT_ERROR_BADQUOTE   -15 /* only from poptParseArgString() */
#define	POPT_ERROR_ERRNO   -16 /* only from poptParseArgString() */
#define	POPT_ERROR_BADNUMBER   -17
#define	POPT_ERROR_OVERFLOW   -18
#define	POPT_BADOPTION_NOALIAS   (1 << 0) /* don't go into an alias */
#define	POPT_CONTEXT_NO_EXEC   (1 << 0) /* ignore exec expansions */
#define	POPT_CONTEXT_KEEP_FIRST   (1 << 1) /* pay attention to argv[0] */
#define	POPT_CONTEXT_POSIXMEHARDER   (1 << 2) /* options can't follow args */
#define	POPT_AUTOHELP

Typedefs
typedef struct poptContext_s *	poptContext
typedef struct poptOption *	poptOption
typedef void(*	poptCallbackType) (poptContext con, enum poptCallbackReason reason, const struct poptOption *opt, const char *arg, const void *data)

Enumerations
enum	poptCallbackReason { POPT_CALLBACK_REASON_PRE , POPT_CALLBACK_REASON_POST , POPT_CALLBACK_REASON_OPTION }

Functions
poptContext	poptGetContext (const char *name, int argc, const char **argv, const struct poptOption *options, int flags)
void	poptResetContext (poptContext con)
int	poptGetNextOpt (poptContext con)
const char *	poptGetOptArg (poptContext con)
const char *	poptGetArg (poptContext con)
const char *	poptPeekArg (poptContext con)
const char **	poptGetArgs (poptContext con)
const char *	poptBadOption (poptContext con, int flags)
void	poptFreeContext (poptContext con)
int	poptStuffArgs (poptContext con, const char **argv)
int	poptAddAlias (poptContext con, struct poptAlias alias, int flags)
int	poptReadConfigFile (poptContext con, const char *fn)
int	poptReadDefaultConfig (poptContext con, int useEnv)
int	poptDupArgv (int argc, const char **argv, int *argcPtr, const char ***argvPtr)
int	poptParseArgvString (const char *s, int *argcPtr, const char ***argvPtr)
const char *	poptStrerror (const int error)
void	poptSetExecPath (poptContext con, const char *path, int allowAbsolute)
void	poptPrintHelp (poptContext con, FILE *f, int flags)
void	poptPrintUsage (poptContext con, FILE *f, int flags)
void	poptSetOtherOptionHelp (poptContext con, const char *text)
const char *	poptGetInvocationName (poptContext con)
int	poptStrippedArgv (poptContext con, int argc, char **argv)

Variables
struct poptOption	poptHelpOptions []

Macro Definition Documentation

POPT_ARG_CALLBACK

#define POPT_ARG_CALLBACK

Value:

             5  /* table-wide callback... must be
             set first in table; arg points 
             to callback, descrip points to 
             callback data to pass */

POPT_ARG_INCLUDE_TABLE

#define POPT_ARG_INCLUDE_TABLE   4 /* arg points to table */

POPT_ARG_INT

#define POPT_ARG_INT   2

POPT_ARG_INTL_DOMAIN

#define POPT_ARG_INTL_DOMAIN

Value:

             6       /* set the translation domain
             for this table and any
             included tables; arg points
             to the domain string */

POPT_ARG_LONG

#define POPT_ARG_LONG   3

POPT_ARG_MASK

#define POPT_ARG_MASK   0x0000FFFF

POPT_ARG_NONE

#define POPT_ARG_NONE   0

POPT_ARG_STRING

#define POPT_ARG_STRING   1

POPT_ARG_VAL

#define POPT_ARG_VAL   7 /* arg should take value val */

POPT_ARGFLAG_DOC_HIDDEN

#define POPT_ARGFLAG_DOC_HIDDEN   0x40000000 /* don't show in help/usage */

POPT_ARGFLAG_ONEDASH

#define POPT_ARGFLAG_ONEDASH   0x80000000 /* allow -longoption */

POPT_ARGFLAG_STRIP

#define POPT_ARGFLAG_STRIP   0x20000000 /* strip this arg from argv (only applies to long args) */

POPT_AUTOHELP

#define POPT_AUTOHELP

Value:

      { NULL, '\0', POPT_ARG_INCLUDE_TABLE, poptHelpOptions, \
      0, "Help options", NULL },

POPT_BADOPTION_NOALIAS

#define POPT_BADOPTION_NOALIAS   (1 << 0) /* don't go into an alias */

POPT_CBFLAG_INC_DATA

#define POPT_CBFLAG_INC_DATA

Value:

                 0x20000000  /* use data from the include line,
                 not the subtable */

POPT_CBFLAG_POST

#define POPT_CBFLAG_POST   0x40000000 /* call the callback after parse */

POPT_CBFLAG_PRE

#define POPT_CBFLAG_PRE   0x80000000 /* call the callback before parse */

POPT_CONTEXT_KEEP_FIRST

#define POPT_CONTEXT_KEEP_FIRST   (1 << 1) /* pay attention to argv[0] */

POPT_CONTEXT_NO_EXEC

#define POPT_CONTEXT_NO_EXEC   (1 << 0) /* ignore exec expansions */

POPT_CONTEXT_POSIXMEHARDER

#define POPT_CONTEXT_POSIXMEHARDER   (1 << 2) /* options can't follow args */

POPT_ERROR_BADNUMBER

#define POPT_ERROR_BADNUMBER   -17

POPT_ERROR_BADOPT

#define POPT_ERROR_BADOPT   -11

POPT_ERROR_BADQUOTE

#define POPT_ERROR_BADQUOTE   -15 /* only from poptParseArgString() */

POPT_ERROR_ERRNO

#define POPT_ERROR_ERRNO   -16 /* only from poptParseArgString() */

POPT_ERROR_NOARG

#define POPT_ERROR_NOARG   -10

POPT_ERROR_OPTSTOODEEP

#define POPT_ERROR_OPTSTOODEEP   -13

POPT_ERROR_OVERFLOW

#define POPT_ERROR_OVERFLOW   -18

POPT_OPTION_DEPTH

#define POPT_OPTION_DEPTH   10

Typedef Documentation

poptCallbackType

typedef void(* poptCallbackType) (poptContext con, enum poptCallbackReason reason, const struct poptOption *opt, const char *arg, const void *data)

poptContext

typedef struct poptContext_s* poptContext

poptOption

typedef struct poptOption* poptOption

Enumeration Type Documentation

poptCallbackReason

enum poptCallbackReason

Enumerator
POPT_CALLBACK_REASON_PRE
POPT_CALLBACK_REASON_POST
POPT_CALLBACK_REASON_OPTION

Function Documentation

poptAddAlias()

int poptAddAlias	(	poptContext	con,
		struct poptAlias	alias,
		int	flags
	)

References poptContext_s::aliases, poptAlias::argc, poptAlias::argv, poptAlias::longName, poptContext_s::numAliases, and poptAlias::shortName.

poptBadOption()

const char* poptBadOption	(	poptContext	con,
		int	flags
	)

References optionStackEntry::argv, flags, optionStackEntry::next, poptContext_s::optionStack, poptContext_s::os, and POPT_BADOPTION_NOALIAS.

poptDupArgv()

int poptDupArgv	(	int	argc,
		const char **	argv,
		int *	argcPtr,
		const char ***	argvPtr
	)

References POPT_ERROR_NOARG.

Referenced by handleAlias(), poptParseArgvString(), and poptStuffArgs().

poptFreeContext()

void poptFreeContext

(

poptContext

con

)

References poptContext_s::aliases, poptContext_s::appName, poptContext_s::arg_strip, optionStackEntry::argb, poptAlias::argv, poptContext_s::execPath, poptContext_s::execs, poptContext_s::finalArgv, poptContext_s::leftovers, poptAlias::longName, execEntry::longName, poptContext_s::numAliases, poptContext_s::numExecs, poptContext_s::os, poptContext_s::otherHelp, PBM_FREE, poptResetContext(), execEntry::script, and xfree.

Referenced by CACmdLnOptions::parse().

poptGetArg()

const char* poptGetArg

(

poptContext

con

)

References poptContext_s::leftovers, poptContext_s::nextLeftover, and poptContext_s::numLeftovers.

poptGetArgs()

const char** poptGetArgs

(

poptContext

con

)

References poptContext_s::leftovers, poptContext_s::nextLeftover, and poptContext_s::numLeftovers.

poptGetContext()

poptContext poptGetContext	(	const char *	name,
		int	argc,
		const char **	argv,
		const struct poptOption *	options,
		int	flags
	)

References poptContext_s::aliases, poptContext_s::appName, poptContext_s::arg_strip, optionStackEntry::argb, optionStackEntry::argc, optionStackEntry::argv, poptContext_s::execAbsolute, poptContext_s::execs, poptContext_s::finalArgv, poptContext_s::finalArgvAlloced, poptContext_s::flags, flags, invokeCallbacks(), poptContext_s::leftovers, optionStackEntry::next, poptContext_s::numAliases, poptContext_s::numExecs, poptContext_s::options, poptContext_s::optionStack, poptContext_s::os, POPT_CONTEXT_KEEP_FIRST, and POPT_CONTEXT_POSIXMEHARDER.

Referenced by CACmdLnOptions::parse().

poptGetInvocationName()

const char* poptGetInvocationName

(

poptContext

con

)

References optionStackEntry::argv, and poptContext_s::os.

poptGetNextOpt()

int poptGetNextOpt

(

poptContext

con

)

References alloca(), poptOption::arg, optionStackEntry::argb, optionStackEntry::argc, poptOption::argInfo, optionStackEntry::argv, cleanOSE(), expandNextArg(), poptContext_s::finalArgv, poptContext_s::finalArgvAlloced, poptContext_s::finalArgvCount, findOption(), poptContext_s::flags, handleAlias(), handleExec(), invokeCallbacks(), poptContext_s::leftovers, poptOption::longName, optionStackEntry::next, optionStackEntry::nextArg, optionStackEntry::nextCharArg, poptContext_s::numLeftovers, poptContext_s::options, poptContext_s::optionStack, poptContext_s::os, PBM_ISSET, POPT_, POPT_ARG_INT, POPT_ARG_LONG, POPT_ARG_MASK, POPT_ARG_NONE, POPT_ARG_STRING, POPT_ARG_VAL, POPT_ARGFLAG_STRIP, POPT_CALLBACK_REASON_OPTION, POPT_CONTEXT_POSIXMEHARDER, POPT_ERROR_BADNUMBER, POPT_ERROR_BADOPT, POPT_ERROR_NOARG, POPT_ERROR_OVERFLOW, poptStripArg(), poptContext_s::restLeftover, poptOption::shortName, poptOption::val, xfree, and xstrdup().

Referenced by CACmdLnOptions::parse().

poptGetOptArg()

const char* poptGetOptArg

(

poptContext

con

)

References optionStackEntry::nextArg, and poptContext_s::os.

poptParseArgvString()

int poptParseArgvString	(	const char *	s,
		int *	argcPtr,
		const char ***	argvPtr
	)

References alloca(), POPT_ARGV_ARRAY_GROW_DELTA, POPT_ERROR_BADQUOTE, and poptDupArgv().

poptPeekArg()

const char* poptPeekArg

(

poptContext

con

)

References poptContext_s::leftovers, poptContext_s::nextLeftover, and poptContext_s::numLeftovers.

poptPrintHelp()

void poptPrintHelp	(	poptContext	con,
		FILE *	f,
		int	flags
	)

References maxArgWidth(), poptContext_s::options, poptContext_s::otherHelp, POPT_, showHelpIntro(), and singleTableHelp().

Referenced by displayArgs().

poptPrintUsage()

void poptPrintUsage	(	poptContext	con,
		FILE *	f,
		int	flags
	)

References poptContext_s::options, poptContext_s::otherHelp, showHelpIntro(), showShortOptions(), and singleTableUsage().

Referenced by displayArgs().

poptReadConfigFile()

int poptReadConfigFile	(	poptContext	con,
		const char *	fn
	)

poptReadDefaultConfig()

int poptReadDefaultConfig	(	poptContext	con,
		int	useEnv
	)

poptResetContext()

void poptResetContext

(

poptContext

con

)

References poptContext_s::arg_strip, optionStackEntry::argb, cleanOSE(), optionStackEntry::currAlias, poptContext_s::doExec, poptContext_s::finalArgv, poptContext_s::finalArgvCount, optionStackEntry::next, optionStackEntry::nextArg, optionStackEntry::nextCharArg, poptContext_s::nextLeftover, poptContext_s::numLeftovers, poptContext_s::optionStack, poptContext_s::os, PBM_FREE, poptContext_s::restLeftover, and xfree.

Referenced by poptFreeContext().

poptSetExecPath()

void poptSetExecPath	(	poptContext	con,
		const char *	path,
		int	allowAbsolute
	)

References poptContext_s::execAbsolute, poptContext_s::execPath, xfree, and xstrdup().

poptSetOtherOptionHelp()

void poptSetOtherOptionHelp	(	poptContext	con,
		const char *	text
	)

References poptContext_s::otherHelp, xfree, and xstrdup().

poptStrerror()

const char* poptStrerror

(

const int

error

)

References POPT_, POPT_ERROR_BADNUMBER, POPT_ERROR_BADOPT, POPT_ERROR_BADQUOTE, POPT_ERROR_ERRNO, POPT_ERROR_NOARG, POPT_ERROR_OPTSTOODEEP, POPT_ERROR_OVERFLOW, and strerror().

poptStrippedArgv()

int poptStrippedArgv	(	poptContext	con,
		int	argc,
		char **	argv
	)

References poptContext_s::arg_strip, optionStackEntry::argc, optionStackEntry::argv, and PBM_ISSET.

poptStuffArgs()

int poptStuffArgs	(	poptContext	con,
		const char **	argv
	)

References optionStackEntry::argb, optionStackEntry::argc, optionStackEntry::argv, optionStackEntry::currAlias, optionStackEntry::next, optionStackEntry::nextArg, optionStackEntry::nextCharArg, poptContext_s::optionStack, poptContext_s::os, POPT_ERROR_OPTSTOODEEP, POPT_OPTION_DEPTH, poptDupArgv(), and optionStackEntry::stuffed.

Variable Documentation

poptHelpOptions

struct poptOption poptHelpOptions[]

extern

Referenced by getArgDescrip().