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
7 * $Id: configuration.h,v 1.34 2004/01/25 18:17:08 zorglub Exp $
9 * Authors: Gildas Bazin <gbazin@netcourrier.com>
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;
71 char **ppsz_list; /* List of possible values for the option */
72 int *pi_list; /* Idem for integers */
73 char **ppsz_list_text; /* Friendly names for list values */
74 int i_list; /* Options list size */
75 vlc_callback_t pf_list_update; /* Callback that updates the list */
77 vlc_mutex_t *p_lock; /* Lock to use when modifying the config */
78 vlc_bool_t b_dirty; /* Dirty flag to indicate a config change */
79 vlc_bool_t b_advanced; /* Flag to indicate an advanced option */
81 /* Original option values */
87 /*****************************************************************************
88 * Prototypes - these methods are used to get, set or manipulate configuration
90 *****************************************************************************/
91 VLC_EXPORT( int, __config_GetType, (vlc_object_t *, const char *) );
92 VLC_EXPORT( int, __config_GetInt, (vlc_object_t *, const char *) );
93 VLC_EXPORT( void, __config_PutInt, (vlc_object_t *, const char *, int) );
94 VLC_EXPORT( float, __config_GetFloat, (vlc_object_t *, const char *) );
95 VLC_EXPORT( void, __config_PutFloat, (vlc_object_t *, const char *, float) );
96 VLC_EXPORT( char *, __config_GetPsz, (vlc_object_t *, const char *) );
97 VLC_EXPORT( void, __config_PutPsz, (vlc_object_t *, const char *, const char *) );
99 VLC_EXPORT( int, __config_LoadCmdLine, ( vlc_object_t *, int *, char *[], vlc_bool_t ) );
100 VLC_EXPORT( char *, config_GetHomeDir, ( void ) );
101 VLC_EXPORT( int, __config_LoadConfigFile, ( vlc_object_t *, const char * ) );
102 VLC_EXPORT( int, __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
103 VLC_EXPORT( void, __config_ResetAll, ( vlc_object_t * ) );
105 VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) );
106 VLC_EXPORT( module_t *, config_FindModule,( vlc_object_t *, const char * ) );
108 VLC_EXPORT( void, config_Duplicate, ( module_t *, module_config_t * ) );
109 void config_Free ( module_t * );
111 VLC_EXPORT( void, config_SetCallbacks, ( module_config_t *, module_config_t * ) );
112 VLC_EXPORT( void, config_UnsetCallbacks, ( module_config_t * ) );
114 #define config_GetType(a,b) __config_GetType(VLC_OBJECT(a),b)
115 #define config_GetInt(a,b) __config_GetInt(VLC_OBJECT(a),b)
116 #define config_PutInt(a,b,c) __config_PutInt(VLC_OBJECT(a),b,c)
117 #define config_GetFloat(a,b) __config_GetFloat(VLC_OBJECT(a),b)
118 #define config_PutFloat(a,b,c) __config_PutFloat(VLC_OBJECT(a),b,c)
119 #define config_GetPsz(a,b) __config_GetPsz(VLC_OBJECT(a),b)
120 #define config_PutPsz(a,b,c) __config_PutPsz(VLC_OBJECT(a),b,c)
122 #define config_LoadCmdLine(a,b,c,d) __config_LoadCmdLine(VLC_OBJECT(a),b,c,d)
123 #define config_LoadConfigFile(a,b) __config_LoadConfigFile(VLC_OBJECT(a),b)
124 #define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b)
125 #define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a))
127 /*****************************************************************************
128 * Macros used to build the configuration structure.
130 * Note that internally we support only 3 types of config data: int , float
132 * The other types declared here just map to one of these 3 basic types but
133 * have the advantage of also providing very good hints to a configuration
134 * interface so as to make it more user friendly.
135 * The configuration structure also includes category hints. These hints can
136 * provide a configuration interface with some very useful data and again
137 * allow for a more user friendly interface.
138 *****************************************************************************/
140 #define add_category_hint( text, longtext, advc ) \
142 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
143 (i_config+11) * sizeof(module_config_t)); \
144 { 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; }
145 #define add_subcategory_hint( text, longtext ) \
147 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
148 (i_config+11) * sizeof(module_config_t)); \
149 { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY, NULL, NULL, '\0', text, longtext }; p_config[ i_config ] = tmp; }
150 #define end_subcategory_hint \
152 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
153 (i_config+11) * sizeof(module_config_t)); \
154 { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY_END, NULL, NULL, '\0' }; p_config[ i_config ] = tmp; }
155 #define add_usage_hint( text ) \
157 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
158 (i_config+11) * sizeof(module_config_t)); \
159 { static module_config_t tmp = { CONFIG_HINT_USAGE, NULL, NULL, '\0', text }; p_config[ i_config ] = tmp; }
161 #define add_string( name, psz_value, p_callback, text, longtext, advc ) \
163 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
164 (i_config+11) * sizeof(module_config_t)); \
165 { 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; }
166 #define add_file( name, psz_value, p_callback, text, longtext, advc ) \
168 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
169 (i_config+11) * sizeof(module_config_t)); \
170 { 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; }
171 #define add_directory( name, psz_value, p_callback, text, longtext, advc ) \
173 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
174 (i_config+11) * sizeof(module_config_t)); \
175 { 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; }
176 #define add_module( name, psz_caps, psz_value, p_callback, text, longtext, advc ) \
178 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
179 (i_config+11) * sizeof(module_config_t)); \
180 { 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; }
181 #define add_integer( name, i_value, p_callback, text, longtext, advc ) \
183 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
184 (i_config+11) * sizeof(module_config_t)); \
185 { 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; }
186 #define add_key( name, i_value, p_callback, text, longtext, advc ) \
188 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
189 (i_config+11) * sizeof(module_config_t)); \
190 { 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; }
191 #define add_integer_with_range( name, i_value, i_min, i_max, p_callback, text, longtext, advc ) \
193 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
194 (i_config+11) * sizeof(module_config_t)); \
195 { 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; }
196 #define add_float( name, f_value, p_callback, text, longtext, advc ) \
198 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
199 (i_config+11) * sizeof(module_config_t)); \
200 { 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; }
201 #define add_float_with_range( name, f_value, f_min, f_max, p_callback, text, longtext, advc ) \
203 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
204 (i_config+11) * sizeof(module_config_t)); \
205 { 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; }
206 #define add_bool( name, b_value, p_callback, text, longtext, advc ) \
208 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
209 (i_config+11) * sizeof(module_config_t)); \
210 { 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; }
212 /* Modifier macros for the config options (used for fine tuning) */
213 #define change_short( ch ) \
214 p_config[i_config].i_short = ch;
216 #define change_string_list( list, list_text, list_update_func ) \
217 p_config[i_config].i_list = sizeof(list)/sizeof(char *); \
218 p_config[i_config].ppsz_list = list; \
219 p_config[i_config].ppsz_list_text = list_text; \
220 p_config[i_config].pf_list_update = list_update_func;
222 #define change_integer_list( list, list_text, list_update_func ) \
223 p_config[i_config].i_list = sizeof(list)/sizeof(int); \
224 p_config[i_config].pi_list = list; \
225 p_config[i_config].ppsz_list_text = list_text; \
226 p_config[i_config].pf_list_update = list_update_func;