X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ed58dbeab64d18a0f869ea8e1610a0a88ad7b22c..fe6b43a36e8c641c86404cd9369ad3f1402d1546:/include/wx/dynlib.h?ds=sidebyside diff --git a/include/wx/dynlib.h b/include/wx/dynlib.h index e6b0bc8c14..a08ed217a8 100644 --- a/include/wx/dynlib.h +++ b/include/wx/dynlib.h @@ -1,11 +1,11 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: dynlib.cpp -// Purpose: Dynamic library management -// Author: Guilhem Lavaux +// Name: wx/dynlib.h +// Purpose: Dynamic library loading classes +// Author: Guilhem Lavaux, Vadim Zeitlin, Vaclav Slavik // Modified by: // Created: 20/07/98 // RCS-ID: $Id$ -// Copyright: (c) Guilhem Lavaux +// Copyright: (c) 1998 Guilhem Lavaux // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// @@ -33,19 +33,23 @@ # endif // Unix flavour #endif // !Unix or already have some HAVE_xxx defined -#if defined(HAVE_DLOPEN) +// Note: WXPM/EMX has to be tested first, since we want to use +// native version, even if configure detected presence of DLOPEN. +#if defined(__WXPM__) || defined(__EMX__) +# define INCL_DOS +# include + typedef HMODULE wxDllType; +#elif defined(HAVE_DLOPEN) # include typedef void *wxDllType; #elif defined(HAVE_SHL_LOAD) # include typedef shl_t wxDllType; #elif defined(__WINDOWS__) -# include - typedef HMODULE wxDllType; -#elif defined(__OS2__) -# define INCL_DOS -# include +# include // needed to get HMODULE typedef HMODULE wxDllType; +#elif defined(__DARWIN__) + typedef void *wxDllType; #elif defined(__WXMAC__) typedef CFragConnectionID wxDllType; #else @@ -59,54 +63,126 @@ #endif // ---------------------------------------------------------------------------- -// wxDllLoader +// wxDllLoader: low level DLL functions, use wxDynamicLibrary in your code // ---------------------------------------------------------------------------- -/** wxDllLoader is a class providing an interface similar to unix's - dlopen(). It is used by the wxLibrary framework and manages the - actual loading of DLLs and the resolving of symbols in them. - There are no instances of this class, it simply serves as a - namespace for its static member functions. + +/* + wxDllLoader is a class providing an interface similar to unix's dlopen(). + It is used by wxDynamicLibrary wxLibrary and manages the actual loading of + DLLs and the resolving of symbols in them. There are no instances of this + class, it simply serves as a namespace for its static member functions. */ -class wxDllLoader +class WXDLLEXPORT wxDllLoader { - public: - /** This function loads a shared library into memory, with libname - being the basename of the library, without the filename - extension. No initialisation of the library will be done. - @param libname Name of the shared object to load. - @param success Must point to a bool variable which will be set to TRUE or FALSE. - @return A handle to the loaded DLL. Use success parameter to test if it is valid. - */ - static wxDllType LoadLibrary(const wxString & libname, bool *success = NULL); - /** This function unloads the shared library. */ - static void UnloadLibrary(wxDllType dll); - /** This function returns a valid handle for the main program - itself. */ - static wxDllType GetProgramHandle(void); - /** This function resolves a symbol in a loaded DLL, such as a +public: + /* + This function loads the shared library libname into memory. + + libname may be either the full path to the file or just the filename in + which case the library is searched for in all standard locations + (use GetDllExt() to construct the filename) + + if success pointer is not NULL, it will be filled with TRUE if everything + went ok and FALSE otherwise + */ + static wxDllType LoadLibrary(const wxString& libname, bool *success = NULL); + + /* + This function unloads the shared library previously loaded with + LoadLibrary + */ + static void UnloadLibrary(wxDllType dll); + + /* + This function returns a valid handle for the main program + itself or NULL if back linking is not supported by the current platform + (e.g. Win32). + */ + static wxDllType GetProgramHandle(); + + /* + This function resolves a symbol in a loaded DLL, such as a variable or function name. - @param dllHandle Handle of the DLL, as returned by LoadDll(). - @param name Name of the symbol. - @return A pointer to the symbol. - */ - static void * GetSymbol(wxDllType dllHandle, const wxString &name); - private: - /// forbid construction of objects - wxDllLoader(); + + dllHandle Handle of the DLL, as returned by LoadDll(). + name Name of the symbol. + + Returns the pointer to the symbol or NULL on error. + */ + static void * GetSymbol(wxDllType dllHandle, const wxString &name); + + // return the standard DLL extension (with leading dot) for this platform + static wxString GetDllExt(); + +private: + // forbid construction of objects + wxDllLoader(); }; // ---------------------------------------------------------------------------- -// wxLibrary +// wxDynamicLibrary - friendly interface to wxDllLoader // ---------------------------------------------------------------------------- -class wxLibrary : public wxObject +class WXDLLEXPORT wxDynamicLibrary { public: - wxHashTable classTable; + // ctors + wxDynamicLibrary() { m_library = 0; } + wxDynamicLibrary(const wxString& name) { Load(name); } + + // return TRUE if the library was loaded successfully + bool IsLoaded() const { return m_library != 0; } + operator bool() const { return IsLoaded(); } + + // load the library with the given name (full or not), return TRUE on + // success + bool Load(const wxString& name) + { + m_library = wxDllLoader::LoadLibrary(name); + + return IsLoaded(); + } + + // unload the library, also done automatically in dtor + void Unload() + { + if ( IsLoaded() ) + wxDllLoader::UnloadLibrary(m_library); + } + + // load a symbol from the library, return NULL if an error occured or + // symbol wasn't found + void *GetSymbol(const wxString& name) const + { + wxCHECK_MSG( IsLoaded(), NULL, + _T("can't load symbol from unloaded library") ); + + return wxDllLoader::GetSymbol(m_library, name); + } + + // unload the library + // + // NB: dtor is not virtual, don't derive from this class + ~wxDynamicLibrary() { Unload(); } + +private: + // the handle to DLL or NULL + wxDllType m_library; + + // no copy ctor/assignment operators (or we'd try to unload the library + // twice) + DECLARE_NO_COPY_CLASS(wxDynamicLibrary) +}; + +// ---------------------------------------------------------------------------- +// wxLibrary +// ---------------------------------------------------------------------------- +class WXDLLEXPORT wxLibrary : public wxObject +{ public: wxLibrary(wxDllType handle); - ~wxLibrary(); + virtual ~wxLibrary(); // Get a symbol from the dynamic library void *GetSymbol(const wxString& symbname); @@ -118,15 +194,16 @@ protected: void PrepareClasses(wxClassInfo *first); wxDllType m_handle; -}; - +public: + wxHashTable classTable; +}; // ---------------------------------------------------------------------------- // wxLibraries // ---------------------------------------------------------------------------- -class wxLibraries +class WXDLLEXPORT wxLibraries { public: wxLibraries();