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