#include <stdio.h>
#include "export.h"

Include dependency graph for options_popt.h:

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

Classes
struct	poptOption

struct	poptAlias

struct	poptItem_s

struct	poptBits_s

Macros
#define	POPT_OPTION_DEPTH 10

Arg type identifiers
#define	POPT_ARG_NONE 0U

#define	POPT_ARG_STRING 1U

#define	POPT_ARG_INT 2U

#define	POPT_ARG_LONG 3U

#define	POPT_ARG_INCLUDE_TABLE 4U

#define	POPT_ARG_CALLBACK 5U

#define	POPT_ARG_INTL_DOMAIN 6U

#define	POPT_ARG_VAL 7U

#define	POPT_ARG_FLOAT 8U

#define	POPT_ARG_DOUBLE 9U

#define	POPT_ARG_LONGLONG 10U

#define	POPT_ARG_MAINCALL 16U+11U

#define	POPT_ARG_ARGV 12U

#define	POPT_ARG_SHORT 13U

#define	POPT_ARG_BITSET 16U+14U

#define	POPT_ARG_MASK 0x000000FFU

#define	POPT_GROUP_MASK 0x0000FF00U

Arg modifiers
#define	POPT_ARGFLAG_ONEDASH 0x80000000U

#define	POPT_ARGFLAG_DOC_HIDDEN 0x40000000U

#define	POPT_ARGFLAG_STRIP 0x20000000U

#define	POPT_ARGFLAG_OPTIONAL 0x10000000U

#define	POPT_ARGFLAG_OR 0x08000000U

#define	POPT_ARGFLAG_NOR 0x09000000U

#define	POPT_ARGFLAG_AND 0x04000000U

#define	POPT_ARGFLAG_NAND 0x05000000U

#define	POPT_ARGFLAG_XOR 0x02000000U

#define	POPT_ARGFLAG_NOT 0x01000000U

#define	POPT_ARGFLAG_LOGICALOPS (POPT_ARGFLAG_OR\|POPT_ARGFLAG_AND\|POPT_ARGFLAG_XOR)

#define	POPT_BIT_SET (POPT_ARG_VAL\|POPT_ARGFLAG_OR)

#define	POPT_BIT_CLR (POPT_ARG_VAL\|POPT_ARGFLAG_NAND)

#define	POPT_ARGFLAG_SHOW_DEFAULT 0x00800000U

#define	POPT_ARGFLAG_RANDOM 0x00400000U

#define	POPT_ARGFLAG_TOGGLE 0x00200000U

Callback modifiers
#define	POPT_CBFLAG_PRE 0x80000000U

#define	POPT_CBFLAG_POST 0x40000000U

#define	POPT_CBFLAG_INC_DATA 0x20000000U

#define	POPT_CBFLAG_SKIPOPTION 0x10000000U

#define	POPT_CBFLAG_CONTINUE 0x08000000U

Error return values
#define	POPT_ERROR_NOARG -10

#define	POPT_ERROR_BADOPT -11

#define	POPT_ERROR_OPTSTOODEEP -13

#define	POPT_ERROR_BADQUOTE -15

#define	POPT_ERROR_ERRNO -16

#define	POPT_ERROR_BADNUMBER -17

#define	POPT_ERROR_OVERFLOW -18

#define	POPT_ERROR_BADOPERATION -19

#define	POPT_ERROR_NULLARG -20

#define	POPT_ERROR_MALLOC -21

#define	POPT_ERROR_BADCONFIG -22

poptBadOption() flags
#define	POPT_BADOPTION_NOALIAS (1U << 0)

poptGetContext() flags
#define	POPT_CONTEXT_NO_EXEC (1U << 0)

#define	POPT_CONTEXT_KEEP_FIRST (1U << 1)

#define	POPT_CONTEXT_POSIXMEHARDER (1U << 2)

#define	POPT_CONTEXT_ARG_OPTS (1U << 4)

typedef struct poptItem_s *	poptItem

Auto-generated help/usage
#define	POPT_AUTOALIAS

#define	UNUSED(x) x __attribute__((__unused__))

#define	N_(foo) foo

#define	POPT_TABLEEND { NULL, '\0', 0, NULL, 0, NULL, NULL }

#define	POPT_AUTOHELP

#define	POPT_READFILE_TRIMNEWLINES 1

#define	_POPT_BITS_N 1024U /* estimated population */

#define	_POPT_BITS_M ((3U * _POPT_BITS_N) / 2U)

#define	_POPT_BITS_K 16U /* no. of linear hash combinations */

enum	poptCallbackReason { POPT_CALLBACK_REASON_PRE = 0, POPT_CALLBACK_REASON_POST = 1, POPT_CALLBACK_REASON_OPTION = 2 }

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)

typedef struct poptBits_s *	poptBits

struct poptOption	poptAliasOptions []

struct poptOption *	poptHelpOptionsAutoHelp

struct poptOption *	poptHelpOptionsI18N

unsigned int	_poptBitsN

unsigned int	_poptBitsM

unsigned int	_poptBitsK

void	displayArgs (poptContext con, enum poptCallbackReason foo __attribute__((__unused__)), struct poptOption key, const char arg __attribute__((__unused__)), void *data __attribute__((__unused__)))

poptContext	poptFreeContext (poptContext con)

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

poptContext	poptFini (poptContext con)

poptContext	poptInit (int argc, const char *argv, const struct poptOption options, const char *configPaths)

void	poptResetContext (poptContext con)

int	poptGetNextOpt (poptContext con)

char *	poptGetOptArg (poptContext con)

const char *	poptGetArg (poptContext con)

const char *	poptPeekArg (poptContext con)

const char **	poptGetArgs (poptContext con)

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

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

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

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

int	poptSaneFile (const char *fn)

int	poptReadFile (const char fn, char bp, size_t nbp, int flags)

int	poptReadConfigFile (poptContext con, const char *fn)

int	poptReadConfigFiles (poptContext con, const char *paths)

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)

int	poptConfigFileToString (FILE fp, char *argstrp, int flags)

const char *	poptStrerror (const int error)

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

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

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

void	poptSetOtherOptionHelp (poptContext con, const char *text)

const char *	poptGetInvocationName (poptContext con)

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

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

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

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

int	poptSaveShort (short *arg, unsigned int argInfo, long aLong)

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

int	poptBitsAdd (poptBits bits, const char *s)

int	poptBitsChk (poptBits bits, const char *s)

int	poptBitsClr (poptBits bits)

int	poptBitsDel (poptBits bits, const char *s)

int	poptBitsIntersect (poptBits *ap, const poptBits b)

int	poptBitsUnion (poptBits *ap, const poptBits b)

int	poptBitsArgs (poptContext con, poptBits *ap)

int	poptSaveBits (poptBits bitsp, unsigned int argInfo, const char s)

Macro Definition Documentation

◆ _POPT_BITS_K

#define _POPT_BITS_K 16U /* no. of linear hash combinations */

Definition at line 601 of file options_popt.h.

◆ _POPT_BITS_M

#define _POPT_BITS_M ((3U * _POPT_BITS_N) / 2U)

Definition at line 600 of file options_popt.h.

◆ _POPT_BITS_N

#define _POPT_BITS_N 1024U /* estimated population */

Definition at line 599 of file options_popt.h.

◆ N_

#define N_ ( foo ) foo

Definition at line 214 of file options_popt.h.

◆ POPT_ARG_ARGV

#define POPT_ARG_ARGV 12U

dupe'd arg appended to realloc'd argv array.

Definition at line 75 of file options_popt.h.

◆ POPT_ARG_BITSET

#define POPT_ARG_BITSET 16U+14U

arg ==> bit set

Definition at line 77 of file options_popt.h.

◆ POPT_ARG_CALLBACK

#define POPT_ARG_CALLBACK 5U

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

Definition at line 61 of file options_popt.h.

◆ POPT_ARG_DOUBLE

#define POPT_ARG_DOUBLE 9U

arg ==> double

Definition at line 71 of file options_popt.h.

◆ POPT_ARG_FLOAT

#define POPT_ARG_FLOAT 8U

arg ==> float

Definition at line 70 of file options_popt.h.

◆ POPT_ARG_INCLUDE_TABLE

#define POPT_ARG_INCLUDE_TABLE 4U

arg points to table

Definition at line 60 of file options_popt.h.

◆ POPT_ARG_INT

#define POPT_ARG_INT 2U

arg ==> int

Definition at line 58 of file options_popt.h.

◆ POPT_ARG_INTL_DOMAIN

#define POPT_ARG_INTL_DOMAIN 6U

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

Definition at line 65 of file options_popt.h.

◆ POPT_ARG_LONG

#define POPT_ARG_LONG 3U

arg ==> long

Definition at line 59 of file options_popt.h.

◆ POPT_ARG_LONGLONG

#define POPT_ARG_LONGLONG 10U

arg ==> long long

Definition at line 72 of file options_popt.h.

◆ POPT_ARG_MAINCALL

#define POPT_ARG_MAINCALL 16U+11U

EXPERIMENTAL: return (*arg) (argc, argv)

Definition at line 74 of file options_popt.h.

◆ POPT_ARG_MASK

#define POPT_ARG_MASK 0x000000FFU

Definition at line 79 of file options_popt.h.

◆ POPT_ARG_NONE

#define POPT_ARG_NONE 0U

no arg

Definition at line 56 of file options_popt.h.

◆ POPT_ARG_SHORT

#define POPT_ARG_SHORT 13U

arg ==> short

Definition at line 76 of file options_popt.h.

◆ POPT_ARG_STRING

#define POPT_ARG_STRING 1U

arg will be saved as string

Definition at line 57 of file options_popt.h.

◆ POPT_ARG_VAL

#define POPT_ARG_VAL 7U

arg should take value val

Definition at line 69 of file options_popt.h.

◆ POPT_ARGFLAG_AND

#define POPT_ARGFLAG_AND 0x04000000U

arg will be and'ed

Definition at line 92 of file options_popt.h.

◆ POPT_ARGFLAG_DOC_HIDDEN

#define POPT_ARGFLAG_DOC_HIDDEN 0x40000000U

don't show in help/usage

Definition at line 86 of file options_popt.h.

◆ POPT_ARGFLAG_LOGICALOPS

#define POPT_ARGFLAG_LOGICALOPS (POPT_ARGFLAG_OR|POPT_ARGFLAG_AND|POPT_ARGFLAG_XOR)

Definition at line 96 of file options_popt.h.

◆ POPT_ARGFLAG_NAND

#define POPT_ARGFLAG_NAND 0x05000000U

arg will be nand'ed

Definition at line 93 of file options_popt.h.

◆ POPT_ARGFLAG_NOR

#define POPT_ARGFLAG_NOR 0x09000000U

arg will be nor'ed

Definition at line 91 of file options_popt.h.

◆ POPT_ARGFLAG_NOT

#define POPT_ARGFLAG_NOT 0x01000000U

arg will be negated

Definition at line 95 of file options_popt.h.

◆ POPT_ARGFLAG_ONEDASH

#define POPT_ARGFLAG_ONEDASH 0x80000000U

allow -longoption

Definition at line 85 of file options_popt.h.

◆ POPT_ARGFLAG_OPTIONAL

#define POPT_ARGFLAG_OPTIONAL 0x10000000U

arg may be missing

Definition at line 88 of file options_popt.h.

◆ POPT_ARGFLAG_OR

#define POPT_ARGFLAG_OR 0x08000000U

arg will be or'ed

Definition at line 90 of file options_popt.h.

◆ POPT_ARGFLAG_RANDOM

#define POPT_ARGFLAG_RANDOM 0x00400000U

random value in [1,arg]

Definition at line 105 of file options_popt.h.

◆ POPT_ARGFLAG_SHOW_DEFAULT

#define POPT_ARGFLAG_SHOW_DEFAULT 0x00800000U

show default value in –help

Definition at line 104 of file options_popt.h.

◆ POPT_ARGFLAG_STRIP

#define POPT_ARGFLAG_STRIP 0x20000000U

strip this arg from argv(only applies to long args)

Definition at line 87 of file options_popt.h.

◆ POPT_ARGFLAG_TOGGLE

#define POPT_ARGFLAG_TOGGLE 0x00200000U

permit –[no]opt prefix toggle

Definition at line 106 of file options_popt.h.

◆ POPT_ARGFLAG_XOR

#define POPT_ARGFLAG_XOR 0x02000000U

arg will be xor'ed

Definition at line 94 of file options_popt.h.

◆ POPT_AUTOALIAS

#define POPT_AUTOALIAS

Value:

{ NULL, '\0', POPT_ARG_INCLUDE_TABLE, poptAliasOptions, \

0, "Options implemented via popt alias/exec:", NULL },

Definition at line 185 of file options_popt.h.

◆ POPT_AUTOHELP

#define POPT_AUTOHELP

Value:

{ NULL, '\0', POPT_ARG_INCLUDE_TABLE, poptHelpOptionsAutoHelp, \

0, "Help options:", NULL },

Definition at line 220 of file options_popt.h.

◆ POPT_BADOPTION_NOALIAS

#define POPT_BADOPTION_NOALIAS (1U << 0)

don't go into an alias

Definition at line 136 of file options_popt.h.

◆ POPT_BIT_CLR

#define POPT_BIT_CLR (POPT_ARG_VAL|POPT_ARGFLAG_NAND)

clear arg bit(s)

Definition at line 101 of file options_popt.h.

◆ POPT_BIT_SET

#define POPT_BIT_SET (POPT_ARG_VAL|POPT_ARGFLAG_OR)

set arg bit(s)

Definition at line 99 of file options_popt.h.

◆ POPT_CBFLAG_CONTINUE

#define POPT_CBFLAG_CONTINUE 0x08000000U

continue callbacks with option

Definition at line 116 of file options_popt.h.

◆ POPT_CBFLAG_INC_DATA

#define POPT_CBFLAG_INC_DATA 0x20000000U

use data from the include line, not the subtable

Definition at line 113 of file options_popt.h.

◆ POPT_CBFLAG_POST

#define POPT_CBFLAG_POST 0x40000000U

call the callback after parse

Definition at line 112 of file options_popt.h.

◆ POPT_CBFLAG_PRE

#define POPT_CBFLAG_PRE 0x80000000U

call the callback before parse

Definition at line 111 of file options_popt.h.

◆ POPT_CBFLAG_SKIPOPTION

#define POPT_CBFLAG_SKIPOPTION 0x10000000U

don't callback with option

Definition at line 115 of file options_popt.h.

◆ POPT_CONTEXT_ARG_OPTS

#define POPT_CONTEXT_ARG_OPTS (1U << 4)

return args as options with value 0

Definition at line 144 of file options_popt.h.

◆ POPT_CONTEXT_KEEP_FIRST

#define POPT_CONTEXT_KEEP_FIRST (1U << 1)

pay attention to argv[0]

Definition at line 142 of file options_popt.h.

◆ POPT_CONTEXT_NO_EXEC

#define POPT_CONTEXT_NO_EXEC (1U << 0)

ignore exec expansions

Definition at line 141 of file options_popt.h.

◆ POPT_CONTEXT_POSIXMEHARDER

#define POPT_CONTEXT_POSIXMEHARDER (1U << 2)

options can't follow args

Definition at line 143 of file options_popt.h.

◆ POPT_ERROR_BADCONFIG

#define POPT_ERROR_BADCONFIG -22

config file failed sanity test

Definition at line 131 of file options_popt.h.

◆ POPT_ERROR_BADNUMBER

#define POPT_ERROR_BADNUMBER -17

invalid numeric value

Definition at line 126 of file options_popt.h.

◆ POPT_ERROR_BADOPERATION

#define POPT_ERROR_BADOPERATION -19

mutually exclusive logical operations requested

Definition at line 128 of file options_popt.h.

◆ POPT_ERROR_BADOPT

#define POPT_ERROR_BADOPT -11

unknown option

Definition at line 122 of file options_popt.h.

◆ POPT_ERROR_BADQUOTE

#define POPT_ERROR_BADQUOTE -15

error in paramter quoting

Definition at line 124 of file options_popt.h.

◆ POPT_ERROR_ERRNO

#define POPT_ERROR_ERRNO -16

errno set, use strerror(errno)

Definition at line 125 of file options_popt.h.

◆ POPT_ERROR_MALLOC

#define POPT_ERROR_MALLOC -21

memory allocation failed

Definition at line 130 of file options_popt.h.

◆ POPT_ERROR_NOARG

#define POPT_ERROR_NOARG -10

missing argument

Definition at line 121 of file options_popt.h.

◆ POPT_ERROR_NULLARG

#define POPT_ERROR_NULLARG -20

opt->arg should not be NULL

Definition at line 129 of file options_popt.h.

◆ POPT_ERROR_OPTSTOODEEP

#define POPT_ERROR_OPTSTOODEEP -13

aliases nested too deeply

Definition at line 123 of file options_popt.h.

◆ POPT_ERROR_OVERFLOW

#define POPT_ERROR_OVERFLOW -18

number too large or too small

Definition at line 127 of file options_popt.h.

◆ POPT_GROUP_MASK

#define POPT_GROUP_MASK 0x0000FF00U

Definition at line 80 of file options_popt.h.

◆ POPT_OPTION_DEPTH

#define POPT_OPTION_DEPTH 10

Definition at line 51 of file options_popt.h.

◆ POPT_READFILE_TRIMNEWLINES

#define POPT_READFILE_TRIMNEWLINES 1

Definition at line 383 of file options_popt.h.

◆ POPT_TABLEEND

#define POPT_TABLEEND { NULL, '\0', 0, NULL, 0, NULL, NULL }

Definition at line 215 of file options_popt.h.

◆ UNUSED

#define UNUSED ( x ) x __attribute__((__unused__))

Definition at line 207 of file options_popt.h.

Typedef Documentation

◆ poptBits

typedef struct poptBits_s * poptBits

◆ poptCallbackType

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

Table callback prototype.

Parameters

con	context
reason	reason for callback
opt	option that triggered callback
arg	argument
data	argument data

Definition at line 241 of file options_popt.h.

◆ poptContext

typedef struct poptContext_s* poptContext

Auto help table options.

Definition at line 193 of file options_popt.h.

◆ poptItem

typedef struct poptItem_s * poptItem

A popt alias or exec argument for poptAddItem().

◆ poptOption

typedef struct poptOption* poptOption

Definition at line 226 of file options_popt.h.

Enumeration Type Documentation

◆ poptCallbackReason

enum poptCallbackReason

Enumerator
POPT_CALLBACK_REASON_PRE
POPT_CALLBACK_REASON_POST
POPT_CALLBACK_REASON_OPTION

Definition at line 197 of file options_popt.h.

Function Documentation

◆ displayArgs()

void displayArgs	(	poptContext	con,
		enum poptCallbackReason foo	__attribute__(__unused__),
		struct poptOption *	key,
		const char *arg	__attribute__(__unused__),
		void *data	__attribute__(__unused__)
	)

Display arguments.

Parameters

con	context
foo	(unused)
key	option(s)
arg	(unused)
data	(unused)

Definition at line 760 of file options_popt.cpp.

◆ poptAddAlias()

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

Add alias to context.

Todo:: Pass alias by reference, not value.

Note: This function is deprecated. Use poptAddItem instead.

Parameters

con	context
alias	alias to add
flags	(unused)

Returns: 0 on success

◆ poptAddItem()

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 3580 of file options_popt.cpp.

◆ poptBadOption()

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

Return the option which caused the most recent error.

Parameters

con	context
flags	option flags

Returns: offending option

< don't go into an alias

Definition at line 3623 of file options_popt.cpp.

◆ poptBitsAdd()

int poptBitsAdd	(	poptBits	bits,
		const char *	s
	)

< opt->arg should not be NULL

Definition at line 2785 of file options_popt.cpp.

◆ poptBitsArgs()

int poptBitsArgs	(	poptContext	con,
		poptBits *	ap
	)

< opt->arg should not be NULL

Definition at line 2897 of file options_popt.cpp.

◆ poptBitsChk()

int poptBitsChk	(	poptBits	bits,
		const char *	s
	)

< opt->arg should not be NULL

Definition at line 2804 of file options_popt.cpp.

◆ poptBitsClr()

int poptBitsClr ( poptBits bits )

< opt->arg should not be NULL

Definition at line 2827 of file options_popt.cpp.

◆ poptBitsDel()

int poptBitsDel	(	poptBits	bits,
		const char *	s
	)

< opt->arg should not be NULL

Definition at line 2838 of file options_popt.cpp.

◆ poptBitsIntersect()

int poptBitsIntersect	(	poptBits *	ap,
		const poptBits	b
	)

< opt->arg should not be NULL

Definition at line 2857 of file options_popt.cpp.

◆ poptBitsUnion()

int poptBitsUnion	(	poptBits *	ap,
		const poptBits	b
	)

< opt->arg should not be NULL

Definition at line 2877 of file options_popt.cpp.

◆ poptConfigFileToString()

int poptConfigFileToString	(	FILE *	fp,
		char **	argstrp,
		int	flags
	)

Parses an input configuration file and returns an string that is a command line. For use with popt. You must free the return value when done.

Given the file:

# this line is ignored
    #   this one too
aaa
  bbb
    ccc
bla=bla

this_is   =   fdsafdas
     bad_line=
  reall bad line
  reall bad line  = again
5555=   55555
  test = with lots of spaces

The result is:

--aaa --bbb --ccc --bla="bla" --this_is="fdsafdas" --5555="55555" --test="with lots of spaces"

Passing this to poptParseArgvString() yields an argv of:

'--aaa'
'--bbb'
'--ccc'
'--bla=bla'
'--this_is=fdsafdas'
'--5555=55555'
'--test=with lots of spaces'

Bug:

NULL is returned if file line is too long.

Silently ignores invalid lines.

Parameters

fp	file handle to read
argstrp	return string of options (malloc'd)
flags	unused

Returns: 0 on success

See also: poptParseArgvString

◆ poptDupArgv()

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

Duplicate an argument array.

Note: : The argument array is malloc'd as a single area, so only argv must be free'd.

Parameters

argc	no. of arguments
argv	argument array

Return values

argcPtr	address of returned no. of arguments
argvPtr	address of returned argument array

Returns: 0 on success, POPT_ERROR_NOARG on failure

< missing argument

< memory allocation failed

Definition at line 1939 of file options_popt.cpp.

◆ poptFini()

poptContext poptFini ( poptContext con )

Destroy context (alternative implementation).

Parameters

con context

Returns: NULL always

Definition at line 714 of file options_popt.cpp.

◆ poptFreeContext()

poptContext poptFreeContext ( poptContext con )

Destroy context.

Parameters

con context

Returns: NULL always

Definition at line 3539 of file options_popt.cpp.

◆ poptGetArg()

const char* poptGetArg ( poptContext con )

Return next argument.

Parameters

con context

Returns: next argument, NULL if no argument is available

Definition at line 3494 of file options_popt.cpp.

◆ poptGetArgs()

const char** poptGetArgs ( poptContext con )

Return remaining arguments.

Parameters

con context

Returns: argument array, NULL terminated

Definition at line 3510 of file options_popt.cpp.

◆ poptGetContext()

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

< pay attention to argv[0]

< options can't follow args

Definition at line 2264 of file options_popt.cpp.

◆ poptGetInvocationName()

const char* poptGetInvocationName ( poptContext con )

Return argv[0] from context.

Parameters

con context

Returns: argv[0]

Definition at line 3686 of file options_popt.cpp.

◆ poptGetNextOpt()

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

< unknown option

< options can't follow args

< return args as options with value 0

< unknown option

< allow -longoption

< unknown option

< strip this arg from argv(only applies to long args)

< unknown option

< no arg

< mutually exclusive logical operations requested

< arg should take value val

< mutually exclusive logical operations requested

< no arg

< arg may be missing

< missing argument

< strip this arg from argv(only applies to long args)

< arg may be missing

< arg should take value val

< allow -longoption

< no arg

< arg should take value val

< no arg

Definition at line 3236 of file options_popt.cpp.

◆ poptGetOptArg()

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 3484 of file options_popt.cpp.

◆ poptInit()

poptContext poptInit	(	int	argc,
		const char **	argv,
		const struct poptOption *	options,
		const char *	configPaths
	)

Initialize popt context (alternative implementation). This routine does poptGetContext() and then poptReadConfigFiles().

Parameters

argc	no. of arguments
argv	argument array
options	address of popt option table
configPaths	colon separated file path(s) to read.

Returns: initialized popt context (NULL on error).

Definition at line 720 of file options_popt.cpp.

◆ poptParseArgvString()

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

Parse a string into an argument array. The parse allows ', ", and \ quoting, but ' is treated the same as " and both may include \ quotes.

Note: : The argument array is malloc'd as a single area, so only argv must be free'd.

Parameters

s	string to parse

Return values

argcPtr	address of returned no. of arguments
argvPtr	address of returned argument array

< memory allocation failed

< error in paramter quoting

Definition at line 1980 of file options_popt.cpp.

◆ poptPeekArg()

const char* poptPeekArg ( poptContext con )

Peek at current argument.

Parameters

con context

Returns: current argument, NULL if no argument is available

Definition at line 3502 of file options_popt.cpp.

◆ poptPrintHelp()

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

Print detailed description of options.

Parameters

con	context
fp	ouput file handle
flags	(unused)

◆ poptPrintUsage()

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

Print terse description of options.

Parameters

con	context
fp	ouput file handle
flags	(unused)

◆ poptReadConfigFile()

int poptReadConfigFile	(	poptContext	con,
		const char *	fn
	)

Read configuration file.

Parameters

con	context
fn	file name to read

Returns: 0 on success, POPT_ERROR_ERRNO on failure

< config file failed sanity test

Definition at line 579 of file options_popt.cpp.

◆ poptReadConfigFiles()

int poptReadConfigFiles	(	poptContext	con,
		const char *	paths
	)

Read configuration file(s). Colon separated files to read, looping over poptReadConfigFile(). Note that an '@' character preceeding a path in the list will also perform additional sanity checks on the file before reading.

Parameters

con	context
paths	colon separated file name(s) to read

Returns: 0 on success, POPT_ERROR_BADCONFIG on failure

< config file failed sanity test

Definition at line 629 of file options_popt.cpp.

◆ poptReadDefaultConfig()

int poptReadDefaultConfig	(	poptContext	con,
		int	useEnv
	)

Read default configuration from /etc/popt and $HOME/.popt.

Parameters

con	context
useEnv	(unused)

Returns: 0 on success, POPT_ERROR_ERRNO on failure

◆ poptReadFile()

int poptReadFile	(	const char *	fn,
		char **	bp,
		size_t *	nbp,
		int	flags
	)

Read a file into a buffer.

Parameters

fn file name

Return values

*bp	buffer (malloc'd) (or NULL)
*nbp	no. of bytes in buffer (including final NUL) (or NULL)

Parameters

flags 1 to trim escaped newlines return 0 on success

< errno set, use strerror(errno)

< memory allocation failed

Definition at line 377 of file options_popt.cpp.

◆ poptResetContext()

void poptResetContext ( poptContext con )

Reinitialize popt context.

Parameters

con context

Definition at line 2310 of file options_popt.cpp.

◆ poptSaneFile()

int poptSaneFile ( const char * fn )

Perform sanity checks on a file path.

Parameters

fn file name

Returns: 0 on OK, 1 on NOTOK.

Definition at line 361 of file options_popt.cpp.

◆ poptSaveBits()

int poptSaveBits	(	poptBits *	bitsp,
		unsigned int	argInfo,
		const char *	s
	)

Save a string into a bit set (experimental).

Return values

*bits bit set (lazily malloc'd if NULL)

Parameters

argInfo	logical operation (see POPT_ARGFLAG_*)
s	string to add to bit set

Returns: 0 on success, POPT_ERROR_NULLARG/POPT_ERROR_BADOPERATION

◆ poptSaveInt()

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

< opt->arg should not be NULL

< random value in [1,arg]

< mutually exclusive logical operations requested

< arg will be negated

< arg will be or'ed

< arg will be and'ed

< arg will be xor'ed

< arg will be or'ed

< arg will be and'ed

< arg will be xor'ed

< mutually exclusive logical operations requested

Definition at line 3025 of file options_popt.cpp.

◆ poptSaveLong()

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

< opt->arg should not be NULL

< random value in [1,arg]

< mutually exclusive logical operations requested

< arg will be negated

< arg will be or'ed

< arg will be and'ed

< arg will be xor'ed

< arg will be or'ed

< arg will be and'ed

< arg will be xor'ed

< mutually exclusive logical operations requested

Definition at line 3001 of file options_popt.cpp.

◆ poptSaveLongLong()

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

< opt->arg should not be NULL

< random value in [1,arg]

< mutually exclusive logical operations requested

< arg will be negated

< arg will be or'ed

< arg will be and'ed

< arg will be xor'ed

< arg will be or'ed

< arg will be and'ed

< arg will be xor'ed

< mutually exclusive logical operations requested

Definition at line 2970 of file options_popt.cpp.

◆ poptSaveShort()

int poptSaveShort	(	short *	arg,
		unsigned int	argInfo,
		long	aLong
	)

Save a short integer, performing logical operation with value.

Warning: Alignment check may be too strict on certain platorms.

Parameters

arg	short pointer, aligned on short boundary.
argInfo	logical operation (see POPT_ARGFLAG_*)
aLong	value to use

Returns: 0 on success, POPT_ERROR_NULLARG/POPT_ERROR_BADOPERATION

< opt->arg should not be NULL

< random value in [1,arg]

< mutually exclusive logical operations requested

< arg will be negated

< arg will be or'ed

< arg will be and'ed

< arg will be xor'ed

< arg will be or'ed

< arg will be and'ed

< arg will be xor'ed

< mutually exclusive logical operations requested

Definition at line 3049 of file options_popt.cpp.

◆ poptSaveString()

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

Add a string to an argv array.

Return values

*argvp argv array

Parameters

argInfo	(unused)
val	string arg to add (using strdup)

Returns: 0 on success, POPT_ERROR_NULLARG/POPT_ERROR_BADOPERATION

◆ poptSetExecPath()

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 2170 of file options_popt.cpp.

◆ poptSetOtherOptionHelp()

void poptSetOtherOptionHelp	(	poptContext	con,
		const char *	text
	)

Provide text to replace default "[OPTION...]" in help/usage output.

Parameters

con	context
text	replacement text

Definition at line 1515 of file options_popt.cpp.

◆ poptStrerror()

const char* poptStrerror ( const int error )

Return formatted error string for popt failure.

Parameters

error popt error

Returns: error string

< missing argument

< unknown option

< mutually exclusive logical operations requested

< opt->arg should not be NULL

< aliases nested too deeply

< error in paramter quoting

< invalid numeric value

< number too large or too small

< memory allocation failed

< config file failed sanity test

< errno set, use strerror(errno)

Definition at line 3633 of file options_popt.cpp.

◆ poptStrippedArgv()

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 3691 of file options_popt.cpp.

◆ poptStuffArgs()

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

< aliases nested too deeply

Definition at line 3663 of file options_popt.cpp.

Variable Documentation

◆ _poptBitsK

unsigned int _poptBitsK

Definition at line 2765 of file options_popt.cpp.

◆ _poptBitsM

unsigned int _poptBitsM

Definition at line 2764 of file options_popt.cpp.

◆ _poptBitsN

unsigned int _poptBitsN

Definition at line 2763 of file options_popt.cpp.

◆ poptAliasOptions

struct poptOption poptAliasOptions[]

Empty table marker to enable displaying popt alias/exec options.

Definition at line 777 of file options_popt.cpp.

◆ poptHelpOptionsAutoHelp

struct poptOption* poptHelpOptionsAutoHelp

Definition at line 258 of file options_popt.cpp.

◆ poptHelpOptionsI18N

struct poptOption* poptHelpOptionsI18N

Definition at line 270 of file options_popt.cpp.

Classes

Macros

poptGetContext() flags

Auto-generated help/usage

Macro Definition Documentation

◆ _POPT_BITS_K

◆ _POPT_BITS_M

◆ _POPT_BITS_N

◆ N_

◆ POPT_ARG_ARGV

◆ POPT_ARG_BITSET

◆ POPT_ARG_CALLBACK

◆ POPT_ARG_DOUBLE

◆ POPT_ARG_FLOAT

◆ POPT_ARG_INCLUDE_TABLE

◆ POPT_ARG_INT

◆ POPT_ARG_INTL_DOMAIN

◆ POPT_ARG_LONG

◆ POPT_ARG_LONGLONG

◆ POPT_ARG_MAINCALL

◆ POPT_ARG_MASK

◆ POPT_ARG_NONE

◆ POPT_ARG_SHORT

◆ POPT_ARG_STRING

◆ POPT_ARG_VAL

◆ POPT_ARGFLAG_AND

◆ POPT_ARGFLAG_DOC_HIDDEN

◆ POPT_ARGFLAG_LOGICALOPS

◆ POPT_ARGFLAG_NAND

◆ POPT_ARGFLAG_NOR

◆ POPT_ARGFLAG_NOT

◆ POPT_ARGFLAG_ONEDASH

◆ POPT_ARGFLAG_OPTIONAL

◆ POPT_ARGFLAG_OR

◆ POPT_ARGFLAG_RANDOM

◆ POPT_ARGFLAG_SHOW_DEFAULT

◆ POPT_ARGFLAG_STRIP

◆ POPT_ARGFLAG_TOGGLE

◆ POPT_ARGFLAG_XOR

◆ POPT_AUTOALIAS

◆ POPT_AUTOHELP

◆ POPT_BADOPTION_NOALIAS

◆ POPT_BIT_CLR

◆ POPT_BIT_SET

◆ POPT_CBFLAG_CONTINUE

◆ POPT_CBFLAG_INC_DATA

◆ POPT_CBFLAG_POST

◆ POPT_CBFLAG_PRE

◆ POPT_CBFLAG_SKIPOPTION

◆ POPT_CONTEXT_ARG_OPTS

◆ POPT_CONTEXT_KEEP_FIRST

◆ POPT_CONTEXT_NO_EXEC

◆ POPT_CONTEXT_POSIXMEHARDER

◆ POPT_ERROR_BADCONFIG

◆ 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

◆ POPT_GROUP_MASK

◆ POPT_OPTION_DEPTH

◆ POPT_READFILE_TRIMNEWLINES

◆ POPT_TABLEEND

◆ UNUSED

Typedef Documentation

◆ poptBits

◆ poptCallbackType

◆ poptContext

◆ poptItem

◆ poptOption

Enumeration Type Documentation

◆ poptCallbackReason

Function Documentation

◆ displayArgs()

◆ poptAddAlias()