1 /*****************************************************************************
2 * modules_inner.h : Macros used from within a module.
3 *****************************************************************************
4 * Copyright (C) 2001-2006 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 #if !defined( __LIBVLC__ )
25 #error You are not libvlc or one of its plugins. You cannot include this file
28 /*****************************************************************************
29 * If we are not within a module, assume we're in the vlc core.
30 *****************************************************************************/
31 #if !defined( __PLUGIN__ ) && !defined( __BUILTIN__ )
32 # define MODULE_NAME main
36 * Current plugin ABI version
38 # define MODULE_SUFFIX __0_9_0e
40 /*****************************************************************************
41 * Add a few defines. You do not want to read this section. Really.
42 *****************************************************************************/
46 * if user has #defined MODULE_NAME foo, then we will need:
47 * #define MODULE_STRING "foo"
49 * and, if HAVE_DYNAMIC_PLUGINS is NOT set, we will also need:
50 * #define MODULE_FUNC( zog ) module_foo_zog
52 * this can't easily be done with the C preprocessor, thus a few ugly hacks.
55 /* I can't believe I need to do this to change « foo » to « "foo" » */
56 #define STRINGIFY( z ) UGLY_KLUDGE( z )
57 #define UGLY_KLUDGE( z ) #z
58 /* And I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
59 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
60 #define CRUDE_HACK( y, z ) y##__##z
62 /* If the module is built-in, then we need to define foo_InitModule instead
63 * of InitModule. Same for Activate- and DeactivateModule. */
64 #if defined (HAVE_DYNAMIC_PLUGINS) && !defined (__BUILTIN__)
65 # define E_( function ) CONCATENATE( function, MODULE_SYMBOL )
66 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_SYMBOL )
68 # define E_( function ) CONCATENATE( function, MODULE_NAME )
69 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_NAME )
72 #if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
73 # define DLL_SYMBOL __declspec(dllexport)
74 # define CDECL_SYMBOL __cdecl
75 #elif HAVE_ATTRIBUTE_VISIBILITY
76 # define DLL_SYMBOL __attribute__((visibility("default")))
83 #if defined( __cplusplus )
84 # define EXTERN_SYMBOL extern "C"
86 # define EXTERN_SYMBOL
89 #if defined( USE_DLL )
90 # define IMPORT_SYMBOL __declspec(dllimport)
92 # define IMPORT_SYMBOL
95 #define MODULE_STRING STRINGIFY( MODULE_NAME )
98 * InitModule: this function is called once and only once, when the module
99 * is looked at for the first time. We get the useful data from it, for
100 * instance the module name, its shortcuts, its capabilities... we also create
101 * a copy of its config because the module can be unloaded at any time.
103 #if defined (__PLUGIN__) || defined (__BUILTIN__)
104 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL
105 E_(vlc_entry) ( module_t *p_module );
108 #define vlc_module_begin( ) \
109 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL \
110 __VLC_SYMBOL(vlc_entry) ( module_t *p_module ) \
112 int i_shortcut = 1, res; \
113 size_t i_config = (size_t)(-1); \
114 module_config_t *p_config = NULL; \
115 if (vlc_module_set (p_module, VLC_MODULE_NAME, \
116 (void *)(MODULE_STRING))) \
119 module_t *p_submodule = p_module /* the ; gets added */
121 #define vlc_module_end( ) \
123 res = config_Duplicate( p_module, p_config, ++i_config ); \
124 for( size_t i = 0; i < i_config; i++ ) \
126 if( p_config[ i ].i_action ) \
128 free( p_config[ i ].ppf_action ); \
129 free( p_config[ i ].ppsz_action_text ); \
136 return VLC_SUCCESS; \
140 /* FIXME: cleanup submodules objects ??? */ \
141 return VLC_EGENERIC; \
143 struct _u_n_u_s_e_d_ /* the ; gets added */
146 #define add_submodule( ) \
147 p_submodule = vlc_submodule_create( p_module )
149 #define add_requirement( cap ) \
150 if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
151 (void *)(intptr_t)(CPU_CAPABILITY_##cap))) goto error
153 #define add_shortcut( shortcut ) \
154 if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, (void*)(shortcut))) \
157 #define set_shortname( shortname ) \
158 if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \
159 (void*)(shortname))) goto error;
161 #define set_description( desc ) \
162 if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, (void*)(desc))) \
165 #define set_help( help ) \
166 if (vlc_module_set (p_submodule, VLC_MODULE_HELP, (void*)(help))) \
169 #define set_capability( cap, score ) \
170 if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, (void *)(cap)) \
171 || vlc_module_set (p_submodule, VLC_MODULE_SCORE, \
172 (void *)(intptr_t)(score))) \
175 #define set_callbacks( activate, deactivate ) \
176 if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, (void *)(activate)) \
177 || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, \
178 (void *)(deactivate))) \
181 #define linked_with_a_crap_library_which_uses_atexit( ) \
182 if (vlc_module_set (p_submodule, VLC_MODULE_UNLOADABLE, NULL)) goto error