git.sesse.net Git - vlc/blob - include/modules_inner.h

   1 /*****************************************************************************
   2  * modules_inner.h : Macros used from within a module.
   3  *****************************************************************************
   4  * Copyright (C) 2001 VideoLAN
   5  * $Id: modules_inner.h,v 1.23 2002/06/01 12:31:57 sam Exp $
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *
   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.
  13  *
  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.
  18  *
  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  *****************************************************************************/
  23
  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 #endif
  30
  31 /*****************************************************************************
  32  * Add a few defines. You do not want to read this section. Really.
  33  *****************************************************************************/
  34
  35 /* Explanation:
  36  *
  37  * if user has #defined MODULE_NAME foo, then we will need:
  38  * #define MODULE_STRING "foo"
  39  *
  40  * and, if __BUILTIN__ is set, we will also need:
  41  * #define MODULE_FUNC( zog ) module_foo_zog
  42  *
  43  * this can't easily be done with the C preprocessor, thus a few ugly hacks.
  44  */
  45
  46 /* I can't believe I need to do this to change « foo » to « "foo" » */
  47 #define STRINGIFY( z )   UGLY_KLUDGE( z )
  48 #define UGLY_KLUDGE( z ) #z
  49 /* And I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
  50 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
  51 #define CRUDE_HACK( y, z )  y##__MODULE_##z
  52
  53 /* If the module is built-in, then we need to define foo_InitModule instead
  54  * of InitModule. Same for Activate- and DeactivateModule. */
  55 #if defined( __BUILTIN__ )
  56 #   define _M( function )          CONCATENATE( function, MODULE_NAME )
  57 #   define __VLC_SYMBOL( symbol )  CONCATENATE( symbol, MODULE_NAME )
  58 #   define DECLARE_SYMBOLS         ;
  59 #   define STORE_SYMBOLS           ;
  60 #elif defined( __PLUGIN__ )
  61 #   define _M( function )          function
  62 #   define __VLC_SYMBOL( symbol  ) CONCATENATE( symbol, MODULE_SYMBOL )
  63 #   define DECLARE_SYMBOLS         module_symbols_t* p_symbols;
  64 #   define STORE_SYMBOLS           p_symbols = p_module->p_symbols;
  65 #endif
  66
  67 #define MODULE_STRING STRINGIFY( MODULE_NAME )
  68
  69 /*
  70  * InitModule: this function is called once and only once, when the module
  71  * is looked at for the first time. We get the useful data from it, for
  72  * instance the module name, its shortcuts, its capabilities... we also create
  73  * a copy of its config because the module can be unloaded at any time.
  74  */
  75 #define MODULE_INIT_START                                                     \
  76     DECLARE_SYMBOLS;                                                          \
  77     int __VLC_SYMBOL( InitModule ) ( module_t *p_module )                     \
  78     {                                                                         \
  79         int i_shortcut = 1;                                                   \
  80         STORE_SYMBOLS;                                                        \
  81         p_module->psz_object_name = MODULE_STRING;                            \
  82         p_module->psz_longname = MODULE_STRING;                               \
  83         p_module->psz_program = NULL;                                         \
  84         p_module->pp_shortcuts[ 0 ] = MODULE_STRING;                          \
  85         p_module->i_capabilities = 0;                                         \
  86         p_module->i_cpu_capabilities = 0;                                     \
  87         do {
  88
  89 #define MODULE_INIT_STOP                                                      \
  90         } while( 0 );                                                         \
  91         p_module->pp_shortcuts[ i_shortcut ] = NULL;                          \
  92         config_Duplicate( p_module, p_config );                               \
  93         if( p_module->p_config == NULL )                                      \
  94         {                                                                     \
  95 /*//X            intf_Err( p_module, "InitModule can't duplicate p_config" );*/      \
  96             return -1;                                                        \
  97         }                                                                     \
  98         return 0;                                                             \
  99     }
 100
 101 #define ADD_CAPABILITY( cap, score )                                          \
 102     p_module->i_capabilities |= 1 << MODULE_CAPABILITY_##cap;                 \
 103     p_module->pi_score[ MODULE_CAPABILITY_##cap ] = score;
 104
 105 #define ADD_REQUIREMENT( cap )                                                \
 106     p_module->i_cpu_capabilities |= CPU_CAPABILITY_##cap;
 107
 108 #define ADD_PROGRAM( program )                                                \
 109     p_module->psz_program = program;
 110
 111 #define ADD_SHORTCUT( shortcut )                                              \
 112     p_module->pp_shortcuts[ i_shortcut ] = shortcut;                          \
 113     i_shortcut++;
 114
 115 #define SET_DESCRIPTION( desc )                                               \
 116     p_module->psz_longname = desc;
 117
 118 /*
 119  * ActivateModule: this function is called before functions can be accessed,
 120  * we do allocation tasks here, and maybe additional stuff such as large
 121  * table allocation. Once ActivateModule is called we are almost sure the
 122  * module will be used.
 123  */
 124 #define MODULE_ACTIVATE_START                                                 \
 125     int __VLC_SYMBOL( ActivateModule ) ( module_t *p_module )                 \
 126     {                                                                         \
 127         STORE_SYMBOLS;                                                        \
 128         p_module->p_functions =                                               \
 129           ( module_functions_t * )malloc( sizeof( module_functions_t ) );     \
 130         if( p_module->p_functions == NULL )                                   \
 131         {                                                                     \
 132             return( -1 );                                                     \
 133         }                                                                     \
 134         config_SetCallbacks( p_module->p_config, p_config );                  \
 135         do {
 136
 137 #define MODULE_ACTIVATE_STOP                                                  \
 138         } while( 0 );                                                         \
 139         return 0;                                                             \
 140     }
 141
 142 /*
 143  * DeactivateModule: this function is called after we are finished with the
 144  * module. Everything that has been done in ActivateModule needs to be undone
 145  * here.
 146  */
 147 #define MODULE_DEACTIVATE_START                                               \
 148     int __VLC_SYMBOL( DeactivateModule )( module_t *p_module )                \
 149     {                                                                         \
 150         free( p_module->p_functions );                                        \
 151         do {
 152
 153 #define MODULE_DEACTIVATE_STOP                                                \
 154         } while( 0 );                                                         \
 155         config_UnsetCallbacks( p_module->p_config );                          \
 156         return 0;                                                             \
 157     }