include/modules_inner.h

   1 /*****************************************************************************
   2  * modules_inner.h : Macros used from within a module.
   3  *****************************************************************************
   4  * Copyright (C) 2001-2006 the VideoLAN team
   5  * $Id$
   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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, 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         struct _u_n_u_s_e_d_
  59 #   define STORE_SYMBOLS           struct _u_n_u_s_e_d_
  60 #elif defined( __PLUGIN__ )
  61 #   define E_( function )          CONCATENATE( function, MODULE_SYMBOL )
  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( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
  68 #   define DLL_SYMBOL              __declspec(dllexport)
  69 #   define CDECL_SYMBOL            __cdecl
  70 #else
  71 #   define DLL_SYMBOL
  72 #   define CDECL_SYMBOL
  73 #endif
  74
  75 #if defined( __cplusplus )
  76 #   define EXTERN_SYMBOL           extern "C"
  77 #else
  78 #   define EXTERN_SYMBOL
  79 #endif
  80
  81 #if defined( USE_DLL )
  82 #   define IMPORT_SYMBOL __declspec(dllimport)
  83 #else
  84 #   define IMPORT_SYMBOL
  85 #endif
  86
  87 #define MODULE_STRING STRINGIFY( MODULE_NAME )
  88
  89 /*
  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.
  94  */
  95 #if defined (__PLUGIN__) || defined (__BUILTIN__)
  96 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL
  97 E_(vlc_entry) ( module_t *p_module );
  98 #endif
  99
 100 #define vlc_module_begin( )                                                   \
 101     DECLARE_SYMBOLS;                                                          \
 102     EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
 103     __VLC_SYMBOL(vlc_entry) ( module_t *p_module )                            \
 104     {                                                                         \
 105         int i_shortcut = 1, i_config = -1;                                    \
 106         module_config_t *p_config = NULL;                                     \
 107         static module_config_t config_end = {                                 \
 108             CONFIG_HINT_END, NULL, NULL, 0, NULL, NULL, NULL, 0, 0., 0, 0,    \
 109             0., 0., NULL, NULL, NULL, NULL, NULL, 0, NULL, NULL, 0, NULL,     \
 110             VLC_FALSE, NULL, VLC_FALSE, VLC_FALSE, VLC_FALSE, VLC_FALSE,      \
 111             NULL, 0, 0., NULL, 0, 0., VLC_FALSE                               \
 112         };                                                                    \
 113         STORE_SYMBOLS;                                                        \
 114         p_module->b_submodule = VLC_FALSE;                                    \
 115         p_module->b_unloadable = VLC_TRUE;                                    \
 116         p_module->b_reentrant = VLC_TRUE;                                     \
 117         p_module->psz_object_name = MODULE_STRING;                            \
 118         p_module->psz_shortname = NULL;                                       \
 119         p_module->psz_longname = MODULE_STRING;                               \
 120         p_module->psz_help = NULL;                                            \
 121         p_module->pp_shortcuts[ 0 ] = MODULE_STRING;                          \
 122         p_module->i_cpu = 0;                                                  \
 123         p_module->psz_program = NULL;                                         \
 124         p_module->psz_capability = "";                                        \
 125         p_module->i_score = 1;                                                \
 126         p_module->pf_activate = NULL;                                         \
 127         p_module->pf_deactivate = NULL;                                       \
 128         {                                                                     \
 129             module_t *p_submodule = p_module /* the ; gets added */
 130
 131 #define vlc_module_end( )                                                     \
 132             p_submodule->pp_shortcuts[ i_shortcut ] = NULL;                   \
 133         }                                                                     \
 134         if( p_config )                                                        \
 135         {                                                                     \
 136             int i;                                                            \
 137             p_config[ ++i_config ] = config_end;                              \
 138             config_Duplicate( p_module, p_config );                           \
 139             for( i = 0; i < i_config; i++ )                                   \
 140             {                                                                 \
 141                 if( p_config[ i ].i_action )                                  \
 142                 {                                                             \
 143                     free( p_config[ i ].ppf_action );                         \
 144                     free( p_config[ i ].ppsz_action_text );                   \
 145                 }                                                             \
 146             }                                                                 \
 147             free( p_config );                                                 \
 148         }                                                                     \
 149         else config_Duplicate( p_module, &config_end );                       \
 150         if( p_module->p_config == NULL )                                      \
 151         {                                                                     \
 152             return VLC_EGENERIC;                                              \
 153         }                                                                     \
 154         return VLC_SUCCESS && i_shortcut;                                     \
 155     }                                                                         \
 156     struct _u_n_u_s_e_d_ /* the ; gets added */
 157
 158
 159 #define add_submodule( )                                                      \
 160     p_submodule->pp_shortcuts[ i_shortcut ] = NULL;                           \
 161     p_submodule =                                                             \
 162             (module_t *)vlc_object_create( p_module, VLC_OBJECT_MODULE );     \
 163     vlc_object_attach( p_submodule, p_module );                               \
 164     p_submodule->b_submodule = VLC_TRUE;                                      \
 165     /* Nuahahaha! Heritage! Polymorphism! Ugliness!! */                       \
 166     for( i_shortcut = 0; p_module->pp_shortcuts[ i_shortcut ]; i_shortcut++ ) \
 167     {                                                                         \
 168         p_submodule->pp_shortcuts[ i_shortcut ] =                             \
 169                                 p_module->pp_shortcuts[ i_shortcut ];         \
 170     }                                                                         \
 171     p_submodule->psz_object_name = p_module->psz_object_name;                 \
 172     p_submodule->psz_shortname = p_module->psz_shortname;                     \
 173     p_submodule->psz_longname = p_module->psz_longname;                       \
 174     p_submodule->psz_program = p_module->psz_program;                         \
 175     p_submodule->psz_capability = p_module->psz_capability;                   \
 176     p_submodule->i_score = p_module->i_score;                                 \
 177     p_submodule->i_cpu = p_module->i_cpu;                                     \
 178     p_submodule->pf_activate = NULL;                                          \
 179     p_submodule->pf_deactivate = NULL
 180
 181 #define add_requirement( cap )                                                \
 182     p_module->i_cpu |= CPU_CAPABILITY_##cap
 183
 184 #define add_shortcut( shortcut )                                              \
 185     p_submodule->pp_shortcuts[ i_shortcut ] = shortcut;                       \
 186     i_shortcut++
 187
 188 #define set_shortname( desc )                                                 \
 189     p_submodule->psz_shortname = desc
 190
 191 #define set_description( desc )                                               \
 192     p_submodule->psz_longname = desc
 193
 194 #define set_help( help )                                                      \
 195     p_submodule->psz_help = help
 196
 197 #define set_capability( cap, score )                                          \
 198     p_submodule->psz_capability = cap;                                        \
 199     p_submodule->i_score = score
 200
 201 #define set_program( program )                                                \
 202     p_submodule->psz_program = program
 203
 204 #define set_callbacks( activate, deactivate )                                 \
 205     p_submodule->pf_activate = activate;                                      \
 206     p_submodule->pf_deactivate = deactivate
 207
 208 #define linked_with_a_crap_library_which_uses_atexit( )                       \
 209     p_module->b_unloadable = VLC_FALSE
 210