m_option.h

   1 #ifndef _M_OPTION_H
   2 #define _M_OPTION_H
   3
   4 typedef struct m_option_type m_option_type_t;
   5 typedef struct m_option m_option_t;
   6 struct m_struct_st;
   7
   8 ///////////////////////////// Options types declarations ////////////////////////////
   9
  10 // Simple types
  11 extern m_option_type_t m_option_type_flag;
  12 extern m_option_type_t m_option_type_int;
  13 extern m_option_type_t m_option_type_float;
  14 extern m_option_type_t m_option_type_double;
  15 extern m_option_type_t m_option_type_string;
  16 extern m_option_type_t m_option_type_string_list;
  17 extern m_option_type_t m_option_type_position;
  18
  19 extern m_option_type_t m_option_type_print;
  20 extern m_option_type_t m_option_type_print_indirect;
  21 extern m_option_type_t m_option_type_subconfig;
  22 extern m_option_type_t m_option_type_imgfmt;
  23 extern m_option_type_t m_option_type_afmt;
  24
  25 // Func based types
  26 extern m_option_type_t m_option_type_func_full;
  27 extern m_option_type_t m_option_type_func_param;
  28 extern m_option_type_t m_option_type_func;
  29
  30 typedef void (*m_opt_default_func_t)(m_option_t *, char*);
  31 typedef int (*m_opt_func_full_t)(m_option_t *, char *, char *);
  32 typedef int (*m_opt_func_param_t)(m_option_t *, char *);
  33 typedef int (*m_opt_func_t)(m_option_t *);
  34 ///////////// Backward compat
  35 typedef m_opt_default_func_t cfg_default_func_t;
  36 typedef m_opt_func_full_t cfg_func_arg_param_t;
  37 typedef m_opt_func_param_t cfg_func_param_t;
  38 typedef m_opt_func_t cfg_func_t;
  39
  40 typedef struct {
  41   void** list;
  42   void* name_off;
  43   void* info_off;
  44   void* desc_off;
  45 } m_obj_list_t;
  46
  47 typedef struct {
  48   char* name;
  49   char** attribs;
  50 } m_obj_settings_t;
  51 extern m_option_type_t m_option_type_obj_settings_list;
  52
  53 // Presets are mean to be used with options struct
  54
  55
  56 typedef struct {
  57   struct m_struct_st* in_desc;
  58   struct m_struct_st* out_desc;
  59   void* presets; // Pointer to an arry of struct defined by in_desc
  60   void* name_off; // Offset of the preset name inside the in_struct
  61 } m_obj_presets_t;
  62 extern m_option_type_t m_option_type_obj_presets;
  63
  64 extern m_option_type_t m_option_type_custom_url;
  65
  66 typedef struct {
  67   struct m_struct_st* desc; // Fields description
  68   char separator; // Field separator to use
  69 } m_obj_params_t;
  70 extern m_option_type_t m_option_type_obj_params;
  71
  72 typedef struct {
  73   int start;
  74   int end;
  75 } m_span_t;
  76 extern m_obj_params_t m_span_params_def;
  77
  78
  79 // FIXME: backward compatibility
  80 #define CONF_TYPE_FLAG          (&m_option_type_flag)
  81 #define CONF_TYPE_INT           (&m_option_type_int)
  82 #define CONF_TYPE_FLOAT         (&m_option_type_float)
  83 #define CONF_TYPE_DOUBLE        (&m_option_type_double)
  84 #define CONF_TYPE_STRING        (&m_option_type_string)
  85 #define CONF_TYPE_FUNC          (&m_option_type_func)
  86 #define CONF_TYPE_FUNC_PARAM    (&m_option_type_func_param)
  87 #define CONF_TYPE_PRINT         (&m_option_type_print)
  88 #define CONF_TYPE_PRINT_INDIRECT (&m_option_type_print_indirect)
  89 #define CONF_TYPE_FUNC_FULL     (&m_option_type_func_full)
  90 #define CONF_TYPE_SUBCONFIG     (&m_option_type_subconfig)
  91 #define CONF_TYPE_STRING_LIST   (&m_option_type_string_list)
  92 #define CONF_TYPE_POSITION      (&m_option_type_position)
  93 #define CONF_TYPE_IMGFMT        (&m_option_type_imgfmt)
  94 #define CONF_TYPE_AFMT          (&m_option_type_afmt)
  95 #define CONF_TYPE_SPAN          (&m_option_type_span)
  96 #define CONF_TYPE_OBJ_SETTINGS_LIST (&m_option_type_obj_settings_list)
  97 #define CONF_TYPE_OBJ_PRESETS   (&m_option_type_obj_presets)
  98 #define CONF_TYPE_CUSTOM_URL    (&m_option_type_custom_url)
  99 #define CONF_TYPE_OBJ_PARAMS    (&m_option_type_obj_params)
 100
 101 /////////////////////////////////////////////////////////////////////////////////////////////
 102
 103 struct m_option_type {
 104   char* name;
 105   char* comments; // syntax desc, etc
 106   unsigned int size; // size needed for a save slot
 107   unsigned int flags;
 108
 109   // parse is the only requiered function all others can be NULL
 110   // If dst if non-NULL it should create/update the save slot
 111   // If dst is NULL it should just test the validity of the arg if possible
 112   // Src tell from where come this setting (ie cfg file, command line, playlist, ....
 113   // It should return 1 if param was used, 0 if not.
 114   // On error it must return 1 of the error code below
 115   int (*parse)(m_option_t* opt,char *name, char *param, void* dst, int src);
 116   // Print back a value in human form
 117   char* (*print)(m_option_t* opt,  void* val);
 118
 119   // These 3 will be a memcpy in 50% of the case, it's called to save/restore the status of
 120   // the var it's there for complex type like CONF_TYPE_FUNC*
 121   // update a save slot (dst) from the current value in the prog (src)
 122   void (*save)(m_option_t* opt,void* dst, void* src);
 123   // set the current value (dst) from a save slot
 124   void (*set)(m_option_t* opt,void* dst, void* src);
 125   // Copy betewen 2 slot (if NULL and size > 0 a memcpy will be used
 126   void (*copy)(m_option_t* opt,void* dst, void* src);
 127   // Free the data allocated for a save slot if needed
 128   void (*free)(void* dst);
 129 };
 130
 131 struct m_option {
 132   char *name;
 133   void *p;
 134   m_option_type_t* type;
 135   unsigned int flags;
 136   double min,max;
 137   // This used to be function pointer to hold a 'reverse to defaults' func.
 138   // Nom it can be used to pass any type of extra args.
 139   // Passing a 'default func' is still valid for all func based option types
 140   void* priv; // Type dependent data (for all kind of extended setting)
 141 };
 142
 143
 144 //////////////////////////////// Option flags /////////////////////////////////
 145
 146 // Option flags
 147 #define M_OPT_MIN               (1<<0)
 148 #define M_OPT_MAX               (1<<1)
 149 #define M_OPT_RANGE             (M_OPT_MIN|M_OPT_MAX)
 150 #define M_OPT_NOCFG             (1<<2)
 151 #define M_OPT_NOCMD             (1<<3)
 152 // This option is global : it won't be saved on push and the command
 153 // line parser will set it when it's parsed (ie. it won't be set later)
 154 // e.g options : -v, -quiet
 155 #define M_OPT_GLOBAL            (1<<4)
 156 // Do not save this option : it won't be saved on push but the command
 157 // line parser will put it with it's entry (ie : it may be set later)
 158 // e.g options : -include
 159 #define M_OPT_NOSAVE            (1<<5)
 160 // Emulate old behaviour by pushing the option only if it was set by the user
 161 #define M_OPT_OLD               (1<<6)
 162
 163 // FIXME: backward compatibility
 164 #define CONF_MIN                M_OPT_MIN
 165 #define CONF_MAX                M_OPT_MAX
 166 #define CONF_RANGE              M_OPT_RANGE
 167 #define CONF_NOCFG              M_OPT_NOCFG
 168 #define CONF_NOCMD              M_OPT_NOCMD
 169 #define CONF_GLOBAL             M_OPT_GLOBAL
 170 #define CONF_NOSAVE             M_OPT_NOSAVE
 171 #define CONF_OLD                M_OPT_OLD
 172
 173
 174 ///////////////////////////// Option type flags ///////////////////////////////////
 175
 176 // These flags are for the parsers. The description here apply to the m_config_t
 177 // based parsers (ie. cmd line and config file parsers)
 178 // Some parser will refuse option types that have some of these flags
 179
 180 // This flag is used for the subconfig
 181 // When this flag is set, opt->p should point to another m_option_t array
 182 // Only the parse function will be called. If dst is set, it should create/update
 183 // an array of char* containg opt/val pairs.
 184 // Then the options in the child array will then be set automaticly.
 185 // You can only affect the way suboption are parsed.
 186 // Also note that suboptions may be directly accessed by using -option:subopt blah :-)
 187 #define M_OPT_TYPE_HAS_CHILD            (1<<0)
 188 // If this flag is set the option type support option name with * at the end (used for -aa*)
 189 // This only affect the option name matching, the option type have to implement
 190 // the needed stuff.
 191 #define M_OPT_TYPE_ALLOW_WILDCARD       (1<<1)
 192 // This flag indicate that the data is dynamicly allocated (opt->p point to a pointer)
 193 // It enable a little hack wich replace the initial value by a dynamic copy
 194 // in case the initial value is staticly allocated (pretty common with strings)
 195 #define M_OPT_TYPE_DYNAMIC              (1<<2)
 196 /// If this is set the parse function doesn't directly return
 197 // the wanted thing. Options use this if for some reasons they have to wait
 198 // until the set call to be able to correctly set the target var.
 199 // So for those types you have to first parse and then set the target var
 200 // If this flag isn't set you can parse directly to the target var
 201 // It's used for the callback based option as the callback call may append
 202 // later on.
 203 #define M_OPT_TYPE_INDIRECT             (1<<3)
 204
 205
 206 ///////////////////////////// Parser flags ////////////////////////////////////////
 207
 208 // Config mode : some parser type behave differently depending
 209 // on config->mode value wich is passed in the src param of parse()
 210 #define M_CONFIG_FILE 0
 211 #define M_COMMAND_LINE 1
 212
 213 // Option parser error code
 214 #define M_OPT_UNKNOWN           -1
 215 #define M_OPT_MISSING_PARAM     -2
 216 #define M_OPT_INVALID           -3
 217 #define M_OPT_OUT_OF_RANGE      -4
 218 #define M_OPT_PARSER_ERR        -5
 219 #define M_OPT_EXIT              -6
 220
 221 // FIXME: backward compatibility
 222 #define ERR_NOT_AN_OPTION       M_OPT_UNKNOWN
 223 #define ERR_MISSING_PARAM       M_OPT_MISSING_PARAM
 224 #define ERR_OUT_OF_RANGE        M_OPT_OUT_OF_RANGE
 225 #define ERR_FUNC_ERR            M_OPT_PARSER_ERR
 226
 227 m_option_t* m_option_list_find(m_option_t* list,char* name);
 228
 229 inline static int
 230 m_option_parse(m_option_t* opt,char *name, char *param, void* dst, int src) {
 231   return opt->type->parse(opt,name,param,dst,src);
 232 }
 233
 234 inline static  char*
 235 m_option_print(m_option_t* opt,  void* val_ptr) {
 236   if(opt->type->print)
 237     return opt->type->print(opt,val_ptr);
 238   else
 239     return (char*)-1;
 240 }
 241
 242 inline static  void
 243 m_option_save(m_option_t* opt,void* dst, void* src) {
 244   if(opt->type->save)
 245     opt->type->save(opt,dst,src);
 246 }
 247
 248 inline static  void
 249 m_option_set(m_option_t* opt,void* dst, void* src) {
 250   if(opt->type->set)
 251     opt->type->set(opt,dst,src);
 252 }
 253
 254 inline  static void
 255 m_option_copy(m_option_t* opt,void* dst, void* src) {
 256   if(opt->type->copy)
 257     opt->type->set(opt,dst,src);
 258   else if(opt->type->size > 0)
 259     memcpy(dst,src,opt->type->size);
 260 }
 261
 262 inline static void
 263 m_option_free(m_option_t* opt,void* dst) {
 264   if(opt->type->free)
 265     opt->type->free(dst);
 266 }
 267
 268 #endif /* _M_OPTION_H */