1 /*****************************************************************************
2 * modules_inner.h : Macros used from within a module.
3 *****************************************************************************
4 * Copyright (C) 2001 VideoLAN
5 * $Id: modules_inner.h,v 1.7 2001/05/30 17:03:11 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 *****************************************************************************/
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 ) module_##y##_##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. */
60 # define _M( function ) CONCATENATE( MODULE_NAME, function )
62 # define MODULE_INIT_START \
63 int CONCATENATE( MODULE_NAME, InitModule ) ( module_t *p_module ) \
65 p_module->psz_name = MODULE_STRING; \
66 p_module->psz_version = VERSION;
68 # define MODULE_INIT_STOP \
72 # define MODULE_ACTIVATE_START \
73 int CONCATENATE( MODULE_NAME, ActivateModule ) ( module_t *p_module ) \
75 p_module->p_functions = \
76 ( module_functions_t * )malloc( sizeof( module_functions_t ) ); \
77 if( p_module->p_functions == NULL ) \
81 p_module->p_config = p_config;
83 # define MODULE_ACTIVATE_STOP \
87 # define MODULE_DEACTIVATE_START \
88 int CONCATENATE( MODULE_NAME, DeactivateModule )( module_t *p_module ) \
90 free( p_module->p_functions );
92 # define MODULE_DEACTIVATE_STOP \
98 # define _M( function ) function
100 # define MODULE_INIT_START \
101 int InitModule ( module_t *p_module ) \
103 p_module->psz_name = MODULE_STRING; \
104 p_module->psz_version = VERSION;
106 # define MODULE_INIT_STOP \
110 # define MODULE_ACTIVATE_START \
111 int ActivateModule ( module_t *p_module ) \
113 p_module->p_functions = \
114 ( module_functions_t * )malloc( sizeof( module_functions_t ) ); \
115 if( p_module->p_functions == NULL ) \
119 p_module->p_config = p_config; \
120 p_symbols = p_module->p_symbols;
122 # define MODULE_ACTIVATE_STOP \
126 # define MODULE_DEACTIVATE_START \
127 int DeactivateModule( module_t *p_module ) \
129 free( p_module->p_functions );
131 # define MODULE_DEACTIVATE_STOP \
137 /* Now the real stuff */
138 #define MODULE_STRING STRINGIFY( MODULE_NAME )
140 /*****************************************************************************
141 * Macros used to build the configuration structure.
142 *****************************************************************************/
144 # define MODULE_CONFIG_START \
145 static module_config_t p_config[] = { \
146 { MODULE_CONFIG_ITEM_START, NULL, NULL, NULL, NULL },
148 # define MODULE_CONFIG_START \
149 module_symbols_t* p_symbols; \
150 static module_config_t p_config[] = { \
151 { MODULE_CONFIG_ITEM_START, NULL, NULL, NULL, NULL },
154 #define MODULE_CONFIG_STOP \
155 { 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 },