Defines | Functions

args.c File Reference

#include "args_p.h"
#include <gwenhywfar/misc.h>
#include <gwenhywfar/debug.h>
#include <gwenhywfar/text.h>
#include <string.h>

Go to the source code of this file.

Defines

#define DISABLE_DEBUGLOG

Functions

int GWEN_Args__AppendTXT (GWEN_BUFFER *ubuf, const char *s, unsigned int ins)
int GWEN_Args_Check (int argc, char **argv, int startAt, uint32_t mode, const GWEN_ARGS *args, GWEN_DB_NODE *db)
int GWEN_Args_ShortUsage (GWEN_UNUSED const GWEN_ARGS *args, GWEN_UNUSED GWEN_BUFFER *ubuf, GWEN_UNUSED GWEN_ARGS_OUTTYPE ot)
int GWEN_Args_Usage (const GWEN_ARGS *args, GWEN_BUFFER *ubuf, GWEN_ARGS_OUTTYPE ot)
int GWEN_Args_UsageHTML (GWEN_UNUSED const GWEN_ARGS *args, GWEN_UNUSED GWEN_BUFFER *ubuf)
int GWEN_Args_UsageTXT (const GWEN_ARGS *args, GWEN_BUFFER *ubuf)

Define Documentation

#define DISABLE_DEBUGLOG

Definition at line 39 of file args.c.


Function Documentation

int GWEN_Args__AppendTXT ( GWEN_BUFFER ubuf,
const char *  s,
unsigned int  ins 
)

Definition at line 307 of file args.c.

References GWEN_Buffer_AppendByte().

Referenced by GWEN_Args_UsageTXT().

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_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.

int GWEN_Args_ShortUsage ( GWEN_UNUSED const GWEN_ARGS args,
GWEN_UNUSED GWEN_BUFFER ubuf,
GWEN_UNUSED GWEN_ARGS_OUTTYPE  ot 
)

Definition at line 419 of file args.c.

int GWEN_Args_Usage ( const GWEN_ARGS args,
GWEN_BUFFER ubuf,
GWEN_ARGS_OUTTYPE  ot 
)

Print a "usage" message into the given GWEN_BUFFER ubuf. The message lists all available options. The GWEN_ARGS_OUTTYPE argument is supposed to offer either text or html as output format, but currently only text is implemented.

Definition at line 398 of file args.c.

References DBG_ERROR, GWEN_Args_UsageHTML(), GWEN_Args_UsageTXT(), GWEN_ArgsOutType_Html, GWEN_ArgsOutType_Txt, and GWEN_LOGDOMAIN.

int GWEN_Args_UsageHTML ( GWEN_UNUSED const GWEN_ARGS args,
GWEN_UNUSED GWEN_BUFFER ubuf 
)

Definition at line 391 of file args.c.

Referenced by GWEN_Args_Usage().

int GWEN_Args_UsageTXT ( const GWEN_ARGS args,
GWEN_BUFFER ubuf 
)