1 /*****************************************************************************
2 * modules_macros.h : Macros used from within a module.
3 *****************************************************************************
4 * Copyright (C) 2001-2006 the VideoLAN team
5 * Copyright © 2007-2008 Rémi Denis-Courmont
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 #ifndef LIBVLC_MODULES_MACROS_H
25 # define LIBVLC_MODULES_MACROS_H 1
27 /*****************************************************************************
28 * If we are not within a module, assume we're in the vlc core.
29 *****************************************************************************/
30 #if !defined( __PLUGIN__ ) && !defined( __BUILTIN__ )
31 # define MODULE_NAME main
35 * Current plugin ABI version
37 # define MODULE_SYMBOL 0_9_0k
38 # define MODULE_SUFFIX "__0_9_0k"
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. */
65 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_SYMBOL )
67 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_NAME )
70 #if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
71 # define DLL_SYMBOL __declspec(dllexport)
72 # define CDECL_SYMBOL __cdecl
73 #elif defined (HAVE_ATTRIBUTE_VISIBILITY)
74 # define DLL_SYMBOL __attribute__((visibility("default")))
81 #if defined( __cplusplus )
82 # define EXTERN_SYMBOL extern "C"
84 # define EXTERN_SYMBOL
87 #define MODULE_STRING STRINGIFY( MODULE_NAME )
90 * InitModule: this function is called once and only once, when the module
91 * is looked at for the first time. We get the useful data from it, for
92 * instance the module name, its shortcuts, its capabilities... we also create
93 * a copy of its config because the module can be unloaded at any time.
95 #if defined (__PLUGIN__) || defined (__BUILTIN__)
96 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL
97 __VLC_SYMBOL(vlc_entry) ( module_t *p_module );
100 #define vlc_module_begin( ) \
101 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL \
102 __VLC_SYMBOL(vlc_entry) ( module_t *p_module ) \
104 module_config_t *p_config = NULL; \
105 if (vlc_module_set (p_module, VLC_MODULE_NAME, \
106 (const char *)(MODULE_STRING))) \
109 module_t *p_submodule = p_module /* the ; gets added */
111 #define vlc_module_end( ) \
114 return VLC_SUCCESS; \
117 return VLC_EGENERIC; \
119 struct _u_n_u_s_e_d_ /* the ; gets added */
122 #define add_submodule( ) \
123 p_submodule = vlc_submodule_create( p_module )
125 #define add_requirement( cap ) \
126 if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
127 (int)(CPU_CAPABILITY_##cap))) \
130 #define add_shortcut( shortcut ) \
131 if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, (int)(shortcut))) \
134 #define set_shortname( shortname ) \
135 if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \
136 (const char *)(shortname))) \
139 #define set_description( desc ) \
140 if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, \
141 (const char *)(desc))) \
144 #define set_help( help ) \
145 if (vlc_module_set (p_submodule, VLC_MODULE_HELP, (const char *)(help))) \
148 #define set_capability( cap, score ) \
149 if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, (int)(cap)) \
150 || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
153 #define set_callbacks( activate, deactivate ) \
154 if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \
155 || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \
158 #define linked_with_a_crap_library_which_uses_atexit( ) \
159 if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
162 VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) );
163 VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) );
164 VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, ...) );
165 VLC_EXPORT( module_config_t *, vlc_config_create, (module_t *, int type) );
166 VLC_EXPORT( int, vlc_config_set, (module_config_t *, int, ...) );
168 enum vlc_module_properties
170 /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
171 * Append new items at the end ONLY. */
172 VLC_MODULE_CPU_REQUIREMENT,
174 VLC_MODULE_SHORTNAME,
175 VLC_MODULE_DESCRIPTION,
177 VLC_MODULE_CAPABILITY,
182 VLC_MODULE_NO_UNLOAD,
186 enum vlc_config_properties
188 /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
189 * Append new items at the end ONLY. */
192 /* command line name (args=const char *, vlc_callback_t) */
195 /* description (args=const char *, const char *) */
198 /* actual value (args=int/double/const char *) */
201 /* minimum value (args=int/double/const char * twice) */
204 /* enable advanced flag (args=none) */
207 /* don't write variable to storage (args=none) */
209 VLC_CONFIG_PERSISTENT,
210 /* always write variable to storage (args=none) */
213 /* restart required to apply value change (args=none) */
216 /* hide from user (args=none) */
219 /* tag as no longer supported (args=none) */
221 VLC_CONFIG_CAPABILITY,
222 /* capability for a module or list thereof (args=const char*) */
225 /* one-character (short) command line option name (args=char) */
228 /* possible values list
229 * (args=size_t, const <type> *, const char *const *) */
231 VLC_CONFIG_ADD_ACTION,
232 /* add value change callback (args=vlc_callback_t, const char *) */
235 /* former option name (args=const char *) */
238 /* tag as modifiable by untrusted input item "sources" (args=none) */
241 /*****************************************************************************
242 * Macros used to build the configuration structure.
244 * Note that internally we support only 3 types of config data: int, float
246 * The other types declared here just map to one of these 3 basic types but
247 * have the advantage of also providing very good hints to a configuration
248 * interface so as to make it more user friendly.
249 * The configuration structure also includes category hints. These hints can
250 * provide a configuration interface with some very useful data and again
251 * allow for a more user friendly interface.
252 *****************************************************************************/
254 #define add_type_inner( type ) \
255 p_config = vlc_config_create (p_module, type)
257 #define add_typedesc_inner( type, text, longtext ) \
258 add_type_inner( type ); \
259 vlc_config_set (p_config, VLC_CONFIG_DESC, \
260 (const char *)(text), (const char *)(longtext))
262 #define add_typeadv_inner( type, text, longtext, advc ) \
263 add_typedesc_inner( type, text, longtext ); \
264 if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED)
266 #define add_typename_inner( type, name, text, longtext, advc, cb ) \
267 add_typeadv_inner( type, text, longtext, advc ); \
268 vlc_config_set (p_config, VLC_CONFIG_NAME, \
269 (const char *)(name), (vlc_callback_t)(cb))
271 #define add_string_inner( type, name, text, longtext, advc, cb, v ) \
272 add_typename_inner( type, name, text, longtext, advc, cb ); \
273 vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v))
275 #define add_int_inner( type, name, text, longtext, advc, cb, v ) \
276 add_typename_inner( type, name, text, longtext, advc, cb ); \
277 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v))
280 #define set_category( i_id ) \
281 add_type_inner( CONFIG_CATEGORY ); \
282 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id))
284 #define set_subcategory( i_id ) \
285 add_type_inner( CONFIG_SUBCATEGORY ); \
286 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id))
288 #define set_section( text, longtext ) \
289 add_typedesc_inner( CONFIG_SECTION, text, longtext )
291 #define add_category_hint( text, longtext, advc ) \
292 add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
294 #define add_subcategory_hint( text, longtext ) \
295 add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
297 #define end_subcategory_hint \
298 add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
300 #define add_usage_hint( text ) \
301 add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
303 #define add_string( name, value, p_callback, text, longtext, advc ) \
304 add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, p_callback, value )
306 #define add_password( name, value, p_callback, text, longtext, advc ) \
307 add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, p_callback, value )
309 #define add_file( name, value, p_callback, text, longtext, advc ) \
310 add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, p_callback, value )
312 #define add_directory( name, value, p_callback, text, longtext, advc ) \
313 add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, p_callback, value )
315 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
316 add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, p_callback, value ); \
317 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps))
319 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
320 add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, p_callback, value ); \
321 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps))
324 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
325 add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, p_callback, value ); \
326 p_config->min.i = i_subcategory /* gruik */
328 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
329 add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, advc, p_callback, value ); \
330 p_config->min.i = i_subcategory /* gruik */
333 #define add_integer( name, value, p_callback, text, longtext, advc ) \
334 add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, p_callback, value )
336 #define add_key( name, value, p_callback, text, longtext, advc ) \
337 add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, value )
339 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
340 add_integer( name, value, p_callback, text, longtext, advc ); \
341 change_integer_range( i_min, i_max )
343 #define add_float( name, v, p_callback, text, longtext, advc ) \
344 add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ); \
345 vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v))
347 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
348 add_float( name, value, p_callback, text, longtext, advc ); \
349 change_float_range( f_min, f_max )
351 #define add_bool( name, v, p_callback, text, longtext, advc ) \
352 add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, p_callback ); \
353 if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true)
355 /* For removed option */
356 #define add_obsolete_inner( name, type ) \
357 add_type_inner( type ); \
358 vlc_config_set (p_config, VLC_CONFIG_NAME, \
359 (const char *)(name), (vlc_callback_t)NULL); \
360 vlc_config_set (p_config, VLC_CONFIG_REMOVED)
362 #define add_obsolete_bool( name ) \
363 add_obsolete_inner( name, CONFIG_ITEM_BOOL )
365 #define add_obsolete_integer( name ) \
366 add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
368 #define add_obsolete_float( name ) \
369 add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
371 #define add_obsolete_string( name ) \
372 add_obsolete_inner( name, CONFIG_ITEM_STRING )
374 /* Modifier macros for the config options (used for fine tuning) */
376 #define add_deprecated_alias( name ) \
377 vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name))
379 #define change_short( ch ) \
380 vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch))
382 #define change_string_list( list, list_text, list_update_func ) \
383 vlc_config_set (p_config, VLC_CONFIG_LIST, \
384 (size_t)(sizeof (list) / sizeof (char *)), \
385 (const char *const *)(list), \
386 (const char *const *)(list_text), \
389 #define change_integer_list( list, list_text, list_update_func ) \
390 vlc_config_set (p_config, VLC_CONFIG_LIST, \
391 (size_t)(sizeof (list) / sizeof (int)), \
392 (const int *)(list), \
393 (const char *const *)(list_text), \
396 #define change_float_list( list, list_text, list_update_func ) \
397 vlc_config_set (p_config, VLC_CONFIG_LIST, \
398 (size_t)(sizeof (list) / sizeof (float)), \
399 (const float *)(list), \
400 (const char *const *)(list_text), \
403 #define change_integer_range( minv, maxv ) \
404 vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv))
406 #define change_float_range( minv, maxv ) \
407 vlc_config_set (p_config, VLC_CONFIG_RANGE, \
408 (double)(minv), (double)(maxv))
410 #define change_action_add( pf_action, text ) \
411 vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \
412 (vlc_callback_t)(pf_action), (const char *)(text))
414 #define change_internal() \
415 vlc_config_set (p_config, VLC_CONFIG_PRIVATE)
417 #define change_need_restart() \
418 vlc_config_set (p_config, VLC_CONFIG_RESTART)
420 #define change_autosave() \
421 vlc_config_set (p_config, VLC_CONFIG_PERSISTENT)
423 #define change_unsaveable() \
424 vlc_config_set (p_config, VLC_CONFIG_VOLATILE)
426 #define change_unsafe() (void)0 /* no-op */
428 #define change_safe() \
429 vlc_config_set (p_config, VLC_CONFIG_SAFE)