Data Structures | Macros | Typedefs | Enumerations | Functions
Ecore Getopt

This group contains powerful getopt replacement. More...

Data Structures

union  _Ecore_Getopt_Value
 Union listing the types of parameters that can take Getopt values. More...
 
struct  _Ecore_Getopt_Desc_Store
 Structure used when action is ECORE_GETOPT_ACTION_STORE. More...
 
struct  _Ecore_Getopt_Desc_Callback
 Structure used when action is ECORE_GETOPT_ACTION_CALLBACK. More...
 
struct  _Ecore_Getopt_Desc
 Structure that describe an option of the command line. More...
 
struct  _Ecore_Getopt
 Structure that contains information on all command line options. More...
 

Macros

#define _ECORE_GETOPT_PREDEF   1
 
#define _ECORE_GETOPT_DESC_PREDEF   1
 
#define _ECORE_GETOPT_VALUE_PREDEF   1
 
#define ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, type, arg_requirement, default_value)
 Macro that helps to fill the Ecore_Getopt_Desc table. More...
 
#define ECORE_GETOPT_STORE(shortname, longname, help, type)
 Macro that fills an option in Ecore_Getopt_Desc table. More...
 
#define ECORE_GETOPT_STORE_STR(shortname, longname, help)   ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_STR)
 Macro that fill Ecore_Getopt_Desc table with an option of type string. More...
 
#define ECORE_GETOPT_STORE_BOOL(shortname, longname, help)   ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_BOOL)
 Macro that fill Ecore_Getopt_Desc table with an option of type boolean. More...
 
#define ECORE_GETOPT_STORE_SHORT(shortname, longname, help)   ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_SHORT)
 Macro that fill Ecore_Getopt_Desc table with an option of type short. More...
 
#define ECORE_GETOPT_STORE_INT(shortname, longname, help)   ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_INT)
 Macro that fill Ecore_Getopt_Desc table with an option of type int. More...
 
#define ECORE_GETOPT_STORE_LONG(shortname, longname, help)   ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_LONG)
 Macro that fill Ecore_Getopt_Desc table with an option of type long. More...
 
#define ECORE_GETOPT_STORE_USHORT(shortname, longname, help)   ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_USHORT)
 Macro that fill Ecore_Getopt_Desc table with an option of type ushort. More...
 
#define ECORE_GETOPT_STORE_UINT(shortname, longname, help)   ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_UINT)
 Macro that fill Ecore_Getopt_Desc table with an option of type uint. More...
 
#define ECORE_GETOPT_STORE_ULONG(shortname, longname, help)   ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_ULONG)
 Macro that fill Ecore_Getopt_Desc table with an option of type ulong. More...
 
#define ECORE_GETOPT_STORE_DOUBLE(shortname, longname, help)   ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_DOUBLE)
 Macro that fill Ecore_Getopt_Desc table with an option of type double. More...
 
#define ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, type)
 Macro that helps to fill the Ecore_Getopt_Desc table with a metavar after the description of the option. More...
 
#define ECORE_GETOPT_STORE_METAVAR_STR(shortname, longname, help, metavar)   ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_STR)
 Fill Ecore_Getopt_Desc table with an option of type string and metavar. More...
 
#define ECORE_GETOPT_STORE_METAVAR_BOOL(shortname, longname, help, metavar)   ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_BOOL)
 Fill Ecore_Getopt_Desc table with an option of type boolean and metavar. More...
 
#define ECORE_GETOPT_STORE_METAVAR_SHORT(shortname, longname, help, metavar)   ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_SHORT)
 Fill Ecore_Getopt_Desc table with an option of type short and metavar. More...
 
#define ECORE_GETOPT_STORE_METAVAR_INT(shortname, longname, help, metavar)   ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_INT)
 Fill Ecore_Getopt_Desc table with an option of type int and metavar. More...
 
#define ECORE_GETOPT_STORE_METAVAR_LONG(shortname, longname, help, metavar)   ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_LONG)
 Fill Ecore_Getopt_Desc table with an option of type long and metavar. More...
 
#define ECORE_GETOPT_STORE_METAVAR_USHORT(shortname, longname, help, metavar)   ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_USHORT)
 Fill Ecore_Getopt_Desc table with an option of type unsigned short and metavar. More...
 
#define ECORE_GETOPT_STORE_METAVAR_UINT(shortname, longname, help, metavar)   ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_UINT)
 Fill Ecore_Getopt_Desc table with an option of type unsigned int and metavar. More...
 
#define ECORE_GETOPT_STORE_METAVAR_ULONG(shortname, longname, help, metavar)   ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_ULONG)
 Fill Ecore_Getopt_Desc table with an option of type unsigned long and metavar. More...
 
#define ECORE_GETOPT_STORE_METAVAR_DOUBLE(shortname, longname, help, metavar)   ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_DOUBLE)
 Fill Ecore_Getopt_Desc table with an option of type double and metavar. More...
 
#define ECORE_GETOPT_STORE_DEF(shortname, longname, help, type, default_value)
 Macro that helps to fill the Ecore_Getopt_Desc table with a default value. More...
 
#define ECORE_GETOPT_STORE_DEF_STR(shortname, longname, help, default_value)
 Fill Ecore_Getopt_Desc table with an option of type string and default value. More...
 
#define ECORE_GETOPT_STORE_DEF_BOOL(shortname, longname, help, default_value)
 Fill Ecore_Getopt_Desc table with an option of type boolean and default value. More...
 
#define ECORE_GETOPT_STORE_DEF_SHORT(shortname, longname, help, default_value)
 Fill Ecore_Getopt_Desc table with an option of type short and default value. More...
 
#define ECORE_GETOPT_STORE_DEF_INT(shortname, longname, help, default_value)
 Fill Ecore_Getopt_Desc table with an option of type int and default value. More...
 
#define ECORE_GETOPT_STORE_DEF_LONG(shortname, longname, help, default_value)
 Fill Ecore_Getopt_Desc table with an option of type long and default value. More...
 
#define ECORE_GETOPT_STORE_DEF_USHORT(shortname, longname, help, default_value)
 Fill Ecore_Getopt_Desc table with an option of type unsigned short and default value. More...
 
#define ECORE_GETOPT_STORE_DEF_UINT(shortname, longname, help, default_value)
 Fill Ecore_Getopt_Desc table with an option of type unsigned int and default value. More...
 
#define ECORE_GETOPT_STORE_DEF_ULONG(shortname, longname, help, default_value)
 Fill Ecore_Getopt_Desc table with an option of type unsigned long and default value. More...
 
#define ECORE_GETOPT_STORE_DEF_DOUBLE(shortname, longname, help, default_value)
 Fill Ecore_Getopt_Desc table with an option of type double and default value. More...
 
#define ECORE_GETOPT_STORE_FULL_STR(shortname, longname, help, metavar, arg_requirement, default_value)
 Fill full string type option description in Ecore_Getopt_Desc table. More...
 
#define ECORE_GETOPT_STORE_FULL_BOOL(shortname, longname, help, metavar, arg_requirement, default_value)
 Fill full boolean type option description in Ecore_Getopt_Desc table. More...
 
#define ECORE_GETOPT_STORE_FULL_SHORT(shortname, longname, help, metavar, arg_requirement, default_value)
 Fill full short type option description in Ecore_Getopt_Desc table. More...
 
#define ECORE_GETOPT_STORE_FULL_INT(shortname, longname, help, metavar, arg_requirement, default_value)
 Fill full int type option description in Ecore_Getopt_Desc table. More...
 
#define ECORE_GETOPT_STORE_FULL_LONG(shortname, longname, help, metavar, arg_requirement, default_value)
 Fill full long type option description in Ecore_Getopt_Desc table. More...
 
#define ECORE_GETOPT_STORE_FULL_USHORT(shortname, longname, help, metavar, arg_requirement, default_value)
 Fill full unsigned short type option description in Ecore_Getopt_Desc table. More...
 
#define ECORE_GETOPT_STORE_FULL_UINT(shortname, longname, help, metavar, arg_requirement, default_value)
 Fill full unsigned int type option description in Ecore_Getopt_Desc table. More...
 
#define ECORE_GETOPT_STORE_FULL_ULONG(shortname, longname, help, metavar, arg_requirement, default_value)
 Fill full unsigned long type option description in Ecore_Getopt_Desc table. More...
 
#define ECORE_GETOPT_STORE_FULL_DOUBLE(shortname, longname, help, metavar, arg_requirement, default_value)
 Fill full double type option description in Ecore_Getopt_Desc table. More...
 
#define ECORE_GETOPT_STORE_CONST(shortname, longname, help, value)
 Fill Ecore_Getopt_Desc table with a constant value. More...
 
#define ECORE_GETOPT_STORE_TRUE(shortname, longname, help)
 Fill Ecore_Getopt_Desc table with a true boolean value. More...
 
#define ECORE_GETOPT_STORE_FALSE(shortname, longname, help)
 Fill Ecore_Getopt_Desc table with a false boolean value. More...
 
#define ECORE_GETOPT_CHOICE(shortname, longname, help, choices_array)
 Fill Ecore_Getopt_Desc table with a true boolean value. More...
 
#define ECORE_GETOPT_CHOICE_METAVAR(shortname, longname, help, metavar, choices_array)
 Fill Ecore_Getopt_Desc table with a choice. More...
 
#define ECORE_GETOPT_APPEND(shortname, longname, help, sub_type)
 Fill Ecore_Getopt_Desc table with an append action. More...
 
#define ECORE_GETOPT_APPEND_METAVAR(shortname, longname, help, metavar, type)
 Fill Ecore_Getopt_Desc table with an append action and a metavar. More...
 
#define ECORE_GETOPT_COUNT(shortname, longname, help)
 Fill Ecore_Getopt_Desc table with an count action. More...
 
#define ECORE_GETOPT_CALLBACK_FULL(shortname, longname, help, metavar, callback_func, callback_data, argument_requirement, default_value)
 Fill Ecore_Getopt_Desc table with an callback action and argument requirements. More...
 
#define ECORE_GETOPT_CALLBACK_NOARGS(shortname, longname, help, callback_func, callback_data)
 Fill Ecore_Getopt_Desc table with an callback action and no arguments. More...
 
#define ECORE_GETOPT_CALLBACK_ARGS(shortname, longname, help, metavar, callback_func, callback_data)
 Fill Ecore_Getopt_Desc table with an callback action. More...
 
#define ECORE_GETOPT_HELP(shortname, longname)
 Fill Ecore_Getopt_Desc table with a help action. More...
 
#define ECORE_GETOPT_VERSION(shortname, longname)
 Fill Ecore_Getopt_Desc table with a version action. More...
 
#define ECORE_GETOPT_COPYRIGHT(shortname, longname)
 Fill Ecore_Getopt_Desc table with a copyright action. More...
 
#define ECORE_GETOPT_LICENSE(shortname, longname)
 Fill Ecore_Getopt_Desc table with a license action. More...
 
#define ECORE_GETOPT_BREAK(shortname, longname)
 Fill Ecore_Getopt_Desc table with a break action. More...
 
#define ECORE_GETOPT_BREAK_STR(shortname, longname, help)
 Fill Ecore_Getopt_Desc table with a break action with help message. More...
 
#define ECORE_GETOPT_CATEGORY(name, help)   {0, name, help, NULL, ECORE_GETOPT_ACTION_CATEGORY, {.dummy = NULL}}
 
#define ECORE_GETOPT_SENTINEL   {0, NULL, NULL, NULL, 0, {.dummy = NULL}}
 Fill Ecore_Getopt_Desc table with a sentinel to indicate the end of descriptions.
 
#define ECORE_GETOPT_VALUE_STR(val)   {.strp = &(val)}
 options that store a single value in a variable of type string. More...
 
#define ECORE_GETOPT_VALUE_BOOL(val)   {.boolp = &(val)}
 options that store a single value in a variable of type boolean. More...
 
#define ECORE_GETOPT_VALUE_SHORT(val)   {.shortp = &(val)}
 options that store a single value in a variable of type short. More...
 
#define ECORE_GETOPT_VALUE_INT(val)   {.intp = &(val)}
 options that store a single value in a variable of type int. More...
 
#define ECORE_GETOPT_VALUE_LONG(val)   {.longp = &(val)}
 options that store a single value in a variable of type long. More...
 
#define ECORE_GETOPT_VALUE_USHORT(val)   {.ushortp = &(val)}
 options that store a single value in a variable of type unsigned short. More...
 
#define ECORE_GETOPT_VALUE_UINT(val)   {.uintp = &(val)}
 options that store a single value in a variable of type unsigned int. More...
 
#define ECORE_GETOPT_VALUE_ULONG(val)   {.ulongp = &(val)}
 options that store a single value in a variable of type unsigned long. More...
 
#define ECORE_GETOPT_VALUE_DOUBLE(val)   {.doublep = &(val)}
 options that store a single value in a variable of type double. More...
 
#define ECORE_GETOPT_VALUE_PTR(val)   {.ptrp = &(val)}
 options that store a single value in a variable of type pointer. More...
 
#define ECORE_GETOPT_VALUE_PTR_CAST(val)   {.ptrp = (void **)&(val)}
 options that store a single value in a variable of type pointer casted. More...
 
#define ECORE_GETOPT_VALUE_LIST(val)   {.listp = &(val)}
 options that store a single value in a variable of type list. More...
 
#define ECORE_GETOPT_VALUE_NONE   {.ptrp = NULL}
 options that store a NULL value. More...
 

Typedefs

typedef struct _Ecore_Getopt_Desc_Store Ecore_Getopt_Desc_Store
 
typedef struct _Ecore_Getopt_Desc_Callback Ecore_Getopt_Desc_Callback
 
typedef struct _Ecore_Getopt Ecore_Getopt
 
typedef struct _Ecore_Getopt_Desc Ecore_Getopt_Desc
 
typedef union _Ecore_Getopt_Value Ecore_Getopt_Value
 

Enumerations

enum  Ecore_Getopt_Action {
  ECORE_GETOPT_ACTION_STORE,
  ECORE_GETOPT_ACTION_STORE_CONST,
  ECORE_GETOPT_ACTION_STORE_TRUE,
  ECORE_GETOPT_ACTION_STORE_FALSE,
  ECORE_GETOPT_ACTION_CHOICE,
  ECORE_GETOPT_ACTION_APPEND,
  ECORE_GETOPT_ACTION_COUNT,
  ECORE_GETOPT_ACTION_CALLBACK,
  ECORE_GETOPT_ACTION_HELP,
  ECORE_GETOPT_ACTION_VERSION,
  ECORE_GETOPT_ACTION_COPYRIGHT,
  ECORE_GETOPT_ACTION_LICENSE,
  ECORE_GETOPT_ACTION_BREAK,
  ECORE_GETOPT_ACTION_CATEGORY
}
 Enumeration that defines the actions to do when parsing command line parameters. More...
 
enum  Ecore_Getopt_Type {
  ECORE_GETOPT_TYPE_STR,
  ECORE_GETOPT_TYPE_BOOL,
  ECORE_GETOPT_TYPE_SHORT,
  ECORE_GETOPT_TYPE_INT,
  ECORE_GETOPT_TYPE_LONG,
  ECORE_GETOPT_TYPE_USHORT,
  ECORE_GETOPT_TYPE_UINT,
  ECORE_GETOPT_TYPE_ULONG,
  ECORE_GETOPT_TYPE_DOUBLE
}
 Enumeration that defines the type of the values to store when using append action. More...
 
enum  Ecore_Getopt_Desc_Arg_Requirement {
  ECORE_GETOPT_DESC_ARG_REQUIREMENT_NO = 0,
  ECORE_GETOPT_DESC_ARG_REQUIREMENT_YES = 1,
  ECORE_GETOPT_DESC_ARG_REQUIREMENT_OPTIONAL = 3
}
 Enumeration that defines if the command line options require an argument. More...
 

Functions

EAPI void ecore_getopt_help (FILE *fp, const Ecore_Getopt *info)
 Show nicely formatted help message for the given parser. More...
 
EAPI Eina_Bool ecore_getopt_help_category (FILE *fp, const Ecore_Getopt *info, const char *category)
 Show help for a single category (along with program usage and description). More...
 
EAPI Eina_Bool ecore_getopt_parser_has_duplicates (const Ecore_Getopt *parser)
 Check parser for duplicate entries, print them out. More...
 
EAPI int ecore_getopt_parse (const Ecore_Getopt *parser, Ecore_Getopt_Value *values, int argc, char **argv)
 Parse command line parameters. More...
 
EAPI int ecore_getopt_parse_positional (const Ecore_Getopt *parser, Ecore_Getopt_Value *values, int argc, char **argv, int start)
 Parse command line positional parameters. More...
 
EAPI Eina_Listecore_getopt_list_free (Eina_List *list)
 Utility to free list and nodes allocated by ECORE_GETOPT_ACTION_APPEND. More...
 
EAPI Eina_Bool ecore_getopt_callback_geometry_parse (const Ecore_Getopt *parser, const Ecore_Getopt_Desc *desc, const char *str, void *data, Ecore_Getopt_Value *storage)
 Helper ecore_getopt callback to parse geometry (x:y:w:h). More...
 
EAPI Eina_Bool ecore_getopt_callback_size_parse (const Ecore_Getopt *parser, const Ecore_Getopt_Desc *desc, const char *str, void *data, Ecore_Getopt_Value *storage)
 Helper ecore_getopt callback to parse geometry size (WxH). More...
 

Detailed Description

This group contains powerful getopt replacement.

This replacement handles both short (-X) or long options (–ABC) options, with various actions supported, like storing one value and already converting to required type, counting number of occurrences, setting true or false values, show help, license, copyright and even support user-defined callbacks.

It is provided a set of C Pre Processor macros so definition is straightforward.

Values will be stored elsewhere indicated by an array of pointers to values, it is given in separate to parser description so you can use multiple values with the same parser.

Macro Definition Documentation

§ ECORE_GETOPT_STORE_FULL

#define ECORE_GETOPT_STORE_FULL (   shortname,
  longname,
  help,
  metavar,
  type,
  arg_requirement,
  default_value 
)
Value:
{shortname, longname, help, metavar, ECORE_GETOPT_ACTION_STORE, \
{.store = {type, arg_requirement, default_value}}}
Store a value.
Definition: Ecore_Getopt.h:65

Macro that helps to fill the Ecore_Getopt_Desc table.

§ ECORE_GETOPT_STORE

#define ECORE_GETOPT_STORE (   shortname,
  longname,
  help,
  type 
)
Value:
ECORE_GETOPT_STORE_FULL(shortname, longname, help, NULL, type, \
Argument is required.
Definition: Ecore_Getopt.h:105
#define ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, type, arg_requirement, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table.
Definition: Ecore_Getopt.h:227

Macro that fills an option in Ecore_Getopt_Desc table.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
typeThe option value type.

§ ECORE_GETOPT_STORE_STR

#define ECORE_GETOPT_STORE_STR (   shortname,
  longname,
  help 
)    ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_STR)

Macro that fill Ecore_Getopt_Desc table with an option of type string.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.

§ ECORE_GETOPT_STORE_BOOL

#define ECORE_GETOPT_STORE_BOOL (   shortname,
  longname,
  help 
)    ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_BOOL)

Macro that fill Ecore_Getopt_Desc table with an option of type boolean.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.

§ ECORE_GETOPT_STORE_SHORT

#define ECORE_GETOPT_STORE_SHORT (   shortname,
  longname,
  help 
)    ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_SHORT)

Macro that fill Ecore_Getopt_Desc table with an option of type short.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.

§ ECORE_GETOPT_STORE_INT

#define ECORE_GETOPT_STORE_INT (   shortname,
  longname,
  help 
)    ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_INT)

Macro that fill Ecore_Getopt_Desc table with an option of type int.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
Examples:
ecore_thread_example.c.

§ ECORE_GETOPT_STORE_LONG

#define ECORE_GETOPT_STORE_LONG (   shortname,
  longname,
  help 
)    ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_LONG)

Macro that fill Ecore_Getopt_Desc table with an option of type long.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.

§ ECORE_GETOPT_STORE_USHORT

#define ECORE_GETOPT_STORE_USHORT (   shortname,
  longname,
  help 
)    ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_USHORT)

Macro that fill Ecore_Getopt_Desc table with an option of type ushort.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.

§ ECORE_GETOPT_STORE_UINT

#define ECORE_GETOPT_STORE_UINT (   shortname,
  longname,
  help 
)    ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_UINT)

Macro that fill Ecore_Getopt_Desc table with an option of type uint.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.

§ ECORE_GETOPT_STORE_ULONG

#define ECORE_GETOPT_STORE_ULONG (   shortname,
  longname,
  help 
)    ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_ULONG)

Macro that fill Ecore_Getopt_Desc table with an option of type ulong.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.

§ ECORE_GETOPT_STORE_DOUBLE

#define ECORE_GETOPT_STORE_DOUBLE (   shortname,
  longname,
  help 
)    ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_DOUBLE)

Macro that fill Ecore_Getopt_Desc table with an option of type double.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.

§ ECORE_GETOPT_STORE_METAVAR

#define ECORE_GETOPT_STORE_METAVAR (   shortname,
  longname,
  help,
  metavar,
  type 
)
Value:
ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, type, \
Argument is required.
Definition: Ecore_Getopt.h:105
#define ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, type, arg_requirement, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table.
Definition: Ecore_Getopt.h:227

Macro that helps to fill the Ecore_Getopt_Desc table with a metavar after the description of the option.

§ ECORE_GETOPT_STORE_METAVAR_STR

#define ECORE_GETOPT_STORE_METAVAR_STR (   shortname,
  longname,
  help,
  metavar 
)    ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_STR)

Fill Ecore_Getopt_Desc table with an option of type string and metavar.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.

§ ECORE_GETOPT_STORE_METAVAR_BOOL

#define ECORE_GETOPT_STORE_METAVAR_BOOL (   shortname,
  longname,
  help,
  metavar 
)    ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_BOOL)

Fill Ecore_Getopt_Desc table with an option of type boolean and metavar.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.

§ ECORE_GETOPT_STORE_METAVAR_SHORT

#define ECORE_GETOPT_STORE_METAVAR_SHORT (   shortname,
  longname,
  help,
  metavar 
)    ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_SHORT)

Fill Ecore_Getopt_Desc table with an option of type short and metavar.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.

§ ECORE_GETOPT_STORE_METAVAR_INT

#define ECORE_GETOPT_STORE_METAVAR_INT (   shortname,
  longname,
  help,
  metavar 
)    ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_INT)

Fill Ecore_Getopt_Desc table with an option of type int and metavar.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.

§ ECORE_GETOPT_STORE_METAVAR_LONG

#define ECORE_GETOPT_STORE_METAVAR_LONG (   shortname,
  longname,
  help,
  metavar 
)    ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_LONG)

Fill Ecore_Getopt_Desc table with an option of type long and metavar.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.

§ ECORE_GETOPT_STORE_METAVAR_USHORT

#define ECORE_GETOPT_STORE_METAVAR_USHORT (   shortname,
  longname,
  help,
  metavar 
)    ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_USHORT)

Fill Ecore_Getopt_Desc table with an option of type unsigned short and metavar.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.

§ ECORE_GETOPT_STORE_METAVAR_UINT

#define ECORE_GETOPT_STORE_METAVAR_UINT (   shortname,
  longname,
  help,
  metavar 
)    ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_UINT)

Fill Ecore_Getopt_Desc table with an option of type unsigned int and metavar.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.

§ ECORE_GETOPT_STORE_METAVAR_ULONG

#define ECORE_GETOPT_STORE_METAVAR_ULONG (   shortname,
  longname,
  help,
  metavar 
)    ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_ULONG)

Fill Ecore_Getopt_Desc table with an option of type unsigned long and metavar.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.

§ ECORE_GETOPT_STORE_METAVAR_DOUBLE

#define ECORE_GETOPT_STORE_METAVAR_DOUBLE (   shortname,
  longname,
  help,
  metavar 
)    ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_DOUBLE)

Fill Ecore_Getopt_Desc table with an option of type double and metavar.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.

§ ECORE_GETOPT_STORE_DEF

#define ECORE_GETOPT_STORE_DEF (   shortname,
  longname,
  help,
  type,
  default_value 
)
Value:
ECORE_GETOPT_STORE_FULL(shortname, longname, help, NULL, type, \
default_value)
Argument is optional.
Definition: Ecore_Getopt.h:106
#define ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, type, arg_requirement, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table.
Definition: Ecore_Getopt.h:227

Macro that helps to fill the Ecore_Getopt_Desc table with a default value.

§ ECORE_GETOPT_STORE_DEF_STR

#define ECORE_GETOPT_STORE_DEF_STR (   shortname,
  longname,
  help,
  default_value 
)
Value:
ECORE_GETOPT_STORE_DEF(shortname, longname, help, \
{.strv = default_value})
Value of type string.
Definition: Ecore_Getopt.h:87
#define ECORE_GETOPT_STORE_DEF(shortname, longname, help, type, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table with a default value.
Definition: Ecore_Getopt.h:442

Fill Ecore_Getopt_Desc table with an option of type string and default value.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_DEF_BOOL

#define ECORE_GETOPT_STORE_DEF_BOOL (   shortname,
  longname,
  help,
  default_value 
)
Value:
ECORE_GETOPT_STORE_DEF(shortname, longname, help, \
{.boolv = default_value})
Value of type boolean.
Definition: Ecore_Getopt.h:88
#define ECORE_GETOPT_STORE_DEF(shortname, longname, help, type, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table with a default value.
Definition: Ecore_Getopt.h:442

Fill Ecore_Getopt_Desc table with an option of type boolean and default value.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_DEF_SHORT

#define ECORE_GETOPT_STORE_DEF_SHORT (   shortname,
  longname,
  help,
  default_value 
)
Value:
ECORE_GETOPT_STORE_DEF(shortname, longname, help, \
{.shortv = default_value})
Value of type short.
Definition: Ecore_Getopt.h:89
#define ECORE_GETOPT_STORE_DEF(shortname, longname, help, type, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table with a default value.
Definition: Ecore_Getopt.h:442

Fill Ecore_Getopt_Desc table with an option of type short and default value.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_DEF_INT

#define ECORE_GETOPT_STORE_DEF_INT (   shortname,
  longname,
  help,
  default_value 
)
Value:
ECORE_GETOPT_STORE_DEF(shortname, longname, help, \
{.intv = default_value})
Value of type int.
Definition: Ecore_Getopt.h:90
#define ECORE_GETOPT_STORE_DEF(shortname, longname, help, type, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table with a default value.
Definition: Ecore_Getopt.h:442

Fill Ecore_Getopt_Desc table with an option of type int and default value.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_DEF_LONG

#define ECORE_GETOPT_STORE_DEF_LONG (   shortname,
  longname,
  help,
  default_value 
)
Value:
ECORE_GETOPT_STORE_DEF(shortname, longname, help, \
{.longv = default_value})
Value of type long.
Definition: Ecore_Getopt.h:91
#define ECORE_GETOPT_STORE_DEF(shortname, longname, help, type, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table with a default value.
Definition: Ecore_Getopt.h:442

Fill Ecore_Getopt_Desc table with an option of type long and default value.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_DEF_USHORT

#define ECORE_GETOPT_STORE_DEF_USHORT (   shortname,
  longname,
  help,
  default_value 
)
Value:
ECORE_GETOPT_STORE_DEF(shortname, longname, help, \
{.ushortv = default_value})
Value of type unsigned short.
Definition: Ecore_Getopt.h:92
#define ECORE_GETOPT_STORE_DEF(shortname, longname, help, type, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table with a default value.
Definition: Ecore_Getopt.h:442

Fill Ecore_Getopt_Desc table with an option of type unsigned short and default value.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_DEF_UINT

#define ECORE_GETOPT_STORE_DEF_UINT (   shortname,
  longname,
  help,
  default_value 
)
Value:
ECORE_GETOPT_STORE_DEF(shortname, longname, help, \
{.uintv = default_value})
Value of type unsigned int.
Definition: Ecore_Getopt.h:93
#define ECORE_GETOPT_STORE_DEF(shortname, longname, help, type, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table with a default value.
Definition: Ecore_Getopt.h:442

Fill Ecore_Getopt_Desc table with an option of type unsigned int and default value.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_DEF_ULONG

#define ECORE_GETOPT_STORE_DEF_ULONG (   shortname,
  longname,
  help,
  default_value 
)
Value:
ECORE_GETOPT_STORE_DEF(shortname, longname, help, \
{.ulongv = default_value})
Value of type unsigned long.
Definition: Ecore_Getopt.h:94
#define ECORE_GETOPT_STORE_DEF(shortname, longname, help, type, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table with a default value.
Definition: Ecore_Getopt.h:442

Fill Ecore_Getopt_Desc table with an option of type unsigned long and default value.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_DEF_DOUBLE

#define ECORE_GETOPT_STORE_DEF_DOUBLE (   shortname,
  longname,
  help,
  default_value 
)
Value:
ECORE_GETOPT_STORE_DEF(shortname, longname, help, \
{.doublev = default_value})
Value of type double.
Definition: Ecore_Getopt.h:95
#define ECORE_GETOPT_STORE_DEF(shortname, longname, help, type, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table with a default value.
Definition: Ecore_Getopt.h:442

Fill Ecore_Getopt_Desc table with an option of type double and default value.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_FULL_STR

#define ECORE_GETOPT_STORE_FULL_STR (   shortname,
  longname,
  help,
  metavar,
  arg_requirement,
  default_value 
)
Value:
ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, \
arg_requirement, \
{.strv = default_value})
Value of type string.
Definition: Ecore_Getopt.h:87
#define ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, type, arg_requirement, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table.
Definition: Ecore_Getopt.h:227

Fill full string type option description in Ecore_Getopt_Desc table.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.
arg_requirementThe option argument requirements.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_FULL_BOOL

#define ECORE_GETOPT_STORE_FULL_BOOL (   shortname,
  longname,
  help,
  metavar,
  arg_requirement,
  default_value 
)
Value:
ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, \
arg_requirement, \
{.boolv = default_value})
Value of type boolean.
Definition: Ecore_Getopt.h:88
#define ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, type, arg_requirement, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table.
Definition: Ecore_Getopt.h:227

Fill full boolean type option description in Ecore_Getopt_Desc table.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.
arg_requirementThe option argument requirements.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_FULL_SHORT

#define ECORE_GETOPT_STORE_FULL_SHORT (   shortname,
  longname,
  help,
  metavar,
  arg_requirement,
  default_value 
)
Value:
ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, \
arg_requirement, \
{.shortv = default_value})
Value of type short.
Definition: Ecore_Getopt.h:89
#define ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, type, arg_requirement, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table.
Definition: Ecore_Getopt.h:227

Fill full short type option description in Ecore_Getopt_Desc table.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.
arg_requirementThe option argument requirements.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_FULL_INT

#define ECORE_GETOPT_STORE_FULL_INT (   shortname,
  longname,
  help,
  metavar,
  arg_requirement,
  default_value 
)
Value:
ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, \
arg_requirement, \
{.intv = default_value})
Value of type int.
Definition: Ecore_Getopt.h:90
#define ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, type, arg_requirement, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table.
Definition: Ecore_Getopt.h:227

Fill full int type option description in Ecore_Getopt_Desc table.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.
arg_requirementThe option argument requirements.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_FULL_LONG

#define ECORE_GETOPT_STORE_FULL_LONG (   shortname,
  longname,
  help,
  metavar,
  arg_requirement,
  default_value 
)
Value:
ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, \
arg_requirement, \
{.longv = default_value})
Value of type long.
Definition: Ecore_Getopt.h:91
#define ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, type, arg_requirement, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table.
Definition: Ecore_Getopt.h:227

Fill full long type option description in Ecore_Getopt_Desc table.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.
arg_requirementThe option argument requirements.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_FULL_USHORT

#define ECORE_GETOPT_STORE_FULL_USHORT (   shortname,
  longname,
  help,
  metavar,
  arg_requirement,
  default_value 
)
Value:
ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, \
arg_requirement, \
{.ushortv = default_value})
Value of type unsigned short.
Definition: Ecore_Getopt.h:92
#define ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, type, arg_requirement, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table.
Definition: Ecore_Getopt.h:227

Fill full unsigned short type option description in Ecore_Getopt_Desc table.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.
arg_requirementThe option argument requirements.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_FULL_UINT

#define ECORE_GETOPT_STORE_FULL_UINT (   shortname,
  longname,
  help,
  metavar,
  arg_requirement,
  default_value 
)
Value:
ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, \
arg_requirement, \
{.uintv = default_value})
Value of type unsigned int.
Definition: Ecore_Getopt.h:93
#define ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, type, arg_requirement, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table.
Definition: Ecore_Getopt.h:227

Fill full unsigned int type option description in Ecore_Getopt_Desc table.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.
arg_requirementThe option argument requirements.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_FULL_ULONG

#define ECORE_GETOPT_STORE_FULL_ULONG (   shortname,
  longname,
  help,
  metavar,
  arg_requirement,
  default_value 
)
Value:
ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, \
arg_requirement, \
{.ulongv = default_value})
Value of type unsigned long.
Definition: Ecore_Getopt.h:94
#define ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, type, arg_requirement, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table.
Definition: Ecore_Getopt.h:227

Fill full unsigned long type option description in Ecore_Getopt_Desc table.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.
arg_requirementThe option argument requirements.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_FULL_DOUBLE

#define ECORE_GETOPT_STORE_FULL_DOUBLE (   shortname,
  longname,
  help,
  metavar,
  arg_requirement,
  default_value 
)
Value:
ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, \
arg_requirement, \
{.doublev = default_value})
Value of type double.
Definition: Ecore_Getopt.h:95
#define ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, type, arg_requirement, default_value)
Macro that helps to fill the Ecore_Getopt_Desc table.
Definition: Ecore_Getopt.h:227

Fill full double type option description in Ecore_Getopt_Desc table.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.
arg_requirementThe option argument requirements.
default_valueThe default value for the parameter of the option.

§ ECORE_GETOPT_STORE_CONST

#define ECORE_GETOPT_STORE_CONST (   shortname,
  longname,
  help,
  value 
)
Value:
{shortname, longname, help, NULL, ECORE_GETOPT_ACTION_STORE_CONST, \
{.store_const = value}}
Store a const.
Definition: Ecore_Getopt.h:66

Fill Ecore_Getopt_Desc table with a constant value.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
valueThe constant value to store.

§ ECORE_GETOPT_STORE_TRUE

#define ECORE_GETOPT_STORE_TRUE (   shortname,
  longname,
  help 
)
Value:
{shortname, longname, help, NULL, ECORE_GETOPT_ACTION_STORE_TRUE, \
{.dummy = NULL}}
Store TRUE.
Definition: Ecore_Getopt.h:67

Fill Ecore_Getopt_Desc table with a true boolean value.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.

§ ECORE_GETOPT_STORE_FALSE

#define ECORE_GETOPT_STORE_FALSE (   shortname,
  longname,
  help 
)
Value:
{shortname, longname, help, NULL, ECORE_GETOPT_ACTION_STORE_FALSE, \
{.dummy = NULL}}
Store FALSE.
Definition: Ecore_Getopt.h:68

Fill Ecore_Getopt_Desc table with a false boolean value.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.

§ ECORE_GETOPT_CHOICE

#define ECORE_GETOPT_CHOICE (   shortname,
  longname,
  help,
  choices_array 
)
Value:
{shortname, longname, help, NULL, ECORE_GETOPT_ACTION_CHOICE, \
{.choices = choices_array}}
Store a choice between several values.
Definition: Ecore_Getopt.h:69

Fill Ecore_Getopt_Desc table with a true boolean value.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
choices_arrayAn string array of different choices.

§ ECORE_GETOPT_CHOICE_METAVAR

#define ECORE_GETOPT_CHOICE_METAVAR (   shortname,
  longname,
  help,
  metavar,
  choices_array 
)
Value:
{shortname, longname, help, metavar, ECORE_GETOPT_ACTION_CHOICE, \
{.choices = choices_array}}
Store a choice between several values.
Definition: Ecore_Getopt.h:69

Fill Ecore_Getopt_Desc table with a choice.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.
choices_arrayAn string array of different choices.

§ ECORE_GETOPT_APPEND

#define ECORE_GETOPT_APPEND (   shortname,
  longname,
  help,
  sub_type 
)
Value:
{shortname, longname, help, NULL, ECORE_GETOPT_ACTION_APPEND, \
{.append_type = sub_type}}
Allocate and store a new value of type Ecore_Getopt_Type.
Definition: Ecore_Getopt.h:70

Fill Ecore_Getopt_Desc table with an append action.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
sub_typeThe type of the new value to store.

§ ECORE_GETOPT_APPEND_METAVAR

#define ECORE_GETOPT_APPEND_METAVAR (   shortname,
  longname,
  help,
  metavar,
  type 
)
Value:
{shortname, longname, help, metavar, ECORE_GETOPT_ACTION_APPEND, \
{.append_type = type}}
Allocate and store a new value of type Ecore_Getopt_Type.
Definition: Ecore_Getopt.h:70

Fill Ecore_Getopt_Desc table with an append action and a metavar.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.
typeThe type of the new value to store.
Examples:
ecore_thread_example.c.

§ ECORE_GETOPT_COUNT

#define ECORE_GETOPT_COUNT (   shortname,
  longname,
  help 
)
Value:
{shortname, longname, help, NULL, ECORE_GETOPT_ACTION_COUNT, \
{.dummy = NULL}}
Store a count number.
Definition: Ecore_Getopt.h:71

Fill Ecore_Getopt_Desc table with an count action.

This will store the number of time the option has been passed to the command line.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.

§ ECORE_GETOPT_CALLBACK_FULL

#define ECORE_GETOPT_CALLBACK_FULL (   shortname,
  longname,
  help,
  metavar,
  callback_func,
  callback_data,
  argument_requirement,
  default_value 
)
Value:
{shortname, longname, help, metavar, ECORE_GETOPT_ACTION_CALLBACK, \
{.callback = {callback_func, callback_data, \
argument_requirement, default_value}}}
Call a callback.
Definition: Ecore_Getopt.h:72

Fill Ecore_Getopt_Desc table with an callback action and argument requirements.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.
callback_funcThe callback function to call.
callback_dataThe data to pass to the callback.
argument_requirementthe required arguments to this option.
default_valueThe default values for these arguments.

§ ECORE_GETOPT_CALLBACK_NOARGS

#define ECORE_GETOPT_CALLBACK_NOARGS (   shortname,
  longname,
  help,
  callback_func,
  callback_data 
)
Value:
ECORE_GETOPT_CALLBACK_FULL(shortname, longname, help, NULL, \
callback_func, callback_data, \
NULL)
Argument is not required.
Definition: Ecore_Getopt.h:104
#define ECORE_GETOPT_CALLBACK_FULL(shortname, longname, help, metavar, callback_func, callback_data, argument_requirement, default_value)
Fill Ecore_Getopt_Desc table with an callback action and argument requirements.
Definition: Ecore_Getopt.h:817

Fill Ecore_Getopt_Desc table with an callback action and no arguments.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
callback_funcThe callback function to call.
callback_dataThe data to pass to the callback.

§ ECORE_GETOPT_CALLBACK_ARGS

#define ECORE_GETOPT_CALLBACK_ARGS (   shortname,
  longname,
  help,
  metavar,
  callback_func,
  callback_data 
)
Value:
ECORE_GETOPT_CALLBACK_FULL(shortname, longname, help, metavar, \
callback_func, callback_data, \
NULL)
#define ECORE_GETOPT_CALLBACK_FULL(shortname, longname, help, metavar, callback_func, callback_data, argument_requirement, default_value)
Fill Ecore_Getopt_Desc table with an callback action and argument requirements.
Definition: Ecore_Getopt.h:817
Argument is required.
Definition: Ecore_Getopt.h:105

Fill Ecore_Getopt_Desc table with an callback action.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.
metavarThe metavar message concerning the parameter of the option.
callback_funcThe callback function to call.
callback_dataThe data to pass to the callback.

§ ECORE_GETOPT_HELP

#define ECORE_GETOPT_HELP (   shortname,
  longname 
)
Value:
{shortname, longname, "show this message.", "CATEGORY", \
ECORE_GETOPT_ACTION_HELP, \
{.dummy = NULL}}

Fill Ecore_Getopt_Desc table with a help action.

Parameters
shortnameThe help option short name.
longnameThe help option long name.
Examples:
ecore_thread_example.c.

§ ECORE_GETOPT_VERSION

#define ECORE_GETOPT_VERSION (   shortname,
  longname 
)
Value:
{shortname, longname, "show program version.", NULL, \
ECORE_GETOPT_ACTION_VERSION, \
{.dummy = NULL}}

Fill Ecore_Getopt_Desc table with a version action.

Parameters
shortnameThe version option short name.
longnameThe version option long name.

§ ECORE_GETOPT_COPYRIGHT

#define ECORE_GETOPT_COPYRIGHT (   shortname,
  longname 
)
Value:
{shortname, longname, "show copyright.", NULL, \
ECORE_GETOPT_ACTION_COPYRIGHT, \
{.dummy = NULL}}

Fill Ecore_Getopt_Desc table with a copyright action.

Parameters
shortnameThe copyright option short name.
longnameThe copyright option long name.

§ ECORE_GETOPT_LICENSE

#define ECORE_GETOPT_LICENSE (   shortname,
  longname 
)
Value:
{shortname, longname, "show license.", NULL, \
ECORE_GETOPT_ACTION_LICENSE, \
{.dummy = NULL}}

Fill Ecore_Getopt_Desc table with a license action.

Parameters
shortnameThe license option short name.
longnameThe license option long name.

§ ECORE_GETOPT_BREAK

#define ECORE_GETOPT_BREAK (   shortname,
  longname 
)
Value:
{shortname, longname, "stop parsing options.", NULL, \
ECORE_GETOPT_ACTION_BREAK, \
{.dummy = NULL}}

Fill Ecore_Getopt_Desc table with a break action.

Parameters
shortnameThe option short name.
longnameThe option long name.

§ ECORE_GETOPT_BREAK_STR

#define ECORE_GETOPT_BREAK_STR (   shortname,
  longname,
  help 
)
Value:
{shortname, longname, help, NULL, \
ECORE_GETOPT_ACTION_BREAK, \
{.dummy = NULL}}

Fill Ecore_Getopt_Desc table with a break action with help message.

Parameters
shortnameThe option short name.
longnameThe option long name.
helpThe help message concerning this option.

§ ECORE_GETOPT_VALUE_STR

#define ECORE_GETOPT_VALUE_STR (   val)    {.strp = &(val)}

options that store a single value in a variable of type string.

Parameters
valThe value to store.

§ ECORE_GETOPT_VALUE_BOOL

#define ECORE_GETOPT_VALUE_BOOL (   val)    {.boolp = &(val)}

options that store a single value in a variable of type boolean.

Parameters
valThe value to store.
Examples:
ecore_thread_example.c.

§ ECORE_GETOPT_VALUE_SHORT

#define ECORE_GETOPT_VALUE_SHORT (   val)    {.shortp = &(val)}

options that store a single value in a variable of type short.

Parameters
valThe value to store.

§ ECORE_GETOPT_VALUE_INT

#define ECORE_GETOPT_VALUE_INT (   val)    {.intp = &(val)}

options that store a single value in a variable of type int.

Parameters
valThe value to store.
Examples:
ecore_thread_example.c.

§ ECORE_GETOPT_VALUE_LONG

#define ECORE_GETOPT_VALUE_LONG (   val)    {.longp = &(val)}

options that store a single value in a variable of type long.

Parameters
valThe value to store.

§ ECORE_GETOPT_VALUE_USHORT

#define ECORE_GETOPT_VALUE_USHORT (   val)    {.ushortp = &(val)}

options that store a single value in a variable of type unsigned short.

Parameters
valThe value to store.

§ ECORE_GETOPT_VALUE_UINT

#define ECORE_GETOPT_VALUE_UINT (   val)    {.uintp = &(val)}

options that store a single value in a variable of type unsigned int.

Parameters
valThe value to store.

§ ECORE_GETOPT_VALUE_ULONG

#define ECORE_GETOPT_VALUE_ULONG (   val)    {.ulongp = &(val)}

options that store a single value in a variable of type unsigned long.

Parameters
valThe value to store.

§ ECORE_GETOPT_VALUE_DOUBLE

#define ECORE_GETOPT_VALUE_DOUBLE (   val)    {.doublep = &(val)}

options that store a single value in a variable of type double.

Parameters
valThe value to store.

§ ECORE_GETOPT_VALUE_PTR

#define ECORE_GETOPT_VALUE_PTR (   val)    {.ptrp = &(val)}

options that store a single value in a variable of type pointer.

Parameters
valThe value to store.

§ ECORE_GETOPT_VALUE_PTR_CAST

#define ECORE_GETOPT_VALUE_PTR_CAST (   val)    {.ptrp = (void **)&(val)}

options that store a single value in a variable of type pointer casted.

Parameters
valThe value to store.

§ ECORE_GETOPT_VALUE_LIST

#define ECORE_GETOPT_VALUE_LIST (   val)    {.listp = &(val)}

options that store a single value in a variable of type list.

Parameters
valThe value to store.
Examples:
ecore_thread_example.c.

§ ECORE_GETOPT_VALUE_NONE

#define ECORE_GETOPT_VALUE_NONE   {.ptrp = NULL}

options that store a NULL value.

Parameters
valThe value to store.
Examples:
ecore_thread_example.c.

Enumeration Type Documentation

§ Ecore_Getopt_Action

Enumeration that defines the actions to do when parsing command line parameters.

Enumerator
ECORE_GETOPT_ACTION_STORE 

Store a value.

ECORE_GETOPT_ACTION_STORE_CONST 

Store a const.

ECORE_GETOPT_ACTION_STORE_TRUE 

Store TRUE.

ECORE_GETOPT_ACTION_STORE_FALSE 

Store FALSE.

ECORE_GETOPT_ACTION_CHOICE 

Store a choice between several values.

ECORE_GETOPT_ACTION_APPEND 

Allocate and store a new value of type Ecore_Getopt_Type.

ECORE_GETOPT_ACTION_COUNT 

Store a count number.

ECORE_GETOPT_ACTION_CALLBACK 

Call a callback.

ECORE_GETOPT_ACTION_HELP 

Show help text.

ECORE_GETOPT_ACTION_VERSION 

Show version.

ECORE_GETOPT_ACTION_COPYRIGHT 

Show copyright.

ECORE_GETOPT_ACTION_LICENSE 

Show license.

ECORE_GETOPT_ACTION_BREAK 

Stop parsing options.

§ Ecore_Getopt_Type

Enumeration that defines the type of the values to store when using append action.

Enumerator
ECORE_GETOPT_TYPE_STR 

Value of type string.

ECORE_GETOPT_TYPE_BOOL 

Value of type boolean.

ECORE_GETOPT_TYPE_SHORT 

Value of type short.

ECORE_GETOPT_TYPE_INT 

Value of type int.

ECORE_GETOPT_TYPE_LONG 

Value of type long.

ECORE_GETOPT_TYPE_USHORT 

Value of type unsigned short.

ECORE_GETOPT_TYPE_UINT 

Value of type unsigned int.

ECORE_GETOPT_TYPE_ULONG 

Value of type unsigned long.

ECORE_GETOPT_TYPE_DOUBLE 

Value of type double.

§ Ecore_Getopt_Desc_Arg_Requirement

Enumeration that defines if the command line options require an argument.

Enumerator
ECORE_GETOPT_DESC_ARG_REQUIREMENT_NO 

Argument is not required.

ECORE_GETOPT_DESC_ARG_REQUIREMENT_YES 

Argument is required.

ECORE_GETOPT_DESC_ARG_REQUIREMENT_OPTIONAL 

Argument is optional.

Function Documentation

§ ecore_getopt_help()

EAPI void ecore_getopt_help ( FILE *  fp,
const Ecore_Getopt info 
)

Show nicely formatted help message for the given parser.

Parameters
fpThe file the message will be printed on.
infoThe structure containing information about command line options.
See also
ecore_getopt_help_category()

§ ecore_getopt_help_category()

EAPI Eina_Bool ecore_getopt_help_category ( FILE *  fp,
const Ecore_Getopt info,
const char *  category 
)

Show help for a single category (along with program usage and description).

Parameters
fpThe file the message will be printed on.
infoThe structure containing information about command line options.
categoryThe category to print.
Returns
EINA_TRUE when the category exists, EINA_FALSE otherwise.
See also
ecore_getopt_help()

References _Ecore_Getopt_Desc::action, _Ecore_Getopt::descs, and EINA_FALSE.

§ ecore_getopt_parser_has_duplicates()

EAPI Eina_Bool ecore_getopt_parser_has_duplicates ( const Ecore_Getopt parser)

Check parser for duplicate entries, print them out.

Returns
EINA_TRUE if there are duplicates, EINA_FALSE otherwise.
Parameters
parserThe parser to be checked.

References _Ecore_Getopt_Desc::action, _Ecore_Getopt::descs, ECORE_GETOPT_ACTION_HELP, EINA_FALSE, EINA_TRUE, _Ecore_Getopt_Desc::longname, and _Ecore_Getopt_Desc::shortname.

§ ecore_getopt_parse()

EAPI int ecore_getopt_parse ( const Ecore_Getopt parser,
Ecore_Getopt_Value values,
int  argc,
char **  argv 
)

Parse command line parameters.

Walks the command line parameters and parse them based on parser description, doing actions based on parser->descs->action, like showing help text, license, copyright, storing values in values and so on.

It is expected that values is of the same size than parser->descs, options that do not need a value it will be left untouched.

All values are expected to be initialized before use. Options with action ECORE_GETOPT_ACTION_STORE and non required arguments (others than ECORE_GETOPT_DESC_ARG_REQUIREMENT_YES), are expected to provide a value in def to be used.

The following actions will store 1 on value as a boolean (value->boolp) if it's not NULL to indicate these actions were executed:

  • ECORE_GETOPT_ACTION_HELP
  • ECORE_GETOPT_ACTION_VERSION
  • ECORE_GETOPT_ACTION_COPYRIGHT
  • ECORE_GETOPT_ACTION_LICENSE

Just ECORE_GETOPT_ACTION_APPEND will allocate memory and thus need to be freed. For consistency between all of appended subtypes, eina_list->data will contain an allocated memory with the value, that is, for ECORE_GETOPT_TYPE_STR it will contain a copy of the argument, ECORE_GETOPT_TYPE_INT a pointer to an allocated integer and so on.

If parser is in strict mode (see Ecore_Getopt->strict), then any error will abort parsing and -1 is returned. Otherwise it will try to continue as far as possible.

This function may reorder argv elements.

Translation of help strings (description), metavar, usage, license and copyright may be translated, standard/global gettext() call will be applied on them if ecore was compiled with such support.

This function will not parse positional arguments! If these are declared (metavar is defined with both shortname and longname being empty), then you must call ecore_getopt_parse_positional() with the last argument (start) being the result of this function. This is done so you can have "quit options", those that once called you want to exit without doing further parsing, as is the case with help, license, copyright, version and eventually others you may define.

Parameters
parserdescription of how to work.
valueswhere to store values, it is assumed that this is a vector of the same size as parser->descs. Values should be previously initialized.
argchow many elements in argv. If not provided it will be retrieved with ecore_app_args_get().
argvcommand line parameters.
Returns
index of first non-option parameter or -1 on error.
See also
ecore_getopt_parse_positional()

References ecore_app_args_get(), _Ecore_Getopt_Desc::longname, _Ecore_Getopt::prog, and _Ecore_Getopt_Desc::shortname.

§ ecore_getopt_parse_positional()

EAPI int ecore_getopt_parse_positional ( const Ecore_Getopt parser,
Ecore_Getopt_Value values,
int  argc,
char **  argv,
int  start 
)

Parse command line positional parameters.

Walks the command line positional parameters (those that do not start with "-" or "--") and parse them based on parser description, doing actions based on parser->descs->action, like storing values of some type.

It is expected that values is of the same size than parser->descs, same as with ecore_getopt_parse().

All values are expected to be initialized before use.

Unlike the ecore_getopt_parse(), only the following options are supported:

  • ECORE_GETOPT_ACTION_STORE
  • ECORE_GETOPT_ACTION_CHOICE
  • ECORE_GETOPT_ACTION_APPEND
  • ECORE_GETOPT_ACTION_CALLBACK

There is a special case for ECORE_GETOPT_ACTION_APPEND as it will consume all remaining elements. It is also special in the sense that it will allocate memory and thus need to be freed. For consistency between all of appended subtypes, eina_list->data will contain an allocated memory with the value, that is, for ECORE_GETOPT_TYPE_STR it will contain a copy of the argument, ECORE_GETOPT_TYPE_INT a pointer to an allocated integer and so on.

If parser is in strict mode (see Ecore_Getopt->strict), then any error will abort parsing and -1 is returned. Otherwise it will try to continue as far as possible.

Translation of help strings (description) and metavar may be done, standard/global gettext() call will be applied on them if ecore was compiled with such support.

Parameters
parserdescription of how to work.
valueswhere to store values, it is assumed that this is a vector of the same size as parser->descs. Values should be previously initialized.
argchow many elements in argv. If not provided it will be retrieved with ecore_app_args_get().
argvcommand line parameters.
startthe initial position argument to look at, usually the return of ecore_getopt_parse(). If less than 1, will try to find it automatically.
Returns
index of first non-option parameter or -1 on error. If the last positional argument is of action ECORE_GETOPT_ACTION_APPEND then it will be the same as argc.

References _Ecore_Getopt::descs, ecore_app_args_get(), _Ecore_Getopt_Desc::longname, _Ecore_Getopt_Desc::metavar, _Ecore_Getopt::prog, and _Ecore_Getopt_Desc::shortname.

§ ecore_getopt_list_free()

EAPI Eina_List* ecore_getopt_list_free ( Eina_List list)

Utility to free list and nodes allocated by ECORE_GETOPT_ACTION_APPEND.

Parameters
listpointer to list to be freed.
Returns
always NULL, so you can easily make your list head NULL.

References EINA_LIST_FREE.

§ ecore_getopt_callback_geometry_parse()

EAPI Eina_Bool ecore_getopt_callback_geometry_parse ( const Ecore_Getopt parser,
const Ecore_Getopt_Desc desc,
const char *  str,
void *  data,
Ecore_Getopt_Value storage 
)

Helper ecore_getopt callback to parse geometry (x:y:w:h).

Parameters
parserThis parameter isn't in use.
descThis parameter isn't in use.
strGeometry value
dataThis parameter isn't in use.
storagemust be a pointer to Eina_Rectangle and will be used to store the four values passed in the given string.
Returns
EINA_TRUE on success, EINA_FALSE on incorrect geometry value.

This is a helper functions to be used with ECORE_GETOPT_CALLBACK_*().

callback_data value is ignored, you can safely use NULL.

References EINA_FALSE, EINA_TRUE, _Eina_Rectangle::h, _Ecore_Getopt_Value::ptrp, _Eina_Rectangle::w, _Eina_Rectangle::x, and _Eina_Rectangle::y.

§ ecore_getopt_callback_size_parse()

EAPI Eina_Bool ecore_getopt_callback_size_parse ( const Ecore_Getopt parser,
const Ecore_Getopt_Desc desc,
const char *  str,
void *  data,
Ecore_Getopt_Value storage 
)

Helper ecore_getopt callback to parse geometry size (WxH).

Parameters
parserThis parameter isn't in use.
descThis parameter isn't in use.
strsize value
dataThis parameter isn't in use.
storagemust be a pointer to Eina_Rectangle and will be used to store the two values passed in the given string and 0 in the x and y fields.
Returns
EINA_TRUE on success, EINA_FALSE on incorrect size value.

callback_data value is ignored, you can safely use NULL.

References EINA_FALSE, EINA_TRUE, _Eina_Rectangle::h, _Ecore_Getopt_Value::ptrp, _Eina_Rectangle::w, _Eina_Rectangle::x, and _Eina_Rectangle::y.