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