git.sesse.net Git - vlc/blob - include/vlc_modules_macros.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 #if !defined( __LIBVLC__ )
  25   #error You are not libvlc or one of its plugins. You cannot include this file
  26 #endif
  27
  28 /*****************************************************************************
  29  * If we are not within a module, assume we're in the vlc core.
  30  *****************************************************************************/
  31 #if !defined( __PLUGIN__ ) && !defined( __BUILTIN__ )
  32 #   define MODULE_NAME main
  33 #endif
  34
  35 /*****************************************************************************
  36  * Add a few defines. You do not want to read this section. Really.
  37  *****************************************************************************/
  38
  39 /* Explanation:
  40  *
  41  * if user has #defined MODULE_NAME foo, then we will need:
  42  * #define MODULE_STRING "foo"
  43  *
  44  * and, if __BUILTIN__ is set, we will also need:
  45  * #define MODULE_FUNC( zog ) module_foo_zog
  46  *
  47  * this can't easily be done with the C preprocessor, thus a few ugly hacks.
  48  */
  49
  50 /* I can't believe I need to do this to change « foo » to « "foo" » */
  51 #define STRINGIFY( z )   UGLY_KLUDGE( z )
  52 #define UGLY_KLUDGE( z ) #z
  53 /* And I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
  54 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
  55 #define CRUDE_HACK( y, z )  y##__##z
  56
  57 /* If the module is built-in, then we need to define foo_InitModule instead
  58  * of InitModule. Same for Activate- and DeactivateModule. */
  59 #if defined( __BUILTIN__ )
  60 #   define E_( function )          CONCATENATE( function, MODULE_NAME )
  61 #   define __VLC_SYMBOL( symbol )  CONCATENATE( symbol, MODULE_NAME )
  62 #elif defined( __PLUGIN__ )
  63 #   define E_( function )          CONCATENATE( function, MODULE_SYMBOL )
  64 #   define __VLC_SYMBOL( symbol  ) CONCATENATE( symbol, MODULE_SYMBOL )
  65 #endif
  66
  67 #if defined( __BUILTIN__ ) || defined( HAVE_SHARED_LIBVLC )
  68 #   define DECLARE_SYMBOLS         struct _u_n_u_s_e_d_
  69 #   define STORE_SYMBOLS           struct _u_n_u_s_e_d_
  70 #else
  71 #   define DECLARE_SYMBOLS         module_symbols_t* p_symbols = NULL
  72 #   define STORE_SYMBOLS           p_symbols = p_module->p_symbols
  73 #endif
  74
  75 #if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
  76 #   define DLL_SYMBOL              __declspec(dllexport)
  77 #   define CDECL_SYMBOL            __cdecl
  78 #elif HAVE_ATTRIBUTE_VISIBILITY
  79 #   define DLL_SYMBOL __attribute__((visibility("default")))
  80 #   define CDECL_SYMBOL
  81 #else
  82 #   define DLL_SYMBOL
  83 #   define CDECL_SYMBOL
  84 #endif
  85
  86 #if defined( __cplusplus )
  87 #   define EXTERN_SYMBOL           extern "C"
  88 #else
  89 #   define EXTERN_SYMBOL
  90 #endif
  91
  92 #if defined( USE_DLL )
  93 #   define IMPORT_SYMBOL __declspec(dllimport)
  94 #else
  95 #   define IMPORT_SYMBOL
  96 #endif
  97
  98 #define MODULE_STRING STRINGIFY( MODULE_NAME )
  99
 100 /*
 101  * InitModule: this function is called once and only once, when the module
 102  * is looked at for the first time. We get the useful data from it, for
 103  * instance the module name, its shortcuts, its capabilities... we also create
 104  * a copy of its config because the module can be unloaded at any time.
 105  */
 106 #if defined (__PLUGIN__) || defined (__BUILTIN__)
 107 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL
 108 E_(vlc_entry) ( module_t *p_module );
 109 #endif
 110
 111 #define vlc_module_begin( )                                                   \
 112     DECLARE_SYMBOLS;                                                          \
 113     EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
 114     __VLC_SYMBOL(vlc_entry) ( module_t *p_module )                            \
 115     {                                                                         \
 116         int i_shortcut = 1, res;                                              \
 117         size_t i_config = (size_t)(-1);                                       \
 118         module_config_t *p_config = NULL;                                     \
 119         STORE_SYMBOLS;                                                        \
 120         if (vlc_module_set (p_module, VLC_MODULE_NAME,                        \
 121                             (void *)(MODULE_STRING)))                         \
 122             goto error;                                                       \
 123         {                                                                     \
 124             module_t *p_submodule = p_module /* the ; gets added */
 125
 126 #define vlc_module_end( )                                                     \
 127         }                                                                     \
 128         res = config_Duplicate( p_module, p_config, ++i_config );             \
 129         for( size_t i = 0; i < i_config; i++ )                                \
 130         {                                                                     \
 131             if( p_config[ i ].i_action )                                      \
 132             {                                                                 \
 133                 free( p_config[ i ].ppf_action );                             \
 134                 free( p_config[ i ].ppsz_action_text );                       \
 135             }                                                                 \
 136         }                                                                     \
 137         free( p_config );                                                     \
 138         if (res)                                                              \
 139             return res;                                                       \
 140         (void)i_shortcut;                                                     \
 141         return VLC_SUCCESS;                                                   \
 142                                                                               \
 143     error:                                                                    \
 144         free( p_config );                                                     \
 145         /* FIXME: cleanup submodules objects ??? */                           \
 146         return VLC_EGENERIC;                                                  \
 147     }                                                                         \
 148     struct _u_n_u_s_e_d_ /* the ; gets added */
 149
 150
 151 #define add_submodule( ) \
 152     p_submodule = vlc_submodule_create( p_module )
 153
 154 #define add_requirement( cap ) \
 155     if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
 156                         (void *)(CPU_CAPABILITY_##cap))) goto error
 157
 158 #define add_shortcut( shortcut ) \
 159     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, (void*)(shortcut))) \
 160         goto error
 161
 162 #define set_shortname( shortname ) \
 163     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \
 164                         (void*)(shortname))) goto error;
 165
 166 #define set_description( desc ) \
 167     if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, (void*)(desc))) \
 168         goto error;
 169
 170 #define set_help( help ) \
 171     if (vlc_module_set (p_submodule, VLC_MODULE_HELP, (void*)(help))) \
 172         goto error
 173
 174 #define set_capability( cap, score ) \
 175     if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, (void *)(cap)) \
 176      || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (void *)(score))) \
 177         goto error
 178
 179 #define set_program( program ) \
 180     if (vlc_module_set (p_submodule, VLC_MODULE_PROGRAM, (void *)(program))) \
 181         goto error
 182
 183 #define set_callbacks( activate, deactivate ) \
 184     if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, (void *)(activate)) \
 185      || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, \
 186                         (void *)(deactivate))) \
 187         goto error
 188
 189 #define linked_with_a_crap_library_which_uses_atexit( ) \
 190     if (vlc_module_set (p_submodule, VLC_MODULE_UNLOADABLE, NULL)) goto error
 191