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.23 2003/01/06 00:37:29 garf 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 */
47 #define CONFIG_ITEM 0x00F0
49 struct module_config_t
51 int i_type; /* Configuration type */
52 char *psz_type; /* Configuration subtype */
53 char *psz_name; /* Option name */
54 char i_short; /* Optional short option name */
55 char *psz_text; /* Short comment on the configuration option */
56 char *psz_longtext; /* Long comment on the configuration option */
57 char *psz_value; /* Option value */
58 int i_value; /* Option value */
59 float f_value; /* Option value */
60 int i_min; /* Option minimum value */
61 int i_max; /* Option maximum value */
62 float f_min; /* Option minimum value */
63 float f_max; /* Option maximum value */
65 /* Function to call when commiting a change */
66 void ( * pf_callback ) ( vlc_object_t * );
68 char **ppsz_list; /* List of possible values for the option */
70 vlc_mutex_t *p_lock; /* Lock to use when modifying the config */
71 vlc_bool_t b_dirty; /* Dirty flag to indicate a config change */
75 /*****************************************************************************
76 * Prototypes - these methods are used to get, set or manipulate configuration
78 *****************************************************************************/
79 VLC_EXPORT( int, __config_GetInt, (vlc_object_t *, const char *) );
80 VLC_EXPORT( void, __config_PutInt, (vlc_object_t *, const char *, int) );
81 VLC_EXPORT( float, __config_GetFloat, (vlc_object_t *, const char *) );
82 VLC_EXPORT( void, __config_PutFloat, (vlc_object_t *, const char *, float) );
83 VLC_EXPORT( char *, __config_GetPsz, (vlc_object_t *, const char *) );
84 VLC_EXPORT( void, __config_PutPsz, (vlc_object_t *, const char *, const char *) );
86 VLC_EXPORT( int, __config_LoadCmdLine, ( vlc_object_t *, int *, char *[], vlc_bool_t ) );
87 VLC_EXPORT( char *, config_GetHomeDir, ( void ) );
88 VLC_EXPORT( int, __config_LoadConfigFile, ( vlc_object_t *, const char * ) );
89 VLC_EXPORT( int, __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
90 VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char *psz_name ) );
92 VLC_EXPORT( void, config_Duplicate, ( module_t *, module_config_t * ) );
93 void config_Free ( module_t * );
95 VLC_EXPORT( void, config_SetCallbacks, ( module_config_t *, module_config_t * ) );
96 VLC_EXPORT( void, config_UnsetCallbacks, ( module_config_t * ) );
98 #define config_GetInt(a,b) __config_GetInt(VLC_OBJECT(a),b)
99 #define config_PutInt(a,b,c) __config_PutInt(VLC_OBJECT(a),b,c)
100 #define config_GetFloat(a,b) __config_GetFloat(VLC_OBJECT(a),b)
101 #define config_PutFloat(a,b,c) __config_PutFloat(VLC_OBJECT(a),b,c)
102 #define config_GetPsz(a,b) __config_GetPsz(VLC_OBJECT(a),b)
103 #define config_PutPsz(a,b,c) __config_PutPsz(VLC_OBJECT(a),b,c)
105 #define config_LoadCmdLine(a,b,c,d) __config_LoadCmdLine(VLC_OBJECT(a),b,c,d)
106 #define config_LoadConfigFile(a,b) __config_LoadConfigFile(VLC_OBJECT(a),b)
107 #define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b)
109 /*****************************************************************************
110 * Macros used to build the configuration structure.
112 * Note that internally we support only 3 types of config data: int , float
114 * The other types declared here just map to one of these 3 basic types but
115 * have the advantage of also providing very good hints to a configuration
116 * interface so as to make it more user friendly.
117 * The configuration structure also includes category hints. These hints can
118 * provide a configuration interface with some very useful data and again
119 * allow for a more user friendly interface.
120 *****************************************************************************/
122 #define add_category_hint( text, longtext ) \
123 { static module_config_t tmp = { CONFIG_HINT_CATEGORY, NULL, NULL, '\0', text, longtext }; p_config[ i_config ] = tmp; } i_config++
124 #define add_subcategory_hint( text, longtext ) \
125 { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY, NULL, NULL, '\0', text, longtext }; p_config[ i_config ] = tmp; } i_config++
126 #define end_subcategory_hint \
127 { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY_END, NULL, NULL, '\0' }; p_config[ i_config ] = tmp; } i_config++
128 #define add_usage_hint( text ) \
129 { static module_config_t tmp = { CONFIG_HINT_USAGE, NULL, NULL, '\0', text }; p_config[ i_config ] = tmp; } i_config++
131 #define add_string( name, psz_value, p_callback, text, longtext ) \
132 { static module_config_t tmp = { CONFIG_ITEM_STRING, NULL, name, '\0', text, longtext, psz_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; } i_config++
133 #define add_string_from_list( name, psz_value, ppsz_list, p_callback, text, \
135 { static module_config_t tmp = { CONFIG_ITEM_STRING, NULL, name, '\0', text, longtext, psz_value, 0, 0, 0, 0, 0, 0, NULL, ppsz_list }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; } i_config++
136 #define add_file( name, psz_value, p_callback, text, longtext ) \
137 { 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; } i_config++
138 #define add_module( name, psz_caps, psz_value, p_callback, text, longtext ) \
139 { 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; } i_config++
140 #define add_integer( name, i_value, p_callback, text, longtext ) \
141 { 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; } i_config++
142 #define add_integer_with_range( name, i_value, i_min, i_max, p_callback, text, longtext ) \
143 { 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; } i_config++
144 #define add_float( name, f_value, p_callback, text, longtext ) \
145 { 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; } i_config++
146 #define add_float_with_range( name, f_value, f_min, f_max, p_callback, text, longtext ) \
147 { 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; } i_config++
148 #define add_bool( name, b_value, p_callback, text, longtext ) \
149 { 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; } i_config++
151 /* These should be seldom used. They were added just to provide easy shortcuts
152 * for the command line interface */
153 #define add_string_with_short( name, ch, psz_value, p_callback, text, ltext ) \
154 { static module_config_t tmp = { CONFIG_ITEM_STRING, NULL, name, ch, text, ltext, psz_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; } i_config++
155 #define add_file_with_short( name, ch, psz_value, p_callback, text, ltext ) \
156 { static module_config_t tmp = { CONFIG_ITEM_FILE, NULL, name, ch, text, ltext, psz_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; } i_config++
157 #define add_module_with_short( name, ch, psz_caps, psz_value, p_callback, \
159 { static module_config_t tmp = { CONFIG_ITEM_MODULE, psz_caps, name, ch, text, ltext, psz_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; } i_config++
160 #define add_integer_with_short( name, ch, i_value, p_callback, text, ltext ) \
161 { static module_config_t tmp = { CONFIG_ITEM_INTEGER, NULL, name, ch, text, ltext, NULL, i_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; } i_config++
162 #define add_float_with_short( name, ch, f_value, p_callback, text, ltext ) \
163 { static module_config_t tmp = { CONFIG_ITEM_FLOAT, NULL, name, ch, text, ltext, NULL, 0, f_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; } i_config++
164 #define add_bool_with_short( name, ch, b_value, p_callback, text, ltext ) \
165 { static module_config_t tmp = { CONFIG_ITEM_BOOL, NULL, name, ch, text, ltext, NULL, b_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; } i_config++