CLPMAC.h File Reference

Macros for single definition of C struct and argument table for Command Line Parsing. More...

#include <stddef.h>

Go to the source code of this file.

Macros
#define	CLPARGTAB_SKALAR(kyw, nam, typ, min, max, atyp, flg, oid, tab, dft, man, hlp)   { atyp ,(kyw), NULL,(min), 1 ,sizeof(typ), offsetof(STRUCT_NAME,nam),(oid),(flg) ,(tab),(dft),(man),(hlp),0,0.0,NULL,#typ},
	Defines a scalar (single value) with the command line keyword kyw and the member name nam. More...
#define	CLPARGTAB_STRING(kyw, nam, siz, min, max, atyp, flg, oid, tab, dft, man, hlp)   { CLPTYP_STRING,(kyw), NULL,(min),(max), (siz), offsetof(STRUCT_NAME,nam),(oid),(flg) ,(tab),(dft),(man),(hlp),0,0.0,NULL,NULL},
	Defines a string with the command line keyword kyw and the member name nam. More...
#define	CLPARGTAB_DYNSTR(kyw, nam, siz, min, max, atyp, flg, oid, tab, dft, man, hlp)   { CLPTYP_STRING,(kyw), NULL,(min),(max), (siz), offsetof(STRUCT_NAME,nam),(oid),((flg)|CLPFLG_DYN),(tab),(dft),(man),(hlp),0,0.0,NULL,NULL},
	Defines a dynamic string with the command line keyword kyw and the member name nam (pointer to alloced memory, must be freed by the using application). More...
#define	CLPARGTAB_ARRAY(kyw, nam, typ, min, max, atyp, flg, oid, tab, dft, man, hlp)   { atyp ,(kyw), NULL,(min),(max),sizeof(typ), offsetof(STRUCT_NAME,nam),(oid),(flg) ,(tab),(dft),(man),(hlp),0,0.0,NULL,#typ},
	Defines an array with the command line keyword kyw and the member name nam. More...
#define	CLPARGTAB_DYNARY(kyw, nam, typ, min, max, atyp, flg, oid, tab, dft, man, hlp)   { atyp ,(kyw), NULL,(min),(max),sizeof(typ), offsetof(STRUCT_NAME,nam),(oid),((flg)|CLPFLG_DYN),(tab),(dft),(man),(hlp),0,0.0,NULL,#typ},
	Defines an dynamic array with the command line keyword kyw and the member name nam (pointer to alloced memory, must be freed by the using application). More...
#define	CLPARGTAB_ALIAS(kyw, ali)   { CLPTYP_XALIAS,(kyw),(ali), 0 , 0 , 0 , 0 , 0 , CLPFLG_ALI, NULL, NULL, NULL, NULL,0,0.0,NULL,NULL},
	Defines an alias name for another argument. More...
#define	CLPARGTAB_CLS   { CLPTYP_NON , NULL, NULL, 0 , 0 , 0 , 0 , 0 , 0 , NULL, NULL, NULL, NULL,0,0.0,NULL,NULL}
	Will mark the end of an argument table. More...

Detailed Description

Macros for single definition of C struct and argument table for Command Line Parsing.

Author

Falk Reichbott

Date

20.10.2012

Copyright

2012 limes datentechnik gmbh

CLP table macros

This file is commonly included 2 times in a C file where the command line arguments of a program are defined. The first inclusion is used to define the C struct types where the parsed argument values will be stored. The second inclusion is used to define a table which describes the available command line arguments. With this method one source of description is used to define the argument table as well as the C struct where the parsed values will be stored.

DEFINE_STRUCT acts as a switch to the CLPARGTAB_* macros and determines if they define members of a C struct or entries of the argument table.
If defined the macros define struct members. Otherwise they define entries of the argument table.