]> git.sesse.net Git - vlc/blobdiff - include/vlc_plugin.h
Remove unused variable.
[vlc] / include / vlc_plugin.h
index 6b6ccae55254eeb7112d8a2a3987a947704ae787..f0d2554562ecbb4b15a76776a44664f5c0cf25c2 100644 (file)
@@ -34,8 +34,8 @@
 /**
  * Current plugin ABI version
  */
-# define MODULE_SYMBOL 0_9_0k
-# define MODULE_SUFFIX "__0_9_0k"
+# define MODULE_SYMBOL 0_9_0m
+# define MODULE_SUFFIX "__0_9_0m"
 
 /*****************************************************************************
  * Add a few defines. You do not want to read this section. Really.
@@ -43,7 +43,7 @@
 
 /* Explanation:
  *
- * if HAVE_DYNAMIC_PLUGINS is NOT set, we will need:
+ * if linking a module statically, we will need:
  * #define MODULE_FUNC( zog ) module_foo_zog
  *
  * this can't easily be done with the C preprocessor, thus a few ugly hacks.
@@ -66,9 +66,6 @@
 #if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
 #   define DLL_SYMBOL              __declspec(dllexport)
 #   define CDECL_SYMBOL            __cdecl
-#elif defined (HAVE_ATTRIBUTE_VISIBILITY)
-#   define DLL_SYMBOL __attribute__((visibility("default")))
-#   define CDECL_SYMBOL
 #else
 #   define DLL_SYMBOL
 #   define CDECL_SYMBOL
  * instance the module name, its shortcuts, its capabilities... we also create
  * a copy of its config because the module can be unloaded at any time.
  */
-#if defined (__PLUGIN__) || defined (__BUILTIN__)
-EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL
-E_(vlc_entry) ( module_t *p_module );
-#endif
-
 #define vlc_module_begin( )                                                   \
     EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
+    E_(vlc_entry) ( module_t *p_module );                                     \
+                                                                              \
+    EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
     __VLC_SYMBOL(vlc_entry) ( module_t *p_module )                            \
     {                                                                         \
         module_config_t *p_config = NULL;                                     \
+        const char *domain = NULL;                                            \
         if (vlc_module_set (p_module, VLC_MODULE_NAME,                        \
                             (const char *)(MODULE_STRING)))                   \
             goto error;                                                       \
         {                                                                     \
-            module_t *p_submodule = p_module /* the ; gets added */
+            module_t *p_submodule = p_module;
 
 #define vlc_module_end( )                                                     \
         }                                                                     \
@@ -110,48 +106,52 @@ E_(vlc_entry) ( module_t *p_module );
     error:                                                                    \
         return VLC_EGENERIC;                                                  \
     }                                                                         \
-    struct _u_n_u_s_e_d_ /* the ; gets added */
-
+    VLC_METADATA_EXPORTS
 
 #define add_submodule( ) \
-    p_submodule = vlc_submodule_create( p_module )
+    p_submodule = vlc_submodule_create( p_module );
 
 #define add_requirement( cap ) \
     if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
                         (int)(CPU_CAPABILITY_##cap))) \
-        goto error
+        goto error;
 
 #define add_shortcut( shortcut ) \
-    if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, (int)(shortcut))) \
-        goto error
+    if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \
+        (const char *)(shortcut))) \
+        goto error;
 
 #define set_shortname( shortname ) \
-    if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \
-        (const char *)(shortname))) \
-        goto error
+    if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, domain, \
+                        (const char *)(shortname))) \
+        goto error;
 
 #define set_description( desc ) \
-    if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, \
+    if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, domain, \
                         (const char *)(desc))) \
-        goto error
+        goto error;
 
 #define set_help( help ) \
-    if (vlc_module_set (p_submodule, VLC_MODULE_HELP, (const char *)(help))) \
-        goto error
+    if (vlc_module_set (p_submodule, VLC_MODULE_HELP, domain, \
+                        (const char *)(help))) \
+        goto error;
 
 #define set_capability( cap, score ) \
-    if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, (int)(cap)) \
+    if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \
+                        (const char *)(cap)) \
      || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
-        goto error
+        goto error;
 
 #define set_callbacks( activate, deactivate ) \
     if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \
      || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \
-        goto error
+        goto error;
 
 #define linked_with_a_crap_library_which_uses_atexit( ) \
     if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
-        goto error
+        goto error;
+
+#define set_text_domain( dom ) domain = (dom);
 
 VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) );
 VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) );
@@ -165,16 +165,19 @@ enum vlc_module_properties
      * Append new items at the end ONLY. */
     VLC_MODULE_CPU_REQUIREMENT,
     VLC_MODULE_SHORTCUT,
-    VLC_MODULE_SHORTNAME,
-    VLC_MODULE_DESCRIPTION,
-    VLC_MODULE_HELP,
+    VLC_MODULE_SHORTNAME_NODOMAIN,
+    VLC_MODULE_DESCRIPTION_NODOMAIN,
+    VLC_MODULE_HELP_NODOMAIN,
     VLC_MODULE_CAPABILITY,
     VLC_MODULE_SCORE,
-    VLC_MODULE_PROGRAM,
+    VLC_MODULE_PROGRAM, /* obsoleted */
     VLC_MODULE_CB_OPEN,
     VLC_MODULE_CB_CLOSE,
     VLC_MODULE_NO_UNLOAD,
     VLC_MODULE_NAME,
+    VLC_MODULE_SHORTNAME,
+    VLC_MODULE_DESCRIPTION,
+    VLC_MODULE_HELP,
 };
 
 enum vlc_config_properties
@@ -185,7 +188,7 @@ enum vlc_config_properties
     VLC_CONFIG_NAME,
     /* command line name (args=const char *, vlc_callback_t) */
 
-    VLC_CONFIG_DESC,
+    VLC_CONFIG_DESC_NODOMAIN,
     /* description (args=const char *, const char *) */
 
     VLC_CONFIG_VALUE,
@@ -218,11 +221,11 @@ enum vlc_config_properties
     VLC_CONFIG_SHORTCUT,
     /* one-character (short) command line option name (args=char) */
 
-    VLC_CONFIG_LIST,
+    VLC_CONFIG_LIST_NODOMAIN,
     /* possible values list
      * (args=size_t, const <type> *, const char *const *) */
 
-    VLC_CONFIG_ADD_ACTION,
+    VLC_CONFIG_ADD_ACTION_NODOMAIN,
     /* add value change callback (args=vlc_callback_t, const char *) */
 
     VLC_CONFIG_OLDNAME,
@@ -230,6 +233,17 @@ enum vlc_config_properties
 
     VLC_CONFIG_SAFE,
     /* tag as modifiable by untrusted input item "sources" (args=none) */
+
+    VLC_CONFIG_DESC,
+    /* description (args=const char *, const char *, const char *) */
+
+    VLC_CONFIG_LIST,
+    /* possible values list
+     * (args=const char *, size_t, const <type> *, const char *const *) */
+
+    VLC_CONFIG_ADD_ACTION,
+    /* add value change callback
+     * (args=const char *, vlc_callback_t, const char *) */
 };
 
 /*****************************************************************************
@@ -246,38 +260,38 @@ enum vlc_config_properties
  *****************************************************************************/
 
 #define add_type_inner( type ) \
-    p_config = vlc_config_create (p_module, type)
+    p_config = vlc_config_create (p_module, type);
 
 #define add_typedesc_inner( type, text, longtext ) \
-    add_type_inner( type ); \
-    vlc_config_set (p_config, VLC_CONFIG_DESC, \
-                    (const char *)(text), (const char *)(longtext))
+    add_type_inner( type ) \
+    vlc_config_set (p_config, VLC_CONFIG_DESC, domain, \
+                    (const char *)(text), (const char *)(longtext));
 
 #define add_typeadv_inner( type, text, longtext, advc ) \
-    add_typedesc_inner( type, text, longtext ); \
-    if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED)
+    add_typedesc_inner( type, text, longtext ) \
+    if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED);
 
 #define add_typename_inner( type, name, text, longtext, advc, cb ) \
-    add_typeadv_inner( type, text, longtext, advc ); \
+    add_typeadv_inner( type, text, longtext, advc ) \
     vlc_config_set (p_config, VLC_CONFIG_NAME, \
-                    (const char *)(name), (vlc_callback_t)(cb))
+                    (const char *)(name), (vlc_callback_t)(cb));
 
 #define add_string_inner( type, name, text, longtext, advc, cb, v ) \
-    add_typename_inner( type, name, text, longtext, advc, cb ); \
-    vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v))
+    add_typename_inner( type, name, text, longtext, advc, cb ) \
+    vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v));
 
 #define add_int_inner( type, name, text, longtext, advc, cb, v ) \
-    add_typename_inner( type, name, text, longtext, advc, cb ); \
-    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v))
+    add_typename_inner( type, name, text, longtext, advc, cb ) \
+    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v));
 
 
 #define set_category( i_id ) \
-    add_type_inner( CONFIG_CATEGORY ); \
-    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id))
+    add_type_inner( CONFIG_CATEGORY ) \
+    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
 
 #define set_subcategory( i_id ) \
-    add_type_inner( CONFIG_SUBCATEGORY ); \
-    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id))
+    add_type_inner( CONFIG_SUBCATEGORY ) \
+    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
 
 #define set_section( text, longtext ) \
     add_typedesc_inner( CONFIG_SECTION, text, longtext )
@@ -295,63 +309,74 @@ enum vlc_config_properties
     add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
 
 #define add_string( name, value, p_callback, text, longtext, advc ) \
-    add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, p_callback, value )
+    add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
+                      p_callback, value )
 
 #define add_password( name, value, p_callback, text, longtext, advc ) \
-    add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, p_callback, value )
+    add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
+                      p_callback, value )
 
 #define add_file( name, value, p_callback, text, longtext, advc ) \
-    add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, p_callback, value )
+    add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, \
+                      p_callback, value )
 
 #define add_directory( name, value, p_callback, text, longtext, advc ) \
-    add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, p_callback, value )
+    add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
+                      p_callback, value )
 
 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
-    add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, p_callback, value ); \
-    vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps))
+    add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
+                      p_callback, value ) \
+    vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
 
 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
-    add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, p_callback, value ); \
-    vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps))
+    add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
+                      p_callback, value ) \
+    vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
 
 #ifndef __PLUGIN__
 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
-    add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, p_callback, value ); \
-    p_config->min.i = i_subcategory /* gruik */
+    add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
+                      p_callback, value ) \
+    p_config->min.i = i_subcategory /* gruik */;
 
 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
-    add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, advc, p_callback, value ); \
-    p_config->min.i = i_subcategory /* gruik */
+    add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
+                      advc, p_callback, value ) \
+    p_config->min.i = i_subcategory /* gruik */;
 #endif
 
 #define add_integer( name, value, p_callback, text, longtext, advc ) \
-    add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, p_callback, value )
+    add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, \
+                   p_callback, value )
 
 #define add_key( name, value, p_callback, text, longtext, advc ) \
-    add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, value )
+    add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, \
+                   value )
 
 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
-    add_integer( name, value, p_callback, text, longtext, advc ); \
+    add_integer( name, value, p_callback, text, longtext, advc ) \
     change_integer_range( i_min, i_max )
 
 #define add_float( name, v, p_callback, text, longtext, advc ) \
-    add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ); \
-    vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v))
+    add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ) \
+    vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v));
 
 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
-    add_float( name, value, p_callback, text, longtext, advc ); \
+    add_float( name, value, p_callback, text, longtext, advc ) \
     change_float_range( f_min, f_max )
 
 #define add_bool( name, v, p_callback, text, longtext, advc ) \
-    add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, p_callback ); \
-    if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true)
+    add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, \
+                        p_callback ) \
+    if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true);
 
 /* For removed option */
 #define add_obsolete_inner( name, type ) \
-    add_type_inner( type ); \
+    add_type_inner( type ) \
     vlc_config_set (p_config, VLC_CONFIG_NAME, \
                     (const char *)(name), (vlc_callback_t)NULL); \
-    vlc_config_set (p_config, VLC_CONFIG_REMOVED)
+    vlc_config_set (p_config, VLC_CONFIG_REMOVED);
 
 #define add_obsolete_bool( name ) \
         add_obsolete_inner( name, CONFIG_ITEM_BOOL )
@@ -371,55 +396,85 @@ enum vlc_config_properties
     vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name))
 
 #define change_short( ch ) \
-    vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch))
+    vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch));
 
 #define change_string_list( list, list_text, list_update_func ) \
-    vlc_config_set (p_config, VLC_CONFIG_LIST, \
+    vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
                     (size_t)(sizeof (list) / sizeof (char *)), \
                     (const char *const *)(list), \
                     (const char *const *)(list_text), \
-                    list_update_func)
+                    list_update_func);
 
 #define change_integer_list( list, list_text, list_update_func ) \
-    vlc_config_set (p_config, VLC_CONFIG_LIST, \
+    vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
                     (size_t)(sizeof (list) / sizeof (int)), \
                     (const int *)(list), \
                     (const char *const *)(list_text), \
-                    list_update_func)
+                    list_update_func);
 
 #define change_float_list( list, list_text, list_update_func ) \
-    vlc_config_set (p_config, VLC_CONFIG_LIST, \
+    vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
                     (size_t)(sizeof (list) / sizeof (float)), \
                     (const float *)(list), \
                     (const char *const *)(list_text), \
-                    list_update_func)
+                    list_update_func);
 
 #define change_integer_range( minv, maxv ) \
-    vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv))
+    vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv));
 
 #define change_float_range( minv, maxv ) \
     vlc_config_set (p_config, VLC_CONFIG_RANGE, \
-                    (double)(minv), (double)(maxv))
+                    (double)(minv), (double)(maxv));
 
 #define change_action_add( pf_action, text ) \
-    vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \
-                    (vlc_callback_t)(pf_action), (const char *)(text))
+    vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, domain, \
+                    (vlc_callback_t)(pf_action), (const char *)(text));
 
 #define change_internal() \
-    vlc_config_set (p_config, VLC_CONFIG_PRIVATE)
+    vlc_config_set (p_config, VLC_CONFIG_PRIVATE);
 
 #define change_need_restart() \
-    vlc_config_set (p_config, VLC_CONFIG_RESTART)
+    vlc_config_set (p_config, VLC_CONFIG_RESTART);
 
 #define change_autosave() \
-    vlc_config_set (p_config, VLC_CONFIG_PERSISTENT)
+    vlc_config_set (p_config, VLC_CONFIG_PERSISTENT);
 
 #define change_unsaveable() \
-    vlc_config_set (p_config, VLC_CONFIG_VOLATILE)
+    vlc_config_set (p_config, VLC_CONFIG_VOLATILE);
 
-#define change_unsafe() (void)0 /* no-op */
+#define change_unsafe() (void)0; /* no-op */
 
 #define change_safe() \
-    vlc_config_set (p_config, VLC_CONFIG_SAFE)
+    vlc_config_set (p_config, VLC_CONFIG_SAFE);
+
+/* Meta data plugin exports */
+#define VLC_META_EXPORT( name, value ) \
+    EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
+    E_(vlc_entry_ ## name) (void); \
+    EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
+    __VLC_SYMBOL(vlc_entry_ ## name) (void) \
+    { \
+         return value; \
+    }
+
+#if defined (__LIBVLC__)
+# define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
+    "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
+    "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
+    "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
+    "\x6c\x6f\x70\x70\x65\x72\x73" )
+#elif !defined (VLC_COPYRIGHT_EXPORT)
+# define VLC_COPYRIGHT_EXPORT
+#endif
+#define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
+    "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
+    "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
+    "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
+    "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
+    "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" )
+
+#define VLC_METADATA_EXPORTS \
+    VLC_COPYRIGHT_EXPORT \
+    VLC_LICENSE_EXPORT
 
 #endif