popt.c File Reference

#include "system.h"
#include <math.h>
#include "findme.h"
#include "poptint.h"

Include dependency graph for popt.c:

Defines
#define	_ABS(a) ((((a) - 0.0) < DBL_EPSILON) ? -(a) : (a))
Functions
static char *	strerror (int errno)
void	poptSetExecPath (poptContext con, const char *path, int allowAbsolute)
	Limit search for executables.
static void	invokeCallbacksPRE (poptContext con, const struct poptOption *opt)
static void	invokeCallbacksPOST (poptContext con, const struct poptOption *opt)
static void	invokeCallbacksOPTION (poptContext con, const struct poptOption opt, const struct poptOption myOpt, const void *myData, int shorty)
poptContext	poptGetContext (const char name, int argc, const char argv, const struct poptOption options, unsigned int flags)
	Initialize popt context.
static void	cleanOSE (struct optionStackEntry *os)
void	poptResetContext (poptContext con)
	Reinitialize popt context.
static int	handleExec (poptContext con, const char *longName, char shortName)
static int	handleAlias (poptContext con, const char longName, char shortName, const char nextCharArg)
static int	execCommand (poptContext con)
static struct poptOption *	findOption (const struct poptOption opt, const char longName, int longNameLen, char shortName, poptCallbackType callback, const void *callbackData, int singleDash)
static const char *	findNextArg (poptContext con, unsigned argx, int delete_arg)
static const char *	expandNextArg (poptContext con, const char *s)
static void	poptStripArg (poptContext con, int which)
int	poptSaveLong (long *arg, unsigned int argInfo, long aLong)
	Save a long, performing logical operation with value.
int	poptSaveInt (int *arg, unsigned int argInfo, long aLong)
	Save an integer, performing logical operation with value.
int	poptGetNextOpt (poptContext con)
	Return value of next option found.
char *	poptGetOptArg (poptContext con)
	Return next option argument (if any).
const char *	poptGetArg (poptContext con)
	Return next argument.
const char *	poptPeekArg (poptContext con)
	Peek at current argument.
const char **	poptGetArgs (poptContext con)
	Return remaining arguments.
poptContext	poptFreeContext (poptContext con)
	Destroy context.
int	poptAddAlias (poptContext con, struct poptAlias alias, int flags)
	Add alias to context.
int	poptAddItem (poptContext con, poptItem newItem, int flags)
	Add alias/exec item to context.
const char *	poptBadOption (poptContext con, unsigned int flags)
	Return the option which caused the most recent error.
const char *	poptStrerror (const int error)
	Return formatted error string for popt failure.
int	poptStuffArgs (poptContext con, const char **argv)
	Add arguments to context.
const char *	poptGetInvocationName (poptContext con)
	Return argv[0] from context.
int	poptStrippedArgv (poptContext con, int argc, char **argv)
	Shuffle argv pointers to remove stripped args, returns new argc.
Variables
static unsigned int	seed = 0

Define Documentation

#define _ABS ( a ) ((((a) - 0.0) < DBL_EPSILON) ? -(a) : (a))

Referenced by poptGetNextOpt().

Function Documentation

static void cleanOSE ( struct optionStackEntry * os ) [static]

Definition at line 209 of file popt.c.

References _free(), optionStackEntry::argb, optionStackEntry::argv, optionStackEntry::nextArg, and PBM_FREE.

Referenced by poptGetNextOpt(), and poptResetContext().

static int execCommand ( poptContext con ) [static]

Definition at line 362 of file popt.c.

References poptItem_s::argc, poptItem_s::argv, poptContext_s::doExec, poptContext_s::execAbsolute, poptContext_s::execPath, poptContext_s::finalArgv, poptContext_s::finalArgvCount, poptContext_s::leftovers, poptContext_s::numLeftovers, POPT_ERROR_ERRNO, POPT_ERROR_MALLOC, POPT_ERROR_NOARG, and POPT_findProgramPath().

Referenced by poptGetNextOpt().

static const char* expandNextArg	(	poptContext	con,
		const char *	s
	)			`[static]`

Definition at line 569 of file popt.c.

References findNextArg().

Referenced by poptGetNextOpt().

static const char* findNextArg	(	poptContext	con,
		unsigned	argx,
		int	delete_arg
	)			`[static]`

Definition at line 531 of file popt.c.

References optionStackEntry::argb, optionStackEntry::argc, optionStackEntry::argv, optionStackEntry::next, poptContext_s::optionStack, poptContext_s::os, PBM_ALLOC, PBM_ISSET, and PBM_SET.

Referenced by expandNextArg().

static struct poptOption* findOption	(	const struct poptOption *	opt,
		const char *	longName,
		int	longNameLen,
		char	shortName,
		poptCallbackType *	callback,
		const void **	callbackData,
		int	singleDash
	)			`[static, read]`

Definition at line 463 of file popt.c.

References poptOption::arg, poptOption::argInfo, poptOption::descrip, poptOption::longName, POPT_ARG_CALLBACK, POPT_ARG_INCLUDE_TABLE, POPT_ARG_MASK, POPT_ARGFLAG_ONEDASH, POPT_CBFLAG_INC_DATA, poptHelpOptions, poptHelpOptionsI18N, and poptOption::shortName.

Referenced by poptGetNextOpt().

static int handleAlias	(	poptContext	con,
		const char *	longName,
		char	shortName,
		const char *	nextCharArg
	)			`[static]`

static int handleExec	(	poptContext	con,
		const char *	longName,
		char	shortName
	)			`[static]`

Definition at line 253 of file popt.c.

References poptContext_s::doExec, poptContext_s::execs, poptContext_s::finalArgv, poptContext_s::finalArgvAlloced, poptContext_s::finalArgvCount, poptContext_s::flags, poptOption::longName, poptContext_s::numExecs, poptItem_s::option, POPT_CONTEXT_NO_EXEC, and poptOption::shortName.

Referenced by poptGetNextOpt().

static void invokeCallbacksOPTION	(	poptContext	con,
		const struct poptOption *	opt,
		const struct poptOption *	myOpt,
		const void *	myData,
		int	shorty
	)			`[static]`

Definition at line 116 of file popt.c.

References poptOption::arg, poptOption::argInfo, poptOption::descrip, poptOption::longName, optionStackEntry::nextArg, poptContext_s::os, POPT_ARG_CALLBACK, POPT_ARG_INCLUDE_TABLE, POPT_ARG_MASK, POPT_CALLBACK_REASON_OPTION, POPT_CBFLAG_CONTINUE, POPT_CBFLAG_SKIPOPTION, poptHelpOptions, poptHelpOptionsI18N, and poptOption::shortName.

Referenced by poptGetNextOpt().

static void invokeCallbacksPOST	(	poptContext	con,
		const struct poptOption *	opt
	)			`[static]`

Definition at line 90 of file popt.c.

References poptOption::arg, poptOption::argInfo, poptOption::descrip, poptOption::longName, POPT_ARG_CALLBACK, POPT_ARG_INCLUDE_TABLE, POPT_ARG_MASK, POPT_CALLBACK_REASON_POST, POPT_CBFLAG_POST, poptHelpOptions, poptHelpOptionsI18N, and poptOption::shortName.

Referenced by poptGetNextOpt().

static void invokeCallbacksPRE	(	poptContext	con,
		const struct poptOption *	opt
	)			`[static]`

Definition at line 64 of file popt.c.

References poptOption::arg, poptOption::argInfo, poptOption::descrip, poptOption::longName, POPT_ARG_CALLBACK, POPT_ARG_INCLUDE_TABLE, POPT_ARG_MASK, POPT_CALLBACK_REASON_PRE, POPT_CBFLAG_PRE, poptHelpOptions, poptHelpOptionsI18N, and poptOption::shortName.

Referenced by poptGetContext().

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

Add alias to context.

Todo:: Pass alias by reference, not value.

Deprecated:: Use poptAddItem instead.

Parameters:

	con	context
	alias	alias to add
	flags	(unused)

Returns:: 0 on success

Definition at line 1112 of file popt.c.

References poptAlias::argc, poptAlias::argv, poptAlias::longName, POPT_ARGFLAG_DOC_HIDDEN, poptAddItem(), and poptAlias::shortName.

int poptAddItem	(	poptContext	con,
		poptItem	newItem,
		int	flags
	)

Add alias/exec item to context.

Parameters:

	con	context
	newItem	alias/exec item to add
	flags	0 for alias, 1 for exec

Returns:: 0 on success

Definition at line 1130 of file popt.c.

References poptContext_s::aliases, poptOption::arg, poptItem_s::argc, poptOption::argDescrip, poptOption::argInfo, poptItem_s::argv, poptOption::descrip, poptContext_s::execs, poptOption::longName, poptContext_s::numAliases, poptContext_s::numExecs, poptItem_s::option, poptOption::shortName, poptOption::val, and xstrdup.

Referenced by configLine(), and poptAddAlias().

const char* poptBadOption	(	poptContext	con,
		unsigned int	flags
	)

Return the option which caused the most recent error.

Parameters:

	con	context
	flags

Returns:: offending option

Definition at line 1173 of file popt.c.

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

poptContext poptFreeContext ( poptContext con )

Destroy context.

Parameters:

con

context

Returns:: NULL always

Definition at line 1068 of file popt.c.

References _free(), poptContext_s::aliases, poptContext_s::appName, poptContext_s::arg_strip, optionStackEntry::argb, poptOption::argDescrip, poptItem_s::argv, poptOption::descrip, poptContext_s::execPath, poptContext_s::execs, poptContext_s::finalArgv, poptContext_s::leftovers, poptOption::longName, poptContext_s::numAliases, poptContext_s::numExecs, poptItem_s::option, poptContext_s::os, poptContext_s::otherHelp, PBM_FREE, and poptResetContext().

Referenced by displayArgs().

const char* poptGetArg ( poptContext con )

Return next argument.

Parameters:

con

context

Returns:: next argument, NULL if no argument is available

Definition at line 1038 of file popt.c.

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

const char** poptGetArgs ( poptContext con )

Return remaining arguments.

Parameters:

con

context

Returns:: argument array, NULL terminated

Definition at line 1054 of file popt.c.

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

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

Initialize popt context.

Parameters:

	name	context name (usually argv[0] program name)
	argc	no. of arguments
	argv	argument array
	options	address of popt option table
	flags	or'd POPT_CONTEXT_* bits