Add missing wxUSE_OLE checks to safearray.cpp.

[wxWidgets.git] / include / wx / dynlib.h

diff --git a/include/wx/dynlib.h b/include/wx/dynlib.h
index e163ae209866aebc2e3276135530710103099de7..6a704d7eb66278822f580f88f3051020bd0ea2b4 100644 (file)
--- a/include/wx/dynlib.h
+++ b/include/wx/dynlib.h
@@ -12,42 +12,37 @@
 #ifndef _WX_DYNLIB_H__
 #define _WX_DYNLIB_H__
 
 #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"
 
 #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 <os2.h>
+// note that we have our own dlerror() implementation under Darwin
+#if (defined(HAVE_DLERROR) && !defined(__EMX__)) || defined(__DARWIN__)
+    #define wxHAVE_DYNLIB_ERROR

 #endif
 
 #endif
 

-#ifdef __WXMSW__
-#include "wx/msw/private.h"
-#endif
+class WXDLLIMPEXP_FWD_BASE wxDynamicLibraryDetailsCreator;

 
 // ----------------------------------------------------------------------------
 // conditional compilation
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // 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.
 // native version, even if configure detected presence of DLOPEN.

-#if defined(__WXPM__) || defined(__EMX__) || defined(__WINDOWS__)
-    typedef HMODULE             wxDllType;
+#if defined(__OS2__) || defined(__EMX__) || defined(__WINDOWS__)
+    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 <dlfcn.h>
     typedef void               *wxDllType;
 #elif defined(HAVE_SHL_LOAD)
     #include <dl.h>
     typedef shl_t               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(__DARWIN__)
-    typedef void               *wxDllType;

 #elif defined(__WXMAC__)
     #include <CodeFragments.h>
     typedef CFragConnectionID   wxDllType;
 #elif defined(__WXMAC__)
     #include <CodeFragments.h>
     typedef CFragConnectionID   wxDllType;


@@ -62,21 +57,30 @@
 enum wxDLFlags
 {
     wxDL_LAZY       = 0x00000001,   // resolve undefined symbols at first use
 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
     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_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.
 
                                     // 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
     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_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

 };
 
 enum wxDynamicLibraryCategory
 };
 
 enum wxDynamicLibraryCategory


@@ -104,11 +108,121 @@ enum wxPluginCategory
 // type only once, as the first parameter, and creating a variable of this type
 // called "pfn<name>" initialized with the "name" from the "dynlib"
 #define wxDYNLIB_FUNCTION(type, name, dynlib) \
 // type only once, as the first parameter, and creating a variable of this type
 // called "pfn<name>" 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 __WINDOWS__
+
+// 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 // __WINDOWS__
+
+// 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
+// ----------------------------------------------------------------------------

 
 

-// ---------------------------------------------------------------------------
-// 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
 {
 
 class WXDLLIMPEXP_BASE wxDynamicLibrary
 {


@@ -118,7 +232,7 @@ public:
     static wxDllType         GetProgramHandle();
 
     // return the platform standard DLL extension (with leading dot)
     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)
 
     wxDynamicLibrary() : m_handle(0) { }
     wxDynamicLibrary(const wxString& libname, int flags = wxDL_DEFAULT)


@@ -135,7 +249,12 @@ public:
     bool IsLoaded() const { return m_handle != 0; }
 
     // load the library with the given name (full or not), return true if ok
     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
 
     // 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


@@ -172,8 +291,47 @@ public:
     //
     // Returns a pointer to the symbol on success, or NULL if an error occurred
     // or the symbol wasn't found.
     //
     // 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 __WINDOWS__
+    // 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 // __WINDOWS__
+
+    // 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)
 
     // return platform-specific name of dynamic library with proper extension
     // and prefix (e.g. "foo.dll" on Windows or "libfoo.so" on Linux)


@@ -191,140 +349,62 @@ public:
     static wxString GetPluginsDirectory();
 
 
     static wxString GetPluginsDirectory();
 
 

-#if WXWIN_COMPATIBILITY_2_2
-    operator bool() const { return IsLoaded(); }
-#endif
+#ifdef __WINDOWS__
+    // 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 // __WINDOWS__

 
 protected:
 
 protected:

-    // the real implementation of GetSymbol()
+    // common part of GetSymbol() and HasSymbol()

     void *DoGetSymbol(const wxString& name, bool *success = 0) const;
 
     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.
 
     // 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)
 
     // 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)
-};
-
-
-// ----------------------------------------------------------------------------
-// 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
+    wxDECLARE_NO_COPY_CLASS(wxDynamicLibrary);

 };
 
 };
 

+#ifdef __WINDOWS__

 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------

-// wxLibrary
+// wxLoadedDLL is a MSW-only internal helper class allowing to dynamically bind
+// to a DLL already loaded into the project address space

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-#include "wx/hash.h"
-
-class WXDLLIMPEXP_BASE wxLibrary : public wxObject
+class wxLoadedDLL : public wxDynamicLibrary

 {
 public:
 {
 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);
+    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 // __WINDOWS__

 
 // ----------------------------------------------------------------------------
 // Interesting defines
 
 // ----------------------------------------------------------------------------
 // Interesting defines