git.sesse.net Git - vlc/blob - src/misc/modules_plugin.h.in

   1 /*****************************************************************************
   2  * modules_plugin.h : Plugin management functions used by the core application.
   3  *****************************************************************************
   4  * Copyright (C) 2001 VideoLAN
   5  * $Id: modules_plugin.h.in,v 1.3 2002/08/08 00:35:11 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  * Inline functions for handling dynamic modules
  26  *****************************************************************************/
  27
  28 /*****************************************************************************
  29  * module_load: load a dynamic library
  30  *****************************************************************************
  31  * This function loads a dynamically linked library using a system dependant
  32  * method, and returns a non-zero value on error, zero otherwise.
  33  *****************************************************************************/
  34 static int module_load( const char * psz_filename, module_handle_t * handle )
  35 {
  36 #ifdef SYS_BEOS
  37     *handle = load_add_on( psz_filename );
  38     return( *handle < 0 );
  39
  40 #elif defined(WIN32)
  41     *handle = LoadLibrary( psz_filename );
  42     return( *handle == NULL );
  43
  44 #elif defined(RTLD_NOW)
  45 #   if defined(SYS_LINUX)
  46     /* We should NOT open modules with RTLD_GLOBAL, or we are going to get
  47      * namespace collisions when two modules have common public symbols,
  48      * but ALSA is being a pest here. */
  49     if( strstr( psz_filename, "alsa.so" ) )
  50     {
  51         *handle = dlopen( psz_filename, RTLD_NOW | RTLD_GLOBAL );
  52         return( *handle == NULL );
  53     }
  54 #   endif
  55     *handle = dlopen( psz_filename, RTLD_NOW );
  56     return( *handle == NULL );
  57
  58 #else
  59     *handle = dlopen( psz_filename, DL_LAZY );
  60     return( *handle == NULL );
  61
  62 #endif
  63 }
  64
  65 /*****************************************************************************
  66  * module_unload: unload a dynamic library
  67  *****************************************************************************
  68  * This function unloads a previously opened dynamically linked library
  69  * using a system dependant method. No return value is taken in consideration,
  70  * since some libraries sometimes refuse to close properly.
  71  *****************************************************************************/
  72 static void module_unload( module_handle_t handle )
  73 {
  74 #ifdef SYS_BEOS
  75     unload_add_on( handle );
  76
  77 #elif defined(WIN32)
  78     FreeLibrary( handle );
  79
  80 #else
  81     dlclose( handle );
  82
  83 #endif
  84     return;
  85 }
  86
  87 /*****************************************************************************
  88  * module_getsymbol: get a symbol from a dynamic library
  89  *****************************************************************************
  90  * This function queries a loaded library for a symbol specified in a
  91  * string, and returns a pointer to it. We don't check for dlerror() or
  92  * similar functions, since we want a non-NULL symbol anyway.
  93  *****************************************************************************/
  94 static void * _module_getsymbol( module_handle_t handle,
  95                                  const char * psz_function )
  96 {
  97 #ifdef SYS_BEOS
  98     void * p_symbol;
  99     if( B_OK == get_image_symbol( handle, psz_function,
 100                                   B_SYMBOL_TYPE_TEXT, &p_symbol ) )
 101     {
 102         return( p_symbol );
 103     }
 104     else
 105     {
 106         return( NULL );
 107     }
 108
 109 #elif defined(WIN32)
 110     return( (void *)GetProcAddress( handle, psz_function ) );
 111
 112 #else
 113     return( dlsym( handle, psz_function ) );
 114
 115 #endif
 116 }
 117
 118 static void * module_getsymbol( module_handle_t handle,
 119                                 const char * psz_function )
 120 {
 121     void * p_symbol = _module_getsymbol( handle, psz_function );
 122
 123     /* MacOS X dl library expects symbols to begin with "_". So do
 124      * some other operating systems. That's really lame, but hey, what
 125      * can we do ? */
 126     if( p_symbol == NULL )
 127     {
 128         char *psz_call = malloc( strlen( psz_function ) + 2 );
 129
 130         strcpy( psz_call + 1, psz_function );
 131         psz_call[ 0 ] = '_';
 132         p_symbol = _module_getsymbol( handle, psz_call );
 133         free( psz_call );
 134     }
 135
 136     return p_symbol;
 137 }
 138
 139 /*****************************************************************************
 140  * module_error: wrapper for dlerror()
 141  *****************************************************************************
 142  * This function returns the error message of the last module operation. It
 143  * returns the string "failed" on systems which do not have a dlerror() like
 144  * function. psz_buffer can be used to store temporary data, it is guaranteed
 145  * to be kept intact until the return value of module_error has been used.
 146  *****************************************************************************/
 147 static const char * module_error( char *psz_buffer )
 148 {
 149 #if defined(SYS_BEOS)
 150     return( "failed" );
 151
 152 #elif defined(WIN32)
 153     int i, i_error = GetLastError();
 154
 155     FormatMessage( FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
 156                    NULL, i_error, MAKELANGID (LANG_NEUTRAL, SUBLANG_DEFAULT),
 157                    (LPTSTR) psz_buffer, 256, NULL);
 158
 159     /* Go to the end of the string */
 160     for( i = 0;
 161          psz_buffer[i] && psz_buffer[i] != '\r' && psz_buffer[i] != '\n';
 162          i++ ) {};
 163
 164     if( psz_buffer[i] )
 165     {
 166         snprintf( psz_buffer + i, 256 - i, " (error %i)", i_error );
 167         psz_buffer[ 255 ] = '\0';
 168     }
 169
 170     return psz_buffer;
 171
 172 #else
 173     return( dlerror() );
 174
 175 #endif
 176 }
 177
 178 /*****************************************************************************
 179  * STORE_SYMBOLS: store known symbols into p_symbols for plugin access.
 180  *****************************************************************************/