1 /*****************************************************************************
2 * vlc_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-2006 VLC authors and VideoLAN
9 * Authors: Gildas Bazin <gbazin@videolan.org>
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU Lesser General Public License as published by
13 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public License
22 * along with this program; if not, write to the Free Software Foundation,
23 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
26 #ifndef VLC_CONFIGURATION_H
27 #define VLC_CONFIGURATION_H 1
31 * This file describes the programming interface for the configuration module.
32 * It includes functions allowing to declare, get or set configuration options.
35 #include <sys/types.h> /* for ssize_t */
41 struct config_category_t
55 typedef int (*vlc_string_list_cb
)(vlc_object_t
*, const char *,
57 typedef int (*vlc_integer_list_cb
)(vlc_object_t
*, const char *,
58 int64_t **, char ***);
60 struct module_config_t
62 uint8_t i_type
; /* Configuration type */
63 char i_short
; /* Optional short option name */
64 unsigned b_advanced
:1; /* Advanced option */
65 unsigned b_internal
:1; /* Hidden from prefs and help */
66 unsigned b_unsaveable
:1; /* Not stored in configuration */
67 unsigned b_safe
:1; /* Safe in web plugins and playlists */
68 unsigned b_removed
:1; /* Deprecated */
70 const char *psz_type
; /* Configuration subtype */
71 const char *psz_name
; /* Option name */
72 const char *psz_text
; /* Short comment on the configuration option */
73 const char *psz_longtext
; /* Long comment on the configuration option */
75 module_value_t value
; /* Option value */
81 uint16_t list_count
; /* Options list size */
84 const char **psz
; /* List of possible values for the option */
86 vlc_string_list_cb psz_cb
;
87 vlc_integer_list_cb i_cb
;
89 const char **list_text
; /* Friendly names for list values */
90 const char *list_cb_name
;
94 /*****************************************************************************
95 * Prototypes - these methods are used to get, set or manipulate configuration
97 *****************************************************************************/
98 VLC_API
int config_GetType(vlc_object_t
*, const char *) VLC_USED
;
99 VLC_API
int64_t config_GetInt(vlc_object_t
*, const char *) VLC_USED
;
100 VLC_API
void config_PutInt(vlc_object_t
*, const char *, int64_t);
101 VLC_API
float config_GetFloat(vlc_object_t
*, const char *) VLC_USED
;
102 VLC_API
void config_PutFloat(vlc_object_t
*, const char *, float);
103 VLC_API
char * config_GetPsz(vlc_object_t
*, const char *) VLC_USED VLC_MALLOC
;
104 VLC_API
void config_PutPsz(vlc_object_t
*, const char *, const char *);
105 VLC_API ssize_t
config_GetIntChoices(vlc_object_t
*, const char *,
106 int64_t **, char ***) VLC_USED
;
107 VLC_API ssize_t
config_GetPszChoices(vlc_object_t
*, const char *,
108 char ***, char ***) VLC_USED
;
110 VLC_API
int config_SaveConfigFile( vlc_object_t
* );
111 #define config_SaveConfigFile(a) config_SaveConfigFile(VLC_OBJECT(a))
113 VLC_API
void config_ResetAll( vlc_object_t
* );
114 #define config_ResetAll(a) config_ResetAll(VLC_OBJECT(a))
116 VLC_API module_config_t
* config_FindConfig( vlc_object_t
*, const char * ) VLC_USED
;
117 VLC_API
char * config_GetDataDir(void) VLC_USED VLC_MALLOC
;
118 VLC_API
char *config_GetLibDir(void) VLC_USED
;
120 typedef enum vlc_userdir
122 VLC_HOME_DIR
, /* User's home */
123 VLC_CONFIG_DIR
, /* VLC-specific configuration directory */
124 VLC_DATA_DIR
, /* VLC-specific data directory */
125 VLC_CACHE_DIR
, /* VLC-specific user cached data directory */
126 /* Generic directories (same as XDG) */
127 VLC_DESKTOP_DIR
=0x80,
137 VLC_API
char * config_GetUserDir( vlc_userdir_t
) VLC_USED VLC_MALLOC
;
139 VLC_API
void config_AddIntf( vlc_object_t
*, const char * );
140 VLC_API
void config_RemoveIntf( vlc_object_t
*, const char * );
141 VLC_API
bool config_ExistIntf( vlc_object_t
*, const char * ) VLC_USED
;
143 #define config_GetType(a,b) config_GetType(VLC_OBJECT(a),b)
144 #define config_GetInt(a,b) config_GetInt(VLC_OBJECT(a),b)
145 #define config_PutInt(a,b,c) config_PutInt(VLC_OBJECT(a),b,c)
146 #define config_GetFloat(a,b) config_GetFloat(VLC_OBJECT(a),b)
147 #define config_PutFloat(a,b,c) config_PutFloat(VLC_OBJECT(a),b,c)
148 #define config_GetPsz(a,b) config_GetPsz(VLC_OBJECT(a),b)
149 #define config_PutPsz(a,b,c) config_PutPsz(VLC_OBJECT(a),b,c)
151 #define config_AddIntf(a,b) config_AddIntf(VLC_OBJECT(a),b)
152 #define config_RemoveIntf(a,b) config_RemoveIntf(VLC_OBJECT(a),b)
153 #define config_ExistIntf(a,b) config_ExistIntf(VLC_OBJECT(a),b)
155 /****************************************************************************
157 ****************************************************************************/
158 struct config_chain_t
160 config_chain_t
*p_next
; /**< Pointer on the next config_chain_t element */
162 char *psz_name
; /**< Option name */
163 char *psz_value
; /**< Option value */
168 * - create all options in the array ppsz_options (var_Create).
169 * - parse the given linked list of config_chain_t and set the value (var_Set).
171 * The option names will be created by adding the psz_prefix prefix.
173 VLC_API
void config_ChainParse( vlc_object_t
*, const char *psz_prefix
, const char *const *ppsz_options
, config_chain_t
* );
174 #define config_ChainParse( a, b, c, d ) config_ChainParse( VLC_OBJECT(a), b, c, d )
177 * This function will parse a configuration string (psz_opts) and
178 * - set all options for this module in a chained list (*pp_cfg)
179 * - returns a pointer on the next module if any.
181 * The string format is
182 * module{option=*,option=*}
184 * The options values are unescaped using config_StringUnescape.
186 VLC_API
const char *config_ChainParseOptions( config_chain_t
**pp_cfg
, const char *ppsz_opts
);
189 * This function will parse a configuration string (psz_string) and
190 * - set the module name (*ppsz_name)
191 * - set all options for this module in a chained list (*pp_cfg)
192 * - returns a pointer on the next module if any.
194 * The string format is
195 * module{option=*,option=*}[:modulenext{option=*,...}]
197 * The options values are unescaped using config_StringUnescape.
199 VLC_API
char *config_ChainCreate( char **ppsz_name
, config_chain_t
**pp_cfg
, const char *psz_string
) VLC_USED VLC_MALLOC
;
202 * This function will release a linked list of config_chain_t
203 * (Including the head)
205 VLC_API
void config_ChainDestroy( config_chain_t
* );
208 * This function will duplicate a linked list of config_chain_t
210 VLC_API config_chain_t
* config_ChainDuplicate( const config_chain_t
* ) VLC_USED VLC_MALLOC
;
213 * This function will unescape a string in place and will return a pointer on
215 * No memory is allocated by it (unlike config_StringEscape).
216 * If NULL is given as parameter nothing will be done (NULL will be returned).
218 * The following sequences will be unescaped (only one time):
221 VLC_API
char * config_StringUnescape( char *psz_string
);
224 * This function will escape a string that can be unescaped by
225 * config_StringUnescape.
226 * The returned value is allocated by it. You have to free it once you
227 * do not need it anymore (unlike config_StringUnescape).
228 * If NULL is given as parameter nothing will be done (NULL will be returned).
230 * The escaped characters are ' " and \
232 VLC_API
char * config_StringEscape( const char *psz_string
) VLC_USED VLC_MALLOC
;
238 #endif /* _VLC_CONFIGURATION_H */