subopt-helper.h

   1 #ifndef SUBOPT_HELPER_H
   2 #define SUBOPT_HELPER_H
   3
   4 /**
   5  * \file subopt-helper.h
   6  *
   7  * \brief Datatype and functions declarations for usage
   8  *        of the suboption parser.
   9  *
  10  */
  11
  12 #define OPT_ARG_BOOL 0
  13 #define OPT_ARG_INT  1
  14 #define OPT_ARG_STR  2
  15 #define OPT_ARG_MSTRZ 3 ///< A malloced, zero terminated string, use free()!
  16
  17 typedef int (*opt_test_f)(void *);
  18
  19 /** simple structure for defining the option name, type and storage location */
  20 typedef struct opt_s
  21 {
  22   char * name; ///< string that identifies the option
  23   int type;    ///< option type as defined in subopt-helper.h
  24   void * valp; ///< pointer to the mem where the value should be stored
  25   opt_test_f test; ///< argument test func ( optional )
  26   int set;     ///< Is set internally by the parser if the option was found.
  27                ///< Don't use it at initialization of your opts, it will be
  28                ///< overriden anyway!
  29 } opt_t;
  30
  31 /** parses the string for the options specified in opt */
  32 int subopt_parse( char const * const str, opt_t * opts );
  33
  34
  35 /*------------------ arg specific types and declaration -------------------*/
  36 typedef struct strarg_s
  37 {
  38   int len; ///< length of the string determined by the parser
  39   char const * str;  ///< pointer to position inside the parse string
  40 } strarg_t;
  41
  42
  43 int int_non_neg( int * i );
  44 int int_pos( int * i );
  45
  46 int strargcmp(strarg_t *arg, char *str);
  47 int strargcasecmp(strarg_t *arg, char *str);
  48
  49 #endif