X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/550343399aa1355469ffed72c8cf84c732dcf98b..7422d79765db9e7280da187be7a1b016491b8cfd:/include/wx/dynlib.h diff --git a/include/wx/dynlib.h b/include/wx/dynlib.h index 04a10d4fc8..a5f60686cf 100644 --- a/include/wx/dynlib.h +++ b/include/wx/dynlib.h @@ -19,19 +19,12 @@ #include "wx/string.h" #include "wx/dynarray.h" -#if defined(__OS2__) || defined(__EMX__) -#include "wx/os2/private.h" -#endif - -#ifdef __WXMSW__ -#include "wx/msw/private.h" -#endif - -#if defined(HAVE_DLERROR) && !defined(__EMX__) +// note that we have our own dlerror() implementation under Darwin +#if (defined(HAVE_DLERROR) && !defined(__EMX__)) || defined(__DARWIN__) #define wxHAVE_DYNLIB_ERROR #endif -class WXDLLIMPEXP_BASE wxDynamicLibraryDetailsCreator; +class WXDLLIMPEXP_FWD_BASE wxDynamicLibraryDetailsCreator; // ---------------------------------------------------------------------------- // conditional compilation @@ -40,15 +33,16 @@ class WXDLLIMPEXP_BASE wxDynamicLibraryDetailsCreator; // Note: __OS2__/EMX has to be tested first, since we want to use // native version, even if configure detected presence of DLOPEN. #if defined(__OS2__) || defined(__EMX__) || defined(__WINDOWS__) - typedef HMODULE wxDllType; + typedef WXHMODULE wxDllType; +#elif defined(__DARWIN__) + // Don't include dlfcn.h on Darwin, we may be using our own replacements. + typedef void *wxDllType; #elif defined(HAVE_DLOPEN) #include typedef void *wxDllType; #elif defined(HAVE_SHL_LOAD) #include typedef shl_t wxDllType; -#elif defined(__DARWIN__) - typedef void *wxDllType; #elif defined(__WXMAC__) #include typedef CFragConnectionID wxDllType; @@ -71,9 +65,21 @@ enum wxDLFlags wxDL_VERBATIM = 0x00000008, // attempt to load the supplied library // name without appending the usual dll // filename extension. + + // this flag is obsolete, don't use wxDL_NOSHARE = 0x00000010, // load new DLL, don't reuse already loaded // (only for wxPluginManager) + wxDL_QUIET = 0x00000020, // don't log an error if failed to load + + // this flag is dangerous, for internal use of wxMSW only, don't use at all + // and especially don't use directly, use wxLoadedDLL instead if you really + // do need it + wxDL_GET_LOADED = 0x00000040, // Win32 only: return handle of already + // loaded DLL or NULL otherwise; Unload() + // should not be called so don't forget to + // Detach() if you use this function + wxDL_DEFAULT = wxDL_NOW // default flags correspond to Win32 }; @@ -102,7 +108,64 @@ enum wxPluginCategory // type only once, as the first parameter, and creating a variable of this type // called "pfn" initialized with the "name" from the "dynlib" #define wxDYNLIB_FUNCTION(type, name, dynlib) \ - type pfn ## name = (type)(dynlib).GetSymbol(_T(#name)) + type pfn ## name = (type)(dynlib).GetSymbol(wxT(#name)) + + +// a more convenient function replacing wxDYNLIB_FUNCTION above +// +// it uses the convention that the type of the function is its name suffixed +// with "_t" but it doesn't define a variable but just assigns the loaded value +// to it and also allows to pass it the prefix to be used instead of hardcoding +// "pfn" (the prefix can be "m_" or "gs_pfn" or whatever) +// +// notice that this function doesn't generate error messages if the symbol +// couldn't be loaded, the caller should generate the appropriate message +#define wxDL_INIT_FUNC(pfx, name, dynlib) \ + pfx ## name = (name ## _t)(dynlib).RawGetSymbol(#name) + +#ifdef __WXMSW__ + +// same as wxDL_INIT_FUNC() but appends 'A' or 'W' to the function name, see +// wxDynamicLibrary::GetSymbolAorW() +#define wxDL_INIT_FUNC_AW(pfx, name, dynlib) \ + pfx ## name = (name ## _t)(dynlib).GetSymbolAorW(#name) + +#endif // __WXMSW__ + +// the following macros can be used to redirect a whole library to a class and +// check at run-time if the library is present and contains all required +// methods +// +// notice that they are supposed to be used inside a class which has "m_ok" +// member variable indicating if the library had been successfully loaded + +// helper macros constructing the name of the variable storing the function +// pointer and the name of its type from the function name +#define wxDL_METHOD_NAME(name) m_pfn ## name +#define wxDL_METHOD_TYPE(name) name ## _t + +// parameters are: +// - rettype: return type of the function, e.g. "int" +// - name: name of the function, e.g. "foo" +// - args: function signature in parentheses, e.g. "(int x, int y)" +// - argnames: the names of the parameters in parentheses, e.g. "(x, y)" +// - defret: the value to return if the library wasn't successfully loaded +#define wxDL_METHOD_DEFINE( rettype, name, args, argnames, defret ) \ + typedef rettype (* wxDL_METHOD_TYPE(name)) args ; \ + wxDL_METHOD_TYPE(name) wxDL_METHOD_NAME(name); \ + rettype name args \ + { return m_ok ? wxDL_METHOD_NAME(name) argnames : defret; } + +#define wxDL_VOIDMETHOD_DEFINE( name, args, argnames ) \ + typedef void (* wxDL_METHOD_TYPE(name)) args ; \ + wxDL_METHOD_TYPE(name) wxDL_METHOD_NAME(name); \ + void name args \ + { if ( m_ok ) wxDL_METHOD_NAME(name) argnames ; } + +#define wxDL_METHOD_LOAD(lib, name) \ + wxDL_METHOD_NAME(name) = \ + (wxDL_METHOD_TYPE(name)) lib.GetSymbol(#name, &m_ok); \ + if ( !m_ok ) return false // ---------------------------------------------------------------------------- // wxDynamicLibraryDetails: contains details about a loaded wxDynamicLibrary @@ -169,7 +232,7 @@ public: static wxDllType GetProgramHandle(); // return the platform standard DLL extension (with leading dot) - static const wxChar *GetDllExt() { return ms_dllext; } + static const wxString& GetDllExt() { return ms_dllext; } wxDynamicLibrary() : m_handle(0) { } wxDynamicLibrary(const wxString& libname, int flags = wxDL_DEFAULT) @@ -286,9 +349,18 @@ public: static wxString GetPluginsDirectory(); -#if WXWIN_COMPATIBILITY_2_2 - operator bool() const { return IsLoaded(); } -#endif +#ifdef __WXMSW__ + // return the handle (HMODULE/HINSTANCE) of the DLL with the given name + // and/or containing the specified address: for XP and later systems only + // the address is used and the name is ignored but for the previous systems + // only the name (which may be either a full path to the DLL or just its + // base name, possibly even without extension) is used + // + // the returned handle reference count is not incremented so it doesn't + // need to be freed using FreeLibrary() but it also means that it can + // become invalid if the DLL is unloaded + static WXHMODULE MSWGetModuleHandle(const char *name, void *addr); +#endif // __WXMSW__ protected: // common part of GetSymbol() and HasSymbol() @@ -301,132 +373,38 @@ protected: // platform specific shared lib suffix. - static const wxChar *ms_dllext; + static const wxString ms_dllext; // the handle to DLL or NULL wxDllType m_handle; // no copy ctor/assignment operators (or we'd try to unload the library // twice) - DECLARE_NO_COPY_CLASS(wxDynamicLibrary) + wxDECLARE_NO_COPY_CLASS(wxDynamicLibrary); }; +#ifdef __WXMSW__ // ---------------------------------------------------------------------------- -// wxDllLoader: low level DLL functions, use wxDynamicLibrary in your code -// ---------------------------------------------------------------------------- - -#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 - 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 WXDLLIMPEXP_BASE wxDllLoader -{ -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& name, 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() { return wxDynamicLibrary::GetProgramHandle(); } - - /* - This function resolves a symbol in a loaded DLL, such as a - variable or function name. - - 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, bool *success = 0); - - // return the standard DLL extension (with leading dot) for this platform - static wxString GetDllExt() { return wxDynamicLibrary::GetDllExt(); } - -private: - - wxDllLoader(); // forbid construction of objects -}; - - -// ---------------------------------------------------------------------------- -// wxLibrary -// ---------------------------------------------------------------------------- - -#include "wx/hash.h" - -class WXDLLIMPEXP_BASE wxLibrary : public wxObject -{ -public: - wxLibrary(wxDllType handle); - virtual ~wxLibrary(); - - // Get a symbol from the dynamic library - void *GetSymbol(const wxString& symbname); - - // Create the object whose classname is "name" - wxObject *CreateObject(const wxString& name); - -protected: - void PrepareClasses(wxClassInfo *first); - - wxDllType m_handle; - -public: - wxHashTable classTable; -}; - -// ---------------------------------------------------------------------------- -// wxLibraries +// wxLoadedDLL is a MSW-only internal helper class allowing to dynamically bind +// to a DLL already loaded into the project address space // ---------------------------------------------------------------------------- -class WXDLLIMPEXP_BASE wxLibraries +class wxLoadedDLL : public wxDynamicLibrary { public: - wxLibraries(); - ~wxLibraries(); - - // caller is responsible for deleting the returned pointer if !NULL - wxLibrary *LoadLibrary(const wxString& basename); - - wxObject *CreateObject(const wxString& name); + wxLoadedDLL(const wxString& dllname) + : wxDynamicLibrary(dllname, wxDL_GET_LOADED | wxDL_VERBATIM | wxDL_QUIET) + { + } -protected: - wxList m_loaded; + ~wxLoadedDLL() + { + Detach(); + } }; -// ---------------------------------------------------------------------------- -// Global variables -// ---------------------------------------------------------------------------- - -extern WXDLLIMPEXP_DATA_BASE(wxLibraries) wxTheLibraries; - -#endif // WXWIN_COMPATIBILITY_2_2 && wxUSE_DYNAMIC_LOADER +#endif // __WXMSW__ // ---------------------------------------------------------------------------- // Interesting defines