/*****************************************************************************
- * configuration.h : configuration management module
+ * vlc_configuration.h : configuration management module
* This file describes the programming interface for the configuration module.
* It includes functions allowing to declare, get or set configuration options.
*****************************************************************************
- * Copyright (C) 1999-2006 the VideoLAN team
+ * Copyright (C) 1999-2006 VLC authors and VideoLAN
* $Id$
*
* Authors: Gildas Bazin <gbazin@videolan.org>
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
*
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
-# ifdef __cplusplus
-extern "C" {
-# endif
-
-/*****************************************************************************
- * Macros used to build the configuration structure.
- *****************************************************************************/
-
-/* Configuration hint types */
-
-
-#define CONFIG_HINT_CATEGORY 0x0002 /* Start of new category */
-#define CONFIG_HINT_SUBCATEGORY 0x0003 /* Start of sub-category */
-#define CONFIG_HINT_SUBCATEGORY_END 0x0004 /* End of sub-category */
-#define CONFIG_HINT_USAGE 0x0005 /* Usage information */
-
-#define CONFIG_CATEGORY 0x0006 /* Set category */
-#define CONFIG_SUBCATEGORY 0x0007 /* Set subcategory */
-#define CONFIG_SECTION 0x0008 /* Start of new section */
-
-#define CONFIG_HINT 0x000F
-
-/* Configuration item types */
-#define CONFIG_ITEM_STRING 0x0010 /* String option */
-#define CONFIG_ITEM_FILE 0x0020 /* File option */
-#define CONFIG_ITEM_MODULE 0x0030 /* Module option */
-#define CONFIG_ITEM_INTEGER 0x0040 /* Integer option */
-#define CONFIG_ITEM_BOOL 0x0050 /* Bool option */
-#define CONFIG_ITEM_FLOAT 0x0060 /* Float option */
-#define CONFIG_ITEM_DIRECTORY 0x0070 /* Directory option */
-#define CONFIG_ITEM_KEY 0x0080 /* Hot key option */
-#define CONFIG_ITEM_MODULE_CAT 0x0090 /* Module option */
-#define CONFIG_ITEM_MODULE_LIST 0x00A0 /* Module option */
-#define CONFIG_ITEM_MODULE_LIST_CAT 0x00B0 /* Module option */
-
-#define CONFIG_ITEM 0x00F0
-
-/* Item types that use a string value (i.e. serialized in the module cache) */
-#define CONFIG_STRING_TYPES \
- { \
- CONFIG_ITEM_STRING, CONFIG_ITEM_FILE, CONFIG_ITEM_MODULE, \
- CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_MODULE_CAT, \
- CONFIG_ITEM_MODULE_LIST, CONFIG_ITEM_MODULE_LIST_CAT \
- }
-
-static inline int IsConfigStringType (int type)
-{
- const unsigned char config_string_types[] = CONFIG_STRING_TYPES;
-
- /* NOTE: this needs to be changed if we ever get more than 255 types */
- return memchr (config_string_types, type, sizeof (config_string_types))
- != NULL;
-}
-
-static inline int IsConfigIntegerType (int type)
-{
- return (type == CONFIG_ITEM_INTEGER) || (type == CONFIG_ITEM_KEY)
- || (type == CONFIG_ITEM_BOOL);
-}
+#ifndef VLC_CONFIGURATION_H
+#define VLC_CONFIGURATION_H 1
-static inline int IsConfigFloatType (int type)
-{
- return type == CONFIG_ITEM_FLOAT;
-}
-
-/*******************************************************************
- * All predefined categories and subcategories
- *******************************************************************/
-#define CAT_INTERFACE 1
- #define SUBCAT_INTERFACE_GENERAL 101
- #define SUBCAT_INTERFACE_MAIN 102
- #define SUBCAT_INTERFACE_CONTROL 103
- #define SUBCAT_INTERFACE_HOTKEYS 104
-
-#define CAT_AUDIO 2
- #define SUBCAT_AUDIO_GENERAL 201
- #define SUBCAT_AUDIO_AOUT 202
- #define SUBCAT_AUDIO_AFILTER 203
- #define SUBCAT_AUDIO_VISUAL 204
- #define SUBCAT_AUDIO_MISC 205
-
-#define CAT_VIDEO 3
- #define SUBCAT_VIDEO_GENERAL 301
- #define SUBCAT_VIDEO_VOUT 302
- #define SUBCAT_VIDEO_VFILTER 303
- #define SUBCAT_VIDEO_TEXT 304
- #define SUBCAT_VIDEO_SUBPIC 305
- #define SUBCAT_VIDEO_VFILTER2 306
-
-#define CAT_INPUT 4
- #define SUBCAT_INPUT_GENERAL 401
- #define SUBCAT_INPUT_ACCESS 402
- #define SUBCAT_INPUT_ACCESS_FILTER 403
- #define SUBCAT_INPUT_DEMUX 404
- #define SUBCAT_INPUT_VCODEC 405
- #define SUBCAT_INPUT_ACODEC 406
- #define SUBCAT_INPUT_SCODEC 407
-
-#define CAT_SOUT 5
- #define SUBCAT_SOUT_GENERAL 501
- #define SUBCAT_SOUT_STREAM 502
- #define SUBCAT_SOUT_MUX 503
- #define SUBCAT_SOUT_ACO 504
- #define SUBCAT_SOUT_PACKETIZER 505
- #define SUBCAT_SOUT_SAP 506
- #define SUBCAT_SOUT_VOD 507
+/**
+ * \file
+ * This file describes the programming interface for the configuration module.
+ * It includes functions allowing to declare, get or set configuration options.
+ */
-#define CAT_ADVANCED 6
- #define SUBCAT_ADVANCED_CPU 601
- #define SUBCAT_ADVANCED_MISC 602
- #define SUBCAT_ADVANCED_NETWORK 603
- #define SUBCAT_ADVANCED_XML 604
+#include <sys/types.h> /* for ssize_t */
-#define CAT_PLAYLIST 7
- #define SUBCAT_PLAYLIST_GENERAL 701
- #define SUBCAT_PLAYLIST_SD 702
- #define SUBCAT_PLAYLIST_EXPORT 703
+# ifdef __cplusplus
+extern "C" {
+# endif
struct config_category_t
{
typedef union
{
- const char *psz;
- int i;
+ char *psz;
+ int64_t i;
float f;
} module_value_t;
-typedef union
-{
- int i;
- float f;
-} module_nvalue_t;
+typedef int (*vlc_string_list_cb)(vlc_object_t *, const char *,
+ char ***, char ***);
+typedef int (*vlc_integer_list_cb)(vlc_object_t *, const char *,
+ int64_t **, char ***);
struct module_config_t
{
- int i_type; /* Configuration type */
- const char *psz_type; /* Configuration subtype */
- const char *psz_name; /* Option name */
- char i_short; /* Optional short option name */
- const char *psz_text; /* Short comment on the configuration option */
- const char *psz_longtext; /* Long comment on the configuration option */
+ uint8_t i_type; /* Configuration type */
+ char i_short; /* Optional short option name */
+ unsigned b_advanced:1; /* Advanced option */
+ unsigned b_internal:1; /* Hidden from prefs and help */
+ unsigned b_unsaveable:1; /* Not stored in configuration */
+ unsigned b_safe:1; /* Safe in web plugins and playlists */
+ unsigned b_removed:1; /* Deprecated */
+
+ char *psz_type; /* Configuration subtype */
+ char *psz_name; /* Option name */
+ char *psz_text; /* Short comment on the configuration option */
+ char *psz_longtext; /* Long comment on the configuration option */
+
module_value_t value; /* Option value */
module_value_t orig;
- module_value_t saved;
- module_nvalue_t min;
- module_nvalue_t max;
-
- /* Function to call when commiting a change */
- vlc_callback_t pf_callback;
- void *p_callback_data;
+ module_value_t min;
+ module_value_t max;
/* Values list */
- const char **ppsz_list; /* List of possible values for the option */
- int *pi_list; /* Idem for integers */
- const char **ppsz_list_text; /* Friendly names for list values */
- int i_list; /* Options list size */
-
- /* Actions list */
- vlc_callback_t *ppf_action; /* List of possible actions for a config */
- const char **ppsz_action_text; /* Friendly names for actions */
- int i_action; /* actions list size */
-
- /* Misc */
- vlc_mutex_t *p_lock; /* Lock to use when modifying the config */
- vlc_bool_t b_dirty; /* Dirty flag to indicate a config change */
- vlc_bool_t b_advanced; /* Flag to indicate an advanced option */
- vlc_bool_t b_internal; /* Flag to indicate option is not to be shown */
- vlc_bool_t b_restart; /* Flag to indicate the option need a restart */
- /* to take effect */
-
- /* Deprecated */
- const char *psz_current; /* Good option name */
- vlc_bool_t b_strict; /* Transitionnal or strict */
-
- /* Option values loaded from config file */
- vlc_bool_t b_autosave; /* Config will be auto-saved at exit time */
- vlc_bool_t b_unsaveable; /* confg should be saved*/
+ uint16_t list_count; /* Options list size */
+ union
+ {
+ char **psz; /* List of possible values for the option */
+ int *i;
+ vlc_string_list_cb psz_cb;
+ vlc_integer_list_cb i_cb;
+ } list;
+ char **list_text; /* Friendly names for list values */
};
/*****************************************************************************
* Prototypes - these methods are used to get, set or manipulate configuration
* data.
*****************************************************************************/
-VLC_EXPORT( int, __config_GetType, (vlc_object_t *, const char *) );
-VLC_EXPORT( int, __config_GetInt, (vlc_object_t *, const char *) );
-VLC_EXPORT( void, __config_PutInt, (vlc_object_t *, const char *, int) );
-VLC_EXPORT( float, __config_GetFloat, (vlc_object_t *, const char *) );
-VLC_EXPORT( void, __config_PutFloat, (vlc_object_t *, const char *, float) );
-VLC_EXPORT( char *, __config_GetPsz, (vlc_object_t *, const char *) );
-VLC_EXPORT( void, __config_PutPsz, (vlc_object_t *, const char *, const char *) );
-
-#define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b)
-VLC_EXPORT( int, __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
-#define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a))
-VLC_EXPORT( void, __config_ResetAll, ( vlc_object_t * ) );
-
-VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) );
-VLC_EXPORT( module_t *, config_FindModule,( vlc_object_t *, const char * ) );
-
-VLC_EXPORT( int, config_Duplicate,( module_t *, const module_config_t *, size_t ));
-
-#define config_GetType(a,b) __config_GetType(VLC_OBJECT(a),b)
-#define config_GetInt(a,b) __config_GetInt(VLC_OBJECT(a),b)
-#define config_PutInt(a,b,c) __config_PutInt(VLC_OBJECT(a),b,c)
-#define config_GetFloat(a,b) __config_GetFloat(VLC_OBJECT(a),b)
-#define config_PutFloat(a,b,c) __config_PutFloat(VLC_OBJECT(a),b,c)
-#define config_GetPsz(a,b) __config_GetPsz(VLC_OBJECT(a),b)
-#define config_PutPsz(a,b,c) __config_PutPsz(VLC_OBJECT(a),b,c)
-
-
-/*****************************************************************************
- * Macros used to build the configuration structure.
- *
- * Note that internally we support only 3 types of config data: int, float
- * and string.
- * The other types declared here just map to one of these 3 basic types but
- * have the advantage of also providing very good hints to a configuration
- * interface so as to make it more user friendly.
- * The configuration structure also includes category hints. These hints can
- * provide a configuration interface with some very useful data and again
- * allow for a more user friendly interface.
- *****************************************************************************/
-
-#define add_config_inner( ) \
- i_config++; \
- if( (i_config % 10) == 0 ) \
- p_config = (module_config_t *) \
- realloc(p_config, (i_config+11) * sizeof(module_config_t)); \
- memset( p_config + i_config, 0, sizeof( *p_config ) )
-
-#define add_type_inner( type ) \
- add_config_inner( ); \
- p_config[i_config].i_type = type
-
-#define add_typedesc_inner( type, text, longtext ) \
- add_type_inner( type ); \
- p_config[i_config].psz_text = text; \
- p_config[i_config].psz_longtext = longtext
-
-#define add_typeadv_inner( type, text, longtext, advc ) \
- add_typedesc_inner( type, text, longtext ); \
- p_config[i_config].b_advanced = advc
-
-#define add_typename_inner( type, name, text, longtext, advc, cb ) \
- add_typeadv_inner( type, text, longtext, advc ); \
- p_config[i_config].psz_name = name; \
- p_config[i_config].pf_callback = cb
-
-#define add_string_inner( type, name, text, longtext, advc, cb, v ) \
- add_typename_inner( type, name, text, longtext, advc, cb ); \
- p_config[i_config].value.psz = v
-
-#define add_int_inner( type, name, text, longtext, advc, cb, v ) \
- add_typename_inner( type, name, text, longtext, advc, cb ); \
- p_config[i_config].value.i = v
-
-
-#define set_category( i_id ) \
- add_type_inner( CONFIG_CATEGORY ); \
- p_config[i_config].value.i = i_id
-
-#define set_subcategory( i_id ) \
- add_type_inner( CONFIG_SUBCATEGORY ); \
- p_config[i_config].value.i = i_id
-
-#define set_section( text, longtext ) \
- add_typedesc_inner( CONFIG_SECTION, text, longtext )
-
-#define add_category_hint( text, longtext, advc ) \
- add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
-
-#define add_subcategory_hint( text, longtext ) \
- add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
-
-#define end_subcategory_hint \
- add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
-
-#define add_usage_hint( text ) \
- add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
-
-#define add_string( name, value, p_callback, text, longtext, advc ) \
- add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, p_callback, value )
-
-#define add_file( name, value, p_callback, text, longtext, advc ) \
- add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, p_callback, value )
-
-#define add_directory( name, value, p_callback, text, longtext, advc ) \
- add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, p_callback, value )
-
-#define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
- add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, p_callback, value ); \
- p_config[i_config].psz_type = psz_caps
-
-#define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
- add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, p_callback, value ); \
- p_config[i_config].min.i = i_subcategory /* gruik */
-
-#define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
- add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, p_callback, value ); \
- p_config[i_config].psz_type = psz_caps
-
-#define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
- add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, advc, p_callback, value ); \
- p_config[i_config].min.i = i_subcategory /* gruik */
-
-#define add_integer( name, value, p_callback, text, longtext, advc ) \
- add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, p_callback, value )
-
-#define add_key( name, value, p_callback, text, longtext, advc ) \
- add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, value )
-
-#define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
- add_integer( name, value, p_callback, text, longtext, advc ); \
- change_integer_range( i_min, i_max )
-
-#define add_float( name, v, p_callback, text, longtext, advc ) \
- add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ); \
- p_config[i_config].value.f = v
-
-#define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
- add_float( name, value, p_callback, text, longtext, advc ); \
- change_float_range( f_min, f_max )
-
-#define add_bool( name, v, p_callback, text, longtext, advc ) \
- add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, p_callback ); \
- p_config[i_config].value.i = v
-
-/* For renamed option */
-#define add_deprecated( name, strict ) \
- add_config_inner( ); \
- p_config[ i_config ].i_type = p_config[ i_config -1 ].i_type; \
- p_config[ i_config ].psz_name = name; \
- p_config[i_config].b_strict = strict; \
- p_config[ i_config ].psz_current = p_config[ i_config-1].psz_current \
- ? p_config[ i_config-1 ].psz_current \
- : p_config[ i_config-1 ].psz_name;
-
-/* For removed option */
-#define add_suppressed_inner( name, type ) \
- add_type_inner( type ); \
- p_config[ i_config ].psz_name = name; \
- p_config[ i_config ].psz_current = "SUPPRESSED";
-
-#define add_suppressed_bool( name ) \
- add_suppressed_inner( name, CONFIG_ITEM_BOOL )
-
-#define add_suppressed_integer( name ) \
- add_suppressed_inner( name, CONFIG_ITEM_INTEGER )
-
-#define add_suppressed_float( name ) \
- add_suppressed_inner( name, CONFIG_ITEM_FLOAT )
-
-#define add_suppressed_string( name ) \
- add_suppressed_inner( name, CONFIG_ITEM_STRING )
-
-/* Modifier macros for the config options (used for fine tuning) */
-#define change_short( ch ) \
- p_config[i_config].i_short = ch;
-
-#define change_string_list( list, list_text, list_update_func ) \
- p_config[i_config].i_list = sizeof(list)/sizeof(char *); \
- p_config[i_config].ppsz_list = list; \
- p_config[i_config].ppsz_list_text = list_text;
-
-#define change_integer_list( list, list_text, list_update_func ) \
- p_config[i_config].i_list = sizeof(list)/sizeof(int); \
- p_config[i_config].pi_list = (int *)list; \
- p_config[i_config].ppsz_list_text = list_text;
-
-#define change_integer_range( minv, maxv ) \
- p_config[i_config].min.i = minv; \
- p_config[i_config].max.i = maxv;
-
-#define change_float_range( minv, maxv ) \
- p_config[i_config].min.f = minv; \
- p_config[i_config].max.f = maxv;
-
-#define change_action_add( pf_action, action_text ) \
- if( !p_config[i_config].i_action ) \
- { p_config[i_config].ppsz_action_text = 0; \
- p_config[i_config].ppf_action = 0; } \
- p_config[i_config].ppf_action = (vlc_callback_t *) \
- realloc( p_config[i_config].ppf_action, \
- (p_config[i_config].i_action + 1) * sizeof(void *) ); \
- p_config[i_config].ppsz_action_text = (const char **)\
- realloc( p_config[i_config].ppsz_action_text, \
- (p_config[i_config].i_action + 1) * sizeof(void *) ); \
- p_config[i_config].ppf_action[p_config[i_config].i_action] = pf_action; \
- p_config[i_config].ppsz_action_text[p_config[i_config].i_action] = \
- action_text; \
- p_config[i_config].i_action++;
-
-#define change_internal() \
- p_config[i_config].b_internal = VLC_TRUE;
-
-#define change_need_restart() \
- p_config[i_config].b_restart = VLC_TRUE;
-
-#define change_autosave() \
- p_config[i_config].b_autosave = VLC_TRUE;
-
-#define change_unsaveable() \
- p_config[i_config].b_unsaveable = VLC_TRUE;
+VLC_API int config_GetType(vlc_object_t *, const char *) VLC_USED;
+VLC_API int64_t config_GetInt(vlc_object_t *, const char *) VLC_USED;
+VLC_API void config_PutInt(vlc_object_t *, const char *, int64_t);
+VLC_API float config_GetFloat(vlc_object_t *, const char *) VLC_USED;
+VLC_API void config_PutFloat(vlc_object_t *, const char *, float);
+VLC_API char * config_GetPsz(vlc_object_t *, const char *) VLC_USED VLC_MALLOC;
+VLC_API void config_PutPsz(vlc_object_t *, const char *, const char *);
+VLC_API ssize_t config_GetIntChoices(vlc_object_t *, const char *,
+ int64_t **, char ***) VLC_USED;
+VLC_API ssize_t config_GetPszChoices(vlc_object_t *, const char *,
+ char ***, char ***) VLC_USED;
+
+VLC_API int config_SaveConfigFile( vlc_object_t * );
+#define config_SaveConfigFile(a) config_SaveConfigFile(VLC_OBJECT(a))
+
+VLC_API void config_ResetAll( vlc_object_t * );
+#define config_ResetAll(a) config_ResetAll(VLC_OBJECT(a))
+
+VLC_API module_config_t * config_FindConfig( vlc_object_t *, const char * ) VLC_USED;
+VLC_API char * config_GetDataDir(void) VLC_USED VLC_MALLOC;
+VLC_API char *config_GetLibDir(void) VLC_USED;
+
+typedef enum vlc_userdir
+{
+ VLC_HOME_DIR, /* User's home */
+ VLC_CONFIG_DIR, /* VLC-specific configuration directory */
+ VLC_DATA_DIR, /* VLC-specific data directory */
+ VLC_CACHE_DIR, /* VLC-specific user cached data directory */
+ /* Generic directories (same as XDG) */
+ VLC_DESKTOP_DIR=0x80,
+ VLC_DOWNLOAD_DIR,
+ VLC_TEMPLATES_DIR,
+ VLC_PUBLICSHARE_DIR,
+ VLC_DOCUMENTS_DIR,
+ VLC_MUSIC_DIR,
+ VLC_PICTURES_DIR,
+ VLC_VIDEOS_DIR,
+} vlc_userdir_t;
+
+VLC_API char * config_GetUserDir( vlc_userdir_t ) VLC_USED VLC_MALLOC;
+
+VLC_API void config_AddIntf( vlc_object_t *, const char * );
+VLC_API void config_RemoveIntf( vlc_object_t *, const char * );
+VLC_API bool config_ExistIntf( vlc_object_t *, const char * ) VLC_USED;
+
+#define config_GetType(a,b) config_GetType(VLC_OBJECT(a),b)
+#define config_GetInt(a,b) config_GetInt(VLC_OBJECT(a),b)
+#define config_PutInt(a,b,c) config_PutInt(VLC_OBJECT(a),b,c)
+#define config_GetFloat(a,b) config_GetFloat(VLC_OBJECT(a),b)
+#define config_PutFloat(a,b,c) config_PutFloat(VLC_OBJECT(a),b,c)
+#define config_GetPsz(a,b) config_GetPsz(VLC_OBJECT(a),b)
+#define config_PutPsz(a,b,c) config_PutPsz(VLC_OBJECT(a),b,c)
+
+#define config_AddIntf(a,b) config_AddIntf(VLC_OBJECT(a),b)
+#define config_RemoveIntf(a,b) config_RemoveIntf(VLC_OBJECT(a),b)
+#define config_ExistIntf(a,b) config_ExistIntf(VLC_OBJECT(a),b)
/****************************************************************************
* config_chain_t:
****************************************************************************/
struct config_chain_t
{
- config_chain_t *p_next;
+ config_chain_t *p_next; /**< Pointer on the next config_chain_t element */
- char *psz_name;
- char *psz_value;
+ char *psz_name; /**< Option name */
+ char *psz_value; /**< Option value */
};
-#define config_ChainParse( a, b, c, d ) __config_ChainParse( VLC_OBJECT(a), b, c, d )
-VLC_EXPORT( void, __config_ChainParse, ( vlc_object_t *, const char *psz_prefix, const char **ppsz_options, config_chain_t * ) );
-VLC_EXPORT( char *, config_ChainCreate, ( char **, config_chain_t **, const char * ) );
-VLC_EXPORT( void, config_ChainDestroy, ( config_chain_t * ) );
-
-static inline config_chain_t *config_chain_find( config_chain_t *p_cfg, const char *psz_name )
-{
- while( p_cfg && strcmp( p_cfg->psz_name, psz_name ) )
- {
- p_cfg = p_cfg->p_next;
- }
-
- return p_cfg;
-}
-
-static inline char *config_chain_find_value( config_chain_t *p_cfg, const char *psz_name )
-{
- while( p_cfg && strcmp( p_cfg->psz_name, psz_name ) )
- {
- p_cfg = p_cfg->p_next;
- }
-
- if( p_cfg && p_cfg->psz_value )
- {
- return( p_cfg->psz_value );
- }
-
- return NULL;
-}
+/**
+ * This function will
+ * - create all options in the array ppsz_options (var_Create).
+ * - parse the given linked list of config_chain_t and set the value (var_Set).
+ *
+ * The option names will be created by adding the psz_prefix prefix.
+ */
+VLC_API void config_ChainParse( vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, config_chain_t * );
+#define config_ChainParse( a, b, c, d ) config_ChainParse( VLC_OBJECT(a), b, c, d )
+
+/**
+ * This function will parse a configuration string (psz_opts) and
+ * - set all options for this module in a chained list (*pp_cfg)
+ * - returns a pointer on the next module if any.
+ *
+ * The string format is
+ * module{option=*,option=*}
+ *
+ * The options values are unescaped using config_StringUnescape.
+ */
+VLC_API const char *config_ChainParseOptions( config_chain_t **pp_cfg, const char *ppsz_opts );
+
+/**
+ * This function will parse a configuration string (psz_string) and
+ * - set the module name (*ppsz_name)
+ * - set all options for this module in a chained list (*pp_cfg)
+ * - returns a pointer on the next module if any.
+ *
+ * The string format is
+ * module{option=*,option=*}[:modulenext{option=*,...}]
+ *
+ * The options values are unescaped using config_StringUnescape.
+ */
+VLC_API char *config_ChainCreate( char **ppsz_name, config_chain_t **pp_cfg, const char *psz_string ) VLC_USED VLC_MALLOC;
+
+/**
+ * This function will release a linked list of config_chain_t
+ * (Including the head)
+ */
+VLC_API void config_ChainDestroy( config_chain_t * );
+
+/**
+ * This function will duplicate a linked list of config_chain_t
+ */
+VLC_API config_chain_t * config_ChainDuplicate( const config_chain_t * ) VLC_USED VLC_MALLOC;
+
+/**
+ * This function will unescape a string in place and will return a pointer on
+ * the given string.
+ * No memory is allocated by it (unlike config_StringEscape).
+ * If NULL is given as parameter nothing will be done (NULL will be returned).
+ *
+ * The following sequences will be unescaped (only one time):
+ * \\ \' and \"
+ */
+VLC_API char * config_StringUnescape( char *psz_string );
+
+/**
+ * This function will escape a string that can be unescaped by
+ * config_StringUnescape.
+ * The returned value is allocated by it. You have to free it once you
+ * do not need it anymore (unlike config_StringUnescape).
+ * If NULL is given as parameter nothing will be done (NULL will be returned).
+ *
+ * The escaped characters are ' " and \
+ */
+VLC_API char * config_StringEscape( const char *psz_string ) VLC_USED VLC_MALLOC;
# ifdef __cplusplus
}
# endif
+
+#endif /* _VLC_CONFIGURATION_H */
projects / vlc / blobdiff