include/vlc_configuration.h

   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
   7  * $Id$
   8  *
   9  * Authors: Gildas Bazin <gbazin@videolan.org>
  10  *
  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.
  15  *
  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.
  20  *
  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  *****************************************************************************/
  25
  26 #ifndef VLC_CONFIGURATION_H
  27 #define VLC_CONFIGURATION_H 1
  28
  29 /**
  30  * \file
  31  * This file describes the programming interface for the configuration module.
  32  * It includes functions allowing to declare, get or set configuration options.
  33  */
  34
  35 #include <sys/types.h>  /* for ssize_t */
  36
  37 # ifdef __cplusplus
  38 extern "C" {
  39 # endif
  40
  41 struct config_category_t
  42 {
  43     int         i_id;
  44     const char *psz_name;
  45     const char *psz_help;
  46 };
  47
  48 typedef union
  49 {
  50     char       *psz;
  51     int64_t     i;
  52     float       f;
  53 } module_value_t;
  54
  55 typedef int (*vlc_string_list_cb)(vlc_object_t *, const char *,
  56                                   char ***, char ***);
  57 typedef int (*vlc_integer_list_cb)(vlc_object_t *, const char *,
  58                                    int64_t **, char ***);
  59
  60 struct module_config_t
  61 {
  62     union
  63     {
  64         struct
  65         {
  66             uint8_t     i_type;                        /* Configuration type */
  67             char        i_short;               /* Optional short option name */
  68             unsigned    b_advanced:1;                     /* Advanced option */
  69             unsigned    b_internal:1;          /* Hidden from prefs and help */
  70             unsigned    b_unsaveable:1;       /* Not stored in configuration */
  71             unsigned    b_safe:1;       /* Safe in web plugins and playlists */
  72             unsigned    b_removed:1;                           /* Deprecated */
  73         };
  74         uint32_t flags;
  75     };
  76     char *psz_type;                                 /* Configuration subtype */
  77     char *psz_name;                                           /* Option name */
  78     char *psz_text;             /* Short comment on the configuration option */
  79     char *psz_longtext;          /* Long comment on the configuration option */
  80
  81     module_value_t value;                                    /* Option value */
  82     module_value_t orig;
  83     module_value_t min;
  84     module_value_t max;
  85
  86     /* Values list */
  87     uint16_t list_count;                                /* Options list size */
  88     union
  89     {
  90         char **psz;               /* List of possible values for the option */
  91         int   *i;
  92         vlc_string_list_cb psz_cb;
  93         vlc_integer_list_cb i_cb;
  94     } list;
  95     char **list_text;                      /* Friendly names for list values */
  96 };
  97
  98 /*****************************************************************************
  99  * Prototypes - these methods are used to get, set or manipulate configuration
 100  * data.
 101  *****************************************************************************/
 102 VLC_API int config_GetType(vlc_object_t *, const char *) VLC_USED;
 103 VLC_API int64_t config_GetInt(vlc_object_t *, const char *) VLC_USED;
 104 VLC_API void config_PutInt(vlc_object_t *, const char *, int64_t);
 105 VLC_API float config_GetFloat(vlc_object_t *, const char *) VLC_USED;
 106 VLC_API void config_PutFloat(vlc_object_t *, const char *, float);
 107 VLC_API char * config_GetPsz(vlc_object_t *, const char *) VLC_USED VLC_MALLOC;
 108 VLC_API void config_PutPsz(vlc_object_t *, const char *, const char *);
 109 VLC_API ssize_t config_GetIntChoices(vlc_object_t *, const char *,
 110                                      int64_t **, char ***) VLC_USED;
 111 VLC_API ssize_t config_GetPszChoices(vlc_object_t *, const char *,
 112                                      char ***, char ***) VLC_USED;
 113
 114 VLC_API int config_SaveConfigFile( vlc_object_t * );
 115 #define config_SaveConfigFile(a) config_SaveConfigFile(VLC_OBJECT(a))
 116
 117 VLC_API void config_ResetAll( vlc_object_t * );
 118 #define config_ResetAll(a) config_ResetAll(VLC_OBJECT(a))
 119
 120 VLC_API module_config_t * config_FindConfig( vlc_object_t *, const char * ) VLC_USED;
 121 VLC_API char * config_GetDataDir(void) VLC_USED VLC_MALLOC;
 122 VLC_API char *config_GetLibDir(void) VLC_USED;
 123
 124 typedef enum vlc_userdir
 125 {
 126     VLC_HOME_DIR, /* User's home */
 127     VLC_CONFIG_DIR, /* VLC-specific configuration directory */
 128     VLC_DATA_DIR, /* VLC-specific data directory */
 129     VLC_CACHE_DIR, /* VLC-specific user cached data directory */
 130     /* Generic directories (same as XDG) */
 131     VLC_DESKTOP_DIR=0x80,
 132     VLC_DOWNLOAD_DIR,
 133     VLC_TEMPLATES_DIR,
 134     VLC_PUBLICSHARE_DIR,
 135     VLC_DOCUMENTS_DIR,
 136     VLC_MUSIC_DIR,
 137     VLC_PICTURES_DIR,
 138     VLC_VIDEOS_DIR,
 139 } vlc_userdir_t;
 140
 141 VLC_API char * config_GetUserDir( vlc_userdir_t ) VLC_USED VLC_MALLOC;
 142
 143 VLC_API void config_AddIntf( vlc_object_t *, const char * );
 144 VLC_API void config_RemoveIntf( vlc_object_t *, const char * );
 145 VLC_API bool config_ExistIntf( vlc_object_t *, const char * ) VLC_USED;
 146
 147 #define config_GetType(a,b) config_GetType(VLC_OBJECT(a),b)
 148 #define config_GetInt(a,b) config_GetInt(VLC_OBJECT(a),b)
 149 #define config_PutInt(a,b,c) config_PutInt(VLC_OBJECT(a),b,c)
 150 #define config_GetFloat(a,b) config_GetFloat(VLC_OBJECT(a),b)
 151 #define config_PutFloat(a,b,c) config_PutFloat(VLC_OBJECT(a),b,c)
 152 #define config_GetPsz(a,b) config_GetPsz(VLC_OBJECT(a),b)
 153 #define config_PutPsz(a,b,c) config_PutPsz(VLC_OBJECT(a),b,c)
 154
 155 #define config_AddIntf(a,b) config_AddIntf(VLC_OBJECT(a),b)
 156 #define config_RemoveIntf(a,b) config_RemoveIntf(VLC_OBJECT(a),b)
 157 #define config_ExistIntf(a,b) config_ExistIntf(VLC_OBJECT(a),b)
 158
 159 /****************************************************************************
 160  * config_chain_t:
 161  ****************************************************************************/
 162 struct config_chain_t
 163 {
 164     config_chain_t *p_next;     /**< Pointer on the next config_chain_t element */
 165
 166     char        *psz_name;      /**< Option name */
 167     char        *psz_value;     /**< Option value */
 168 };
 169
 170 /**
 171  * This function will
 172  * - create all options in the array ppsz_options (var_Create).
 173  * - parse the given linked list of config_chain_t and set the value (var_Set).
 174  *
 175  * The option names will be created by adding the psz_prefix prefix.
 176  */
 177 VLC_API void config_ChainParse( vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, config_chain_t * );
 178 #define config_ChainParse( a, b, c, d ) config_ChainParse( VLC_OBJECT(a), b, c, d )
 179
 180 /**
 181  * This function will parse a configuration string (psz_opts) and
 182  * - set all options for this module in a chained list (*pp_cfg)
 183  * - returns a pointer on the next module if any.
 184  *
 185  * The string format is
 186  *   module{option=*,option=*}
 187  *
 188  * The options values are unescaped using config_StringUnescape.
 189  */
 190 VLC_API const char *config_ChainParseOptions( config_chain_t **pp_cfg, const char *ppsz_opts );
 191
 192 /**
 193  * This function will parse a configuration string (psz_string) and
 194  * - set the module name (*ppsz_name)
 195  * - set all options for this module in a chained list (*pp_cfg)
 196  * - returns a pointer on the next module if any.
 197  *
 198  * The string format is
 199  *   module{option=*,option=*}[:modulenext{option=*,...}]
 200  *
 201  * The options values are unescaped using config_StringUnescape.
 202  */
 203 VLC_API char *config_ChainCreate( char **ppsz_name, config_chain_t **pp_cfg, const char *psz_string ) VLC_USED VLC_MALLOC;
 204
 205 /**
 206  * This function will release a linked list of config_chain_t
 207  * (Including the head)
 208  */
 209 VLC_API void config_ChainDestroy( config_chain_t * );
 210
 211 /**
 212  * This function will duplicate a linked list of config_chain_t
 213  */
 214 VLC_API config_chain_t * config_ChainDuplicate( const config_chain_t * ) VLC_USED VLC_MALLOC;
 215
 216 /**
 217  * This function will unescape a string in place and will return a pointer on
 218  * the given string.
 219  * No memory is allocated by it (unlike config_StringEscape).
 220  * If NULL is given as parameter nothing will be done (NULL will be returned).
 221  *
 222  * The following sequences will be unescaped (only one time):
 223  * \\ \' and \"
 224  */
 225 VLC_API char * config_StringUnescape( char *psz_string );
 226
 227 /**
 228  * This function will escape a string that can be unescaped by
 229  * config_StringUnescape.
 230  * The returned value is allocated by it. You have to free it once you
 231  * do not need it anymore (unlike config_StringUnescape).
 232  * If NULL is given as parameter nothing will be done (NULL will be returned).
 233  *
 234  * The escaped characters are ' " and \
 235  */
 236 VLC_API char * config_StringEscape( const char *psz_string ) VLC_USED VLC_MALLOC;
 237
 238 # ifdef __cplusplus
 239 }
 240 # endif
 241
 242 #endif /* _VLC_CONFIGURATION_H */