1 /*****************************************************************************
2 * configuration.h : configuration management module
3 * This file describes the programming interface for the configuration module.
4 * It includes functions allowing to declare, get or set configuration options.
5 *****************************************************************************
6 * Copyright (C) 1999, 2000 VideoLAN
9 * Authors: Gildas Bazin <gbazin@videolan.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
24 *****************************************************************************/
26 /*****************************************************************************
27 * Macros used to build the configuration structure.
28 *****************************************************************************/
30 /* Configuration hint types */
31 #define CONFIG_HINT_END 0x0001 /* End of config */
32 #define CONFIG_HINT_CATEGORY 0x0002 /* Start of new category */
33 #define CONFIG_HINT_SUBCATEGORY 0x0003 /* Start of sub-category */
34 #define CONFIG_HINT_SUBCATEGORY_END 0x0004 /* End of sub-category */
35 #define CONFIG_HINT_USAGE 0x0005 /* Usage information */
37 #define CONFIG_HINT 0x000F
39 /* Configuration item types */
40 #define CONFIG_ITEM_STRING 0x0010 /* String option */
41 #define CONFIG_ITEM_FILE 0x0020 /* File option */
42 #define CONFIG_ITEM_MODULE 0x0030 /* Module option */
43 #define CONFIG_ITEM_INTEGER 0x0040 /* Integer option */
44 #define CONFIG_ITEM_BOOL 0x0050 /* Bool option */
45 #define CONFIG_ITEM_FLOAT 0x0060 /* Float option */
46 #define CONFIG_ITEM_DIRECTORY 0x0070 /* Directory option */
47 #define CONFIG_ITEM_KEY 0x0080 /* Hot key option */
49 #define CONFIG_ITEM 0x00F0
51 struct module_config_t
53 int i_type; /* Configuration type */
54 char *psz_type; /* Configuration subtype */
55 char *psz_name; /* Option name */
56 char i_short; /* Optional short option name */
57 char *psz_text; /* Short comment on the configuration option */
58 char *psz_longtext; /* Long comment on the configuration option */
59 char *psz_value; /* Option value */
60 int i_value; /* Option value */
61 float f_value; /* Option value */
62 int i_min; /* Option minimum value */
63 int i_max; /* Option maximum value */
64 float f_min; /* Option minimum value */
65 float f_max; /* Option maximum value */
67 /* Function to call when commiting a change */
68 vlc_callback_t pf_callback;
69 void *p_callback_data;
72 char **ppsz_list; /* List of possible values for the option */
73 int *pi_list; /* Idem for integers */
74 char **ppsz_list_text; /* Friendly names for list values */
75 int i_list; /* Options list size */
78 vlc_callback_t *ppf_action; /* List of possible actions for a config */
79 char **ppsz_action_text; /* Friendly names for actions */
80 int i_action; /* actions list size */
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 */
85 vlc_bool_t b_advanced; /* Flag to indicate an advanced option */
87 /* Original option values */
93 /*****************************************************************************
94 * Prototypes - these methods are used to get, set or manipulate configuration
96 *****************************************************************************/
97 VLC_EXPORT( int, __config_GetType, (vlc_object_t *, const char *) );
98 VLC_EXPORT( int, __config_GetInt, (vlc_object_t *, const char *) );
99 VLC_EXPORT( void, __config_PutInt, (vlc_object_t *, const char *, int) );
100 VLC_EXPORT( float, __config_GetFloat, (vlc_object_t *, const char *) );
101 VLC_EXPORT( void, __config_PutFloat, (vlc_object_t *, const char *, float) );
102 VLC_EXPORT( char *, __config_GetPsz, (vlc_object_t *, const char *) );
103 VLC_EXPORT( void, __config_PutPsz, (vlc_object_t *, const char *, const char *) );
105 VLC_EXPORT( int, __config_LoadCmdLine, ( vlc_object_t *, int *, char *[], vlc_bool_t ) );
106 VLC_EXPORT( char *, config_GetHomeDir, ( void ) );
107 VLC_EXPORT( int, __config_LoadConfigFile, ( vlc_object_t *, const char * ) );
108 VLC_EXPORT( int, __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
109 VLC_EXPORT( void, __config_ResetAll, ( vlc_object_t * ) );
111 VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) );
112 VLC_EXPORT( module_t *, config_FindModule,( vlc_object_t *, const char * ) );
114 VLC_EXPORT( void, config_Duplicate, ( module_t *, module_config_t * ) );
115 void config_Free ( module_t * );
117 VLC_EXPORT( void, config_SetCallbacks, ( module_config_t *, module_config_t * ) );
118 VLC_EXPORT( void, config_UnsetCallbacks, ( module_config_t * ) );
120 #define config_GetType(a,b) __config_GetType(VLC_OBJECT(a),b)
121 #define config_GetInt(a,b) __config_GetInt(VLC_OBJECT(a),b)
122 #define config_PutInt(a,b,c) __config_PutInt(VLC_OBJECT(a),b,c)
123 #define config_GetFloat(a,b) __config_GetFloat(VLC_OBJECT(a),b)
124 #define config_PutFloat(a,b,c) __config_PutFloat(VLC_OBJECT(a),b,c)
125 #define config_GetPsz(a,b) __config_GetPsz(VLC_OBJECT(a),b)
126 #define config_PutPsz(a,b,c) __config_PutPsz(VLC_OBJECT(a),b,c)
128 #define config_LoadCmdLine(a,b,c,d) __config_LoadCmdLine(VLC_OBJECT(a),b,c,d)
129 #define config_LoadConfigFile(a,b) __config_LoadConfigFile(VLC_OBJECT(a),b)
130 #define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b)
131 #define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a))
134 int config_CreateDir( vlc_object_t *, char * );
136 /*****************************************************************************
137 * Macros used to build the configuration structure.
139 * Note that internally we support only 3 types of config data: int , float
141 * The other types declared here just map to one of these 3 basic types but
142 * have the advantage of also providing very good hints to a configuration
143 * interface so as to make it more user friendly.
144 * The configuration structure also includes category hints. These hints can
145 * provide a configuration interface with some very useful data and again
146 * allow for a more user friendly interface.
147 *****************************************************************************/
149 #define add_category_hint( text, longtext, advc ) \
151 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
152 (i_config+11) * sizeof(module_config_t)); \
153 { 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; }
154 #define add_subcategory_hint( text, longtext ) \
156 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
157 (i_config+11) * sizeof(module_config_t)); \
158 { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY, NULL, NULL, '\0', text, longtext }; p_config[ i_config ] = tmp; }
159 #define end_subcategory_hint \
161 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
162 (i_config+11) * sizeof(module_config_t)); \
163 { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY_END, NULL, NULL, '\0' }; p_config[ i_config ] = tmp; }
164 #define add_usage_hint( text ) \
166 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
167 (i_config+11) * sizeof(module_config_t)); \
168 { static module_config_t tmp = { CONFIG_HINT_USAGE, NULL, NULL, '\0', text }; p_config[ i_config ] = tmp; }
170 #define add_string( name, psz_value, p_callback, text, longtext, advc ) \
172 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
173 (i_config+11) * sizeof(module_config_t)); \
174 { 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; }
175 #define add_file( name, psz_value, p_callback, text, longtext, advc ) \
177 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
178 (i_config+11) * sizeof(module_config_t)); \
179 { 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; }
180 #define add_directory( name, psz_value, p_callback, text, longtext, advc ) \
182 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
183 (i_config+11) * sizeof(module_config_t)); \
184 { 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; }
185 #define add_module( name, psz_caps, psz_value, p_callback, text, longtext, advc ) \
187 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
188 (i_config+11) * sizeof(module_config_t)); \
189 { 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; }
190 #define add_integer( name, i_value, p_callback, text, longtext, advc ) \
192 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
193 (i_config+11) * sizeof(module_config_t)); \
194 { 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; }
195 #define add_key( name, i_value, p_callback, text, longtext, advc ) \
197 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
198 (i_config+11) * sizeof(module_config_t)); \
199 { 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; }
200 #define add_integer_with_range( name, i_value, i_min, i_max, p_callback, text, longtext, advc ) \
202 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
203 (i_config+11) * sizeof(module_config_t)); \
204 { 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; }
205 #define add_float( name, f_value, p_callback, text, longtext, advc ) \
207 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
208 (i_config+11) * sizeof(module_config_t)); \
209 { 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; }
210 #define add_float_with_range( name, f_value, f_min, f_max, p_callback, text, longtext, advc ) \
212 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
213 (i_config+11) * sizeof(module_config_t)); \
214 { 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; }
215 #define add_bool( name, b_value, p_callback, text, longtext, advc ) \
217 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
218 (i_config+11) * sizeof(module_config_t)); \
219 { 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; }
221 /* Modifier macros for the config options (used for fine tuning) */
222 #define change_short( ch ) \
223 p_config[i_config].i_short = ch;
225 #define change_string_list( list, list_text, list_update_func ) \
226 p_config[i_config].i_list = sizeof(list)/sizeof(char *); \
227 p_config[i_config].ppsz_list = list; \
228 p_config[i_config].ppsz_list_text = list_text;
230 #define change_integer_list( list, list_text, list_update_func ) \
231 p_config[i_config].i_list = sizeof(list)/sizeof(int); \
232 p_config[i_config].pi_list = list; \
233 p_config[i_config].ppsz_list_text = list_text;
235 #define change_action_add( pf_action, action_text ) \
236 if( !p_config[i_config].i_action ) \
237 { p_config[i_config].ppsz_action_text = 0; \
238 p_config[i_config].ppf_action = 0; } \
239 p_config[i_config].ppf_action = (vlc_callback_t *) \
240 realloc( p_config[i_config].ppf_action, \
241 (p_config[i_config].i_action + 1) * sizeof(void *) ); \
242 p_config[i_config].ppsz_action_text = (char **)\
243 realloc( p_config[i_config].ppsz_action_text, \
244 (p_config[i_config].i_action + 1) * sizeof(void *) ); \
245 p_config[i_config].ppf_action[p_config[i_config].i_action] = pf_action; \
246 p_config[i_config].ppsz_action_text[p_config[i_config].i_action] = \
248 p_config[i_config].i_action++;