args.h File Reference
#include <gwenhywfar/gwenhywfarapi.h>
#include <gwenhywfar/types.h>
#include <gwenhywfar/buffer.h>
#include <gwenhywfar/db.h>
Go to the source code of this file.
|
Data Structures |
struct | GWEN_ARGS |
Defines |
#define | GWEN_ARGS_FLAGS_HAS_ARGUMENT 0x00000001 |
#define | GWEN_ARGS_FLAGS_HELP 0x00000004 |
#define | GWEN_ARGS_FLAGS_LAST 0x00000002 |
#define | GWEN_ARGS_MODE_ALLOW_FREEPARAM 0x00000001 |
#define | GWEN_ARGS_MODE_STOP_AT_FREEPARAM 0x00000002 |
#define | GWEN_ARGS_RESULT_ERROR (-1) |
#define | GWEN_ARGS_RESULT_HELP (-2) |
Typedefs |
typedef struct GWEN_ARGS | GWEN_ARGS |
Enumerations |
enum | GWEN_ARGS_OUTTYPE { GWEN_ArgsOutType_Txt = 0,
GWEN_ArgsOutType_Html
} |
enum | GWEN_ARGS_TYPE { GWEN_ArgsType_Char = 0,
GWEN_ArgsType_Int
} |
Functions |
GWENHYWFAR_API int | GWEN_Args_Check (int argc, char **argv, int startAt, uint32_t mode, const GWEN_ARGS *args, GWEN_DB_NODE *db) |
GWENHYWFAR_API int | GWEN_Args_ShortUsage (const GWEN_ARGS *args, GWEN_BUFFER *ubuf, GWEN_ARGS_OUTTYPE ot) |
GWENHYWFAR_API int | GWEN_Args_Usage (const GWEN_ARGS *args, GWEN_BUFFER *ubuf, GWEN_ARGS_OUTTYPE ot) |
Define Documentation
#define GWEN_ARGS_FLAGS_HAS_ARGUMENT 0x00000001 |
#define GWEN_ARGS_FLAGS_HELP 0x00000004 |
#define GWEN_ARGS_FLAGS_LAST 0x00000002 |
#define GWEN_ARGS_MODE_ALLOW_FREEPARAM 0x00000001 |
#define GWEN_ARGS_MODE_STOP_AT_FREEPARAM 0x00000002 |
#define GWEN_ARGS_RESULT_ERROR (-1) |
#define GWEN_ARGS_RESULT_HELP (-2) |
Typedef Documentation
Enumeration Type Documentation
- Enumerator:
-
GWEN_ArgsOutType_Txt |
|
GWEN_ArgsOutType_Html |
|
Definition at line 66 of file args.h.
- Enumerator:
-
GWEN_ArgsType_Char |
|
GWEN_ArgsType_Int |
|
Definition at line 61 of file args.h.
Function Documentation
GWENHYWFAR_API int GWEN_Args_Check |
( |
int |
argc, |
|
|
char ** |
argv, |
|
|
int |
startAt, |
|
|
uint32_t |
mode, |
|
|
const GWEN_ARGS * |
args, |
|
|
GWEN_DB_NODE * |
db | |
|
) |
| | |
This function parses the given argument list. Known options are stored within the given DB under their respective name. Free parameters (which are arguments without leading "-"'s) are stored in the variable "params" of the given db.
Definition at line 44 of file args.c.
References DBG_DEBUG, DBG_ERROR, DBG_INFO, GWEN_ARGS::flags, GWEN_ARGS_FLAGS_HAS_ARGUMENT, GWEN_ARGS_FLAGS_HELP, GWEN_ARGS_FLAGS_LAST, GWEN_ARGS_MODE_ALLOW_FREEPARAM, GWEN_ARGS_MODE_STOP_AT_FREEPARAM, GWEN_ARGS_RESULT_ERROR, GWEN_ARGS_RESULT_HELP, GWEN_ArgsType_Char, GWEN_ArgsType_Int, GWEN_DB_FLAGS_DEFAULT, GWEN_DB_FLAGS_OVERWRITE_VARS, GWEN_DB_GetIntValue(), GWEN_DB_Group_free(), GWEN_DB_Group_new(), GWEN_DB_SetCharValue(), GWEN_DB_SetIntValue(), GWEN_LOGDOMAIN, GWEN_ARGS::longOption, GWEN_ARGS::maxNum, GWEN_ARGS::minNum, GWEN_ARGS::name, GWEN_ARGS::shortOption, and GWEN_ARGS::type.
Currently unimplemented; does nothing and returns zero.
Definition at line 418 of file args.c.