1 /*****************************************************************************
2 * modules_inner.h : Macros used from within a module.
3 *****************************************************************************
4 * Copyright (C) 2001 VideoLAN
5 * $Id: modules_inner.h,v 1.11 2002/01/09 02:01:14 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 * Check that we are within a module.
26 *****************************************************************************/
27 #if !( defined( MODULE_NAME ) || defined( MAKE_DEP ) )
28 # error "You must define MODULE_NAME before using modules_inner.h !"
31 /*****************************************************************************
32 * Add a few defines. You do not want to read this section. Really.
33 *****************************************************************************/
37 * if user has #defined MODULE_NAME foo, then we will need:
38 * #define MODULE_STRING "foo"
39 * #define MODULE_VAR(blah) "VLC_MODULE_foo_blah"
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##__MODULE_##z
54 #define MODULE_VAR( z ) "VLC_MODULE_" #z
56 /* If the module is built-in, then we need to define foo_InitModule instead
57 * of InitModule. Same for Activate- and DeactivateModule. */
59 # define _M( function ) CONCATENATE( function, MODULE_NAME )
60 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_NAME )
61 # define DECLARE_SYMBOLS ;
62 # define STORE_SYMBOLS ;
64 # define _M( function ) function
65 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_SYMBOL )
66 # define DECLARE_SYMBOLS module_symbols_t* p_symbols;
67 # define STORE_SYMBOLS p_symbols = p_module->p_symbols;
70 #define MODULE_STRING STRINGIFY( MODULE_NAME )
73 * InitModule: this function is called once and only once, when the module
74 * is looked at for the first time. We get the useful data from it, for
75 * instance the module name, its shortcuts, its capabilities...
77 #define MODULE_INIT_START \
78 int __VLC_SYMBOL( InitModule ) ( module_t *p_module ) \
81 p_module->psz_name = MODULE_STRING; \
82 p_module->psz_longname = MODULE_STRING; \
83 p_module->psz_program = NULL; \
84 p_module->i_capabilities = 0; \
85 p_module->i_cpu_capabilities = 0;
87 #define MODULE_INIT_STOP \
88 p_module->pp_shortcuts[ i_shortcut ] = NULL; \
92 #define ADD_CAPABILITY( cap, score ) \
93 p_module->i_capabilities |= 1 << MODULE_CAPABILITY_##cap; \
94 p_module->pi_score[ MODULE_CAPABILITY_##cap ] = score;
96 #define ADD_REQUIREMENT( cap ) \
97 p_module->i_cpu_capabilities |= CPU_CAPABILITY_##cap;
99 #define ADD_PROGRAM( program ) \
100 p_module->psz_program = program;
102 #define ADD_SHORTCUT( shortcut ) \
103 p_module->pp_shortcuts[ i_shortcut ] = shortcut; \
106 #define SET_DESCRIPTION( desc ) \
107 p_module->psz_longname = desc;
110 * ActivateModule: this function is called before functions can be accessed,
111 * we do allocation tasks here, and maybe additional stuff such as large
112 * table allocation. Once ActivateModule is called we are almost sure the
113 * module will be used.
115 #define MODULE_ACTIVATE_START \
118 int __VLC_SYMBOL( ActivateModule ) ( module_t *p_module ) \
120 p_module->p_functions = \
121 ( module_functions_t * )malloc( sizeof( module_functions_t ) ); \
122 if( p_module->p_functions == NULL ) \
126 p_module->p_config = p_config; \
129 #define MODULE_ACTIVATE_STOP \
134 * DeactivateModule: this function is called after we are finished with the
135 * module. Everything that has been done in ActivateModule needs to be undone
138 #define MODULE_DEACTIVATE_START \
139 int __VLC_SYMBOL( DeactivateModule )( module_t *p_module ) \
141 free( p_module->p_functions );
143 #define MODULE_DEACTIVATE_STOP \
147 /*****************************************************************************
148 * Macros used to build the configuration structure.
149 *****************************************************************************/
151 #define MODULE_CONFIG_START \
152 static module_config_t p_config[] = { \
153 { MODULE_CONFIG_ITEM_START, NULL, NULL, NULL, NULL },
155 #define MODULE_CONFIG_STOP \
156 { MODULE_CONFIG_ITEM_END, NULL, NULL, NULL, NULL } };
158 #define ADD_WINDOW( text ) \
159 { MODULE_CONFIG_ITEM_WINDOW, text, NULL, NULL, NULL },
160 #define ADD_FRAME( text ) \
161 { MODULE_CONFIG_ITEM_FRAME, text, NULL, NULL, NULL },
162 #define ADD_PANE( text ) \
163 { MODULE_CONFIG_ITEM_PANE, text, NULL, NULL, NULL },
164 #define ADD_COMMENT( text ) \
165 { MODULE_CONFIG_ITEM_COMMENT, text, NULL, NULL, NULL },
166 #define ADD_STRING( text, name, p_update ) \
167 { MODULE_CONFIG_ITEM_STRING, text, name, NULL, p_update },
168 #define ADD_FILE( text, name, p_update ) \
169 { MODULE_CONFIG_ITEM_FILE, text, name, NULL, p_update },
170 #define ADD_CHECK( text, name, p_update ) \
171 { MODULE_CONFIG_ITEM_CHECK, text, name, NULL, p_update },
172 #define ADD_CHOOSE( text, name, p_getlist, p_update ) \
173 { MODULE_CONFIG_ITEM_CHOOSE, text, name, p_getlist, p_update },
174 #define ADD_RADIO( text, name, p_getlist, p_update ) \
175 { MODULE_CONFIG_ITEM_RADIO, text, name, p_getlist, p_update },
176 #define ADD_SCALE( text, name, p_getlist, p_update ) \
177 { MODULE_CONFIG_ITEM_SCALE, text, name, p_getlist, p_update },
178 #define ADD_SPIN( text, name, p_getlist, p_update ) \
179 { MODULE_CONFIG_ITEM_SPIN, text, name, p_getlist, p_update },