Remove unneeded psz_program hack.
[vlc.git] / 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 HAVE_DYNAMIC_PLUGINS is NOT 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 (HAVE_DYNAMIC_PLUGINS) && !defined (__BUILTIN__)
60 #   define E_( function )          CONCATENATE( function, MODULE_SYMBOL )
61 #   define __VLC_SYMBOL( symbol  ) CONCATENATE( symbol, MODULE_SYMBOL )
62 #else
63 #   define E_( function )          CONCATENATE( function, MODULE_NAME )
64 #   define __VLC_SYMBOL( symbol )  CONCATENATE( symbol, MODULE_NAME )
65 #endif
66
67 #if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
68 #   define DLL_SYMBOL              __declspec(dllexport)
69 #   define CDECL_SYMBOL            __cdecl
70 #elif HAVE_ATTRIBUTE_VISIBILITY
71 #   define DLL_SYMBOL __attribute__((visibility("default")))
72 #   define CDECL_SYMBOL
73 #else
74 #   define DLL_SYMBOL
75 #   define CDECL_SYMBOL
76 #endif
77
78 #if defined( __cplusplus )
79 #   define EXTERN_SYMBOL           extern "C"
80 #else
81 #   define EXTERN_SYMBOL
82 #endif
83
84 #if defined( USE_DLL )
85 #   define IMPORT_SYMBOL __declspec(dllimport)
86 #else
87 #   define IMPORT_SYMBOL
88 #endif
89
90 #define MODULE_STRING STRINGIFY( MODULE_NAME )
91
92 /*
93  * InitModule: this function is called once and only once, when the module
94  * is looked at for the first time. We get the useful data from it, for
95  * instance the module name, its shortcuts, its capabilities... we also create
96  * a copy of its config because the module can be unloaded at any time.
97  */
98 #if defined (__PLUGIN__) || defined (__BUILTIN__)
99 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL
100 E_(vlc_entry) ( module_t *p_module );
101 #endif
102
103 #define vlc_module_begin( )                                                   \
104     EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
105     __VLC_SYMBOL(vlc_entry) ( module_t *p_module )                            \
106     {                                                                         \
107         int i_shortcut = 1, res;                                              \
108         size_t i_config = (size_t)(-1);                                       \
109         module_config_t *p_config = NULL;                                     \
110         if (vlc_module_set (p_module, VLC_MODULE_NAME,                        \
111                             (void *)(MODULE_STRING)))                         \
112             goto error;                                                       \
113         {                                                                     \
114             module_t *p_submodule = p_module /* the ; gets added */
115
116 #define vlc_module_end( )                                                     \
117         }                                                                     \
118         res = config_Duplicate( p_module, p_config, ++i_config );             \
119         for( size_t i = 0; i < i_config; i++ )                                \
120         {                                                                     \
121             if( p_config[ i ].i_action )                                      \
122             {                                                                 \
123                 free( p_config[ i ].ppf_action );                             \
124                 free( p_config[ i ].ppsz_action_text );                       \
125             }                                                                 \
126         }                                                                     \
127         free( p_config );                                                     \
128         if (res)                                                              \
129             return res;                                                       \
130         (void)i_shortcut;                                                     \
131         return VLC_SUCCESS;                                                   \
132                                                                               \
133     error:                                                                    \
134         free( p_config );                                                     \
135         /* FIXME: cleanup submodules objects ??? */                           \
136         return VLC_EGENERIC;                                                  \
137     }                                                                         \
138     struct _u_n_u_s_e_d_ /* the ; gets added */
139
140
141 #define add_submodule( ) \
142     p_submodule = vlc_submodule_create( p_module )
143
144 #define add_requirement( cap ) \
145     if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
146                         (void *)(intptr_t)(CPU_CAPABILITY_##cap))) goto error
147
148 #define add_shortcut( shortcut ) \
149     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, (void*)(shortcut))) \
150         goto error
151
152 #define set_shortname( shortname ) \
153     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \
154                         (void*)(shortname))) goto error;
155
156 #define set_description( desc ) \
157     if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, (void*)(desc))) \
158         goto error
159
160 #define set_help( help ) \
161     if (vlc_module_set (p_submodule, VLC_MODULE_HELP, (void*)(help))) \
162         goto error
163
164 #define set_capability( cap, score ) \
165     if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, (void *)(cap)) \
166      || vlc_module_set (p_submodule, VLC_MODULE_SCORE, \
167                         (void *)(intptr_t)(score))) \
168         goto error
169
170 #define set_callbacks( activate, deactivate ) \
171     if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, (void *)(activate)) \
172      || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, \
173                         (void *)(deactivate))) \
174         goto error
175
176 #define linked_with_a_crap_library_which_uses_atexit( ) \
177     if (vlc_module_set (p_submodule, VLC_MODULE_UNLOADABLE, NULL)) goto error
178