1 /*****************************************************************************
2 * modules_inner.h : Macros used from within a module.
3 *****************************************************************************
4 * Copyright (C) 2001 VideoLAN
5 * $Id: modules_inner.h,v 1.31 2002/08/21 17:31:58 sam Exp $
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
25 * If we are not within a module, assume we're in the vlc core.
26 *****************************************************************************/
27 #if !defined( __PLUGIN__ ) && !defined( __BUILTIN__ )
28 # define MODULE_NAME main
29 # define MODULE_PATH main
32 /*****************************************************************************
33 * Add a few defines. You do not want to read this section. Really.
34 *****************************************************************************/
38 * if user has #defined MODULE_NAME foo, then we will need:
39 * #define MODULE_STRING "foo"
41 * and, if __BUILTIN__ is set, we will also need:
42 * #define MODULE_FUNC( zog ) module_foo_zog
44 * this can't easily be done with the C preprocessor, thus a few ugly hacks.
47 /* I can't believe I need to do this to change « foo » to « "foo" » */
48 #define STRINGIFY( z ) UGLY_KLUDGE( z )
49 #define UGLY_KLUDGE( z ) #z
50 /* And I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
51 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
52 #define CRUDE_HACK( y, z ) y##__##z
54 /* If the module is built-in, then we need to define foo_InitModule instead
55 * of InitModule. Same for Activate- and DeactivateModule. */
56 #if defined( __BUILTIN__ )
57 # define E_( function ) CONCATENATE( function, MODULE_PATH )
58 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_PATH )
59 # define DECLARE_SYMBOLS struct _u_n_u_s_e_d_
60 # define STORE_SYMBOLS struct _u_n_u_s_e_d_
61 #elif defined( __PLUGIN__ )
62 # define E_( function ) function
63 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_SYMBOL )
64 # define DECLARE_SYMBOLS module_symbols_t* p_symbols
65 # define STORE_SYMBOLS p_symbols = p_module->p_symbols
68 #if defined( __cplusplus )
69 # define EXTERN_SYMBOL extern "C"
71 # define EXTERN_SYMBOL
74 #define MODULE_STRING STRINGIFY( MODULE_NAME )
77 * InitModule: this function is called once and only once, when the module
78 * is looked at for the first time. We get the useful data from it, for
79 * instance the module name, its shortcuts, its capabilities... we also create
80 * a copy of its config because the module can be unloaded at any time.
82 #define vlc_module_begin( ) \
84 EXTERN_SYMBOL int __VLC_SYMBOL(vlc_entry) ( module_t *p_module ) \
86 int i_shortcut = 1, i_config = 0; \
87 module_config_t p_config[ 100 ]; \
89 p_module->b_submodule = VLC_FALSE; \
90 p_module->b_unloadable = VLC_TRUE; \
91 p_module->b_reentrant = VLC_TRUE; \
92 p_module->psz_object_name = MODULE_STRING; \
93 p_module->psz_longname = MODULE_STRING; \
94 p_module->pp_shortcuts[ 0 ] = MODULE_STRING; \
95 p_module->i_cpu = 0; \
96 p_module->psz_program = NULL; \
97 p_module->psz_capability = ""; \
98 p_module->i_score = 1; \
99 p_module->pf_activate = NULL; \
100 p_module->pf_deactivate = NULL; \
102 module_t *p_submodule = p_module /* the ; gets added */
104 #define vlc_module_end( ) \
105 p_submodule->pp_shortcuts[ i_shortcut ] = NULL; \
108 module_config_t tmp = { CONFIG_HINT_END, NULL, NULL, '\0' }; \
109 p_config[ i_config ] = tmp; \
111 config_Duplicate( p_module, p_config ); \
112 if( p_module->p_config == NULL ) \
116 return 0 && i_shortcut; \
118 int __VLC_SYMBOL(vlc_entry) ( module_t * ) /* the ; gets added */
121 #define add_submodule( ) \
122 p_submodule->pp_shortcuts[ i_shortcut ] = NULL; \
124 (module_t *)vlc_object_create( p_module, VLC_OBJECT_MODULE ); \
125 vlc_object_attach( p_submodule, p_module ); \
126 p_submodule->b_submodule = VLC_TRUE; \
127 /* Nuahahaha! Heritage! Polymorphism! Ugliness!! */ \
128 for( i_shortcut = 0; p_module->pp_shortcuts[ i_shortcut ]; i_shortcut++ ) \
130 p_submodule->pp_shortcuts[ i_shortcut ] = \
131 p_module->pp_shortcuts[ i_shortcut ]; \
133 p_submodule->psz_object_name = p_module->psz_object_name; \
134 p_submodule->psz_longname = p_module->psz_longname; \
135 p_submodule->psz_program = p_module->psz_program; \
136 p_submodule->psz_capability = p_module->psz_capability; \
137 p_submodule->i_score = p_module->i_score; \
138 p_submodule->i_cpu = p_module->i_cpu; \
139 p_submodule->pf_activate = NULL; \
140 p_submodule->pf_deactivate = NULL
142 #define add_requirement( cap ) \
143 p_module->i_cpu |= CPU_CAPABILITY_##cap
145 #define add_shortcut( shortcut ) \
146 p_submodule->pp_shortcuts[ i_shortcut ] = shortcut; \
149 #define set_description( desc ) \
150 p_submodule->psz_longname = desc
152 #define set_capability( cap, score ) \
153 p_submodule->psz_capability = cap; \
154 p_submodule->i_score = score
156 #define set_program( program ) \
157 p_submodule->psz_program = program
159 #define set_callbacks( activate, deactivate ) \
160 p_submodule->pf_activate = activate; \
161 p_submodule->pf_deactivate = deactivate
163 #define linked_with_a_crap_library_which_uses_atexit( ) \
164 p_module->b_unloadable = VLC_FALSE
167 * module_activate: this function is called before functions can be accessed,
168 * we do allocation tasks here, and maybe additional stuff such as large
169 * table allocation. Once ActivateModule is called we are almost sure the
170 * module will be used.
172 #define module_activate( prototype ) \
173 __module_activate( prototype ); \
174 int __VLC_SYMBOL( module_activate ) ( module_t *p_module ) \
177 config_SetCallbacks( p_module->p_config, p_config ); \
178 return __module_activate( p_module ); \
181 static int __module_activate( prototype )
184 * DeactivateModule: this function is called after we are finished with the
185 * module. Everything that has been done in ActivateModule needs to be undone
188 #define module_deactivate( prototype ) \
189 __module_deactivate( prototype ); \
190 int __VLC_SYMBOL( module_deactivate )( module_t *p_module ) \
192 int i_ret = __module_deactivate( p_module ); \
193 config_UnsetCallbacks( p_module->p_config ); \
197 static int __module_deactivate( prototype )