vlc_configuration.h 9.07 KB
Newer Older
1
/*****************************************************************************
Pere Orga's avatar
Pere Orga committed
2
 * vlc_configuration.h : configuration management module
3 4 5
 * This file describes the programming interface for the configuration module.
 * It includes functions allowing to declare, get or set configuration options.
 *****************************************************************************
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
6
 * Copyright (C) 1999-2006 VLC authors and VideoLAN
7
 * $Id$
8
 *
9
 * Authors: Gildas Bazin <gbazin@videolan.org>
10
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
11 12 13
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
14
 * (at your option) any later version.
15
 *
16 17
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
18 19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
20
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
21 22 23
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 25
 *****************************************************************************/

26 27
#ifndef VLC_CONFIGURATION_H
#define VLC_CONFIGURATION_H 1
28

29 30 31 32 33
/**
 * \file
 * This file describes the programming interface for the configuration module.
 * It includes functions allowing to declare, get or set configuration options.
 */
34

35 36
#include <sys/types.h>  /* for ssize_t */

37 38 39 40
# ifdef __cplusplus
extern "C" {
# endif

41 42 43
struct config_category_t
{
    int         i_id;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
44 45
    const char *psz_name;
    const char *psz_help;
46 47
};

48 49
typedef union
{
50
    char       *psz;
51
    int64_t     i;
52 53 54
    float       f;
} module_value_t;

55 56
typedef int (*vlc_string_list_cb)(vlc_object_t *, const char *,
                                  char ***, char ***);
57 58
typedef int (*vlc_integer_list_cb)(vlc_object_t *, const char *,
                                   int64_t **, char ***);
59

60
struct module_config_t
61
{
62 63 64 65 66 67 68 69
    uint8_t     i_type;                        /* Configuration type */
    char        i_short;               /* Optional short option name */
    unsigned    b_advanced:1;                     /* Advanced option */
    unsigned    b_internal:1;          /* Hidden from prefs and help */
    unsigned    b_unsaveable:1;       /* Not stored in configuration */
    unsigned    b_safe:1;       /* Safe in web plugins and playlists */
    unsigned    b_removed:1;                           /* Deprecated */

70 71 72 73
    const char *psz_type;                           /* Configuration subtype */
    const char *psz_name;                                     /* Option name */
    const char *psz_text;       /* Short comment on the configuration option */
    const char *psz_longtext;    /* Long comment on the configuration option */
74

75 76
    module_value_t value;                                    /* Option value */
    module_value_t orig;
77 78
    module_value_t min;
    module_value_t max;
79

80
    /* Values list */
81 82 83
    uint16_t list_count;                                /* Options list size */
    union
    {
84
        const char **psz;          /* List of possible values for the option */
85
        const int  *i;
86
        vlc_string_list_cb psz_cb;
87
        vlc_integer_list_cb i_cb;
88
    } list;
89
    const char **list_text;                /* Friendly names for list values */
90
    const char *list_cb_name;
91
    void *owner;
92
};
93 94 95 96 97

/*****************************************************************************
 * Prototypes - these methods are used to get, set or manipulate configuration
 * data.
 *****************************************************************************/
98 99
VLC_API int config_GetType(vlc_object_t *, const char *) VLC_USED;
VLC_API int64_t config_GetInt(vlc_object_t *, const char *) VLC_USED;
100
VLC_API void config_PutInt(vlc_object_t *, const char *, int64_t);
101
VLC_API float config_GetFloat(vlc_object_t *, const char *) VLC_USED;
102
VLC_API void config_PutFloat(vlc_object_t *, const char *, float);
103
VLC_API char * config_GetPsz(vlc_object_t *, const char *) VLC_USED VLC_MALLOC;
104
VLC_API void config_PutPsz(vlc_object_t *, const char *, const char *);
105 106
VLC_API ssize_t config_GetIntChoices(vlc_object_t *, const char *,
                                     int64_t **, char ***) VLC_USED;
107 108
VLC_API ssize_t config_GetPszChoices(vlc_object_t *, const char *,
                                     char ***, char ***) VLC_USED;
109 110

VLC_API int config_SaveConfigFile( vlc_object_t * );
111 112
#define config_SaveConfigFile(a) config_SaveConfigFile(VLC_OBJECT(a))

113
VLC_API void config_ResetAll( vlc_object_t * );
114
#define config_ResetAll(a) config_ResetAll(VLC_OBJECT(a))
115

116
VLC_API module_config_t * config_FindConfig( vlc_object_t *, const char * ) VLC_USED;
117
VLC_API char * config_GetDataDir(void) VLC_USED VLC_MALLOC;
118
VLC_API char *config_GetLibDir(void) VLC_USED;
119

120 121 122 123 124
typedef enum vlc_userdir
{
    VLC_HOME_DIR, /* User's home */
    VLC_CONFIG_DIR, /* VLC-specific configuration directory */
    VLC_DATA_DIR, /* VLC-specific data directory */
125
    VLC_CACHE_DIR, /* VLC-specific user cached data directory */
126
    /* Generic directories (same as XDG) */
127
    VLC_DESKTOP_DIR=0x80,
128 129 130 131 132 133 134
    VLC_DOWNLOAD_DIR,
    VLC_TEMPLATES_DIR,
    VLC_PUBLICSHARE_DIR,
    VLC_DOCUMENTS_DIR,
    VLC_MUSIC_DIR,
    VLC_PICTURES_DIR,
    VLC_VIDEOS_DIR,
135 136
} vlc_userdir_t;

137
VLC_API char * config_GetUserDir( vlc_userdir_t ) VLC_USED VLC_MALLOC;
138

139 140
VLC_API void config_AddIntf( vlc_object_t *, const char * );
VLC_API void config_RemoveIntf( vlc_object_t *, const char * );
141
VLC_API bool config_ExistIntf( vlc_object_t *, const char * ) VLC_USED;
142

143 144 145 146 147 148 149
#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_PutFloat(a,b,c) config_PutFloat(VLC_OBJECT(a),b,c)
#define config_GetPsz(a,b) config_GetPsz(VLC_OBJECT(a),b)
#define config_PutPsz(a,b,c) config_PutPsz(VLC_OBJECT(a),b,c)
150

151 152 153
#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)
154

155 156 157 158 159
/****************************************************************************
 * config_chain_t:
 ****************************************************************************/
struct config_chain_t
{
160
    config_chain_t *p_next;     /**< Pointer on the next config_chain_t element */
161

162 163
    char        *psz_name;      /**< Option name */
    char        *psz_value;     /**< Option value */
164 165
};

166 167 168 169 170 171 172
/**
 * This function will
 * - create all options in the array ppsz_options (var_Create).
 * - parse the given linked list of config_chain_t and set the value (var_Set).
 *
 * The option names will be created by adding the psz_prefix prefix.
 */
173
VLC_API void config_ChainParse( vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, config_chain_t * );
174
#define config_ChainParse( a, b, c, d ) config_ChainParse( VLC_OBJECT(a), b, c, d )
175

176 177 178 179 180 181 182 183 184 185 186 187
/**
 * This function will parse a configuration string (psz_opts) and
 * - set all options for this module in a chained list (*pp_cfg)
 * - returns a pointer on the next module if any.
 *
 * The string format is
 *   module{option=*,option=*}
 *
 * The options values are unescaped using config_StringUnescape.
 */
VLC_API const char *config_ChainParseOptions( config_chain_t **pp_cfg, const char *ppsz_opts );

188 189 190 191 192 193 194 195 196 197 198
/**
 * This function will parse a configuration string (psz_string) and
 * - set the module name (*ppsz_name)
 * - set all options for this module in a chained list (*pp_cfg)
 * - returns a pointer on the next module if any.
 *
 * The string format is
 *   module{option=*,option=*}[:modulenext{option=*,...}]
 *
 * The options values are unescaped using config_StringUnescape.
 */
199
VLC_API char *config_ChainCreate( char **ppsz_name, config_chain_t **pp_cfg, const char *psz_string ) VLC_USED VLC_MALLOC;
200 201 202 203 204

/**
 * This function will release a linked list of config_chain_t
 * (Including the head)
 */
205
VLC_API void config_ChainDestroy( config_chain_t * );
206

207 208 209
/**
 * This function will duplicate a linked list of config_chain_t
 */
210
VLC_API config_chain_t * config_ChainDuplicate( const config_chain_t * ) VLC_USED VLC_MALLOC;
211

212 213 214 215 216 217 218 219 220
/**
 * This function will unescape a string in place and will return a pointer on
 * the given string.
 * No memory is allocated by it (unlike config_StringEscape).
 * If NULL is given as parameter nothing will be done (NULL will be returned).
 *
 * The following sequences will be unescaped (only one time):
 * \\ \' and \"
 */
221
VLC_API char * config_StringUnescape( char *psz_string );
222 223 224 225 226 227 228 229 230 231

/**
 * This function will escape a string that can be unescaped by
 * config_StringUnescape.
 * The returned value is allocated by it. You have to free it once you
 * do not need it anymore (unlike config_StringUnescape).
 * If NULL is given as parameter nothing will be done (NULL will be returned).
 *
 * The escaped characters are ' " and \
 */
232
VLC_API char * config_StringEscape( const char *psz_string ) VLC_USED VLC_MALLOC;
233

234 235 236
# ifdef __cplusplus
}
# endif
237 238

#endif /* _VLC_CONFIGURATION_H */