popt.c File Reference

#include "system.h"
#include <math.h>
#include "poptint.h"
Include dependency graph for popt.c:

Go to the source code of this file.

Defines

#define LLONG_MAX   9223372036854775807LL
#define LLONG_MIN   (-LLONG_MAX - 1LL)
#define DBL_EPSILON   2.2204460492503131e-16
#define POPT_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, size_t longNameLen, char shortName, const char *nextArg)
static const char * findProgramPath (const char *argv0)
 Return absolute path to executable by searching PATH.
static int execCommand (poptContext con)
static struct poptOption * findOption (const struct poptOption *opt, const char *longName, size_t 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 poptSaveString (const char ***argvp, UNUSED(unsigned int argInfo), const char *val)
int poptSaveLongLong (long long *arg, unsigned int argInfo, long long aLongLong)
 Save a long long, performing logical operation with value.
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.
static poptItem poptFreeItems (poptItem items, int nitems)
poptContext poptFreeContext (poptContext con)
 Destroy context.
int poptAddAlias (poptContext con, struct poptAlias alias, UNUSED(int flags))
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 DBL_EPSILON   2.2204460492503131e-16

Referenced by poptGetNextOpt().

#define LLONG_MAX   9223372036854775807LL

Referenced by poptGetNextOpt().

#define LLONG_MIN   (-LLONG_MAX - 1LL)

Referenced by poptGetNextOpt().

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

Referenced by poptGetNextOpt().

Function Documentation

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

Definition at line 206 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 436 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, findProgramPath(), poptContext_s::leftovers, poptContext_s::numLeftovers, POPT_ERROR_ERRNO, POPT_ERROR_MALLOC, POPT_ERROR_NOARG, and stpcpy().

Referenced by poptGetNextOpt().

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

Definition at line 638 of file popt.c.

References findNextArg(), and stpcpy().

Referenced by poptGetNextOpt().

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

Definition at line 600 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,
size_t  longNameLen,
char  shortName,
poptCallbackType *  callback,
const void **  callbackData,
int  singleDash 
) [static, read]

Definition at line 538 of file popt.c.

References poptOption::arg, poptArg_u::cb, CBF_ISSET, poptOption::descrip, F_ISSET, poptOption::longName, poptArg_u::opt, POPT_ARG_CALLBACK, POPT_ARG_INCLUDE_TABLE, poptArgType, poptSubstituteHelpI18N, poptArg_u::ptr, and poptOption::shortName.

Referenced by poptGetNextOpt().

static const char* findProgramPath ( const char *  argv0  )  [static]

Return absolute path to executable by searching PATH.

Parameters:
argv0 name of executable
Returns:
(malloc'd) absolute path to executable (or NULL)

Definition at line 391 of file popt.c.

References stpcpy(), and xstrdup.

Referenced by execCommand().

static int handleAlias ( poptContext  con,
const char *  longName,
size_t  longNameLen,
char  shortName,
const char *  nextArg 
) [static]

Definition at line 309 of file popt.c.

References poptContext_s::aliases, optionStackEntry::argb, optionStackEntry::argc, poptItem_s::argc, optionStackEntry::argv, poptItem_s::argv, optionStackEntry::currAlias, poptOption::longName, optionStackEntry::next, optionStackEntry::nextArg, optionStackEntry::nextCharArg, poptContext_s::numAliases, poptItem_s::option, poptContext_s::optionStack, poptContext_s::os, POPT_ERROR_OPTSTOODEEP, POPT_OPTION_DEPTH, poptDupArgv(), poptOption::shortName, and optionStackEntry::stuffed.

Referenced by poptGetNextOpt().

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

Definition at line 250 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, poptOption::shortName, and stpcpy().

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 117 of file popt.c.

References poptOption::arg, poptArg_u::cb, CBF_ISSET, poptOption::descrip, poptOption::longName, optionStackEntry::nextArg, poptArg_u::opt, poptContext_s::os, POPT_ARG_CALLBACK, POPT_ARG_INCLUDE_TABLE, POPT_CALLBACK_REASON_OPTION, poptArgType, poptSubstituteHelpI18N, poptArg_u::ptr, and poptOption::shortName.

Referenced by poptGetNextOpt().

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

Definition at line 93 of file popt.c.

References poptOption::arg, poptArg_u::cb, CBF_ISSET, poptOption::descrip, poptOption::longName, poptArg_u::opt, POPT_ARG_CALLBACK, POPT_ARG_INCLUDE_TABLE, POPT_CALLBACK_REASON_POST, poptArgType, poptSubstituteHelpI18N, poptArg_u::ptr, and poptOption::shortName.

Referenced by poptGetNextOpt().

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

Definition at line 69 of file popt.c.

References poptOption::arg, poptArg_u::cb, CBF_ISSET, poptOption::descrip, poptOption::longName, poptArg_u::opt, POPT_ARG_CALLBACK, POPT_ARG_INCLUDE_TABLE, POPT_CALLBACK_REASON_PRE, poptArgType, poptSubstituteHelpI18N, poptArg_u::ptr, and poptOption::shortName.

Referenced by poptGetContext().

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

Definition at line 1274 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 1292 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 1335 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 1251 of file popt.c.

References _free(), poptContext_s::aliases, poptContext_s::appName, poptContext_s::arg_strip, optionStackEntry::argb, poptContext_s::execPath, poptContext_s::execs, poptContext_s::finalArgv, poptContext_s::leftovers, poptContext_s::numAliases, poptContext_s::numExecs, poptContext_s::os, poptContext_s::otherHelp, PBM_FREE, poptFreeItems(), and poptResetContext().

Referenced by displayArgs().

static poptItem poptFreeItems ( poptItem  items,
int  nitems 
) [static]

Definition at line 1232 of file popt.c.

References _free(), poptOption::argDescrip, poptItem_s::argv, poptOption::descrip, poptOption::longName, and poptItem_s::option.

Referenced by poptFreeContext().

const char* poptGetArg ( poptContext  con  ) 

Return next argument.

Parameters:
con context
Returns:
next argument, NULL if no argument is available

Definition at line 1201 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 1217 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
Returns:
initialized popt context

Definition at line 163 of file popt.c.

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, invokeCallbacksPRE(), poptContext_s::leftovers, optionStackEntry::next, poptContext_s::numAliases, poptContext_s::numExecs, poptContext_s::options, poptContext_s::optionStack, poptContext_s::os, POPT_CONTEXT_KEEP_FIRST, POPT_CONTEXT_POSIXMEHARDER, and xstrdup.

const char* poptGetInvocationName ( poptContext  con  ) 

Return argv[0] from context.

Parameters:
con context
Returns:
argv[0]

Definition at line 1396 of file popt.c.

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

int poptGetNextOpt ( poptContext  con  ) 

Return value of next option found.

Parameters:
con context
Returns:
next option val, -1 on last item, POPT_ERROR_* on error

Definition at line 844 of file popt.c.

References _free(), poptOption::arg, optionStackEntry::argb, optionStackEntry::argc, poptOption::argInfo, poptArg_u::argv, optionStackEntry::argv, cleanOSE(), DBL_EPSILON, poptContext_s::doExec, poptArg_u::doublep, execCommand(), expandNextArg(), F_ISSET, poptContext_s::finalArgv, poptContext_s::finalArgvAlloced, poptContext_s::finalArgvCount, findOption(), poptContext_s::flags, poptArg_u::floatp, handleAlias(), handleExec(), poptArg_u::intp, invokeCallbacksOPTION(), invokeCallbacksPOST(), poptContext_s::leftovers, LLONG_MAX, LLONG_MIN, poptArg_u::longlongp, poptOption::longName, poptArg_u::longp, poptContext_s::maincall, optionStackEntry::next, optionStackEntry::nextArg, optionStackEntry::nextCharArg, poptContext_s::numLeftovers, poptContext_s::options, poptContext_s::optionStack, poptContext_s::os, PBM_ISSET, POPT_, POPT_ABS, POPT_ARG_ARGV, POPT_ARG_DOUBLE, POPT_ARG_FLOAT, POPT_ARG_INT, POPT_ARG_LONG, POPT_ARG_LONGLONG, POPT_ARG_MAINCALL, POPT_ARG_NONE, POPT_ARG_STRING, POPT_ARG_VAL, POPT_CONTEXT_ARG_OPTS, POPT_CONTEXT_POSIXMEHARDER, POPT_ERROR_BADNUMBER, POPT_ERROR_BADOPERATION, POPT_ERROR_BADOPT, POPT_ERROR_NOARG, POPT_ERROR_NULLARG, POPT_ERROR_OVERFLOW, poptArgType, poptSaveInt(), poptSaveLong(), poptSaveLongLong(), poptSaveString(), poptStripArg(), poptArg_u::ptr, poptContext_s::restLeftover, poptOption::shortName, stpcpy(), poptOption::val, and xstrdup.

char* poptGetOptArg ( poptContext  con  ) 

Return next option argument (if any).

Parameters:
con context
Returns:
option argument, NULL if no argument is available

Definition at line 1191 of file popt.c.

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

const char* poptPeekArg ( poptContext  con  ) 

Peek at current argument.

Parameters:
con context
Returns:
current argument, NULL if no argument is available

Definition at line 1209 of file popt.c.

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

void poptResetContext ( poptContext  con  ) 

Reinitialize popt context.

Parameters:
con context

Definition at line 216 of file popt.c.

References _free(), 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, and poptContext_s::restLeftover.

Referenced by poptFreeContext().

int poptSaveInt ( int *  arg,
unsigned int  argInfo,
long  aLong 
)

Save an integer, performing logical operation with value.

Warning:
Alignment check may be too strict on certain platorms.
Parameters:
arg integer pointer, aligned on int boundary.
argInfo logical operation (see POPT_ARGFLAG_*)
aLong value to use
Returns:
0 on success, POPT_ERROR_NULLARG/POPT_ERROR_BADOPERATION

Definition at line 807 of file popt.c.

References LF_ISSET, POPT_ARGFLAG_AND, POPT_ARGFLAG_OR, POPT_ARGFLAG_XOR, POPT_ERROR_BADOPERATION, and POPT_ERROR_NULLARG.

Referenced by poptGetNextOpt().

int poptSaveLong ( long *  arg,
unsigned int  argInfo,
long  aLong 
)

Save a long, performing logical operation with value.

Warning:
Alignment check may be too strict on certain platorms.
Parameters:
arg integer pointer, aligned on int boundary.
argInfo logical operation (see POPT_ARGFLAG_*)
aLong value to use
Returns:
0 on success, POPT_ERROR_NULLARG/POPT_ERROR_BADOPERATION

Definition at line 771 of file popt.c.

References LF_ISSET, POPT_ARGFLAG_AND, POPT_ARGFLAG_OR, POPT_ARGFLAG_XOR, POPT_ERROR_BADOPERATION, and POPT_ERROR_NULLARG.

Referenced by poptGetNextOpt().

int poptSaveLongLong ( long long *  arg,
unsigned int  argInfo,
long long  aLongLong 
)

Save a long long, performing logical operation with value.

Warning:
Alignment check may be too strict on certain platorms.
Parameters:
arg integer pointer, aligned on int boundary.
argInfo logical operation (see POPT_ARGFLAG_*)
aLongLong value to use
Returns:
0 on success, POPT_ERROR_NULLARG/POPT_ERROR_BADOPERATION

Definition at line 731 of file popt.c.

References LF_ISSET, POPT_ARGFLAG_AND, POPT_ARGFLAG_OR, POPT_ARGFLAG_XOR, POPT_ERROR_BADOPERATION, and POPT_ERROR_NULLARG.

Referenced by poptGetNextOpt().

int poptSaveString ( const char ***  argvp,
UNUSED(unsigned int argInfo)  ,
const char *  val 
)

Definition at line 706 of file popt.c.

References optionStackEntry::argc, xrealloc, and xstrdup.

Referenced by poptGetNextOpt().

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

Limit search for executables.

Parameters:
con context
path single path to search for executables
allowAbsolute absolute paths only?

Definition at line 61 of file popt.c.

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

const char* poptStrerror ( const int  error  ) 

Return formatted error string for popt failure.

Parameters:
error popt error
Returns:
error string

Definition at line 1345 of file popt.c.

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

static void poptStripArg ( poptContext  con,
int  which 
) [static]

Definition at line 692 of file popt.c.

References poptContext_s::arg_strip, optionStackEntry::argc, poptContext_s::optionStack, PBM_ALLOC, and PBM_SET.

Referenced by poptGetNextOpt().

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

Shuffle argv pointers to remove stripped args, returns new argc.

Parameters:
con context
argc no. of args
argv arg vector
Returns:
new argc

Definition at line 1401 of file popt.c.

References poptContext_s::arg_strip, and PBM_ISSET.

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

Add arguments to context.

Parameters:
con context
argv argument array, NULL terminated
Returns:
0 on success, POPT_ERROR_OPTSTOODEEP on failure

Definition at line 1373 of file popt.c.

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.

static char* strerror ( int  errno  )  [static]

Definition at line 34 of file popt.c.

References POPT_.

Referenced by poptStrerror().

Variable Documentation

unsigned int seed = 0 [static]

Definition at line 729 of file popt.c.

Generated for popt by  doxygen 1.6.1