X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/77ffb5937e89927b621128789401db8921fe580f..259c43f679ca655362b5a439e11c87fc0666d663:/include/wx/dynlib.h diff --git a/include/wx/dynlib.h b/include/wx/dynlib.h index 66125b7c28..64aeb305cb 100644 --- a/include/wx/dynlib.h +++ b/include/wx/dynlib.h @@ -6,32 +6,33 @@ // Created: 20/07/98 // RCS-ID: $Id$ // Copyright: (c) 1998 Guilhem Lavaux -// Licence: wxWidgets licence +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_DYNLIB_H__ #define _WX_DYNLIB_H__ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) -# pragma interface "dynlib.h" -#endif - -#include "wx/setup.h" +#include "wx/defs.h" #if wxUSE_DYNLIB_CLASS #include "wx/string.h" +#include "wx/dynarray.h" -// FIXME: can this go in private.h or something too?? #if defined(__WXPM__) || defined(__EMX__) -#define INCL_DOS -#include +#include "wx/os2/private.h" #endif #ifdef __WXMSW__ #include "wx/msw/private.h" #endif +#if defined(HAVE_DLERROR) && !defined(__EMX__) + #define wxHAVE_DYNLIB_ERROR +#endif + +class WXDLLIMPEXP_BASE wxDynamicLibraryDetailsCreator; + // ---------------------------------------------------------------------------- // conditional compilation // ---------------------------------------------------------------------------- @@ -62,21 +63,18 @@ enum wxDLFlags { wxDL_LAZY = 0x00000001, // resolve undefined symbols at first use + // (only works on some Unix versions) wxDL_NOW = 0x00000002, // resolve undefined symbols on load + // (default, always the case under Win32) wxDL_GLOBAL = 0x00000004, // export extern symbols to subsequently // loaded libs. - wxDL_VERBATIM = 0x00000008, // Attempt to load the supplied library + wxDL_VERBATIM = 0x00000008, // attempt to load the supplied library // name without appending the usual dll // filename extension. - wxDL_NOSHARE = 0x00000010, // load new DLL, don't reuse already loaded + // (only for wxPluginManager) - // FIXME: why? (VZ) -#ifdef __osf__ - wxDL_DEFAULT = wxDL_LAZY -#else - wxDL_DEFAULT = wxDL_LAZY | wxDL_GLOBAL -#endif + wxDL_DEFAULT = wxDL_NOW // default flags correspond to Win32 }; enum wxDynamicLibraryCategory @@ -106,9 +104,62 @@ enum wxPluginCategory #define wxDYNLIB_FUNCTION(type, name, dynlib) \ type pfn ## name = (type)(dynlib).GetSymbol(_T(#name)) -// --------------------------------------------------------------------------- -// wxDynamicLibrary -// --------------------------------------------------------------------------- +// ---------------------------------------------------------------------------- +// wxDynamicLibraryDetails: contains details about a loaded wxDynamicLibrary +// ---------------------------------------------------------------------------- + +class WXDLLIMPEXP_BASE wxDynamicLibraryDetails +{ +public: + // ctor, normally never used as these objects are only created by + // wxDynamicLibrary::ListLoaded() + wxDynamicLibraryDetails() { m_address = NULL; m_length = 0; } + + // get the (base) name + wxString GetName() const { return m_name; } + + // get the full path of this object + wxString GetPath() const { return m_path; } + + // get the load address and the extent, return true if this information is + // available + bool GetAddress(void **addr, size_t *len) const + { + if ( !m_address ) + return false; + + if ( addr ) + *addr = m_address; + if ( len ) + *len = m_length; + + return true; + } + + // return the version of the DLL (may be empty if no version info) + wxString GetVersion() const + { + return m_version; + } + +private: + wxString m_name, + m_path, + m_version; + + void *m_address; + size_t m_length; + + friend class wxDynamicLibraryDetailsCreator; +}; + +WX_DECLARE_USER_EXPORTED_OBJARRAY(wxDynamicLibraryDetails, + wxDynamicLibraryDetailsArray, + WXDLLIMPEXP_BASE); + +// ---------------------------------------------------------------------------- +// wxDynamicLibrary: represents a handle to a DLL/shared object +// ---------------------------------------------------------------------------- class WXDLLIMPEXP_BASE wxDynamicLibrary { @@ -131,11 +182,16 @@ public: // to use it polymorphically. ~wxDynamicLibrary() { Unload(); } - // return TRUE if the library was loaded successfully + // return true if the library was loaded successfully bool IsLoaded() const { return m_handle != 0; } // load the library with the given name (full or not), return true if ok - bool Load(wxString libname, int flags = wxDL_DEFAULT); + bool Load(const wxString& libname, int flags = wxDL_DEFAULT); + + // raw function for loading dynamic libs: always behaves as if + // wxDL_VERBATIM were specified and doesn't log error message if the + // library couldn't be loaded but simply returns NULL + static wxDllType RawLoad(const wxString& libname, int flags = wxDL_DEFAULT); // detach the library object from its handle, i.e. prevent the object from // unloading the library in its dtor -- the caller is now responsible for @@ -151,6 +207,16 @@ public: // Return the raw handle from dlopen and friends. wxDllType GetLibHandle() const { return m_handle; } + // check if the given symbol is present in the library, useful to verify if + // a loadable module is our plugin, for example, without provoking error + // messages from GetSymbol() + bool HasSymbol(const wxString& name) const + { + bool ok; + DoGetSymbol(name, &ok); + return ok; + } + // resolve a symbol in a loaded DLL, such as a variable or function name. // 'name' is the (possibly mangled) name of the symbol. (use extern "C" to // export unmangled names) @@ -162,8 +228,47 @@ public: // // Returns a pointer to the symbol on success, or NULL if an error occurred // or the symbol wasn't found. - void *GetSymbol(const wxString& name, bool *success = 0) const; + void *GetSymbol(const wxString& name, bool *success = NULL) const; + + // low-level version of GetSymbol() + static void *RawGetSymbol(wxDllType handle, const wxString& name); + void *RawGetSymbol(const wxString& name) const + { +#if defined (__WXPM__) || defined(__EMX__) + return GetSymbol(name); +#else + return RawGetSymbol(m_handle, name); +#endif + } + +#ifdef __WXMSW__ + // this function is useful for loading functions from the standard Windows + // DLLs: such functions have an 'A' (in ANSI build) or 'W' (in Unicode, or + // wide character build) suffix if they take string parameters + static void *RawGetSymbolAorW(wxDllType handle, const wxString& name) + { + return RawGetSymbol + ( + handle, + name + +#if wxUSE_UNICODE + L'W' +#else + 'A' +#endif + ); + } + + void *GetSymbolAorW(const wxString& name) const + { + return RawGetSymbolAorW(m_handle, name); + } +#endif // __WXMSW__ + // return all modules/shared libraries in the address space of this process + // + // returns an empty array if not implemented or an error occurred + static wxDynamicLibraryDetailsArray ListLoaded(); // return platform-specific name of dynamic library with proper extension // and prefix (e.g. "foo.dll" on Windows or "libfoo.so" on Linux) @@ -186,6 +291,15 @@ public: #endif protected: + // common part of GetSymbol() and HasSymbol() + void *DoGetSymbol(const wxString& name, bool *success = 0) const; + +#ifdef wxHAVE_DYNLIB_ERROR + // log the error after a dlxxx() function failure + static void Error(); +#endif // wxHAVE_DYNLIB_ERROR + + // platform specific shared lib suffix. static const wxChar *ms_dllext; @@ -204,6 +318,8 @@ protected: #if WXWIN_COMPATIBILITY_2_2 && wxUSE_DYNAMIC_LOADER +#include "wx/object.h" + /* wxDllLoader is a class providing an interface similar to unix's dlopen(). It is used by wxDynamicLibrary wxLibrary and manages the actual loading of @@ -220,11 +336,11 @@ public: 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 + if success pointer is not NULL, it will be filled with true if everything + went ok and false otherwise */ static wxDllType LoadLibrary(const wxString& name, bool *success = NULL); - + /* This function unloads the shared library previously loaded with LoadLibrary