git.sesse.net Git - vlc/blob - 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.28 2003/07/23 01:13:47 gbazin 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 #define CONFIG_ITEM_DIRECTORY               0x0070  /* Directory option */
  47
  48 #define CONFIG_ITEM                         0x00F0
  49
  50 struct module_config_t
  51 {
  52     int          i_type;                               /* Configuration type */
  53     char        *psz_type;                          /* Configuration subtype */
  54     char        *psz_name;                                    /* Option name */
  55     char         i_short;                      /* Optional short option name */
  56     char        *psz_text;      /* Short comment on the configuration option */
  57     char        *psz_longtext;   /* Long comment on the configuration option */
  58     char        *psz_value;                                  /* Option value */
  59     int          i_value;                                    /* Option value */
  60     float        f_value;                                    /* Option value */
  61     int         i_min;                               /* Option minimum value */
  62     int         i_max;                               /* Option maximum value */
  63     float       f_min;                               /* Option minimum value */
  64     float       f_max;                               /* Option maximum value */
  65
  66     /* Function to call when commiting a change */
  67     void ( * pf_callback ) ( vlc_object_t * );
  68
  69     char       **ppsz_list;        /* List of possible values for the option */
  70
  71     vlc_mutex_t *p_lock;            /* Lock to use when modifying the config */
  72     vlc_bool_t   b_dirty;          /* Dirty flag to indicate a config change */
  73     vlc_bool_t   b_advanced;          /* Flag to indicate an advanced option */
  74
  75     /* Original option values */
  76     char        *psz_value_orig;
  77     int          i_value_orig;
  78     float        f_value_orig;
  79 };
  80
  81 /*****************************************************************************
  82  * Prototypes - these methods are used to get, set or manipulate configuration
  83  * data.
  84  *****************************************************************************/
  85 VLC_EXPORT( int,    __config_GetType,  (vlc_object_t *, const char *) );
  86 VLC_EXPORT( int,    __config_GetInt,   (vlc_object_t *, const char *) );
  87 VLC_EXPORT( void,   __config_PutInt,   (vlc_object_t *, const char *, int) );
  88 VLC_EXPORT( float,  __config_GetFloat, (vlc_object_t *, const char *) );
  89 VLC_EXPORT( void,   __config_PutFloat, (vlc_object_t *, const char *, float) );
  90 VLC_EXPORT( char *, __config_GetPsz,   (vlc_object_t *, const char *) );
  91 VLC_EXPORT( void,   __config_PutPsz,   (vlc_object_t *, const char *, const char *) );
  92
  93 VLC_EXPORT( int,    __config_LoadCmdLine,  ( vlc_object_t *, int *, char *[], vlc_bool_t ) );
  94 VLC_EXPORT( char *,   config_GetHomeDir,     ( void ) );
  95 VLC_EXPORT( int,    __config_LoadConfigFile, ( vlc_object_t *, const char * ) );
  96 VLC_EXPORT( int,    __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
  97 VLC_EXPORT( void,   __config_ResetAll, ( vlc_object_t * ) );
  98
  99 VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char *psz_name ) );
 100
 101 VLC_EXPORT( void, config_Duplicate, ( module_t *, module_config_t * ) );
 102             void  config_Free       ( module_t * );
 103
 104 VLC_EXPORT( void, config_SetCallbacks, ( module_config_t *, module_config_t * ) );
 105 VLC_EXPORT( void, config_UnsetCallbacks, ( module_config_t * ) );
 106
 107 #define config_GetType(a,b) __config_GetType(VLC_OBJECT(a),b)
 108 #define config_GetInt(a,b) __config_GetInt(VLC_OBJECT(a),b)
 109 #define config_PutInt(a,b,c) __config_PutInt(VLC_OBJECT(a),b,c)
 110 #define config_GetFloat(a,b) __config_GetFloat(VLC_OBJECT(a),b)
 111 #define config_PutFloat(a,b,c) __config_PutFloat(VLC_OBJECT(a),b,c)
 112 #define config_GetPsz(a,b) __config_GetPsz(VLC_OBJECT(a),b)
 113 #define config_PutPsz(a,b,c) __config_PutPsz(VLC_OBJECT(a),b,c)
 114
 115 #define config_LoadCmdLine(a,b,c,d) __config_LoadCmdLine(VLC_OBJECT(a),b,c,d)
 116 #define config_LoadConfigFile(a,b) __config_LoadConfigFile(VLC_OBJECT(a),b)
 117 #define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b)
 118 #define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a))
 119
 120 /*****************************************************************************
 121  * Macros used to build the configuration structure.
 122  *
 123  * Note that internally we support only 3 types of config data: int , float
 124  *   and string.
 125  *   The other types declared here just map to one of these 3 basic types but
 126  *   have the advantage of also providing very good hints to a configuration
 127  *   interface so as to make it more user friendly.
 128  * The configuration structure also includes category hints. These hints can
 129  *   provide a configuration interface with some very useful data and again
 130  *   allow for a more user friendly interface.
 131  *****************************************************************************/
 132
 133 #define add_category_hint( text, longtext, advc ) \
 134     { static module_config_t tmp = { CONFIG_HINT_CATEGORY, NULL, NULL, '\0', text, longtext }; p_config[ i_config ] = tmp; p_config[i_config].b_advanced = advc; } i_config++
 135 #define add_subcategory_hint( text, longtext ) \
 136     { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY, NULL, NULL, '\0', text, longtext }; p_config[ i_config ] = tmp; } i_config++
 137 #define end_subcategory_hint \
 138     { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY_END, NULL, NULL, '\0' }; p_config[ i_config ] = tmp; } i_config++
 139 #define add_usage_hint( text ) \
 140     { static module_config_t tmp = { CONFIG_HINT_USAGE, NULL, NULL, '\0', text }; p_config[ i_config ] = tmp; } i_config++
 141
 142 #define add_string( name, psz_value, p_callback, text, longtext, advc ) \
 143     { static module_config_t tmp = { CONFIG_ITEM_STRING, NULL, name, '\0', text, longtext, psz_value }; tmp.b_advanced = advc; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; } i_config++
 144 #define add_string_from_list( name, psz_value, ppsz_list, p_callback, text, \
 145       longtext, advc ) \
 146     { static module_config_t tmp = { CONFIG_ITEM_STRING, NULL, name, '\0', text, longtext, psz_value, 0, 0, 0, 0, 0, 0, NULL, ppsz_list }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; } i_config++
 147 #define add_file( name, psz_value, p_callback, text, longtext, advc ) \
 148     { static module_config_t tmp = { CONFIG_ITEM_FILE, NULL, name, '\0', text, longtext, psz_value, 0, 0 }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; } i_config++
 149 #define add_directory( name, psz_value, p_callback, text, longtext, advc ) \
 150     { static module_config_t tmp = { CONFIG_ITEM_DIRECTORY, NULL, name, '\0', text, longtext, psz_value, 0, 0 }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; } i_config++
 151 #define add_module( name, psz_caps, psz_value, p_callback, text, longtext, advc ) \
 152     { static module_config_t tmp = { CONFIG_ITEM_MODULE, psz_caps, name, '\0', text, longtext, psz_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; } i_config++
 153 #define add_integer( name, i_value, p_callback, text, longtext, advc ) \
 154     { static module_config_t tmp = { CONFIG_ITEM_INTEGER, NULL, name, '\0', text, longtext, NULL, i_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; } i_config++
 155 #define add_integer_with_range( name, i_value, i_min, i_max, p_callback, text, longtext, advc ) \
 156     { static module_config_t tmp = { CONFIG_ITEM_INTEGER, NULL, name, '\0', text, longtext, NULL, i_value, 0, i_min, i_max }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; } i_config++
 157 #define add_float( name, f_value, p_callback, text, longtext, advc ) \
 158     { static module_config_t tmp = { CONFIG_ITEM_FLOAT, NULL, name, '\0', text, longtext, NULL, 0, f_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; } i_config++
 159 #define add_float_with_range( name, f_value, f_min, f_max, p_callback, text, longtext, advc ) \
 160     { static module_config_t tmp = { CONFIG_ITEM_FLOAT, NULL, name, '\0', text, longtext, NULL, 0, f_value, 0, 0, f_min, f_max }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; } i_config++
 161 #define add_bool( name, b_value, p_callback, text, longtext, advc ) \
 162     { static module_config_t tmp = { CONFIG_ITEM_BOOL, NULL, name, '\0', text, longtext, NULL, b_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; } i_config++
 163
 164 /* These should be seldom used. They were added just to provide easy shortcuts
 165  * for the command line interface */
 166 #define add_string_with_short( name, ch, psz_value, p_callback, text, ltext, advc ) \
 167     { static module_config_t tmp = { CONFIG_ITEM_STRING, NULL, name, ch, text, ltext, psz_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; } i_config++
 168 #define add_file_with_short( name, ch, psz_value, p_callback, text, ltext, advc ) \
 169     { static module_config_t tmp = { CONFIG_ITEM_FILE, NULL, name, ch, text, ltext, psz_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; } i_config++
 170 #define add_module_with_short( name, ch, psz_caps, psz_value, p_callback, \
 171     text, ltext, advc) \
 172     { static module_config_t tmp = { CONFIG_ITEM_MODULE, psz_caps, name, ch, text, ltext, psz_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; } i_config++
 173 #define add_integer_with_short( name, ch, i_value, p_callback, text, ltext, advc ) \
 174     { static module_config_t tmp = { CONFIG_ITEM_INTEGER, NULL, name, ch, text, ltext, NULL, i_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; } i_config++
 175 #define add_float_with_short( name, ch, f_value, p_callback, text, ltext, advc ) \
 176     { static module_config_t tmp = { CONFIG_ITEM_FLOAT, NULL, name, ch, text, ltext, NULL, 0, f_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc;} i_config++
 177 #define add_bool_with_short( name, ch, b_value, p_callback, text, ltext, advc ) \
 178     { static module_config_t tmp = { CONFIG_ITEM_BOOL, NULL, name, ch, text, ltext, NULL, b_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc;} i_config++