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.24 2002/07/31 20:56:50 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##__##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 E_( 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 E_( 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 #if defined( __cplusplus )
  68 #   define EXTERN_SYMBOL           extern "C"
  69 #else
  70 #   define EXTERN_SYMBOL
  71 #endif
  72
  73 #define MODULE_STRING STRINGIFY( MODULE_NAME )
  74
  75 /*
  76  * InitModule: this function is called once and only once, when the module
  77  * is looked at for the first time. We get the useful data from it, for
  78  * instance the module name, its shortcuts, its capabilities... we also create
  79  * a copy of its config because the module can be unloaded at any time.
  80  */
  81 #define vlc_module_begin( )                                                   \
  82     DECLARE_SYMBOLS;                                                          \
  83     EXTERN_SYMBOL int __VLC_SYMBOL(vlc_entry) ( module_t *p_module )          \
  84     {                                                                         \
  85         int i_shortcut = 1, i_config = 0;                                     \
  86         module_config_t p_config[ 100 ];                                      \
  87         STORE_SYMBOLS;                                                        \
  88         p_module->b_submodule = VLC_FALSE;                                    \
  89         p_module->psz_object_name = MODULE_STRING;                            \
  90         p_module->psz_longname = MODULE_STRING;                               \
  91         p_module->pp_shortcuts[ 0 ] = MODULE_STRING;                          \
  92         p_module->i_cpu = 0;                                                  \
  93         p_module->psz_program = NULL;                                         \
  94         p_module->psz_capability = "";                                        \
  95         p_module->i_score = 1;                                                \
  96         p_module->pf_activate = NULL;                                         \
  97         p_module->pf_deactivate = NULL;                                       \
  98         do                                                                    \
  99         {                                                                     \
 100             module_t *p_submodule = p_module /* the ; gets added */
 101
 102 #define vlc_module_end( )                                                     \
 103             p_submodule->pp_shortcuts[ i_shortcut ] = NULL;                   \
 104         } while( 0 );                                                         \
 105         p_config[ i_config ] =                                                \
 106             (module_config_t){ CONFIG_HINT_END, NULL, NULL, '\0' };           \
 107         config_Duplicate( p_module, p_config );                               \
 108         if( p_module->p_config == NULL )                                      \
 109         {                                                                     \
 110             return -1;                                                        \
 111         }                                                                     \
 112         return 0 && i_shortcut;                                               \
 113     }                                                                         \
 114     int __VLC_SYMBOL(vlc_entry) ( module_t * ) /* the ; gets added */
 115
 116
 117 #define add_submodule( )                                                      \
 118     p_submodule->pp_shortcuts[ i_shortcut ] = NULL;                           \
 119     p_submodule = vlc_object_create( p_module, VLC_OBJECT_MODULE );           \
 120     vlc_object_attach( p_submodule, p_module );                               \
 121     p_submodule->b_submodule = VLC_TRUE;                                      \
 122     /* Nuahahaha! Heritage! Polymorphism! Ugliness!! */                       \
 123     for( i_shortcut = 0; p_module->pp_shortcuts[ i_shortcut ]; i_shortcut++ ) \
 124     {                                                                         \
 125         p_submodule->pp_shortcuts[ i_shortcut ] =                             \
 126                                 p_module->pp_shortcuts[ i_shortcut ];         \
 127     }                                                                         \
 128     p_submodule->psz_object_name = p_module->psz_object_name;                 \
 129     p_submodule->psz_program = p_module->psz_program;                         \
 130     p_submodule->psz_capability = p_module->psz_capability;                   \
 131     p_submodule->i_score = p_module->i_score;                                 \
 132     p_submodule->i_cpu = p_module->i_cpu;                                     \
 133     p_submodule->pf_activate = NULL;                                          \
 134     p_submodule->pf_deactivate = NULL
 135
 136 #define add_requirement( cap )                                                \
 137     p_module->i_cpu |= CPU_CAPABILITY_##cap
 138
 139 #define add_shortcut( shortcut )                                              \
 140     p_submodule->pp_shortcuts[ i_shortcut ] = shortcut;                       \
 141     i_shortcut++
 142
 143 #define set_description( desc )                                               \
 144     p_module->psz_longname = desc
 145
 146 #define set_capability( cap, score )                                          \
 147     p_submodule->psz_capability = cap;                                        \
 148     p_submodule->i_score = score
 149
 150 #define set_program( program )                                                \
 151     p_submodule->psz_program = program
 152
 153 #define set_callbacks( activate, deactivate )                                 \
 154     p_submodule->pf_activate = activate;                                      \
 155     p_submodule->pf_deactivate = deactivate
 156
 157 /*
 158  * module_activate: this function is called before functions can be accessed,
 159  * we do allocation tasks here, and maybe additional stuff such as large
 160  * table allocation. Once ActivateModule is called we are almost sure the
 161  * module will be used.
 162  */
 163 #define module_activate( prototype )                                          \
 164     __module_activate( prototype );                                           \
 165     int __VLC_SYMBOL( module_activate ) ( module_t *p_module )                \
 166     {                                                                         \
 167         STORE_SYMBOLS;                                                        \
 168         config_SetCallbacks( p_module->p_config, p_config );                  \
 169         return __module_activate( p_module );                                 \
 170     }                                                                         \
 171                                                                               \
 172     static int __module_activate( prototype )
 173
 174 /*
 175  * DeactivateModule: this function is called after we are finished with the
 176  * module. Everything that has been done in ActivateModule needs to be undone
 177  * here.
 178  */
 179 #define module_deactivate( prototype )                                        \
 180     __module_deactivate( prototype );                                         \
 181     int __VLC_SYMBOL( module_deactivate )( module_t *p_module )               \
 182     {                                                                         \
 183         int i_ret = __module_deactivate( p_module );                          \
 184         config_UnsetCallbacks( p_module->p_config );                          \
 185         return i_ret;                                                         \
 186     }                                                                         \
 187                                                                               \
 188     static int __module_deactivate( prototype )
 189