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.7 2002/04/21 18:32:12 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_PLUGIN           0x0030  /* Plugin 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 typedef 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     void        *p_callback;     /* Function to call when commiting a change */
  59     vlc_mutex_t *p_lock;            /* lock to use when modifying the config */
  60     boolean_t    b_dirty;          /* Dirty flag to indicate a config change */
  61
  62 } module_config_t;
  63
  64 /*****************************************************************************
  65  * Prototypes - these methods are used to get, set or manipulate configuration
  66  * data.
  67  *****************************************************************************/
  68 #ifndef PLUGIN
  69 int    config_GetIntVariable( const char *psz_name );
  70 float  config_GetFloatVariable( const char *psz_name );
  71 char * config_GetPszVariable( const char *psz_name );
  72 void   config_PutIntVariable( const char *psz_name, int i_value );
  73 void   config_PutFloatVariable( const char *psz_name, float f_value );
  74 void   config_PutPszVariable( const char *psz_name, char *psz_value );
  75
  76 int config_LoadConfigFile( const char *psz_module_name );
  77 int config_SaveConfigFile( const char *psz_module_name );
  78 module_config_t *config_FindConfig( const char *psz_name );
  79 module_config_t *config_Duplicate ( module_config_t * );
  80 char *config_GetHomeDir( void );
  81 int config_LoadCmdLine( int *pi_argc, char *ppsz_argv[],
  82                         boolean_t b_ignore_errors );
  83
  84 #else
  85 #   define config_GetIntVariable p_symbols->config_GetIntVariable
  86 #   define config_PutIntVariable p_symbols->config_PutIntVariable
  87 #   define config_GetFloatVariable p_symbols->config_GetFloatVariable
  88 #   define config_PutFloatVariable p_symbols->config_PutFloatVariable
  89 #   define config_GetPszVariable p_symbols->config_GetPszVariable
  90 #   define config_PutPszVariable p_symbols->config_PutPszVariable
  91 #   define config_Duplicate      p_symbols->config_Duplicate
  92 #   define config_FindConfig     p_symbols->config_FindConfig
  93 #   define config_LoadConfigFile p_symbols->config_LoadConfigFile
  94 #   define config_SaveConfigFile p_symbols->config_SaveConfigFile
  95 #endif
  96
  97 /*****************************************************************************
  98  * Macros used to build the configuration structure.
  99  *
 100  * Note that internally we support only 2 types of config data: int and string.
 101  *   The other types declared here just map to one of these 2 basic types but
 102  *   have the advantage of also providing very good hints to a configuration
 103  *   interface so as to make it more user friendly.
 104  * The configuration structure also includes category hints. These hints can
 105  *   provide a configuration inteface with some very useful data and also allow
 106  *   for a more user friendly interface.
 107  *****************************************************************************/
 108
 109 #define MODULE_CONFIG_START \
 110     static module_config_t p_config[] = {
 111
 112 #define MODULE_CONFIG_STOP \
 113     { MODULE_CONFIG_HINT_END, NULL, '\0', NULL, NULL, NULL, 0, 0, NULL, 0 } };
 114
 115 #define ADD_CATEGORY_HINT( text, longtext ) \
 116     { MODULE_CONFIG_HINT_CATEGORY, NULL, '\0', text, longtext, NULL, 0, 0, \
 117       NULL, NULL, 0 },
 118 #define ADD_SUBCATEGORY_HINT( text, longtext ) \
 119     { MODULE_CONFIG_HINT_SUBCATEGORY, NULL, '\0', text, longtext, NULL, 0, 0, \
 120       NULL, NULL, 0 },
 121 #define END_SUBCATEGORY_HINT \
 122     { MODULE_CONFIG_HINT_SUBCATEGORY_END, NULL, '\0', NULL, NULL, NULL, 0, 0, \
 123       NULL, NULL, 0 },
 124 #define ADD_STRING( name, value, p_callback, text, longtext ) \
 125     { MODULE_CONFIG_ITEM_STRING, name, '\0', text, longtext, value, 0, 0, \
 126       p_callback, NULL, 0 },
 127 #define ADD_FILE( name, psz_value, p_callback, text, longtext ) \
 128     { MODULE_CONFIG_ITEM_FILE, name, '\0', text, longtext, psz_value, 0, 0, \
 129       p_callback, NULL, 0 },
 130 #define ADD_PLUGIN( name, i_capability, psz_value, p_callback, text, longtext)\
 131     { MODULE_CONFIG_ITEM_PLUGIN, name, '\0', text, longtext, psz_value, \
 132       i_capability, 0, p_callback, NULL, 0 },
 133 #define ADD_INTEGER( name, i_value, p_callback, text, longtext ) \
 134     { MODULE_CONFIG_ITEM_INTEGER, name, '\0', text, longtext, NULL, i_value, \
 135       0, p_callback, NULL, 0 },
 136 #define ADD_FLOAT( name, f_value, p_callback, text, longtext ) \
 137     { MODULE_CONFIG_ITEM_FLOAT, name, '\0', text, longtext, NULL, 0, f_value, \
 138       p_callback, NULL, 0 },
 139 #define ADD_BOOL( name, p_callback, text, longtext ) \
 140     { MODULE_CONFIG_ITEM_BOOL, name, '\0', text, longtext, NULL, 0, 0, \
 141       p_callback, NULL, 0 },
 142 #define ADD_STRING_WITH_SHORT( name, ch, value, p_callback, text, longtext ) \
 143     { MODULE_CONFIG_ITEM_STRING, name, ch, text, longtext, value, 0, 0, \
 144       p_callback, NULL, 0 },
 145 #define ADD_FILE_WITH_SHORT( name, ch, psz_value, p_callback, text, longtext ) \
 146     { MODULE_CONFIG_ITEM_FILE, name, ch, text, longtext, psz_value, 0, 0, \
 147       p_callback, NULL, 0 },
 148 #define ADD_PLUGIN_WITH_SHORT( name, ch, i_capability, psz_value, p_callback, \
 149   text, longtext) \
 150     { MODULE_CONFIG_ITEM_PLUGIN, name, ch, text, longtext, psz_value, \
 151       i_capability, 0, p_callback, NULL, 0 },
 152 #define ADD_INTEGER_WITH_SHORT( name, ch, i_value, p_callback, text, \
 153   longtext ) \
 154     { MODULE_CONFIG_ITEM_INTEGER, name, ch, text, longtext, NULL, i_value, 0, \
 155       p_callback, NULL, 0 },
 156 #define ADD_FLOAT_WITH_SHORT( name, f_value, p_callback, text, longtext ) \
 157     { MODULE_CONFIG_ITEM_FLOAT, name, ch, text, longtext, NULL, 0, f_value, \
 158       p_callback, NULL, 0 },
 159 #define ADD_BOOL_WITH_SHORT( name, ch, p_callback, text, longtext ) \
 160     { MODULE_CONFIG_ITEM_BOOL, name, ch, text, longtext, NULL, 0, 0, \
 161       p_callback, NULL, 0 },
 162