cfgparser.h

   1 /*
   2  * command line and config file parser
   3  */
   4
   5 #ifdef NEW_CONFIG
   6 #ifdef MP_DEBUG
   7 #warning "NEW_CONFIG defined but still using the old cfgparser.h"
   8 #endif
   9 #include "m_config.h"
  10 #include "m_option.h"
  11 #else
  12
  13 #ifndef __CONFIG_H
  14 #define __CONFIG_H
  15
  16 #define CONF_TYPE_FLAG          0
  17 #define CONF_TYPE_INT           1
  18 #define CONF_TYPE_FLOAT         2
  19 #define CONF_TYPE_STRING        3
  20 #define CONF_TYPE_FUNC          4
  21 #define CONF_TYPE_FUNC_PARAM    5
  22 #define CONF_TYPE_PRINT         6
  23 #define CONF_TYPE_FUNC_FULL     7
  24 #define CONF_TYPE_SUBCONFIG     8
  25 #define CONF_TYPE_STRING_LIST           9
  26 #define CONF_TYPE_POSITION      10
  27
  28
  29 #define ERR_NOT_AN_OPTION       -1
  30 #define ERR_MISSING_PARAM       -2
  31 #define ERR_OUT_OF_RANGE        -3
  32 #define ERR_FUNC_ERR            -4
  33
  34
  35
  36 #define CONF_MIN                (1<<0)
  37 #define CONF_MAX                (1<<1)
  38 #define CONF_RANGE              (CONF_MIN|CONF_MAX)
  39 #define CONF_NOCFG              (1<<2)
  40 #define CONF_NOCMD              (1<<3)
  41 #define CONF_GLOBAL             (1<<4)
  42 #define CONF_NOSAVE                            (1<<5)
  43 #define CONF_OLD                                  (1<<6)
  44
  45
  46 typedef struct config config_t;
  47 typedef struct m_config m_config_t;
  48 typedef struct config_save config_save_t;
  49
  50 struct play_tree;
  51
  52 typedef void (*cfg_default_func_t)(config_t *, char*);
  53
  54 struct config {
  55         char *name;
  56         void *p;
  57         unsigned int type;
  58         unsigned int flags;
  59         float min,max;
  60   /* Use this field when your need to do something before a new value is
  61      assigned to your option */
  62         cfg_default_func_t default_func;
  63 };
  64
  65
  66
  67 struct m_config {
  68   config_t** opt_list;
  69   config_save_t** config_stack;
  70   int cs_level;
  71   int parser_mode;  /* COMMAND_LINE or CONFIG_FILE */
  72   int flags;
  73   char* sub_conf; // When we save a subconfig
  74   struct play_tree* pt; // play tree we use for playlist option, etc
  75   struct play_tree* last_entry; // last added entry
  76   struct play_tree* last_parent; // if last_entry is NULL we must create child of this
  77   int recursion_depth;
  78 };
  79
  80 struct config_save {
  81   config_t* opt;
  82   union {
  83     int as_int;
  84     float as_float;
  85     void* as_pointer;
  86     off_t as_off_t;
  87   } param;
  88   char* opt_name;
  89 };
  90
  91
  92 typedef int (*cfg_func_arg_param_t)(config_t *, char *, char *);
  93 typedef int (*cfg_func_param_t)(config_t *, char *);
  94 typedef int (*cfg_func_t)(config_t *);
  95
  96 /* parse_config_file returns:
  97  *      -1 on error (can't malloc, invalid option...)
  98  *       0 if can't open configfile
  99  *       1 on success
 100  */
 101 int m_config_parse_config_file(m_config_t *config, char *conffile);
 102
 103 /* parse_command_line returns:
 104  *      -1 on error (invalid option...)
 105  *       1 otherwise
 106  */
 107 int m_config_parse_command_line(m_config_t* config, int argc, char **argv);
 108
 109 m_config_t* m_config_new(struct play_tree* pt);
 110
 111 void m_config_free(m_config_t* config);
 112
 113 void m_config_push(m_config_t* config);
 114
 115 /*
 116  * Return 0 on error 1 on success
 117  */
 118 int m_config_pop(m_config_t* config);
 119
 120 /*
 121  * Return 0 on error 1 on success
 122  */
 123 int m_config_register_options(m_config_t *config,config_t *args);
 124
 125 /*
 126  * For all the following function when it's a subconfig option
 127  * you must give an option name like 'tv:channel' and not just
 128  * 'channel'
 129  */
 130
 131 /*
 132  * Return 1 on sucess 0 on failure
 133  */
 134 int m_config_set_option(m_config_t *config,char *opt, char *param);
 135
 136 /*
 137  * Get the config struct defining an option
 138  * Return NULL on error
 139  */
 140 config_t* m_config_get_option(m_config_t *config, char* arg);
 141
 142 /*
 143  * Get the p field of the struct defining an option
 144  * Return NULL on error
 145  */
 146 void* m_config_get_option_ptr(m_config_t *config, char* arg);
 147
 148 /*
 149  * Tell is an option is alredy set or not
 150  * Return -1 one error (requested option arg exist)
 151  * Otherwise 0 or 1
 152  */
 153 int m_config_is_option_set(m_config_t *config, char* arg);
 154
 155 /*
 156  * Return 0 on error 1 on success
 157  */
 158 int m_config_switch_flag(m_config_t *config, char* opt);
 159
 160 /*
 161  * Return 0 on error 1 on success
 162  */
 163 int m_config_set_flag(m_config_t *config, char* opt, int max);
 164
 165 /*
 166  * Return the value of a flag (O or 1) and -1 on error
 167  */
 168 int m_config_get_flag(m_config_t *config, char* opt);
 169
 170 /*
 171  * Set the value of an int option
 172  * Return 0 on error 1 on success
 173  */
 174 int
 175 m_config_set_int(m_config_t *config, char* arg,int val);
 176
 177 /*
 178  * Get the value of an int option
 179  * Return the option value or -1 on error
 180  * If err_ret is not NULL it's set to 1 on error
 181  */
 182 int
 183 m_config_get_int (m_config_t *config, char* arg,int* err_ret);
 184
 185 /*
 186  * Set the value of a float option
 187  * Return 0 on error 1 on success
 188  */
 189 int
 190 m_config_set_float(m_config_t *config, char* arg,float val);
 191
 192
 193 /*
 194  * Get the value of a float option
 195  * Return the option value or -1 on error
 196  * If err_ret is not NULL it's set to 1 on error
 197  */
 198 float
 199 m_config_get_float (m_config_t *config, char* arg,int* err_ret);
 200
 201 #endif /* __CONFIG_H */
 202
 203 #endif /* NEW_CONFIG */