881e3b106a175734ac41d2dc593e2db27b8822dd
[vlc.git] / include / configuration.h
1 /*****************************************************************************
2  * 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, 2000 VideoLAN
7  * $Id: configuration.h,v 1.19 2002/12/06 10:10:40 sam Exp $
8  *
9  * Authors: Gildas Bazin <gbazin@netcourrier.com>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 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 General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
24  *****************************************************************************/
25
26 /*****************************************************************************
27  * Macros used to build the configuration structure.
28  *****************************************************************************/
29
30 /* Configuration hint types */
31 #define CONFIG_HINT_END                     0x0001  /* End of config */
32 #define CONFIG_HINT_CATEGORY                0x0002  /* Start of new category */
33 #define CONFIG_HINT_SUBCATEGORY             0x0003  /* Start of sub-category */
34 #define CONFIG_HINT_SUBCATEGORY_END         0x0004  /* End of sub-category */
35 #define CONFIG_HINT_USAGE                   0x0005  /* Usage information */
36
37 #define CONFIG_HINT                         0x000F
38
39 /* Configuration item types */
40 #define CONFIG_ITEM_STRING                  0x0010  /* String option */
41 #define CONFIG_ITEM_FILE                    0x0020  /* File option */
42 #define CONFIG_ITEM_MODULE                  0x0030  /* Module option */
43 #define CONFIG_ITEM_INTEGER                 0x0040  /* Integer option */
44 #define CONFIG_ITEM_BOOL                    0x0050  /* Bool option */
45 #define CONFIG_ITEM_FLOAT                   0x0060  /* Float option */
46
47 #define CONFIG_ITEM                         0x00F0
48
49 struct module_config_t
50 {
51     int          i_type;                               /* Configuration type */
52     char        *psz_type;                          /* Configuration subtype */
53     char        *psz_name;                                    /* Option name */
54     char         i_short;                      /* Optional short option name */
55     char        *psz_text;      /* Short comment on the configuration option */
56     char        *psz_longtext;   /* Long comment on the configuration option */
57     char        *psz_value;                                  /* Option value */
58     int          i_value;                                    /* Option value */
59     float        f_value;                                    /* Option value */
60
61     /* Function to call when commiting a change */
62     void ( * pf_callback ) ( vlc_object_t * );
63
64     char       **ppsz_list;        /* List of possible values for the option */
65
66     vlc_mutex_t *p_lock;            /* Lock to use when modifying the config */
67     vlc_bool_t   b_dirty;          /* Dirty flag to indicate a config change */
68 };
69
70 /*****************************************************************************
71  * Prototypes - these methods are used to get, set or manipulate configuration
72  * data.
73  *****************************************************************************/
74 VLC_EXPORT( int,    __config_GetInt,   (vlc_object_t *, const char *) );
75 VLC_EXPORT( void,   __config_PutInt,   (vlc_object_t *, const char *, int) );
76 VLC_EXPORT( float,  __config_GetFloat, (vlc_object_t *, const char *) );
77 VLC_EXPORT( void,   __config_PutFloat, (vlc_object_t *, const char *, float) );
78 VLC_EXPORT( char *, __config_GetPsz,   (vlc_object_t *, const char *) );
79 VLC_EXPORT( void,   __config_PutPsz,   (vlc_object_t *, const char *, const char *) );
80
81 VLC_EXPORT( int,    __config_LoadCmdLine,  ( vlc_object_t *, int *, char *[], vlc_bool_t ) );
82 VLC_EXPORT( char *,   config_GetHomeDir,     ( void ) );
83 VLC_EXPORT( int,    __config_LoadConfigFile, ( vlc_object_t *, const char * ) );
84 VLC_EXPORT( int,    __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
85 VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char *psz_name ) );
86
87 VLC_EXPORT( void, config_Duplicate, ( module_t *, module_config_t * ) );
88             void  config_Free       ( module_t * );
89
90 VLC_EXPORT( void, config_SetCallbacks, ( module_config_t *, module_config_t * ) );
91 VLC_EXPORT( void, config_UnsetCallbacks, ( module_config_t * ) );
92
93 #define config_GetInt(a,b) __config_GetInt(VLC_OBJECT(a),b)
94 #define config_PutInt(a,b,c) __config_PutInt(VLC_OBJECT(a),b,c)
95 #define config_GetFloat(a,b) __config_GetFloat(VLC_OBJECT(a),b)
96 #define config_PutFloat(a,b,c) __config_PutFloat(VLC_OBJECT(a),b,c)
97 #define config_GetPsz(a,b) __config_GetPsz(VLC_OBJECT(a),b)
98 #define config_PutPsz(a,b,c) __config_PutPsz(VLC_OBJECT(a),b,c)
99
100 #define config_LoadCmdLine(a,b,c,d) __config_LoadCmdLine(VLC_OBJECT(a),b,c,d)
101 #define config_LoadConfigFile(a,b) __config_LoadConfigFile(VLC_OBJECT(a),b)
102 #define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b)
103
104 /*****************************************************************************
105  * Macros used to build the configuration structure.
106  *
107  * Note that internally we support only 3 types of config data: int , float
108  *   and string.
109  *   The other types declared here just map to one of these 3 basic types but
110  *   have the advantage of also providing very good hints to a configuration
111  *   interface so as to make it more user friendly.
112  * The configuration structure also includes category hints. These hints can
113  *   provide a configuration interface with some very useful data and again
114  *   allow for a more user friendly interface.
115  *****************************************************************************/
116
117 #define add_category_hint( text, longtext ) \
118     { module_config_t tmp = { CONFIG_HINT_CATEGORY, NULL, NULL, '\0', text, longtext, NULL, 0, 0.0, NULL, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
119 #define add_subcategory_hint( text, longtext ) \
120     { module_config_t tmp = { CONFIG_HINT_SUBCATEGORY, NULL, NULL, '\0', text, longtext, NULL, 0, 0.0, NULL, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
121 #define end_subcategory_hint \
122     { module_config_t tmp = { CONFIG_HINT_SUBCATEGORY_END, NULL, NULL, '\0', NULL, NULL, NULL, 0, 0.0, NULL, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
123 #define add_usage_hint( text ) \
124     { module_config_t tmp = { CONFIG_HINT_USAGE, NULL, NULL, '\0', text, NULL, NULL, 0, 0.0, NULL, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
125
126 #define add_string( name, psz_value, p_callback, text, longtext ) \
127     { module_config_t tmp = { CONFIG_ITEM_STRING, NULL, name, '\0', text, longtext, psz_value, 0, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
128 #define add_string_from_list( name, psz_value, ppsz_list, p_callback, text, \
129       longtext ) \
130     { module_config_t tmp = { CONFIG_ITEM_STRING, NULL, name, '\0', text, longtext, psz_value, 0, 0, p_callback, ppsz_list, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
131 #define add_file( name, psz_value, p_callback, text, longtext ) \
132     { module_config_t tmp = { CONFIG_ITEM_FILE, NULL, name, '\0', text, longtext, psz_value, 0, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
133 #define add_module( name, psz_caps, psz_value, p_callback, text, longtext ) \
134     { module_config_t tmp = { CONFIG_ITEM_MODULE, psz_caps, name, '\0', text, longtext, psz_value, 0, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
135 #define add_integer( name, i_value, p_callback, text, longtext ) \
136     { module_config_t tmp = { CONFIG_ITEM_INTEGER, NULL, name, '\0', text, longtext, NULL, i_value, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
137 #define add_float( name, f_value, p_callback, text, longtext ) \
138     { module_config_t tmp = { CONFIG_ITEM_FLOAT, NULL, name, '\0', text, longtext, NULL, 0, f_value, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
139 #define add_bool( name, b_value, p_callback, text, longtext ) \
140     { module_config_t tmp = { CONFIG_ITEM_BOOL, NULL, name, '\0', text, longtext, NULL, b_value, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
141
142 /* These should be seldom used. They were added just to provide easy shortcuts
143  * for the command line interface */
144 #define add_string_with_short( name, ch, psz_value, p_callback, text, ltext ) \
145     { module_config_t tmp = { CONFIG_ITEM_STRING, NULL, name, ch, text, ltext, psz_value, 0, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
146 #define add_file_with_short( name, ch, psz_value, p_callback, text, ltext ) \
147     { module_config_t tmp = { CONFIG_ITEM_FILE, NULL, name, ch, text, ltext, psz_value, 0, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
148 #define add_module_with_short( name, ch, psz_caps, psz_value, p_callback, \
149     text, ltext) \
150     { module_config_t tmp = { CONFIG_ITEM_MODULE, psz_caps, name, ch, text, ltext, psz_value, 0, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
151 #define add_integer_with_short( name, ch, i_value, p_callback, text, ltext ) \
152     { module_config_t tmp = { CONFIG_ITEM_INTEGER, NULL, name, ch, text, ltext, NULL, i_value, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
153 #define add_float_with_short( name, ch, f_value, p_callback, text, ltext ) \
154     { module_config_t tmp = { CONFIG_ITEM_FLOAT, NULL, name, ch, text, ltext, NULL, 0, f_value, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++
155 #define add_bool_with_short( name, ch, b_value, p_callback, text, ltext ) \
156     { module_config_t tmp = { CONFIG_ITEM_BOOL, NULL, name, ch, text, ltext, NULL, b_value, 0, p_callback, NULL, NULL, VLC_FALSE }; p_config[ i_config ] = tmp; } i_config++