compilation fix for Borland C++

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

diff --git a/include/wx/dynlib.h b/include/wx/dynlib.h
index 32b569ccdb557d804503a09ad74bcbaea48ab692..4d5f948628c403c40687be2b64ec24283110b319 100644 (file)
--- a/include/wx/dynlib.h
+++ b/include/wx/dynlib.h
@@ -12,33 +12,35 @@
 #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>
+#if defined(__OS2__) || defined(__EMX__)
+#include "wx/os2/private.h"

 #endif
 
 #ifdef __WXMSW__
 #include "wx/msw/private.h"
 #endif
 
 #endif
 
 #ifdef __WXMSW__
 #include "wx/msw/private.h"
 #endif
 

+// 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_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__)
+#if defined(__OS2__) || defined(__EMX__) || defined(__WINDOWS__)

     typedef HMODULE             wxDllType;
 #elif defined(HAVE_DLOPEN)
     #include <dlfcn.h>
     typedef HMODULE             wxDllType;
 #elif defined(HAVE_DLOPEN)
     #include <dlfcn.h>


@@ -62,21 +64,18 @@
 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.

-

     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_DEFAULT    = wxDL_NOW      // default flags correspond to Win32

 };
 
 enum wxDynamicLibraryCategory
 };
 
 enum wxDynamicLibraryCategory


@@ -106,9 +105,62 @@ enum wxPluginCategory
 #define wxDYNLIB_FUNCTION(type, name, dynlib) \
     type pfn ## name = (type)(dynlib).GetSymbol(_T(#name))
 
 #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
 {
 
 class WXDLLIMPEXP_BASE wxDynamicLibrary
 {


@@ -118,7 +170,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)


@@ -131,11 +183,16 @@ public:
     //       to use it polymorphically.
     ~wxDynamicLibrary() { Unload(); }
 
     //       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 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


@@ -151,6 +208,16 @@ public:
     // Return the raw handle from dlopen and friends.
     wxDllType GetLibHandle() const { return m_handle; }
 
     // 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)
     // 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,15 +229,54 @@ 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 __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)
     static wxString CanonicalizeName(const wxString& name,
                                      wxDynamicLibraryCategory cat = wxDL_LIBRARY);
 
 
     // return platform-specific name of dynamic library with proper extension
     // and prefix (e.g. "foo.dll" on Windows or "libfoo.so" on Linux)
     static wxString CanonicalizeName(const wxString& name,
                                      wxDynamicLibraryCategory cat = wxDL_LIBRARY);
 

-    // return name of wxWindows plugin (adds compiler and version info
+    // return name of wxWidgets plugin (adds compiler and version info

     // to the filename):
     static wxString
     CanonicalizePluginName(const wxString& name,
     // to the filename):
     static wxString
     CanonicalizePluginName(const wxString& name,


@@ -181,13 +287,18 @@ public:
     static wxString GetPluginsDirectory();
 
 
     static wxString GetPluginsDirectory();
 
 

-#if WXWIN_COMPATIBILITY_2_2
-    operator bool() const { return IsLoaded(); }
-#endif
-

 protected:
 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.
     // platform specific shared lib suffix.

-    static const wxChar *ms_dllext;
+    static const wxString ms_dllext;

 
     // the handle to DLL or NULL
     wxDllType m_handle;
 
     // the handle to DLL or NULL
     wxDllType m_handle;


@@ -198,120 +309,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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Interesting defines
 // ----------------------------------------------------------------------------