]> git.sesse.net Git - vlc/blobdiff - include/vlc_configuration.h
use vlc-control to be more multiplatform friendly
[vlc] / include / vlc_configuration.h
index 01181615cea528a6cd5767718fcea8e2dc8f0319..c0ee83a31672588957524be3ae9943950c2c0110 100644 (file)
@@ -123,6 +123,9 @@ extern "C" {
    #define SUBCAT_PLAYLIST_SD 702
    #define SUBCAT_PLAYLIST_EXPORT 703
 
+#define CAT_OSD 8
+   #define SUBCAT_OSD_IMPORT 801
+
 struct config_category_t
 {
     int         i_id;
@@ -132,7 +135,7 @@ struct config_category_t
 
 typedef union
 {
-    const char *psz;
+    char       *psz;
     int         i;
     float       f;
 } module_value_t;
@@ -146,11 +149,11 @@ typedef union
 struct module_config_t
 {
     int          i_type;                               /* Configuration type */
-    const char  *psz_type;                          /* Configuration subtype */
-    const char  *psz_name;                                    /* Option name */
+    char        *psz_type;                          /* Configuration subtype */
+    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 */
+    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;
@@ -162,14 +165,15 @@ struct module_config_t
     void          *p_callback_data;
 
     /* Values list */
-    const char **ppsz_list;       /* List of possible values for the option */
+    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 */
+    char       **ppsz_list_text;          /* Friendly names for list values */
     int          i_list;                               /* Options list size */
+    vlc_callback_t pf_update_list; /*callback to initialize dropdownlists */
 
     /* Actions list */
     vlc_callback_t *ppf_action;    /* List of possible actions for a config */
-    const char    **ppsz_action_text;         /* Friendly names for actions */
+    char          **ppsz_action_text;         /* Friendly names for actions */
     int            i_action;                           /* actions list size */
 
     /* Misc */
@@ -181,12 +185,14 @@ struct module_config_t
                               /* to take effect */
 
     /* Deprecated */
-    const char    *psz_current;                         /* Good option name */
-    vlc_bool_t     b_strict;                     /* Transitionnal or strict */
+    char          *psz_oldname;                          /* Old option name */
+    vlc_bool_t     b_removed;
 
     /* Option values loaded from config file */
     vlc_bool_t   b_autosave;      /* Config will be auto-saved at exit time */
-    vlc_bool_t   b_unsaveable;                    /* Config should be saved */
+    vlc_bool_t   b_unsaveable;                /* Config should not be saved */
+
+    vlc_bool_t   b_safe;
 };
 
 /*****************************************************************************
@@ -207,12 +213,13 @@ 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 * ) );
-VLC_EXPORT( module_t *, config_FindModule,( vlc_object_t *, const char * ) );
-
-VLC_EXPORT( int, config_Duplicate,( module_t *, const module_config_t *, size_t ));
 
 VLC_EXPORT(const char *, config_GetDataDir, ( void ));
 
+VLC_EXPORT( void,       __config_AddIntf,    ( vlc_object_t *, const char * ) );
+VLC_EXPORT( void,       __config_RemoveIntf, ( vlc_object_t *, const char * ) );
+VLC_EXPORT( vlc_bool_t, __config_ExistIntf,  ( vlc_object_t *, const char * ) );
+
 #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)
@@ -221,6 +228,68 @@ VLC_EXPORT(const char *, config_GetDataDir, ( void ));
 #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)
+
+enum vlc_config_properties
+{
+    /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
+     * Append new items at the end ONLY. */
+
+    VLC_CONFIG_NAME,
+    /* command line name (args=const char *, vlc_callback_t) */
+
+    VLC_CONFIG_DESC,
+    /* description (args=const char *, const char *) */
+
+    VLC_CONFIG_VALUE,
+    /* actual value (args=int/double/const char *) */
+
+    VLC_CONFIG_RANGE,
+    /* minimum value (args=int/double/const char * twice) */
+
+    VLC_CONFIG_ADVANCED,
+    /* enable advanced flag (args=none) */
+
+    VLC_CONFIG_VOLATILE,
+    /* don't write variable to storage (args=none) */
+
+    VLC_CONFIG_PERSISTENT,
+    /* always write variable to storage (args=none) */
+
+    VLC_CONFIG_RESTART,
+    /* restart required to apply value change (args=none) */
+
+    VLC_CONFIG_PRIVATE,
+    /* hide from user (args=none) */
+
+    VLC_CONFIG_REMOVED,
+    /* tag as no longer supported (args=none) */
+
+    VLC_CONFIG_CAPABILITY,
+    /* capability for a module or list thereof (args=const char*) */
+
+    VLC_CONFIG_SHORTCUT,
+    /* one-character (short) command line option name (args=char) */
+
+    VLC_CONFIG_LIST,
+    /* possible values list
+     * (args=size_t, const <type> *, const char *const *) */
+
+    VLC_CONFIG_ADD_ACTION,
+    /* add value change callback (args=vlc_callback_t, const char *) */
+
+    VLC_CONFIG_OLDNAME,
+    /* former option name (args=const char *) */
+
+    VLC_CONFIG_SAFE,
+    /* tag as modifiable by untrusted input item "sources" (args=none) */
+};
+
+
+VLC_EXPORT( module_config_t *, vlc_config_create, (module_t *, int type) );
+VLC_EXPORT( int, vlc_config_set, (module_config_t *, int, ...) );
 
 /*****************************************************************************
  * Macros used to build the configuration structure.
@@ -235,47 +304,39 @@ VLC_EXPORT(const char *, config_GetDataDir, ( void ));
  *   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
+    p_config = vlc_config_create (p_module, 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
+    vlc_config_set (p_config, VLC_CONFIG_DESC, \
+                    (const char *)(text), (const char *)(longtext))
 
 #define add_typeadv_inner( type, text, longtext, advc ) \
     add_typedesc_inner( type, text, longtext ); \
-    p_config[i_config].b_advanced = advc
+    if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED)
 
 #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
+    vlc_config_set (p_config, VLC_CONFIG_NAME, \
+                    (const char *)(name), (vlc_callback_t)(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
+    vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(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
+    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v))
 
 
 #define set_category( i_id ) \
     add_type_inner( CONFIG_CATEGORY ); \
-    p_config[i_config].value.i = i_id
+    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id))
 
 #define set_subcategory( i_id ) \
     add_type_inner( CONFIG_SUBCATEGORY ); \
-    p_config[i_config].value.i = i_id
+    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id))
 
 #define set_section( text, longtext ) \
     add_typedesc_inner( CONFIG_SECTION, text, longtext )
@@ -306,19 +367,21 @@ VLC_EXPORT(const char *, config_GetDataDir, ( void ));
 
 #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 */
+    vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps))
 
 #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
+    vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps))
+
+#ifndef __PLUGIN__
+#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->min.i = i_subcategory /* gruik */
 
 #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 */
+    p_config->min.i = i_subcategory /* gruik */
+#endif
 
 #define add_integer( name, value, p_callback, text, longtext, advc ) \
     add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, p_callback, value )
@@ -332,7 +395,7 @@ VLC_EXPORT(const char *, config_GetDataDir, ( void ));
 
 #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
+    vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(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 ); \
@@ -340,23 +403,14 @@ VLC_EXPORT(const char *, config_GetDataDir, ( void ));
 
 #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_alias( name ) \
-    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 = VLC_FALSE; \
-    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;
+    if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)VLC_TRUE)
 
 /* For removed option */
 #define add_obsolete_inner( name, type ) \
     add_type_inner( type ); \
-    p_config[ i_config ].psz_name = name; \
-    p_config[ i_config ].psz_current = "SUPPRESSED";
+    vlc_config_set (p_config, VLC_CONFIG_NAME, \
+                    (const char *)(name), (vlc_callback_t)NULL); \
+    vlc_config_set (p_config, VLC_CONFIG_REMOVED)
 
 #define add_obsolete_bool( name ) \
         add_obsolete_inner( name, CONFIG_ITEM_BOOL )
@@ -371,53 +425,61 @@ VLC_EXPORT(const char *, config_GetDataDir, ( void ));
         add_obsolete_inner( name, CONFIG_ITEM_STRING )
 
 /* Modifier macros for the config options (used for fine tuning) */
+
+#define add_deprecated_alias( name ) \
+    vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name))
+
 #define change_short( ch ) \
-    p_config[i_config].i_short = ch;
+    vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(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;
+    vlc_config_set (p_config, VLC_CONFIG_LIST, \
+                    (size_t)(sizeof (list) / sizeof (char *)), \
+                    (const char *const *)(list), \
+                    (const char *const *)(list_text), \
+                    list_update_func)
 
 #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;
+    vlc_config_set (p_config, VLC_CONFIG_LIST, \
+                    (size_t)(sizeof (list) / sizeof (int)), \
+                    (const int *)(list), \
+                    (const char *const *)(list_text), \
+                    list_update_func)
+
+#define change_float_list( list, list_text, list_update_func ) \
+    vlc_config_set (p_config, VLC_CONFIG_LIST, \
+                    (size_t)(sizeof (list) / sizeof (float)), \
+                    (const float *)(list), \
+                    (const char *const *)(list_text), \
+                    list_update_func)
 
 #define change_integer_range( minv, maxv ) \
-    p_config[i_config].min.i = minv; \
-    p_config[i_config].max.i = maxv;
+    vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(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++;
+    vlc_config_set (p_config, VLC_CONFIG_RANGE, \
+                    (double)(minv), (double)(maxv))
+
+#define change_action_add( pf_action, text ) \
+    vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \
+                    (vlc_callback_t)(pf_action), (const char *)(text))
 
 #define change_internal() \
-    p_config[i_config].b_internal = VLC_TRUE;
+    vlc_config_set (p_config, VLC_CONFIG_PRIVATE)
 
 #define change_need_restart() \
-    p_config[i_config].b_restart = VLC_TRUE;
+    vlc_config_set (p_config, VLC_CONFIG_RESTART)
 
 #define change_autosave() \
-    p_config[i_config].b_autosave = VLC_TRUE;
+    vlc_config_set (p_config, VLC_CONFIG_PERSISTENT)
 
 #define change_unsaveable() \
-    p_config[i_config].b_unsaveable = VLC_TRUE;
+    vlc_config_set (p_config, VLC_CONFIG_VOLATILE)
+
+#define change_unsafe() (void)0 /* no-op */
+
+#define change_safe() \
+    vlc_config_set (p_config, VLC_CONFIG_SAFE)
 
 /****************************************************************************
  * config_chain_t:
@@ -435,165 +497,6 @@ VLC_EXPORT( void,   __config_ChainParse, ( vlc_object_t *, const char *psz_prefi
 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 void config_AddIntf( vlc_object_t *p_this, const char *psz_intf )
-{
-    assert( psz_intf );
-
-    char *psz_config, *psz_parser;
-    size_t i_len = strlen( psz_intf );
-
-    psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "control" );
-    while( psz_parser )
-    {
-        if( !strncmp( psz_intf, psz_parser, i_len ) )
-        {
-            free( psz_config );
-            return;
-        }
-        psz_parser = strchr( psz_parser, ':' );
-        if( psz_parser ) psz_parser++; /* skip the ':' */
-    }
-    free( psz_config );
-
-    psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "extraintf" );
-    while( psz_parser )
-    {
-        if( !strncmp( psz_intf, psz_parser, i_len ) )
-        {
-            free( psz_config );
-            return;
-        }
-        psz_parser = strchr( psz_parser, ':' );
-        if( psz_parser ) psz_parser++; /* skip the ':' */
-    }
-
-    /* interface not found in the config, let's add it */
-    if( psz_config && strlen( psz_config ) > 0 )
-    {
-        char *psz_newconfig;
-        if( asprintf( &psz_newconfig, "%s:%s", psz_config, psz_intf ) != -1 )
-        {
-            config_PutPsz( p_this->p_libvlc, "extraintf", psz_newconfig );
-            free( psz_newconfig );
-        }
-    }
-    else
-        config_PutPsz( p_this->p_libvlc, "extraintf", psz_intf );
-
-    free( psz_config );
-}
-
-static void config_RemoveIntf( vlc_object_t *p_this, const char *psz_intf )
-{
-    assert( psz_intf );
-
-    char *psz_config, *psz_parser;
-    size_t i_len = strlen( psz_intf );
-
-    psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "extraintf" );
-    while( psz_parser )
-    {
-        if( !strncmp( psz_intf, psz_parser, i_len ) )
-        {
-            char *psz_newconfig;
-            char *psz_end = psz_parser + i_len;
-            if( *psz_end == ':' ) psz_end++;
-            *psz_parser = '\0';
-            if( asprintf( &psz_newconfig, "%s%s", psz_config, psz_end ) != -1 )
-            {
-                config_PutPsz( p_this->p_libvlc, "extraintf", psz_newconfig );
-                free( psz_newconfig );
-            }
-            break;
-        }
-        psz_parser = strchr( psz_parser, ':' );
-        if( psz_parser ) psz_parser++; /* skip the ':' */
-    }
-    free( psz_config );
-
-    psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "control" );
-    while( psz_parser )
-    {
-        if( !strncmp( psz_intf, psz_parser, i_len ) )
-        {
-            char *psz_newconfig;
-            char *psz_end = psz_parser + i_len;
-            if( *psz_end == ':' ) psz_end++;
-            *psz_parser = '\0';
-            if( asprintf( &psz_newconfig, "%s%s", psz_config, psz_end ) != -1 )
-            {
-                config_PutPsz( p_this->p_libvlc, "control", psz_newconfig );
-                free( psz_newconfig );
-            }
-            break;
-        }
-        psz_parser = strchr( psz_parser, ':' );
-        if( psz_parser ) psz_parser++; /* skip the ':' */
-    }
-    free( psz_config );
-}
-
-static vlc_bool_t config_ExistIntf( vlc_object_t *p_this, const char *psz_intf )
-{
-    assert( psz_intf );
-
-    char *psz_config, *psz_parser;
-    size_t i_len = strlen( psz_intf );
-
-    psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "extraintf" );
-    while( psz_parser )
-    {
-        if( !strncmp( psz_parser, psz_intf, i_len ) )
-        {
-            free( psz_config );
-            return VLC_TRUE;
-        }
-        psz_parser = strchr( psz_parser, ':' );
-        if( psz_parser ) psz_parser++; /* skip the ':' */
-    }
-    free( psz_config );
-
-    psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "control" );
-    while( psz_parser )
-    {
-        if( !strncmp( psz_parser, psz_intf, i_len ) )
-        {
-            free( psz_config );
-            return VLC_TRUE;
-        }
-        psz_parser = strchr( psz_parser, ':' );
-        if( psz_parser ) psz_parser++; /* skip the ':' */
-    }
-    free( psz_config );
-
-    return VLC_FALSE;
-}
-
-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;
-}
-
 # ifdef __cplusplus
 }
 # endif