ldk_argparse.h

home

Command-line arguments

Command-line argument parsing

A very simple Command-Line argument parser

Features:

  • Define expected command-line arguments with types and descriptions.
  • Parse command-line input and automatically recognize flags and their associated values.
  • Generate usage information based on argument descriptions for user guidance.
  • Provides safe mechanisms to access argument values while preventing buffer overflows.

Usage:

  1. Initialize the argument parser using ldkArgInitParser.
  2. Add expected arguments with ldkArgAddArgument.
  3. Parse command-line arguments using ldkArgParseArguments.
  4. Access argument values with the corresponding retrieval functions.
  5. Print usage information with ldkArgPrintUsage when needed.
  6. Iterate over found arguments using ldkArgForEachArgument.

Limitations:

  • The number of arguments is intentionally fixed and determined at compile time.
  • Currently, no dynamic memory management is implemented as arguments are stored in

a statically allocated array.

  • The size of the array is defined by the macro LDKARGPARSEMAX_ARGS. The

default value is 8. In case a larger value is needed, please define the macro with the required value before including this header.

Macro in ldk_argparse.h

LDK_ARGPARSE_MAX_ARGS_DEFAULT

#define LDK_ARGPARSE_MAX_ARGS_DEFAULT 8
Enum in ldk_argparse.h

LDKArgType

typedef enum{
  LDK_ARG_TYPE_FLAG,
  LDK_ARG_TYPE_INT,
  LDK_ARG_TYPE_STRING
}LDKArgType;
Struct in ldk_argparse.h

LDKArgument

typedef struct{
  const char *name;
  LDKArgType type;
  const char *description;
  char *stringValue;
  bool isFound;
  union{bool flagValue;i32 intValue;};
}LDKArgument;
Function in ldk_argparse.h

ldkArgAddArgument

Register a named command-line argument with the parser.

LDK_API void ldkArgAddArgument(
 LDKArgParser *parser,
 const char *name,
 LDKArgType type,
 const char *description
);

Parameters

LDKArgParser *parser
Argument parser to operate on.
const char *name
Name identifying the object or setting.
LDKArgType type
Type identifier or kind used by the operation.
const char *description
Description used by this operation.
Function in ldk_argparse.h

ldkArgParseArguments

Parse command-line arguments according to the registered options.

LDK_API void ldkArgParseArguments(
 LDKArgParser *parser,
 u32 argc,
 char *argv[]
);

Parameters

LDKArgParser *parser
Argument parser to operate on.
u32 argc
Number of command-line arguments.
char *argv[]
Array of command-line arguments.
Function in ldk_argparse.h

ldkArgPrintUsage

Print usage information for the registered command-line options.

LDK_API void ldkArgPrintUsage(const LDKArgParser *parser);

Parameters

const LDKArgParser *parser
Argument parser to operate on.
Function in ldk_argparse.h

ldkArgGetFlagValue

Read the value of a parsed command-line flag.

LDK_API bool ldkArgGetFlagValue(
 const LDKArgParser *parser,
 const char *name
);

Parameters

const LDKArgParser *parser
Argument parser to operate on.
const char *name
Name identifying the object or setting.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_argparse.h

ldkArgGetIntValue

Read a parsed integer command-line argument.

LDK_API i32 ldkArgGetIntValue(
 const LDKArgParser *parser,
 const char *name
);

Parameters

const LDKArgParser *parser
Argument parser to operate on.
const char *name
Name identifying the object or setting.

Returns

The resulting integer value.

Function in ldk_argparse.h

ldkArgGetStringValue

Read a parsed string command-line argument.

LDK_API const char * ldkArgGetStringValue(
 const LDKArgParser *parser,
 const char *name
);

Parameters

const LDKArgParser *parser
Argument parser to operate on.
const char *name
Name identifying the object or setting.

Returns

Pointer to the requested object or data; NULL when unavailable.

Function in ldk_argparse.h

ldkArgForEachArgument

Visit each registered argument with a callback.

LDK_API void ldkArgForEachArgument(
 const LDKArgParser *parser,
 void(*callback)(const LDKArgument *arg)
);

Parameters

const LDKArgParser *parser
Argument parser to operate on.
void(*callback)(const LDKArgument *arg)
Callback invoked by this operation.