* It includes functions allowing to declare, get or set configuration options.
*****************************************************************************
* Copyright (C) 1999, 2000 VideoLAN
- * $Id: configuration.h,v 1.19 2002/12/06 10:10:40 sam Exp $
+ * $Id: configuration.h,v 1.31 2003/08/14 19:25:55 sigmunau Exp $
*
* Authors: Gildas Bazin <gbazin@netcourrier.com>
*
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 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
#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 0x00F0
char *psz_value; /* Option value */
int i_value; /* Option value */
float f_value; /* Option value */
+ int i_min; /* Option minimum value */
+ int i_max; /* Option maximum value */
+ float f_min; /* Option minimum value */
+ float f_max; /* Option maximum value */
/* Function to call when commiting a change */
- void ( * pf_callback ) ( vlc_object_t * );
+ vlc_callback_t pf_callback;
+ void *p_callback_data;
char **ppsz_list; /* List of possible values for the option */
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 */
+
+ /* Original option values */
+ char *psz_value_orig;
+ int i_value_orig;
+ float f_value_orig;
};
/*****************************************************************************
* 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( char *, config_GetHomeDir, ( void ) );
VLC_EXPORT( int, __config_LoadConfigFile, ( vlc_object_t *, const char * ) );
VLC_EXPORT( int, __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
+VLC_EXPORT( void, __config_ResetAll, ( vlc_object_t * ) );
+
VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char *psz_name ) );
VLC_EXPORT( void, config_Duplicate, ( module_t *, module_config_t * ) );
VLC_EXPORT( void, config_SetCallbacks, ( module_config_t *, module_config_t * ) );
VLC_EXPORT( void, config_UnsetCallbacks, ( module_config_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_LoadCmdLine(a,b,c,d) __config_LoadCmdLine(VLC_OBJECT(a),b,c,d)
#define config_LoadConfigFile(a,b) __config_LoadConfigFile(VLC_OBJECT(a),b)
#define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b)
+#define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a))
/*****************************************************************************
* Macros used to build the configuration structure.
* allow for a more user friendly interface.
*****************************************************************************/
-#define add_category_hint( text, longtext ) \
- { module_config_t tmp = { CONFIG_HINT_CATEGORY, NULL, NULL, '\0', text, longtext, NULL, 0, 0.0, NULL, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
+#define add_category_hint( text, longtext, advc ) \
+ { 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; } i_config++
#define add_subcategory_hint( text, longtext ) \
- { module_config_t tmp = { CONFIG_HINT_SUBCATEGORY, NULL, NULL, '\0', text, longtext, NULL, 0, 0.0, NULL, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
+ { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY, NULL, NULL, '\0', text, longtext }; p_config[ i_config ] = tmp; } i_config++
#define end_subcategory_hint \
- { module_config_t tmp = { CONFIG_HINT_SUBCATEGORY_END, NULL, NULL, '\0', NULL, NULL, NULL, 0, 0.0, NULL, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
+ { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY_END, NULL, NULL, '\0' }; p_config[ i_config ] = tmp; } i_config++
#define add_usage_hint( text ) \
- { module_config_t tmp = { CONFIG_HINT_USAGE, NULL, NULL, '\0', text, NULL, NULL, 0, 0.0, NULL, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
+ { static module_config_t tmp = { CONFIG_HINT_USAGE, NULL, NULL, '\0', text }; p_config[ i_config ] = tmp; } i_config++
-#define add_string( name, psz_value, p_callback, text, longtext ) \
- { module_config_t tmp = { CONFIG_ITEM_STRING, NULL, name, '\0', text, longtext, psz_value, 0, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
+#define add_string( name, psz_value, p_callback, text, longtext, advc ) \
+ { 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; } i_config++
#define add_string_from_list( name, psz_value, ppsz_list, p_callback, text, \
- longtext ) \
- { module_config_t tmp = { CONFIG_ITEM_STRING, NULL, name, '\0', text, longtext, psz_value, 0, 0, p_callback, ppsz_list, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
-#define add_file( name, psz_value, p_callback, text, longtext ) \
- { module_config_t tmp = { CONFIG_ITEM_FILE, NULL, name, '\0', text, longtext, psz_value, 0, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
-#define add_module( name, psz_caps, psz_value, p_callback, text, longtext ) \
- { module_config_t tmp = { CONFIG_ITEM_MODULE, psz_caps, name, '\0', text, longtext, psz_value, 0, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
-#define add_integer( name, i_value, p_callback, text, longtext ) \
- { module_config_t tmp = { CONFIG_ITEM_INTEGER, NULL, name, '\0', text, longtext, NULL, i_value, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
-#define add_float( name, f_value, p_callback, text, longtext ) \
- { module_config_t tmp = { CONFIG_ITEM_FLOAT, NULL, name, '\0', text, longtext, NULL, 0, f_value, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
-#define add_bool( name, b_value, p_callback, text, longtext ) \
- { module_config_t tmp = { CONFIG_ITEM_BOOL, NULL, name, '\0', text, longtext, NULL, b_value, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
+ longtext, advc ) \
+ { static module_config_t tmp = { CONFIG_ITEM_STRING, NULL, name, '\0', text, longtext, psz_value, 0, 0, 0, 0, 0, 0, NULL, NULL, ppsz_list }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; } i_config++
+#define add_file( name, psz_value, p_callback, text, longtext, advc ) \
+ { 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; } i_config++
+#define add_directory( name, psz_value, p_callback, text, longtext, advc ) \
+ { 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; } i_config++
+#define add_module( name, psz_caps, psz_value, p_callback, text, longtext, advc ) \
+ { 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; } i_config++
+#define add_integer( name, i_value, p_callback, text, longtext, advc ) \
+ { 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; } i_config++
+#define add_key( name, i_value, p_callback, text, longtext, advc ) \
+ { 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; } i_config++
+#define add_integer_with_range( name, i_value, i_min, i_max, p_callback, text, longtext, advc ) \
+ { 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; } i_config++
+#define add_float( name, f_value, p_callback, text, longtext, advc ) \
+ { 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; } i_config++
+#define add_float_with_range( name, f_value, f_min, f_max, p_callback, text, longtext, advc ) \
+ { 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; } i_config++
+#define add_bool( name, b_value, p_callback, text, longtext, advc ) \
+ { 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; } i_config++
/* These should be seldom used. They were added just to provide easy shortcuts
* for the command line interface */
-#define add_string_with_short( name, ch, psz_value, p_callback, text, ltext ) \
- { module_config_t tmp = { CONFIG_ITEM_STRING, NULL, name, ch, text, ltext, psz_value, 0, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
-#define add_file_with_short( name, ch, psz_value, p_callback, text, ltext ) \
- { module_config_t tmp = { CONFIG_ITEM_FILE, NULL, name, ch, text, ltext, psz_value, 0, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
+#define add_string_with_short( name, ch, psz_value, p_callback, text, ltext, advc ) \
+ { 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; p_config[i_config].b_advanced = advc; } i_config++
+#define add_file_with_short( name, ch, psz_value, p_callback, text, ltext, advc ) \
+ { 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; p_config[i_config].b_advanced = advc; } i_config++
#define add_module_with_short( name, ch, psz_caps, psz_value, p_callback, \
- text, ltext) \
- { module_config_t tmp = { CONFIG_ITEM_MODULE, psz_caps, name, ch, text, ltext, psz_value, 0, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
-#define add_integer_with_short( name, ch, i_value, p_callback, text, ltext ) \
- { module_config_t tmp = { CONFIG_ITEM_INTEGER, NULL, name, ch, text, ltext, NULL, i_value, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
-#define add_float_with_short( name, ch, f_value, p_callback, text, ltext ) \
- { module_config_t tmp = { CONFIG_ITEM_FLOAT, NULL, name, ch, text, ltext, NULL, 0, f_value, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
-#define add_bool_with_short( name, ch, b_value, p_callback, text, ltext ) \
- { module_config_t tmp = { CONFIG_ITEM_BOOL, NULL, name, ch, text, ltext, NULL, b_value, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
+ text, ltext, advc) \
+ { 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; p_config[i_config].b_advanced = advc; } i_config++
+#define add_integer_with_short( name, ch, i_value, p_callback, text, ltext, advc ) \
+ { 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; p_config[i_config].b_advanced = advc; } i_config++
+#define add_float_with_short( name, ch, f_value, p_callback, text, ltext, advc ) \
+ { 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; p_config[i_config].b_advanced = advc;} i_config++
+#define add_bool_with_short( name, ch, b_value, p_callback, text, ltext, advc ) \
+ { 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; p_config[i_config].b_advanced = advc;} i_config++
projects / vlc / blobdiff