X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0b9ab0bd824b6b9c93849928d67de1ec71e7c167..d11e8786ed13b72766eea18cb577cc00f9f08f41:/include/wx/dynload.h diff --git a/include/wx/dynload.h b/include/wx/dynload.h index fd813044a4..d70c8cfa1f 100644 --- a/include/wx/dynload.h +++ b/include/wx/dynload.h @@ -7,13 +7,13 @@ // Created: 03/12/01 // RCS-ID: $Id$ // Copyright: (c) 2001 Ron Lee <ron@debian.org> -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_DYNAMICLOADER_H__ #define _WX_DYNAMICLOADER_H__ -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "dynload.h" #endif @@ -25,163 +25,111 @@ #if wxUSE_DYNAMIC_LOADER -#include "wx/hash.h" +#include "wx/dynlib.h" +#include "wx/hashmap.h" #include "wx/module.h" +class WXDLLIMPEXP_BASE wxPluginLibrary; -// Ugh, I'd much rather this was typesafe, but no time -// to rewrite wxHashTable right now.. - -typedef wxHashTable wxDLManifest; -typedef wxHashTable wxDLImports; - -// ---------------------------------------------------------------------------- -// conditional compilation -// ---------------------------------------------------------------------------- - - // 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 <os2.h> - typedef HMODULE wxDllType; -#elif defined(HAVE_DLOPEN) -#include <dlfcn.h> - typedef void *wxDllType; -#elif defined(HAVE_SHL_LOAD) -#include <dl.h> - typedef shl_t wxDllType; -#elif defined(__WINDOWS__) -#include <windows.h> // needed to get HMODULE - typedef HMODULE wxDllType; -#elif defined(__DARWIN__) - typedef void *wxDllType; -#elif defined(__WXMAC__) - typedef CFragConnectionID wxDllType; -#else -#error "wxLibrary can't be compiled on this platform, sorry." -#endif - - // LoadLibrary is defined in windows.h as LoadLibraryA, but wxDllLoader - // method should be called LoadLibrary, not LoadLibraryA or LoadLibraryW! - -#if defined(__WIN32__) && defined(LoadLibrary) -# include "wx/msw/winundef.h" -#endif +WX_DECLARE_STRING_HASH_MAP_WITH_DECL(wxPluginLibrary *, wxDLManifest, + class WXDLLIMPEXP_BASE); +typedef wxDLManifest wxDLImports; // --------------------------------------------------------------------------- -// wxDllLoader +// wxPluginLibrary // --------------------------------------------------------------------------- - // Cross platform wrapper for dlopen and friends. - // There are no instances of this class, it simply - // serves as a namespace for its static member functions. +// NOTE: Do not attempt to use a base class pointer to this class. +// wxDL is not virtual and we deliberately hide some of it's +// methods here. +// +// Unless you know exacty why you need to, you probably shouldn't +// instantiate this class directly anyway, use wxPluginManager +// instead. -class WXDLLEXPORT wxDllLoader +class WXDLLIMPEXP_BASE wxPluginLibrary : public wxDynamicLibrary { public: - // 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. - // The platform specific library extension is automatically appended. - - static wxDllType Load(const wxString& name); - - // The same as Load, except 'name' is searched for without modification. + static wxDLImports* ms_classes; // Static hash of all imported classes. - static wxDllType LoadLibrary(const wxString& name); - static void UnloadLibrary(wxDllType dll); + wxPluginLibrary( const wxString &libname, int flags = wxDL_DEFAULT ); + ~wxPluginLibrary(); - // return a valid handle for the main program itself or NULL if - // back linking is not supported by the current platform (e.g. Win32) + wxPluginLibrary *RefLib(); + bool UnrefLib(); - static wxDllType GetProgramHandle(); + // These two are called by the PluginSentinel on (PLUGGABLE) object + // creation/destruction. There is usually no reason for the user to + // call them directly. We have to separate this from the link count, + // since the two are not interchangeable. - // resolve a symbol in a loaded DLL, such as a variable or function - // name. dllHandle is a handle previously returned by LoadLibrary(), - // symbol is the (possibly mangled) name of the symbol. - // (use extern "C" to export unmangled names) - // - // Since it is perfectly valid for the returned symbol to actually be - // NULL, that is not always indication of an error. Pass and test the - // parameter 'success' for a true indication of success or failure to - // load the symbol. - // - // Returns a pointer to the symbol on success. - - static void *GetSymbol(wxDllType dllHandle, const wxString &name, bool *success = 0); - - // return the platform standard DLL extension (with leading dot) - - static const wxString &GetDllExt() { return ms_dllext; } - -private: - - wxDllLoader(); // forbid construction of objects - static const wxString ms_dllext; // Platform specific shared lib suffix. -}; - - -// --------------------------------------------------------------------------- -// wxDynamicLibrary -// --------------------------------------------------------------------------- + // FIXME: for even better debugging PluginSentinel should register + // the name of the class created too, then we can state + // exactly which object was not destroyed which may be + // difficult to find otherwise. Also this code should + // probably only be active in DEBUG mode, but let's just + // get it right first. -class wxDLManifestEntry -{ -public: - - static wxDLImports ms_classes; // Static hash of all imported classes. - - wxDLManifestEntry( const wxString &libname ); - ~wxDLManifestEntry(); - - wxDLManifestEntry *Ref() { ++m_count; return this; } - bool Unref() { return (m_count-- < 2) ? (delete this, TRUE) : FALSE; } - - bool IsLoaded() const { return m_count > 0; } - - wxDllType GetLinkHandle() const { return m_handle; } - wxDllType GetProgramHandle() const { return wxDllLoader::GetProgramHandle(); } - void *GetSymbol(const wxString &symbol, bool *success = 0) + void RefObj() { ++m_objcount; } + void UnrefObj() { - return wxDllLoader::GetSymbol( m_handle, symbol, success ); + wxASSERT_MSG( m_objcount > 0, _T("Too many objects deleted??") ); + --m_objcount; } -private: + // Override/hide some base class methods - // Order of these three *is* important, do not change it + bool IsLoaded() const { return m_linkcount > 0; } + void Unload() { UnrefLib(); } - wxClassInfo *m_before; // sm_first before loading this lib - wxDllType m_handle; // Handle from dlopen. - wxClassInfo *m_after; // ..and after. +private: - size_t m_count; // Ref count of Link and Create calls. - wxModuleList m_wxmodules; // any wxModules that we initialised. + wxClassInfo *m_before; // sm_first before loading this lib + wxClassInfo *m_after; // ..and after. - void UpdateClassInfo(); // Update the wxClassInfo table - void RestoreClassInfo(); // Restore the original wxClassInfo state. - void RegisterModules(); // Init any wxModules in the lib. - void UnregisterModules(); // Cleanup any wxModules we installed. + size_t m_linkcount; // Ref count of library link calls + size_t m_objcount; // ..and (pluggable) object instantiations. + wxModuleList m_wxmodules; // any wxModules that we initialised. -DECLARE_NO_COPY_CLASS(wxDLManifestEntry) + void UpdateClasses(); // Update ms_classes + void RestoreClasses(); // Removes this library from ms_classes + void RegisterModules(); // Init any wxModules in the lib. + void UnregisterModules(); // Cleanup any wxModules we installed. + + DECLARE_NO_COPY_CLASS(wxPluginLibrary) }; -class WXDLLEXPORT wxDynamicLibrary +class WXDLLIMPEXP_BASE wxPluginManager { public: // Static accessors. - static wxDLManifestEntry *Link(const wxString &libname); - static bool Unlink(const wxString &libname); + static wxPluginLibrary *LoadLibrary( const wxString &libname, + int flags = wxDL_DEFAULT ); + static bool UnloadLibrary(const wxString &libname); + + // This is used by wxDllLoader. It's wrapped in the compatibility + // macro because it's of arguable use outside of that. + +#if WXWIN_COMPATIBILITY_2_2 + wxDEPRECATED( static wxPluginLibrary *GetObjectFromHandle(wxDllType handle) ); +#endif // Instance methods. - wxDynamicLibrary(const wxString &libname); - ~wxDynamicLibrary(); + wxPluginManager() : m_entry(NULL) {} + wxPluginManager(const wxString &libname, int flags = wxDL_DEFAULT) + { + Load(libname, flags); + } + ~wxPluginManager() { if ( IsLoaded() ) Unload(); } + + bool Load(const wxString &libname, int flags = wxDL_DEFAULT); + void Unload(); bool IsLoaded() const { return m_entry && m_entry->IsLoaded(); } void *GetSymbol(const wxString &symbol, bool *success = 0) @@ -189,19 +137,28 @@ public: return m_entry->GetSymbol( symbol, success ); } + static void CreateManifest() { ms_manifest = new wxDLManifest(wxKEY_STRING); } + static void ClearManifest() { delete ms_manifest; ms_manifest = NULL; } + private: + // return the pointer to the entry for the library with given name in + // ms_manifest or NULL if none + static wxPluginLibrary *FindByName(const wxString& name) + { + const wxDLManifest::iterator i = ms_manifest->find(name); - static wxDLManifest ms_manifest; // Static hash of loaded libs. - wxDLManifestEntry *m_entry; // Cache our entry in the manifest. + return i == ms_manifest->end() ? NULL : i->second; + } + + static wxDLManifest* ms_manifest; // Static hash of loaded libs. + wxPluginLibrary* m_entry; // Cache our entry in the manifest. // We could allow this class to be copied if we really // wanted to, but not without modification. - -DECLARE_NO_COPY_CLASS(wxDynamicLibrary) + DECLARE_NO_COPY_CLASS(wxPluginManager) }; #endif // wxUSE_DYNAMIC_LOADER #endif // _WX_DYNAMICLOADER_H__ -// vi:sts=4:sw=4:et