X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fmodules_inner.h;h=66db53c2ddfc824c07dcbe25efe816b299a42a2b;hb=d4f18c4eadb23de73e7ae1d1e2e899cbbfbef567;hp=a966569bcce3e3348f5a44f0343a1abd29ae844c;hpb=32d3e55a6e50907ec96dd4a042d08acfbc7e9cf6;p=vlc diff --git a/include/modules_inner.h b/include/modules_inner.h index a966569bcc..66db53c2dd 100644 --- a/include/modules_inner.h +++ b/include/modules_inner.h @@ -2,6 +2,7 @@ * modules_inner.h : Macros used from within a module. ***************************************************************************** * Copyright (C) 2001 VideoLAN + * $Id: modules_inner.h,v 1.13 2002/03/11 07:23:09 gbazin Exp $ * * Authors: Samuel Hocevar * @@ -23,7 +24,7 @@ /***************************************************************************** * Check that we are within a module. *****************************************************************************/ -#ifndef MODULE_NAME +#if !( defined( MODULE_NAME ) || defined( MAKE_DEP ) ) # error "You must define MODULE_NAME before using modules_inner.h !" #endif @@ -38,61 +39,129 @@ * #define MODULE_VAR(blah) "VLC_MODULE_foo_blah" * * and, if BUILTIN is set, we will also need: - * #define InitModule foo_InitModule - * #define ActivateModule foo_ActivateModule - * #define DeactivateModule foo_DeactivateModule + * #define MODULE_FUNC( zog ) module_foo_zog * * this can't easily be done with the C preprocessor, thus a few ugly hacks. */ /* I can't believe I need to do this to change « foo » to « "foo" » */ -#define UGLY_KLUDGE(z) NASTY_CROCK(z) -#define NASTY_CROCK(z) #z -/* And I need to do _this_ to change « foo bar » to « foo_bar » ! */ -#define AWFUL_BRITTLE(y,z) CRUDE_HACK(y,z) -#define CRUDE_HACK(y,z) y##_##z +#define STRINGIFY( z ) UGLY_KLUDGE( z ) +#define UGLY_KLUDGE( z ) #z +/* And I need to do _this_ to change « foo bar » to « module_foo_bar » ! */ +#define CONCATENATE( y, z ) CRUDE_HACK( y, z ) +#define CRUDE_HACK( y, z ) y##__MODULE_##z -/* Also, I need to do this to change « blah » to « "VLC_MODULE_foo_blah" » */ -#define MODULE_STRING UGLY_KLUDGE(MODULE_NAME) -#define MODULE_VAR(z) "VLC_MODULE_" UGLY_KLUDGE(MODULE_NAME) "_" #z +#define MODULE_VAR( z ) "VLC_MODULE_" #z /* If the module is built-in, then we need to define foo_InitModule instead * of InitModule. Same for Activate- and DeactivateModule. */ #ifdef BUILTIN -# define InitModule AWFUL_BRITTLE(MODULE_NAME,InitModule) -# define ActivateModule AWFUL_BRITTLE(MODULE_NAME,ActivateModule) -# define DeactivateModule AWFUL_BRITTLE(MODULE_NAME,DeactivateModule) +# define _M( function ) CONCATENATE( function, MODULE_NAME ) +# define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_NAME ) +# define DECLARE_SYMBOLS ; +# define STORE_SYMBOLS ; +#else +# define _M( function ) function +# define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_SYMBOL ) +# define DECLARE_SYMBOLS module_symbols_t* p_symbols; +# define STORE_SYMBOLS p_symbols = p_module->p_symbols; #endif -/***************************************************************************** - * Macros used to build the configuration structure. - *****************************************************************************/ -#define MODULE_CONFIG_START( text ) \ -static module_config_t p_config[] = { \ - { MODULE_CONFIG_ITEM_START, text, NULL, NULL, NULL }, - -#define MODULE_CONFIG_END \ - { MODULE_CONFIG_ITEM_END, NULL, NULL, NULL, NULL } \ -}; - -#define ADD_FRAME( text ) \ - { MODULE_CONFIG_ITEM_FRAME, text, NULL, NULL, NULL }, -#define ADD_PANE( text ) \ - { MODULE_CONFIG_ITEM_PANE, text, NULL, NULL, NULL }, -#define ADD_COMMENT( text ) \ - { MODULE_CONFIG_ITEM_COMMENT, text, NULL, NULL, NULL }, -#define ADD_STRING( text, name, p_update ) \ - { MODULE_CONFIG_ITEM_STRING, text, name, NULL, p_update }, -#define ADD_FILE( text, name, p_update ) \ - { MODULE_CONFIG_ITEM_FILE, text, name, NULL, p_update }, -#define ADD_CHECK( text, name, p_update ) \ - { MODULE_CONFIG_ITEM_CHECK, text, name, NULL, p_update }, -#define ADD_CHOOSE( text, name, p_getlist, p_update ) \ - { MODULE_CONFIG_ITEM_CHOOSE, text, name, p_getlist, p_update }, -#define ADD_RADIO( text, name, p_getlist, p_update ) \ - { MODULE_CONFIG_ITEM_RADIO, text, name, p_getlist, p_update }, -#define ADD_SCALE( text, name, p_getlist, p_update ) \ - { MODULE_CONFIG_ITEM_SCALE, text, name, p_getlist, p_update }, -#define ADD_SPIN( text, name, p_getlist, p_update ) \ - { MODULE_CONFIG_ITEM_SPIN, text, name, p_getlist, p_update }, +#define MODULE_STRING STRINGIFY( MODULE_NAME ) + +/* + * InitModule: this function is called once and only once, when the module + * is looked at for the first time. We get the useful data from it, for + * instance the module name, its shortcuts, its capabilities... we also create + * a copy of its config because the module can be unloaded at any time. + */ +#define MODULE_INIT_START \ + DECLARE_SYMBOLS; \ + \ + int __VLC_SYMBOL( InitModule ) ( module_t *p_module ) \ + { \ + int i_shortcut = 0; \ + p_module->psz_name = MODULE_STRING; \ + p_module->psz_longname = MODULE_STRING; \ + p_module->psz_program = NULL; \ + p_module->i_capabilities = 0; \ + p_module->i_cpu_capabilities = 0; + +#define MODULE_INIT_STOP \ + STORE_SYMBOLS; \ + p_module->pp_shortcuts[ i_shortcut ] = NULL; \ + p_module->i_config_items = 0; \ + for( p_module->i_config_lines = 0; \ + p_module->i_config_lines < (sizeof(p_config)/ \ + sizeof(module_config_t)); \ + p_module->i_config_lines++ ) \ + { \ + if( p_config[p_module->i_config_lines].i_type & \ + MODULE_CONFIG_ITEM ) \ + p_module->i_config_items++; \ + } \ + vlc_mutex_init( &p_module->config_lock ); \ + p_module->p_config_orig = p_config; \ + p_module->p_config = config_Duplicate( p_module ); \ + if( p_module->p_config == NULL ) \ + { \ + intf_ErrMsg( MODULE_STRING \ + " InitModule error: can't duplicate p_config" ); \ + return( -1 ); \ + } \ + return( 0 ); \ + } + +#define ADD_CAPABILITY( cap, score ) \ + p_module->i_capabilities |= 1 << MODULE_CAPABILITY_##cap; \ + p_module->pi_score[ MODULE_CAPABILITY_##cap ] = score; + +#define ADD_REQUIREMENT( cap ) \ + p_module->i_cpu_capabilities |= CPU_CAPABILITY_##cap; + +#define ADD_PROGRAM( program ) \ + p_module->psz_program = program; + +#define ADD_SHORTCUT( shortcut ) \ + p_module->pp_shortcuts[ i_shortcut ] = shortcut; \ + i_shortcut++; + +#define SET_DESCRIPTION( desc ) \ + p_module->psz_longname = desc; + +/* + * ActivateModule: this function is called before functions can be accessed, + * we do allocation tasks here, and maybe additional stuff such as large + * table allocation. Once ActivateModule is called we are almost sure the + * module will be used. + */ +#define MODULE_ACTIVATE_START \ + int __VLC_SYMBOL( ActivateModule ) ( module_t *p_module ) \ + { \ + p_module->p_functions = \ + ( module_functions_t * )malloc( sizeof( module_functions_t ) ); \ + p_module->p_config_orig = p_config; \ + if( p_module->p_functions == NULL ) \ + { \ + return( -1 ); \ + } \ + STORE_SYMBOLS; + +#define MODULE_ACTIVATE_STOP \ + return( 0 ); \ + } + +/* + * DeactivateModule: this function is called after we are finished with the + * module. Everything that has been done in ActivateModule needs to be undone + * here. + */ +#define MODULE_DEACTIVATE_START \ + int __VLC_SYMBOL( DeactivateModule )( module_t *p_module ) \ + { \ + p_module->p_config_orig = NULL; \ + free( p_module->p_functions ); +#define MODULE_DEACTIVATE_STOP \ + return( 0 ); \ + }