include/wx/dynlib.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dynlib.cpp
   3 // Purpose:     Dynamic library management
   4 // Author:      Guilhem Lavaux
   5 // Modified by:
   6 // Created:     20/07/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Guilhem Lavaux
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_DYNLIB_H__
  13 #define _WX_DYNLIB_H__
  14
  15 #ifdef __GNUG__
  16 #   pragma interface
  17 #endif
  18
  19 #include <wx/setup.h>
  20
  21 #if wxUSE_DYNLIB_CLASS
  22
  23 #include <wx/string.h>
  24 #include <wx/list.h>
  25 #include <wx/hash.h>
  26
  27 // this is normally done by configure, but I leave it here for now...
  28 #if defined(__UNIX__) && !(defined(HAVE_DLOPEN) || defined(HAVE_SHL_LOAD))
  29 #   if defined(__LINUX__) || defined(__SOLARIS__) || defined(__SUNOS__) || defined(__FREEBSD__)
  30 #      define HAVE_DLOPEN
  31 #   elif defined(__HPUX__)
  32 #      define HAVE_SHL_LOAD
  33 #   endif // Unix flavour
  34 #endif // !Unix or already have some HAVE_xxx defined
  35
  36 #if defined(HAVE_DLOPEN)
  37 #   include <dlfcn.h>
  38     typedef void *wxDllType;
  39 #elif defined(HAVE_SHL_LOAD)
  40 #   include <dl.h>
  41     typedef shl_t wxDllType;
  42 #elif defined(__WINDOWS__)
  43 #   include <windows.h>
  44     typedef HMODULE wxDllType;
  45 #elif defined(__WXMAC__)
  46     typedef CFragConnectionID wxDllType;
  47 #else
  48 #   error "wxLibrary can't be compiled on this platform, sorry."
  49 #endif // OS
  50
  51 // defined in windows.h
  52 // This breaks app.cpp if RICHEDIT is included.
  53 #if 0
  54 #ifdef LoadLibrary
  55 #   undef LoadLibrary
  56 #endif
  57 #endif
  58
  59 // ----------------------------------------------------------------------------
  60 // wxDllLoader
  61 // ----------------------------------------------------------------------------
  62 /** wxDllLoader is a class providing an interface similar to unix's
  63     dlopen(). It is used by the wxLibrary framework and manages the
  64     actual loading of DLLs and the resolving of symbols in them.
  65     There are no instances of this class, it simply serves as a
  66     namespace for its static member functions.
  67 */
  68 class wxDllLoader
  69 {
  70  public:
  71    /** This function loads a shared library into memory, with libname
  72        being the basename of the library, without the filename
  73        extension. No initialisation of the library will be done.
  74        @param libname Name of the shared object to load.
  75        @param success Must point to a bool variable which will be set to TRUE or FALSE.
  76        @return A handle to the loaded DLL. Use success parameter to test if it is valid.
  77    */
  78    static wxDllType LoadLibrary(const wxString & libname, bool *success);
  79    /** This function unloads the shared library. */
  80    static void UnloadLibrary(wxDllType dll);
  81    /** This function returns a valid handle for the main program
  82        itself. */
  83    static wxDllType GetProgramHandle(void);
  84    /** This function resolves a symbol in a loaded DLL, such as a
  85        variable or function name.
  86        @param dllHandle Handle of the DLL, as returned by LoadDll().
  87        @param name Name of the symbol.
  88        @return A pointer to the symbol.
  89    */
  90    static void * GetSymbol(wxDllType dllHandle, const wxString &name);
  91  private:
  92    /// forbid construction of objects
  93    wxDllLoader();
  94 };
  95
  96 // ----------------------------------------------------------------------------
  97 // wxLibrary
  98 // ----------------------------------------------------------------------------
  99
 100 class wxLibrary : public wxObject
 101 {
 102 public:
 103     wxHashTable classTable;
 104
 105 public:
 106     wxLibrary(wxDllType handle);
 107     ~wxLibrary();
 108
 109     // Get a symbol from the dynamic library
 110     void *GetSymbol(const wxString& symbname);
 111
 112     // Create the object whose classname is "name"
 113     wxObject *CreateObject(const wxString& name);
 114
 115 protected:
 116     void PrepareClasses(wxClassInfo *first);
 117
 118     wxDllType m_handle;
 119 };
 120
 121
 122
 123 // ----------------------------------------------------------------------------
 124 // wxLibraries
 125 // ----------------------------------------------------------------------------
 126
 127 class wxLibraries
 128 {
 129 public:
 130     wxLibraries();
 131     ~wxLibraries();
 132
 133     // caller is responsible for deleting the returned pointer if !NULL
 134     wxLibrary *LoadLibrary(const wxString& basename);
 135
 136     wxObject *CreateObject(const wxString& name);
 137
 138 protected:
 139     wxList m_loaded;
 140 };
 141
 142 // ----------------------------------------------------------------------------
 143 // Global variables
 144 // ----------------------------------------------------------------------------
 145
 146 extern wxLibraries wxTheLibraries;
 147
 148 // ----------------------------------------------------------------------------
 149 // Interesting defines
 150 // ----------------------------------------------------------------------------
 151
 152 #define WXDLL_ENTRY_FUNCTION() \
 153 extern "C" wxClassInfo *wxGetClassFirst(); \
 154 wxClassInfo *wxGetClassFirst() { \
 155   return wxClassInfo::GetFirst(); \
 156 }
 157
 158 #endif // wxUSE_DYNLIB_CLASS
 159
 160 #endif // _WX_DYNLIB_H__