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.12 2002/06/01 12:31:57 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 MODULE_CONFIG_HINT_END              0x0001  /* End of config */
  32 #define MODULE_CONFIG_HINT_CATEGORY         0x0002  /* Start of new category */
  33 #define MODULE_CONFIG_HINT_SUBCATEGORY      0x0003  /* Start of sub-category */
  34 #define MODULE_CONFIG_HINT_SUBCATEGORY_END  0x0004  /* End of sub-category */
  35
  36 #define MODULE_CONFIG_HINT                  0x000F
  37
  38 /* Configuration item types */
  39 #define MODULE_CONFIG_ITEM_STRING           0x0010  /* String option */
  40 #define MODULE_CONFIG_ITEM_FILE             0x0020  /* File option */
  41 #define MODULE_CONFIG_ITEM_MODULE           0x0030  /* Module option */
  42 #define MODULE_CONFIG_ITEM_INTEGER          0x0040  /* Integer option */
  43 #define MODULE_CONFIG_ITEM_BOOL             0x0050  /* Bool option */
  44 #define MODULE_CONFIG_ITEM_FLOAT            0x0060  /* Float option */
  45
  46 #define MODULE_CONFIG_ITEM                  0x00F0
  47
  48 struct module_config_s
  49 {
  50     int          i_type;                               /* Configuration type */
  51     char        *psz_name;                                    /* Option name */
  52     char         i_short;                      /* Optional short option name */
  53     char        *psz_text;      /* Short comment on the configuration option */
  54     char        *psz_longtext;   /* Long comment on the configuration option */
  55     char        *psz_value;                                  /* Option value */
  56     int          i_value;                                    /* Option value */
  57     float        f_value;                                    /* Option value */
  58
  59     /* Function to call when commiting a change */
  60     void ( * pf_callback ) ( vlc_object_t * );
  61
  62     vlc_mutex_t *p_lock;            /* lock to use when modifying the config */
  63     vlc_bool_t   b_dirty;          /* Dirty flag to indicate a config change */
  64 };
  65
  66 /*****************************************************************************
  67  * Prototypes - these methods are used to get, set or manipulate configuration
  68  * data.
  69  *****************************************************************************/
  70 VLC_EXPORT( int,    __config_GetInt,   (vlc_object_t *, const char *) );
  71 VLC_EXPORT( void,   __config_PutInt,   (vlc_object_t *, const char *, int) );
  72 VLC_EXPORT( float,  __config_GetFloat, (vlc_object_t *, const char *) );
  73 VLC_EXPORT( void,   __config_PutFloat, (vlc_object_t *, const char *, float) );
  74 VLC_EXPORT( char *, __config_GetPsz,   (vlc_object_t *, const char *) );
  75 VLC_EXPORT( void,   __config_PutPsz,   (vlc_object_t *, const char *, char *) );
  76
  77 VLC_EXPORT( int,    config_LoadCmdLine,    ( vlc_object_t *, int *, char *[], vlc_bool_t ) );
  78 VLC_EXPORT( char *, config_GetHomeDir,     ( void ) );
  79 VLC_EXPORT( int,    config_LoadConfigFile, ( vlc_object_t *, const char * ) );
  80 VLC_EXPORT( int,    config_SaveConfigFile, ( vlc_object_t *, const char * ) );
  81 VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char *psz_name ) );
  82
  83 VLC_EXPORT( void, config_Duplicate, ( module_t *, module_config_t * ) );
  84             void  config_Free       ( module_t * );
  85
  86 VLC_EXPORT( void, config_SetCallbacks, ( module_config_t *, module_config_t * ) );
  87 VLC_EXPORT( void, config_UnsetCallbacks, ( module_config_t * ) );
  88
  89 #define config_GetInt(a,b) __config_GetInt(CAST_TO_VLC_OBJECT(a),b)
  90 #define config_PutInt(a,b,c) __config_PutInt(CAST_TO_VLC_OBJECT(a),b,c)
  91 #define config_GetFloat(a,b) __config_GetFloat(CAST_TO_VLC_OBJECT(a),b)
  92 #define config_PutFloat(a,b,c) __config_PutFloat(CAST_TO_VLC_OBJECT(a),b,c)
  93 #define config_GetPsz(a,b) __config_GetPsz(CAST_TO_VLC_OBJECT(a),b)
  94 #define config_PutPsz(a,b,c) __config_PutPsz(CAST_TO_VLC_OBJECT(a),b,c)
  95
  96 /*****************************************************************************
  97  * Macros used to build the configuration structure.
  98  *
  99  * Note that internally we support only 2 types of config data: int and string.
 100  *   The other types declared here just map to one of these 2 basic types but
 101  *   have the advantage of also providing very good hints to a configuration
 102  *   interface so as to make it more user friendly.
 103  * The configuration structure also includes category hints. These hints can
 104  *   provide a configuration inteface with some very useful data and also allow
 105  *   for a more user friendly interface.
 106  *****************************************************************************/
 107
 108 #define MODULE_CONFIG_START \
 109     static module_config_t p_config[] = {
 110
 111 #define MODULE_CONFIG_STOP \
 112     { MODULE_CONFIG_HINT_END, NULL, '\0', NULL, NULL, NULL, 0, 0, NULL, 0 } };
 113
 114 #define ADD_CATEGORY_HINT( text, longtext ) \
 115     { MODULE_CONFIG_HINT_CATEGORY, NULL, '\0', text, longtext, NULL, 0, 0, \
 116       NULL, NULL, 0 },
 117 #define ADD_SUBCATEGORY_HINT( text, longtext ) \
 118     { MODULE_CONFIG_HINT_SUBCATEGORY, NULL, '\0', text, longtext, NULL, 0, 0, \
 119       NULL, NULL, 0 },
 120 #define END_SUBCATEGORY_HINT \
 121     { MODULE_CONFIG_HINT_SUBCATEGORY_END, NULL, '\0', NULL, NULL, NULL, 0, 0, \
 122       NULL, NULL, 0 },
 123 #define ADD_STRING( name, value, p_callback, text, longtext ) \
 124     { MODULE_CONFIG_ITEM_STRING, name, '\0', text, longtext, value, 0, 0, \
 125       p_callback, NULL, 0 },
 126 #define ADD_FILE( name, psz_value, p_callback, text, longtext ) \
 127     { MODULE_CONFIG_ITEM_FILE, name, '\0', text, longtext, psz_value, 0, 0, \
 128       p_callback, NULL, 0 },
 129 #define ADD_MODULE( name, i_capability, psz_value, p_callback, text, longtext)\
 130     { MODULE_CONFIG_ITEM_MODULE, name, '\0', text, longtext, psz_value, \
 131       i_capability, 0, p_callback, NULL, 0 },
 132 #define ADD_INTEGER( name, i_value, p_callback, text, longtext ) \
 133     { MODULE_CONFIG_ITEM_INTEGER, name, '\0', text, longtext, NULL, i_value, \
 134       0, p_callback, NULL, 0 },
 135 #define ADD_FLOAT( name, f_value, p_callback, text, longtext ) \
 136     { MODULE_CONFIG_ITEM_FLOAT, name, '\0', text, longtext, NULL, 0, f_value, \
 137       p_callback, NULL, 0 },
 138 #define ADD_BOOL( name, b_value, p_callback, text, longtext ) \
 139     { MODULE_CONFIG_ITEM_BOOL, name, '\0', text, longtext, NULL, b_value, 0, \
 140       p_callback, NULL, 0 },
 141 #define ADD_STRING_WITH_SHORT( name, ch, psz_value, p_callback, text, ltext ) \
 142     { MODULE_CONFIG_ITEM_STRING, name, ch, text, ltext, psz_value, 0, 0, \
 143       p_callback, NULL, 0 },
 144 #define ADD_FILE_WITH_SHORT( name, ch, psz_value, p_callback, text, ltext ) \
 145     { MODULE_CONFIG_ITEM_FILE, name, ch, text, ltext, psz_value, 0, 0, \
 146       p_callback, NULL, 0 },
 147 #define ADD_MODULE_WITH_SHORT( name, ch, i_capability, psz_value, p_callback, \
 148     text, ltext) \
 149     { MODULE_CONFIG_ITEM_MODULE, name, ch, text, ltext, psz_value, \
 150       i_capability, 0, p_callback, NULL, 0 },
 151 #define ADD_INTEGER_WITH_SHORT( name, ch, i_value, p_callback, text, ltext ) \
 152     { MODULE_CONFIG_ITEM_INTEGER, name, ch, text, ltext, NULL, i_value, 0, \
 153       p_callback, NULL, 0 },
 154 #define ADD_FLOAT_WITH_SHORT( name, ch, f_value, p_callback, text, ltext ) \
 155     { MODULE_CONFIG_ITEM_FLOAT, name, ch, text, ltext, NULL, 0, f_value, \
 156       p_callback, NULL, 0 },
 157 #define ADD_BOOL_WITH_SHORT( name, ch, b_value, p_callback, text, ltext ) \
 158     { MODULE_CONFIG_ITEM_BOOL, name, ch, text, ltext, NULL, b_value, 0, \
 159       p_callback, NULL, 0 },