X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0872eaf957aaf4138dbba007df662ce5eae374e2..52170c5b4419c63d6e0083df411aad420395ec98:/include/wx/dynlib.h

diff --git a/include/wx/dynlib.h b/include/wx/dynlib.h
index a5273869fd..6f842edb17 100644
--- a/include/wx/dynlib.h
+++ b/include/wx/dynlib.h
@@ -12,10 +12,6 @@
 #ifndef _WX_DYNLIB_H__
 #define _WX_DYNLIB_H__
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#   pragma interface "dynlib.h"
-#endif
-
 #include "wx/defs.h"
 
 #if wxUSE_DYNLIB_CLASS
@@ -23,7 +19,7 @@
 #include "wx/string.h"
 #include "wx/dynarray.h"
 
-#if defined(__WXPM__) || defined(__EMX__)
+#if defined(__OS2__) || defined(__EMX__)
 #include "wx/os2/private.h"
 #endif
 
@@ -31,19 +27,20 @@
 #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
 // ----------------------------------------------------------------------------
 
-// Note: WXPM/EMX has to be tested first, since we want to use
+// Note: __OS2__/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__) || defined(__WINDOWS__)
+#if defined(__OS2__) || defined(__EMX__) || defined(__WINDOWS__)
     typedef HMODULE             wxDllType;
 #elif defined(HAVE_DLOPEN)
     #include <dlfcn.h>
@@ -108,6 +105,60 @@ enum wxPluginCategory
 #define wxDYNLIB_FUNCTION(type, name, dynlib) \
     type pfn ## name = (type)(dynlib).GetSymbol(_T(#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)
+#define wxDL_INIT_FUNC(pfx, name, dynlib) \
+    pfx ## name = (name ## _t)(dynlib).GetSymbol(#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
 // ----------------------------------------------------------------------------
@@ -173,7 +224,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)
@@ -245,6 +296,30 @@ public:
 #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
@@ -266,10 +341,6 @@ public:
     static wxString GetPluginsDirectory();
 
 
-#if WXWIN_COMPATIBILITY_2_2
-    operator bool() const { return IsLoaded(); }
-#endif
-
 protected:
     // common part of GetSymbol() and HasSymbol()
     void *DoGetSymbol(const wxString& name, bool *success = 0) const;
@@ -281,7 +352,7 @@ 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;
@@ -292,120 +363,6 @@ protected:
 };
 
 
-// ----------------------------------------------------------------------------
-// wxDllLoader: low level DLL functions, use wxDynamicLibrary in your code
-// ----------------------------------------------------------------------------
-
-#if WXWIN_COMPATIBILITY_2_2 && wxUSE_DYNAMIC_LOADER
-
-/*
-    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
-// ----------------------------------------------------------------------------
-
-class WXDLLIMPEXP_BASE wxLibraries
-{
-public:
-    wxLibraries();
-    ~wxLibraries();
-
-    // caller is responsible for deleting the returned pointer if !NULL
-    wxLibrary *LoadLibrary(const wxString& basename);
-
-    wxObject *CreateObject(const wxString& name);
-
-protected:
-    wxList m_loaded;
-};
-
-// ----------------------------------------------------------------------------
-// Global variables
-// ----------------------------------------------------------------------------
-
-extern WXDLLIMPEXP_DATA_BASE(wxLibraries) wxTheLibraries;
-
-#endif // WXWIN_COMPATIBILITY_2_2 && wxUSE_DYNAMIC_LOADER
-
 // ----------------------------------------------------------------------------
 // Interesting defines
 // ----------------------------------------------------------------------------