Main Page   Modules   Compound List   File List   Compound Members   File Members   Related Pages  

popt/popt.h File Reference

More...

#include <stdio.h>

Go to the source code of this file.

Compounds

struct  poptAlias
struct  poptOption

Arg type identifiers

#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
#define POPT_ARG_CALLBACK   5
#define POPT_ARG_INTL_DOMAIN   6
#define POPT_ARG_VAL   7
#define POPT_ARG_FLOAT   8
#define POPT_ARG_DOUBLE   9
#define POPT_ARG_MASK   0x0000FFFF

Arg modifiers

#define POPT_ARGFLAG_ONEDASH   0x80000000
#define POPT_ARGFLAG_DOC_HIDDEN   0x40000000
#define POPT_ARGFLAG_STRIP   0x20000000
#define POPT_ARGFLAG_OPTIONAL   0x10000000
#define POPT_ARGFLAG_OR   0x08000000
#define POPT_ARGFLAG_NOR   0x09000000
#define POPT_ARGFLAG_AND   0x04000000
#define POPT_ARGFLAG_NAND   0x05000000
#define POPT_ARGFLAG_XOR   0x02000000
#define POPT_ARGFLAG_NOT   0x01000000
#define POPT_ARGFLAG_LOGICALOPS

Callback modifiers

#define POPT_CBFLAG_PRE   0x80000000
#define POPT_CBFLAG_POST   0x40000000
#define POPT_CBFLAG_INC_DATA   0x20000000
#define POPT_CBFLAG_SKIPOPTION   0x10000000
#define POPT_CBFLAG_CONTINUE   0x08000000

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

poptBadOption() flags

#define POPT_BADOPTION_NOALIAS   (1 << 0)

poptGetContext() flags

#define POPT_CONTEXT_NO_EXEC   (1 << 0)
#define POPT_CONTEXT_KEEP_FIRST   (1 << 1)
#define POPT_CONTEXT_POSIXMEHARDER   (1 << 2)

Auto-generated help/usage

#define POPT_AUTOHELP
#define POPT_TABLEEND   { NULL, '\0', 0, 0, 0, NULL, NULL }
struct poptOption poptHelpOptions []

Defines

#define POPT_OPTION_DEPTH   10

Typedefs

typedef struct poptContext_spoptContext
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

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)
void poptPrintHelp (poptContext con, FILE * f, int flags)
void poptPrintUsage (poptContext con, FILE * f, int flags)
void poptSetOtherOptionHelp (poptContext con, const char * text)


Detailed Description

Definition in file popt.h.


Define Documentation

#define POPT_ARGFLAG_AND   0x04000000
 

arg will be and'ed

Definition at line 55 of file popt.h.

#define POPT_ARGFLAG_DOC_HIDDEN   0x40000000
 

don't show in help/usage

Definition at line 49 of file popt.h.

#define POPT_ARGFLAG_LOGICALOPS
 

Initializer:

\
        (POPT_ARGFLAG_OR|POPT_ARGFLAG_AND|POPT_ARGFLAG_XOR)

Definition at line 59 of file popt.h.

#define POPT_ARGFLAG_NAND   0x05000000
 

arg will be nand'ed

Definition at line 56 of file popt.h.

#define POPT_ARGFLAG_NOR   0x09000000
 

arg will be nor'ed

Definition at line 54 of file popt.h.

#define POPT_ARGFLAG_NOT   0x01000000
 

arg will be negated

Definition at line 58 of file popt.h.

#define POPT_ARGFLAG_OPTIONAL   0x10000000
 

arg may be missing

Definition at line 51 of file popt.h.

#define POPT_ARGFLAG_OR   0x08000000
 

arg will be or'ed

Definition at line 53 of file popt.h.

#define POPT_ARGFLAG_STRIP   0x20000000
 

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

Definition at line 50 of file popt.h.

#define POPT_ARGFLAG_XOR   0x02000000
 

arg will be xor'ed

Definition at line 57 of file popt.h.

#define POPT_ARG_CALLBACK   5
 

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

Definition at line 29 of file popt.h.

#define POPT_ARG_DOUBLE   9
 

arg will be converted to double

Definition at line 39 of file popt.h.

#define POPT_ARG_FLOAT   8
 

arg will be converted to float

Definition at line 38 of file popt.h.

#define POPT_ARG_INCLUDE_TABLE   4
 

arg points to table

Definition at line 28 of file popt.h.

#define POPT_ARG_INT   2
 

arg will be converted to int

Definition at line 26 of file popt.h.

#define POPT_ARG_INTL_DOMAIN   6
 

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

Definition at line 33 of file popt.h.

#define POPT_ARG_LONG   3
 

arg will be converted to long

Definition at line 27 of file popt.h.

#define POPT_ARG_MASK   0x0000FFFF
 

Definition at line 41 of file popt.h.

#define POPT_ARG_STRING   1
 

arg will be saved as string

Definition at line 25 of file popt.h.

#define POPT_ARG_VAL   7
 

arg should take value val

Definition at line 37 of file popt.h.

#define POPT_AUTOHELP
 

Initializer:

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

Definition at line 131 of file popt.h.

#define POPT_CBFLAG_CONTINUE   0x08000000
 

continue callbacks with option

Definition at line 72 of file popt.h.

#define POPT_CBFLAG_INC_DATA   0x20000000
 

use data from the include line, not the subtable

Definition at line 69 of file popt.h.

#define POPT_CBFLAG_POST   0x40000000
 

call the callback after parse

Definition at line 68 of file popt.h.

#define POPT_CBFLAG_SKIPOPTION   0x10000000
 

don't callback with option

Definition at line 71 of file popt.h.

#define POPT_CONTEXT_KEEP_FIRST   (1 << 1)
 

pay attention to argv[0]

Definition at line 101 of file popt.h.

#define POPT_CONTEXT_POSIXMEHARDER   (1 << 2)
 

options can't follow args

Definition at line 102 of file popt.h.

#define POPT_ERROR_BADNUMBER   -17
 

invalid numeric value

Definition at line 84 of file popt.h.

#define POPT_ERROR_BADOPERATION   -19
 

mutually exclusive logical operations requested

Definition at line 86 of file popt.h.

#define POPT_ERROR_BADOPT   -11
 

unknown option

Definition at line 80 of file popt.h.

#define POPT_ERROR_BADQUOTE   -15
 

error in paramter quoting

Definition at line 82 of file popt.h.

#define POPT_ERROR_ERRNO   -16
 

errno set, use strerror(errno)

Definition at line 83 of file popt.h.

#define POPT_ERROR_OPTSTOODEEP   -13
 

aliases nested too deeply

Definition at line 81 of file popt.h.

#define POPT_ERROR_OVERFLOW   -18
 

number too large or too small

Definition at line 85 of file popt.h.

#define POPT_OPTION_DEPTH   10
 

Definition at line 18 of file popt.h.

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

Definition at line 133 of file popt.h.


Typedef Documentation

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  
Todo:
Document.

Document.

Parameters:
data  

Definition at line 158 of file popt.h.

typedef struct poptContext_s* poptContext
 

Definition at line 138 of file popt.h.

typedef struct poptOption* poptOption
 

Definition at line 143 of file popt.h.


Enumeration Type Documentation

enum poptCallbackReason
 

Enumeration values:
POPT_CALLBACK_REASON_PRE  
POPT_CALLBACK_REASON_POST  
POPT_CALLBACK_REASON_OPTION  

Definition at line 146 of file popt.h.


Generated at Sun Apr 8 18:43:04 2001 for rpm by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000