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

   1 /*****************************************************************************
   2  * modules_macros.h : Macros used from within a module.
   3  *****************************************************************************
   4  * Copyright (C) 2001-2006 the VideoLAN team
   5  * Copyright © 2007-2008 Rémi Denis-Courmont
   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 #ifndef LIBVLC_MODULES_MACROS_H
  25 # define LIBVLC_MODULES_MACROS_H 1
  26
  27 /*****************************************************************************
  28  * If we are not within a module, assume we're in the vlc core.
  29  *****************************************************************************/
  30 #if !defined( __PLUGIN__ ) && !defined( __BUILTIN__ )
  31 #   define MODULE_NAME main
  32 #endif
  33
  34 /**
  35  * Current plugin ABI version
  36  */
  37 # define MODULE_SYMBOL 0_9_0k
  38 # define MODULE_SUFFIX "__0_9_0k"
  39
  40 /*****************************************************************************
  41  * Add a few defines. You do not want to read this section. Really.
  42  *****************************************************************************/
  43
  44 /* Explanation:
  45  *
  46  * if user has #defined MODULE_NAME foo, then we will need:
  47  * #define MODULE_STRING "foo"
  48  *
  49  * and, if HAVE_DYNAMIC_PLUGINS is NOT set, we will also need:
  50  * #define MODULE_FUNC( zog ) module_foo_zog
  51  *
  52  * this can't easily be done with the C preprocessor, thus a few ugly hacks.
  53  */
  54
  55 /* I can't believe I need to do this to change « foo » to « "foo" » */
  56 #define STRINGIFY( z )   UGLY_KLUDGE( z )
  57 #define UGLY_KLUDGE( z ) #z
  58 /* And I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
  59 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
  60 #define CRUDE_HACK( y, z )  y##__##z
  61
  62 /* If the module is built-in, then we need to define foo_InitModule instead
  63  * of InitModule. Same for Activate- and DeactivateModule. */
  64 #ifdef __PLUGIN__
  65 #   define E_( function )          CONCATENATE( function, MODULE_SYMBOL )
  66 #   define __VLC_SYMBOL( symbol  ) CONCATENATE( symbol, MODULE_SYMBOL )
  67 #else
  68 #   define E_( function )          CONCATENATE( function, MODULE_NAME )
  69 #   define __VLC_SYMBOL( symbol )  CONCATENATE( symbol, MODULE_NAME )
  70 #endif
  71
  72 #if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
  73 #   define DLL_SYMBOL              __declspec(dllexport)
  74 #   define CDECL_SYMBOL            __cdecl
  75 #elif defined (HAVE_ATTRIBUTE_VISIBILITY)
  76 #   define DLL_SYMBOL __attribute__((visibility("default")))
  77 #   define CDECL_SYMBOL
  78 #else
  79 #   define DLL_SYMBOL
  80 #   define CDECL_SYMBOL
  81 #endif
  82
  83 #if defined( __cplusplus )
  84 #   define EXTERN_SYMBOL           extern "C"
  85 #else
  86 #   define EXTERN_SYMBOL
  87 #endif
  88
  89 #if defined( USE_DLL )
  90 #   define IMPORT_SYMBOL __declspec(dllimport)
  91 #else
  92 #   define IMPORT_SYMBOL
  93 #endif
  94
  95 #define MODULE_STRING STRINGIFY( MODULE_NAME )
  96
  97 /*
  98  * InitModule: this function is called once and only once, when the module
  99  * is looked at for the first time. We get the useful data from it, for
 100  * instance the module name, its shortcuts, its capabilities... we also create
 101  * a copy of its config because the module can be unloaded at any time.
 102  */
 103 #if defined (__PLUGIN__) || defined (__BUILTIN__)
 104 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL
 105 E_(vlc_entry) ( module_t *p_module );
 106 #endif
 107
 108 #define vlc_module_begin( )                                                   \
 109     EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
 110     __VLC_SYMBOL(vlc_entry) ( module_t *p_module )                            \
 111     {                                                                         \
 112         module_config_t *p_config = NULL;                                     \
 113         if (vlc_module_set (p_module, VLC_MODULE_NAME,                        \
 114                             (const char *)(MODULE_STRING)))                   \
 115             goto error;                                                       \
 116         {                                                                     \
 117             module_t *p_submodule = p_module /* the ; gets added */
 118
 119 #define vlc_module_end( )                                                     \
 120         }                                                                     \
 121         (void)p_config;                                                       \
 122         return VLC_SUCCESS;                                                   \
 123                                                                               \
 124     error:                                                                    \
 125         return VLC_EGENERIC;                                                  \
 126     }                                                                         \
 127     struct _u_n_u_s_e_d_ /* the ; gets added */
 128
 129
 130 #define add_submodule( ) \
 131     p_submodule = vlc_submodule_create( p_module )
 132
 133 #define add_requirement( cap ) \
 134     if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
 135                         (int)(CPU_CAPABILITY_##cap))) \
 136         goto error
 137
 138 #define add_shortcut( shortcut ) \
 139     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, (int)(shortcut))) \
 140         goto error
 141
 142 #define set_shortname( shortname ) \
 143     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \
 144         (const char *)(shortname))) \
 145         goto error
 146
 147 #define set_description( desc ) \
 148     if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, \
 149                         (const char *)(desc))) \
 150         goto error
 151
 152 #define set_help( help ) \
 153     if (vlc_module_set (p_submodule, VLC_MODULE_HELP, (const char *)(help))) \
 154         goto error
 155
 156 #define set_capability( cap, score ) \
 157     if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, (int)(cap)) \
 158      || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
 159         goto error
 160
 161 #define set_callbacks( activate, deactivate ) \
 162     if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \
 163      || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \
 164         goto error
 165
 166 #define linked_with_a_crap_library_which_uses_atexit( ) \
 167     if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
 168         goto error
 169
 170 VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) );
 171 VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) );
 172 VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, ...) );
 173
 174 enum vlc_module_properties
 175 {
 176     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
 177      * Append new items at the end ONLY. */
 178     VLC_MODULE_CPU_REQUIREMENT,
 179     VLC_MODULE_SHORTCUT,
 180     VLC_MODULE_SHORTNAME,
 181     VLC_MODULE_DESCRIPTION,
 182     VLC_MODULE_HELP,
 183     VLC_MODULE_CAPABILITY,
 184     VLC_MODULE_SCORE,
 185     VLC_MODULE_PROGRAM,
 186     VLC_MODULE_CB_OPEN,
 187     VLC_MODULE_CB_CLOSE,
 188     VLC_MODULE_NO_UNLOAD,
 189     VLC_MODULE_NAME,
 190 };
 191 #endif