]> git.sesse.net Git - vlc/blobdiff - include/configuration.h
* OS X intf is now more consistent with Apple guidelines.
[vlc] / include / configuration.h
index 052a9fdaf3955293b5664faaf46999381274fd50..650fa1ab337d9f6099c6d0598003acd45a05c890 100644 (file)
@@ -4,7 +4,7 @@
  * It includes functions allowing to declare, get or set configuration options.
  *****************************************************************************
  * Copyright (C) 1999, 2000 VideoLAN
- * $Id: configuration.h,v 1.4 2002/03/21 07:11:57 gbazin Exp $
+ * $Id: configuration.h,v 1.10 2002/05/03 20:49:30 sam Exp $
  *
  * Authors: Gildas Bazin <gbazin@netcourrier.com>
  *
 /* Configuration item types */
 #define MODULE_CONFIG_ITEM_STRING           0x0010  /* String option */
 #define MODULE_CONFIG_ITEM_FILE             0x0020  /* File option */
-#define MODULE_CONFIG_ITEM_PLUGIN           0x0030  /* Plugin option */
+#define MODULE_CONFIG_ITEM_MODULE           0x0030  /* Module option */
 #define MODULE_CONFIG_ITEM_INTEGER          0x0040  /* Integer option */
 #define MODULE_CONFIG_ITEM_BOOL             0x0050  /* Bool option */
-#define MODULE_CONFIG_ITEM_ALIAS            0x0060  /* Alias option */
+#define MODULE_CONFIG_ITEM_FLOAT            0x0060  /* Float option */
 
 #define MODULE_CONFIG_ITEM                  0x00F0
 
 typedef struct module_config_s
 {
-    int         i_type;                                /* Configuration type */
+    int          i_type;                               /* Configuration type */
     char        *psz_name;                                    /* Option name */
+    char         i_short;                      /* Optional short option name */
     char        *psz_text;      /* Short comment on the configuration option */
     char        *psz_longtext;   /* Long comment on the configuration option */
     char        *psz_value;                                  /* Option value */
-    int         i_value;                                     /* Option value */
+    int          i_value;                                    /* Option value */
+    float        f_value;                                    /* Option value */
     void        *p_callback;     /* Function to call when commiting a change */
     vlc_mutex_t *p_lock;            /* lock to use when modifying the config */
-    boolean_t   b_dirty;           /* Dirty flag to indicate a config change */
+    boolean_t    b_dirty;          /* Dirty flag to indicate a config change */
 
 } module_config_t;
 
@@ -63,29 +65,38 @@ typedef struct module_config_s
  * Prototypes - these methods are used to get, set or manipulate configuration
  * data.
  *****************************************************************************/
-#ifndef PLUGIN
+#ifndef __PLUGIN__
 int    config_GetIntVariable( const char *psz_name );
+float  config_GetFloatVariable( const char *psz_name );
 char * config_GetPszVariable( const char *psz_name );
 void   config_PutIntVariable( const char *psz_name, int i_value );
+void   config_PutFloatVariable( const char *psz_name, float f_value );
 void   config_PutPszVariable( const char *psz_name, char *psz_value );
 
-int config_LoadConfigFile( const char *psz_module_name );
-int config_SaveConfigFile( const char *psz_module_name );
-module_config_t *config_FindConfig( const char *psz_name );
-module_config_t *config_Duplicate ( module_t *p_module );
-char *config_GetHomeDir( void );
-int config_LoadCmdLine( int *pi_argc, char *ppsz_argv[],
-                        boolean_t b_ignore_errors );
+int    config_LoadConfigFile( const char *psz_module_name );
+int    config_SaveConfigFile( const char *psz_module_name );
+char * config_GetHomeDir( void );
+int    config_LoadCmdLine( int *pi_argc, char *ppsz_argv[],
+                           boolean_t b_ignore_errors );
+
+module_config_t *config_Duplicate     ( module_config_t * );
+module_config_t *config_FindConfig    ( const char * );
+void             config_SetCallbacks  ( module_config_t *, module_config_t * );
+void             config_UnsetCallbacks( module_config_t * );
 
 #else
 #   define config_GetIntVariable p_symbols->config_GetIntVariable
 #   define config_PutIntVariable p_symbols->config_PutIntVariable
+#   define config_GetFloatVariable p_symbols->config_GetFloatVariable
+#   define config_PutFloatVariable p_symbols->config_PutFloatVariable
 #   define config_GetPszVariable p_symbols->config_GetPszVariable
 #   define config_PutPszVariable p_symbols->config_PutPszVariable
-#   define config_Duplicate      p_symbols->config_Duplicate
-#   define config_FindConfig     p_symbols->config_FindConfig
 #   define config_LoadConfigFile p_symbols->config_LoadConfigFile
 #   define config_SaveConfigFile p_symbols->config_SaveConfigFile
+#   define config_Duplicate      p_symbols->config_Duplicate
+#   define config_FindConfig     p_symbols->config_FindConfig
+#   define config_SetCallbacks   p_symbols->config_SetCallbacks
+#   define config_UnsetCallbacks p_symbols->config_UnsetCallbacks
 #endif
 
 /*****************************************************************************
@@ -104,29 +115,53 @@ int config_LoadCmdLine( int *pi_argc, char *ppsz_argv[],
     static module_config_t p_config[] = {
 
 #define MODULE_CONFIG_STOP \
-    { MODULE_CONFIG_HINT_END, NULL, NULL, NULL, NULL, 0, NULL, 0 } };
+    { MODULE_CONFIG_HINT_END, NULL, '\0', NULL, NULL, NULL, 0, 0, NULL, 0 } };
 
 #define ADD_CATEGORY_HINT( text, longtext ) \
-    { MODULE_CONFIG_HINT_CATEGORY, NULL, text, longtext, NULL, 0, NULL, \
-      NULL, 0 },
+    { MODULE_CONFIG_HINT_CATEGORY, NULL, '\0', text, longtext, NULL, 0, 0, \
+      NULL, NULL, 0 },
 #define ADD_SUBCATEGORY_HINT( text, longtext ) \
-    { MODULE_CONFIG_HINT_SUBCATEGORY, NULL, text, longtext, NULL, 0, NULL, \
-      NULL, 0 },
+    { MODULE_CONFIG_HINT_SUBCATEGORY, NULL, '\0', text, longtext, NULL, 0, 0, \
+      NULL, NULL, 0 },
 #define END_SUBCATEGORY_HINT \
-    { MODULE_CONFIG_HINT_SUBCATEGORY_END, NULL, NULL, NULL, NULL, 0, NULL, \
-      NULL, 0 },
+    { MODULE_CONFIG_HINT_SUBCATEGORY_END, NULL, '\0', NULL, NULL, NULL, 0, 0, \
+      NULL, NULL, 0 },
 #define ADD_STRING( name, value, p_callback, text, longtext ) \
-    { MODULE_CONFIG_ITEM_STRING, name, text, longtext, value, 0, \
+    { MODULE_CONFIG_ITEM_STRING, name, '\0', text, longtext, value, 0, 0, \
       p_callback, NULL, 0 },
 #define ADD_FILE( name, psz_value, p_callback, text, longtext ) \
-    { MODULE_CONFIG_ITEM_FILE, name, text, longtext, psz_value, 0, \
+    { MODULE_CONFIG_ITEM_FILE, name, '\0', text, longtext, psz_value, 0, 0, \
       p_callback, NULL, 0 },
-#define ADD_PLUGIN( name, i_capability, psz_value, p_callback, text, longtext)\
-    { MODULE_CONFIG_ITEM_PLUGIN, name, text, longtext, psz_value, \
-      i_capability, p_callback, NULL, 0 },
+#define ADD_MODULE( name, i_capability, psz_value, p_callback, text, longtext)\
+    { MODULE_CONFIG_ITEM_MODULE, name, '\0', text, longtext, psz_value, \
+      i_capability, 0, p_callback, NULL, 0 },
 #define ADD_INTEGER( name, i_value, p_callback, text, longtext ) \
-    { MODULE_CONFIG_ITEM_INTEGER, name, text, longtext, NULL, i_value, \
+    { MODULE_CONFIG_ITEM_INTEGER, name, '\0', text, longtext, NULL, i_value, \
+      0, p_callback, NULL, 0 },
+#define ADD_FLOAT( name, f_value, p_callback, text, longtext ) \
+    { MODULE_CONFIG_ITEM_FLOAT, name, '\0', text, longtext, NULL, 0, f_value, \
       p_callback, NULL, 0 },
 #define ADD_BOOL( name, p_callback, text, longtext ) \
-    { MODULE_CONFIG_ITEM_BOOL, name, text, longtext, NULL, 0, p_callback, \
-      NULL, 0 },
+    { MODULE_CONFIG_ITEM_BOOL, name, '\0', text, longtext, NULL, 0, 0, \
+      p_callback, NULL, 0 },
+#define ADD_STRING_WITH_SHORT( name, ch, value, p_callback, text, longtext ) \
+    { MODULE_CONFIG_ITEM_STRING, name, ch, text, longtext, value, 0, 0, \
+      p_callback, NULL, 0 },
+#define ADD_FILE_WITH_SHORT( name, ch, psz_value, p_callback, text, longtext ) \
+    { MODULE_CONFIG_ITEM_FILE, name, ch, text, longtext, psz_value, 0, 0, \
+      p_callback, NULL, 0 },
+#define ADD_MODULE_WITH_SHORT( name, ch, i_capability, psz_value, p_callback, \
+  text, longtext) \
+    { MODULE_CONFIG_ITEM_MODULE, name, ch, text, longtext, psz_value, \
+      i_capability, 0, p_callback, NULL, 0 },
+#define ADD_INTEGER_WITH_SHORT( name, ch, i_value, p_callback, text, \
+  longtext ) \
+    { MODULE_CONFIG_ITEM_INTEGER, name, ch, text, longtext, NULL, i_value, 0, \
+      p_callback, NULL, 0 },
+#define ADD_FLOAT_WITH_SHORT( name, f_value, p_callback, text, longtext ) \
+    { MODULE_CONFIG_ITEM_FLOAT, name, ch, text, longtext, NULL, 0, f_value, \
+      p_callback, NULL, 0 },
+#define ADD_BOOL_WITH_SHORT( name, ch, p_callback, text, longtext ) \
+    { MODULE_CONFIG_ITEM_BOOL, name, ch, text, longtext, NULL, 0, 0, \
+      p_callback, NULL, 0 },
+