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.13 2002/06/01 18:04:48 sam 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 MODULE_CONFIG_HINT_END 0x0001 /* End of config */
32 #define MODULE_CONFIG_HINT_CATEGORY 0x0002 /* Start of new category */
33 #define MODULE_CONFIG_HINT_SUBCATEGORY 0x0003 /* Start of sub-category */
34 #define MODULE_CONFIG_HINT_SUBCATEGORY_END 0x0004 /* End of sub-category */
36 #define MODULE_CONFIG_HINT 0x000F
38 /* Configuration item types */
39 #define MODULE_CONFIG_ITEM_STRING 0x0010 /* String option */
40 #define MODULE_CONFIG_ITEM_FILE 0x0020 /* File option */
41 #define MODULE_CONFIG_ITEM_MODULE 0x0030 /* Module option */
42 #define MODULE_CONFIG_ITEM_INTEGER 0x0040 /* Integer option */
43 #define MODULE_CONFIG_ITEM_BOOL 0x0050 /* Bool option */
44 #define MODULE_CONFIG_ITEM_FLOAT 0x0060 /* Float option */
46 #define MODULE_CONFIG_ITEM 0x00F0
48 struct module_config_s
50 int i_type; /* Configuration type */
51 char *psz_name; /* Option name */
52 char i_short; /* Optional short option name */
53 char *psz_text; /* Short comment on the configuration option */
54 char *psz_longtext; /* Long comment on the configuration option */
55 char *psz_value; /* Option value */
56 int i_value; /* Option value */
57 float f_value; /* Option value */
59 /* Function to call when commiting a change */
60 void ( * pf_callback ) ( vlc_object_t * );
62 vlc_mutex_t *p_lock; /* lock to use when modifying the config */
63 vlc_bool_t b_dirty; /* Dirty flag to indicate a config change */
66 /*****************************************************************************
67 * Prototypes - these methods are used to get, set or manipulate configuration
69 *****************************************************************************/
70 VLC_EXPORT( int, __config_GetInt, (vlc_object_t *, const char *) );
71 VLC_EXPORT( void, __config_PutInt, (vlc_object_t *, const char *, int) );
72 VLC_EXPORT( float, __config_GetFloat, (vlc_object_t *, const char *) );
73 VLC_EXPORT( void, __config_PutFloat, (vlc_object_t *, const char *, float) );
74 VLC_EXPORT( char *, __config_GetPsz, (vlc_object_t *, const char *) );
75 VLC_EXPORT( void, __config_PutPsz, (vlc_object_t *, const char *, char *) );
77 VLC_EXPORT( int, __config_LoadCmdLine, ( vlc_object_t *, int *, char *[], vlc_bool_t ) );
78 VLC_EXPORT( char *, config_GetHomeDir, ( void ) );
79 VLC_EXPORT( int, __config_LoadConfigFile, ( vlc_object_t *, const char * ) );
80 VLC_EXPORT( int, __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
81 VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char *psz_name ) );
83 VLC_EXPORT( void, config_Duplicate, ( module_t *, module_config_t * ) );
84 void config_Free ( module_t * );
86 VLC_EXPORT( void, config_SetCallbacks, ( module_config_t *, module_config_t * ) );
87 VLC_EXPORT( void, config_UnsetCallbacks, ( module_config_t * ) );
89 #define config_GetInt(a,b) __config_GetInt(CAST_TO_VLC_OBJECT(a),b)
90 #define config_PutInt(a,b,c) __config_PutInt(CAST_TO_VLC_OBJECT(a),b,c)
91 #define config_GetFloat(a,b) __config_GetFloat(CAST_TO_VLC_OBJECT(a),b)
92 #define config_PutFloat(a,b,c) __config_PutFloat(CAST_TO_VLC_OBJECT(a),b,c)
93 #define config_GetPsz(a,b) __config_GetPsz(CAST_TO_VLC_OBJECT(a),b)
94 #define config_PutPsz(a,b,c) __config_PutPsz(CAST_TO_VLC_OBJECT(a),b,c)
96 #define config_LoadCmdLine(a,b,c,d) __config_LoadCmdLine(CAST_TO_VLC_OBJECT(a),b,c,d)
97 #define config_LoadConfigFile(a,b) __config_LoadConfigFile(CAST_TO_VLC_OBJECT(a),b)
98 #define config_SaveConfigFile(a,b) __config_SaveConfigFile(CAST_TO_VLC_OBJECT(a),b)
100 /*****************************************************************************
101 * Macros used to build the configuration structure.
103 * Note that internally we support only 2 types of config data: int and string.
104 * The other types declared here just map to one of these 2 basic types but
105 * have the advantage of also providing very good hints to a configuration
106 * interface so as to make it more user friendly.
107 * The configuration structure also includes category hints. These hints can
108 * provide a configuration inteface with some very useful data and also allow
109 * for a more user friendly interface.
110 *****************************************************************************/
112 #define MODULE_CONFIG_START \
113 static module_config_t p_config[] = {
115 #define MODULE_CONFIG_STOP \
116 { MODULE_CONFIG_HINT_END, NULL, '\0', NULL, NULL, NULL, 0, 0, NULL, 0 } };
118 #define ADD_CATEGORY_HINT( text, longtext ) \
119 { MODULE_CONFIG_HINT_CATEGORY, NULL, '\0', text, longtext, NULL, 0, 0, \
121 #define ADD_SUBCATEGORY_HINT( text, longtext ) \
122 { MODULE_CONFIG_HINT_SUBCATEGORY, NULL, '\0', text, longtext, NULL, 0, 0, \
124 #define END_SUBCATEGORY_HINT \
125 { MODULE_CONFIG_HINT_SUBCATEGORY_END, NULL, '\0', NULL, NULL, NULL, 0, 0, \
127 #define ADD_STRING( name, value, p_callback, text, longtext ) \
128 { MODULE_CONFIG_ITEM_STRING, name, '\0', text, longtext, value, 0, 0, \
129 p_callback, NULL, 0 },
130 #define ADD_FILE( name, psz_value, p_callback, text, longtext ) \
131 { MODULE_CONFIG_ITEM_FILE, name, '\0', text, longtext, psz_value, 0, 0, \
132 p_callback, NULL, 0 },
133 #define ADD_MODULE( name, i_capability, psz_value, p_callback, text, longtext)\
134 { MODULE_CONFIG_ITEM_MODULE, name, '\0', text, longtext, psz_value, \
135 i_capability, 0, p_callback, NULL, 0 },
136 #define ADD_INTEGER( name, i_value, p_callback, text, longtext ) \
137 { MODULE_CONFIG_ITEM_INTEGER, name, '\0', text, longtext, NULL, i_value, \
138 0, p_callback, NULL, 0 },
139 #define ADD_FLOAT( name, f_value, p_callback, text, longtext ) \
140 { MODULE_CONFIG_ITEM_FLOAT, name, '\0', text, longtext, NULL, 0, f_value, \
141 p_callback, NULL, 0 },
142 #define ADD_BOOL( name, b_value, p_callback, text, longtext ) \
143 { MODULE_CONFIG_ITEM_BOOL, name, '\0', text, longtext, NULL, b_value, 0, \
144 p_callback, NULL, 0 },
145 #define ADD_STRING_WITH_SHORT( name, ch, psz_value, p_callback, text, ltext ) \
146 { MODULE_CONFIG_ITEM_STRING, name, ch, text, ltext, psz_value, 0, 0, \
147 p_callback, NULL, 0 },
148 #define ADD_FILE_WITH_SHORT( name, ch, psz_value, p_callback, text, ltext ) \
149 { MODULE_CONFIG_ITEM_FILE, name, ch, text, ltext, psz_value, 0, 0, \
150 p_callback, NULL, 0 },
151 #define ADD_MODULE_WITH_SHORT( name, ch, i_capability, psz_value, p_callback, \
153 { MODULE_CONFIG_ITEM_MODULE, name, ch, text, ltext, psz_value, \
154 i_capability, 0, p_callback, NULL, 0 },
155 #define ADD_INTEGER_WITH_SHORT( name, ch, i_value, p_callback, text, ltext ) \
156 { MODULE_CONFIG_ITEM_INTEGER, name, ch, text, ltext, NULL, i_value, 0, \
157 p_callback, NULL, 0 },
158 #define ADD_FLOAT_WITH_SHORT( name, ch, f_value, p_callback, text, ltext ) \
159 { MODULE_CONFIG_ITEM_FLOAT, name, ch, text, ltext, NULL, 0, f_value, \
160 p_callback, NULL, 0 },
161 #define ADD_BOOL_WITH_SHORT( name, ch, b_value, p_callback, text, ltext ) \
162 { MODULE_CONFIG_ITEM_BOOL, name, ch, text, ltext, NULL, b_value, 0, \
163 p_callback, NULL, 0 },