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
35 /*****************************************************************************
36 * Add a few defines. You do not want to read this section. Really.
37 *****************************************************************************/
41 * if user has #defined MODULE_NAME foo, then we will need:
42 * #define MODULE_STRING "foo"
44 * and, if __BUILTIN__ is set, we will also need:
45 * #define MODULE_FUNC( zog ) module_foo_zog
47 * this can't easily be done with the C preprocessor, thus a few ugly hacks.
50 /* I can't believe I need to do this to change « foo » to « "foo" » */
51 #define STRINGIFY( z ) UGLY_KLUDGE( z )
52 #define UGLY_KLUDGE( z ) #z
53 /* And I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
54 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
55 #define CRUDE_HACK( y, z ) y##__##z
57 /* If the module is built-in, then we need to define foo_InitModule instead
58 * of InitModule. Same for Activate- and DeactivateModule. */
59 #if defined( __BUILTIN__ )
60 # define E_( function ) CONCATENATE( function, MODULE_NAME )
61 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_NAME )
62 # define DECLARE_SYMBOLS struct _u_n_u_s_e_d_
63 # define STORE_SYMBOLS struct _u_n_u_s_e_d_
64 #elif defined( __PLUGIN__ )
65 # define E_( function ) CONCATENATE( function, MODULE_SYMBOL )
66 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_SYMBOL )
67 # define DECLARE_SYMBOLS module_symbols_t* p_symbols
68 # define STORE_SYMBOLS p_symbols = p_module->p_symbols
71 #if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
72 # define DLL_SYMBOL __declspec(dllexport)
73 # define CDECL_SYMBOL __cdecl
74 #elif HAVE_ATTRIBUTE_VISIBILITY
75 # define DLL_SYMBOL __attribute__((visibility("default")))
82 #if defined( __cplusplus )
83 # define EXTERN_SYMBOL extern "C"
85 # define EXTERN_SYMBOL
88 #if defined( USE_DLL )
89 # define IMPORT_SYMBOL __declspec(dllimport)
91 # define IMPORT_SYMBOL
94 #define MODULE_STRING STRINGIFY( MODULE_NAME )
97 * InitModule: this function is called once and only once, when the module
98 * is looked at for the first time. We get the useful data from it, for
99 * instance the module name, its shortcuts, its capabilities... we also create
100 * a copy of its config because the module can be unloaded at any time.
102 #if defined (__PLUGIN__) || defined (__BUILTIN__)
103 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL
104 E_(vlc_entry) ( module_t *p_module );
107 #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; \
116 p_module->b_submodule = VLC_FALSE; \
117 p_module->b_unloadable = VLC_TRUE; \
118 p_module->b_reentrant = VLC_TRUE; \
119 p_module->psz_object_name = MODULE_STRING; \
120 p_module->psz_shortname = NULL; \
121 p_module->psz_longname = MODULE_STRING; \
122 p_module->psz_help = NULL; \
123 p_module->pp_shortcuts[ 0 ] = MODULE_STRING; \
124 p_module->i_cpu = 0; \
125 p_module->psz_program = NULL; \
126 p_module->psz_capability = ""; \
127 p_module->i_score = 1; \
128 p_module->pf_activate = NULL; \
129 p_module->pf_deactivate = NULL; \
131 module_t *p_submodule = p_module /* the ; gets added */
133 #define vlc_module_end( ) \
134 p_submodule->pp_shortcuts[ i_shortcut ] = NULL; \
136 res = config_Duplicate( p_module, p_config, ++i_config ); \
137 for( size_t i = 0; i < i_config; i++ ) \
139 if( p_config[ i ].i_action ) \
141 free( p_config[ i ].ppf_action ); \
142 free( p_config[ i ].ppsz_action_text ); \
149 return VLC_SUCCESS; \
151 struct _u_n_u_s_e_d_ /* the ; gets added */
154 #define add_submodule( ) \
155 p_submodule->pp_shortcuts[ i_shortcut ] = NULL; \
157 (module_t *)vlc_object_create( p_module, VLC_OBJECT_MODULE ); \
158 vlc_object_attach( p_submodule, p_module ); \
159 p_submodule->b_submodule = VLC_TRUE; \
160 /* Nuahahaha! Heritage! Polymorphism! Ugliness!! */ \
161 for( i_shortcut = 0; p_module->pp_shortcuts[ i_shortcut ]; i_shortcut++ ) \
163 p_submodule->pp_shortcuts[ i_shortcut ] = \
164 p_module->pp_shortcuts[ i_shortcut ]; \
166 p_submodule->psz_object_name = p_module->psz_object_name; \
167 p_submodule->psz_shortname = p_module->psz_shortname; \
168 p_submodule->psz_longname = p_module->psz_longname; \
169 p_submodule->psz_program = p_module->psz_program; \
170 p_submodule->psz_capability = p_module->psz_capability; \
171 p_submodule->i_score = p_module->i_score; \
172 p_submodule->i_cpu = p_module->i_cpu; \
173 p_submodule->pf_activate = NULL; \
174 p_submodule->pf_deactivate = NULL
176 #define add_requirement( cap ) \
177 p_module->i_cpu |= CPU_CAPABILITY_##cap
179 #define add_shortcut( shortcut ) \
180 p_submodule->pp_shortcuts[ i_shortcut ] = shortcut; \
183 #define set_shortname( desc ) \
184 p_submodule->psz_shortname = desc
186 #define set_description( desc ) \
187 p_submodule->psz_longname = desc
189 #define set_help( help ) \
190 p_submodule->psz_help = help
192 #define set_capability( cap, score ) \
193 p_submodule->psz_capability = cap; \
194 p_submodule->i_score = score
196 #define set_program( program ) \
197 p_submodule->psz_program = program
199 #define set_callbacks( activate, deactivate ) \
200 p_submodule->pf_activate = activate; \
201 p_submodule->pf_deactivate = deactivate
203 #define linked_with_a_crap_library_which_uses_atexit( ) \
204 p_module->b_unloadable = VLC_FALSE