configuration.h 14.5 KB
Newer Older
gbazin's avatar
 
gbazin committed
1 2 3 4 5 6
/*****************************************************************************
 * configuration.h : configuration management module
 * This file describes the programming interface for the configuration module.
 * It includes functions allowing to declare, get or set configuration options.
 *****************************************************************************
 * Copyright (C) 1999, 2000 VideoLAN
7
 * $Id: configuration.h,v 1.35 2004/01/29 17:04:01 gbazin Exp $
gbazin's avatar
 
gbazin committed
8 9 10 11 12 13 14
 *
 * Authors: Gildas Bazin <gbazin@netcourrier.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
zorglub's avatar
zorglub committed
15
 *
gbazin's avatar
 
gbazin committed
16 17 18 19 20 21 22 23 24 25 26 27 28 29
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

/*****************************************************************************
 * Macros used to build the configuration structure.
 *****************************************************************************/

gbazin's avatar
 
gbazin committed
30
/* Configuration hint types */
gbazin's avatar
 
gbazin committed
31 32 33 34 35
#define CONFIG_HINT_END                     0x0001  /* End of config */
#define CONFIG_HINT_CATEGORY                0x0002  /* Start of new category */
#define CONFIG_HINT_SUBCATEGORY             0x0003  /* Start of sub-category */
#define CONFIG_HINT_SUBCATEGORY_END         0x0004  /* End of sub-category */
#define CONFIG_HINT_USAGE                   0x0005  /* Usage information */
gbazin's avatar
 
gbazin committed
36

gbazin's avatar
 
gbazin committed
37
#define CONFIG_HINT                         0x000F
gbazin's avatar
 
gbazin committed
38 39

/* Configuration item types */
gbazin's avatar
 
gbazin committed
40 41 42 43 44 45
#define CONFIG_ITEM_STRING                  0x0010  /* String option */
#define CONFIG_ITEM_FILE                    0x0020  /* File option */
#define CONFIG_ITEM_MODULE                  0x0030  /* Module option */
#define CONFIG_ITEM_INTEGER                 0x0040  /* Integer option */
#define CONFIG_ITEM_BOOL                    0x0050  /* Bool option */
#define CONFIG_ITEM_FLOAT                   0x0060  /* Float option */
gbazin's avatar
 
gbazin committed
46
#define CONFIG_ITEM_DIRECTORY               0x0070  /* Directory option */
47
#define CONFIG_ITEM_KEY                     0x0080  /* Hot key option */
gbazin's avatar
 
gbazin committed
48

gbazin's avatar
 
gbazin committed
49
#define CONFIG_ITEM                         0x00F0
gbazin's avatar
 
gbazin committed
50

51
struct module_config_t
gbazin's avatar
 
gbazin committed
52
{
Sam Hocevar's avatar
 
Sam Hocevar committed
53
    int          i_type;                               /* Configuration type */
54
    char        *psz_type;                          /* Configuration subtype */
gbazin's avatar
 
gbazin committed
55
    char        *psz_name;                                    /* Option name */
Sam Hocevar's avatar
 
Sam Hocevar committed
56
    char         i_short;                      /* Optional short option name */
gbazin's avatar
 
gbazin committed
57 58 59
    char        *psz_text;      /* Short comment on the configuration option */
    char        *psz_longtext;   /* Long comment on the configuration option */
    char        *psz_value;                                  /* Option value */
Sam Hocevar's avatar
 
Sam Hocevar committed
60 61
    int          i_value;                                    /* Option value */
    float        f_value;                                    /* Option value */
62 63 64 65
    int         i_min;                               /* Option minimum value */
    int         i_max;                               /* Option maximum value */
    float       f_min;                               /* Option minimum value */
    float       f_max;                               /* Option maximum value */
gbazin's avatar
 
gbazin committed
66

67
    /* Function to call when commiting a change */
gbazin's avatar
 
gbazin committed
68 69
    vlc_callback_t pf_callback;
    void          *p_callback_data;
70

71
    /* Values list */
gbazin's avatar
 
gbazin committed
72
    char       **ppsz_list;        /* List of possible values for the option */
73 74 75
    int         *pi_list;          /* Idem for integers */
    char       **ppsz_list_text;   /* Friendly names for list values */
    int          i_list;           /* Options list size */
gbazin's avatar
 
gbazin committed
76

77 78 79 80 81 82
    /* Actions list */
    vlc_callback_t *ppf_action;    /* List of possible actions for a config */
    char           **ppsz_action_text;         /* Friendly names for actions */
    int            i_action;                            /* actions list size */

    /* Misc */
gbazin's avatar
 
gbazin committed
83
    vlc_mutex_t *p_lock;            /* Lock to use when modifying the config */
84
    vlc_bool_t   b_dirty;          /* Dirty flag to indicate a config change */
gbazin's avatar
 
gbazin committed
85 86 87 88 89 90
    vlc_bool_t   b_advanced;          /* Flag to indicate an advanced option */

    /* Original option values */
    char        *psz_value_orig;
    int          i_value_orig;
    float        f_value_orig;
91
};
gbazin's avatar
 
gbazin committed
92 93 94 95 96

/*****************************************************************************
 * Prototypes - these methods are used to get, set or manipulate configuration
 * data.
 *****************************************************************************/
gbazin's avatar
 
gbazin committed
97
VLC_EXPORT( int,    __config_GetType,  (vlc_object_t *, const char *) );
98 99 100 101 102
VLC_EXPORT( int,    __config_GetInt,   (vlc_object_t *, const char *) );
VLC_EXPORT( void,   __config_PutInt,   (vlc_object_t *, const char *, int) );
VLC_EXPORT( float,  __config_GetFloat, (vlc_object_t *, const char *) );
VLC_EXPORT( void,   __config_PutFloat, (vlc_object_t *, const char *, float) );
VLC_EXPORT( char *, __config_GetPsz,   (vlc_object_t *, const char *) );
103
VLC_EXPORT( void,   __config_PutPsz,   (vlc_object_t *, const char *, const char *) );
104

105 106 107 108
VLC_EXPORT( int,    __config_LoadCmdLine,  ( vlc_object_t *, int *, char *[], vlc_bool_t ) );
VLC_EXPORT( char *,   config_GetHomeDir,     ( void ) );
VLC_EXPORT( int,    __config_LoadConfigFile, ( vlc_object_t *, const char * ) );
VLC_EXPORT( int,    __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
gbazin's avatar
 
gbazin committed
109 110
VLC_EXPORT( void,   __config_ResetAll, ( vlc_object_t * ) );

111 112
VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) );
VLC_EXPORT( module_t *, config_FindModule,( vlc_object_t *, const char * ) );
gbazin's avatar
 
gbazin committed
113

114 115
VLC_EXPORT( void, config_Duplicate, ( module_t *, module_config_t * ) );
            void  config_Free       ( module_t * );
116

117 118
VLC_EXPORT( void, config_SetCallbacks, ( module_config_t *, module_config_t * ) );
VLC_EXPORT( void, config_UnsetCallbacks, ( module_config_t * ) );
gbazin's avatar
 
gbazin committed
119

gbazin's avatar
 
gbazin committed
120
#define config_GetType(a,b) __config_GetType(VLC_OBJECT(a),b)
121 122 123 124 125 126
#define config_GetInt(a,b) __config_GetInt(VLC_OBJECT(a),b)
#define config_PutInt(a,b,c) __config_PutInt(VLC_OBJECT(a),b,c)
#define config_GetFloat(a,b) __config_GetFloat(VLC_OBJECT(a),b)
#define config_PutFloat(a,b,c) __config_PutFloat(VLC_OBJECT(a),b,c)
#define config_GetPsz(a,b) __config_GetPsz(VLC_OBJECT(a),b)
#define config_PutPsz(a,b,c) __config_PutPsz(VLC_OBJECT(a),b,c)
gbazin's avatar
 
gbazin committed
127

128 129 130
#define config_LoadCmdLine(a,b,c,d) __config_LoadCmdLine(VLC_OBJECT(a),b,c,d)
#define config_LoadConfigFile(a,b) __config_LoadConfigFile(VLC_OBJECT(a),b)
#define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b)
gbazin's avatar
 
gbazin committed
131
#define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a))
132

gbazin's avatar
 
gbazin committed
133 134 135
/*****************************************************************************
 * Macros used to build the configuration structure.
 *
gbazin's avatar
 
gbazin committed
136 137 138
 * Note that internally we support only 3 types of config data: int , float
 *   and string.
 *   The other types declared here just map to one of these 3 basic types but
gbazin's avatar
 
gbazin committed
139 140 141
 *   have the advantage of also providing very good hints to a configuration
 *   interface so as to make it more user friendly.
 * The configuration structure also includes category hints. These hints can
gbazin's avatar
 
gbazin committed
142 143
 *   provide a configuration interface with some very useful data and again
 *   allow for a more user friendly interface.
gbazin's avatar
 
gbazin committed
144 145
 *****************************************************************************/

146
#define add_category_hint( text, longtext, advc ) \
147
    i_config++; \
gbazin's avatar
 
gbazin committed
148 149
    if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
        (i_config+11) * sizeof(module_config_t)); \
150
    { static module_config_t tmp = { CONFIG_HINT_CATEGORY, NULL, NULL, '\0', text, longtext }; p_config[ i_config ] = tmp; p_config[i_config].b_advanced = advc; }
151
#define add_subcategory_hint( text, longtext ) \
152
    i_config++; \
gbazin's avatar
 
gbazin committed
153 154
    if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
        (i_config+11) * sizeof(module_config_t)); \
155
    { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY, NULL, NULL, '\0', text, longtext }; p_config[ i_config ] = tmp; }
156
#define end_subcategory_hint \
157
    i_config++; \
gbazin's avatar
 
gbazin committed
158 159
    if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
        (i_config+11) * sizeof(module_config_t)); \
160
    { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY_END, NULL, NULL, '\0' }; p_config[ i_config ] = tmp; }
161
#define add_usage_hint( text ) \
162
    i_config++; \
gbazin's avatar
 
gbazin committed
163 164
    if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
        (i_config+11) * sizeof(module_config_t)); \
165
    { static module_config_t tmp = { CONFIG_HINT_USAGE, NULL, NULL, '\0', text }; p_config[ i_config ] = tmp; }
166

167
#define add_string( name, psz_value, p_callback, text, longtext, advc ) \
168
    i_config++; \
gbazin's avatar
 
gbazin committed
169 170
    if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
        (i_config+11) * sizeof(module_config_t)); \
171
    { static module_config_t tmp = { CONFIG_ITEM_STRING, NULL, name, '\0', text, longtext, psz_value }; tmp.b_advanced = advc; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; }
172
#define add_file( name, psz_value, p_callback, text, longtext, advc ) \
173
    i_config++; \
gbazin's avatar
 
gbazin committed
174 175
    if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
        (i_config+11) * sizeof(module_config_t)); \
176
    { static module_config_t tmp = { CONFIG_ITEM_FILE, NULL, name, '\0', text, longtext, psz_value, 0, 0 }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
gbazin's avatar
 
gbazin committed
177
#define add_directory( name, psz_value, p_callback, text, longtext, advc ) \
178
    i_config++; \
gbazin's avatar
 
gbazin committed
179 180
    if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
        (i_config+11) * sizeof(module_config_t)); \
181
    { static module_config_t tmp = { CONFIG_ITEM_DIRECTORY, NULL, name, '\0', text, longtext, psz_value, 0, 0 }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
182
#define add_module( name, psz_caps, psz_value, p_callback, text, longtext, advc ) \
183
    i_config++; \
gbazin's avatar
 
gbazin committed
184 185
    if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
        (i_config+11) * sizeof(module_config_t)); \
186
    { static module_config_t tmp = { CONFIG_ITEM_MODULE, psz_caps, name, '\0', text, longtext, psz_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
187
#define add_integer( name, i_value, p_callback, text, longtext, advc ) \
188
    i_config++; \
gbazin's avatar
 
gbazin committed
189 190
    if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
        (i_config+11) * sizeof(module_config_t)); \
191
    { static module_config_t tmp = { CONFIG_ITEM_INTEGER, NULL, name, '\0', text, longtext, NULL, i_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
192
#define add_key( name, i_value, p_callback, text, longtext, advc ) \
193
    i_config++; \
gbazin's avatar
 
gbazin committed
194 195
    if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
        (i_config+11) * sizeof(module_config_t)); \
196
    { static module_config_t tmp = { CONFIG_ITEM_KEY, NULL, name, '\0', text, longtext, NULL, i_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
197
#define add_integer_with_range( name, i_value, i_min, i_max, p_callback, text, longtext, advc ) \
198
    i_config++; \
gbazin's avatar
 
gbazin committed
199 200
    if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
        (i_config+11) * sizeof(module_config_t)); \
201
    { static module_config_t tmp = { CONFIG_ITEM_INTEGER, NULL, name, '\0', text, longtext, NULL, i_value, 0, i_min, i_max }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
202
#define add_float( name, f_value, p_callback, text, longtext, advc ) \
203
    i_config++; \
gbazin's avatar
 
gbazin committed
204 205
    if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
        (i_config+11) * sizeof(module_config_t)); \
206
    { static module_config_t tmp = { CONFIG_ITEM_FLOAT, NULL, name, '\0', text, longtext, NULL, 0, f_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
207
#define add_float_with_range( name, f_value, f_min, f_max, p_callback, text, longtext, advc ) \
208
    i_config++; \
gbazin's avatar
 
gbazin committed
209 210
    if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
        (i_config+11) * sizeof(module_config_t)); \
211
    { static module_config_t tmp = { CONFIG_ITEM_FLOAT, NULL, name, '\0', text, longtext, NULL, 0, f_value, 0, 0, f_min, f_max }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
212
#define add_bool( name, b_value, p_callback, text, longtext, advc ) \
213
    i_config++; \
gbazin's avatar
 
gbazin committed
214 215
    if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
        (i_config+11) * sizeof(module_config_t)); \
216 217 218 219 220 221 222 223 224
    { static module_config_t tmp = { CONFIG_ITEM_BOOL, NULL, name, '\0', text, longtext, NULL, b_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }

/* Modifier macros for the config options (used for fine tuning) */
#define change_short( ch ) \
    p_config[i_config].i_short = ch;

#define change_string_list( list, list_text, list_update_func ) \
    p_config[i_config].i_list = sizeof(list)/sizeof(char *); \
    p_config[i_config].ppsz_list = list; \
225
    p_config[i_config].ppsz_list_text = list_text;
226 227 228 229

#define change_integer_list( list, list_text, list_update_func ) \
    p_config[i_config].i_list = sizeof(list)/sizeof(int); \
    p_config[i_config].pi_list = list; \
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
    p_config[i_config].ppsz_list_text = list_text;

#define change_action_add( pf_action, action_text ) \
    if( !p_config[i_config].i_action ) \
    { p_config[i_config].ppsz_action_text = 0; \
      p_config[i_config].ppf_action = 0; } \
    p_config[i_config].ppf_action = (vlc_callback_t *) \
      realloc( p_config[i_config].ppf_action, \
      (p_config[i_config].i_action + 1) * sizeof(void *) ); \
    p_config[i_config].ppsz_action_text = (char **)\
      realloc( p_config[i_config].ppsz_action_text, \
      (p_config[i_config].i_action + 1) * sizeof(void *) ); \
    p_config[i_config].ppf_action[p_config[i_config].i_action] = pf_action; \
    p_config[i_config].ppsz_action_text[p_config[i_config].i_action] = \
      action_text; \
    p_config[i_config].i_action++;