Return the old file descriptor/pointer from wx(F)File::Detach().

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

diff --git a/include/wx/dynlib.h b/include/wx/dynlib.h
index 3d31beeb80aeaae7e6daa6143b5ae00b04a8410c..5487ccc949ada3e37e73d9c9277d41d638295a69 100644 (file)
--- a/include/wx/dynlib.h
+++ b/include/wx/dynlib.h
@@ -4,7 +4,6 @@
 // Author:      Guilhem Lavaux, Vadim Zeitlin, Vaclav Slavik
 // Modified by:
 // Created:     20/07/98
 // Author:      Guilhem Lavaux, Vadim Zeitlin, Vaclav Slavik
 // Modified by:
 // Created:     20/07/98

-// RCS-ID:      $Id$

 // Copyright:   (c) 1998 Guilhem Lavaux
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) 1998 Guilhem Lavaux
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////


@@ -19,14 +18,6 @@
 #include "wx/string.h"
 #include "wx/dynarray.h"
 
 #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
-

 // note that we have our own dlerror() implementation under Darwin
 #if (defined(HAVE_DLERROR) && !defined(__EMX__)) || defined(__DARWIN__)
     #define wxHAVE_DYNLIB_ERROR
 // note that we have our own dlerror() implementation under Darwin
 #if (defined(HAVE_DLERROR) && !defined(__EMX__)) || defined(__DARWIN__)
     #define wxHAVE_DYNLIB_ERROR


@@ -41,7 +32,7 @@ class WXDLLIMPEXP_FWD_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__)
 // 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(__DARWIN__)
     // Don't include dlfcn.h on Darwin, we may be using our own replacements.
     typedef void               *wxDllType;


@@ -80,7 +71,9 @@ enum wxDLFlags
 
     wxDL_QUIET      = 0x00000020,   // don't log an error if failed to load
 
 
     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
+    // 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
     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


@@ -114,7 +107,7 @@ 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
 
 
 // a more convenient function replacing wxDYNLIB_FUNCTION above


@@ -129,14 +122,14 @@ enum wxPluginCategory
 #define wxDL_INIT_FUNC(pfx, name, dynlib) \
     pfx ## name = (name ## _t)(dynlib).RawGetSymbol(#name)
 
 #define wxDL_INIT_FUNC(pfx, name, dynlib) \
     pfx ## name = (name ## _t)(dynlib).RawGetSymbol(#name)
 

-#ifdef __WXMSW__
+#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)
 
 
 // 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__
+#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
 
 // 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


@@ -238,7 +231,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 wxString& GetDllExt() { return ms_dllext; }
+    static wxString GetDllExt(wxDynamicLibraryCategory cat = wxDL_LIBRARY);

 
     wxDynamicLibrary() : m_handle(0) { }
     wxDynamicLibrary(const wxString& libname, int flags = wxDL_DEFAULT)
 
     wxDynamicLibrary() : m_handle(0) { }
     wxDynamicLibrary(const wxString& libname, int flags = wxDL_DEFAULT)


@@ -310,7 +303,7 @@ public:
 #endif
     }
 
 #endif
     }
 

-#ifdef __WXMSW__
+#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
     // 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


@@ -332,7 +325,7 @@ public:
     {
         return RawGetSymbolAorW(m_handle, name);
     }
     {
         return RawGetSymbolAorW(m_handle, name);
     }

-#endif // __WXMSW__
+#endif // __WINDOWS__

 
     // return all modules/shared libraries in the address space of this process
     //
 
     // return all modules/shared libraries in the address space of this process
     //


@@ -355,6 +348,19 @@ public:
     static wxString GetPluginsDirectory();
 
 
     static wxString GetPluginsDirectory();
 
 

+#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 wxString& name, void *addr);
+#endif // __WINDOWS__
+

 protected:
     // common part of GetSymbol() and HasSymbol()
     void *DoGetSymbol(const wxString& name, bool *success = 0) const;
 protected:
     // common part of GetSymbol() and HasSymbol()
     void *DoGetSymbol(const wxString& name, bool *success = 0) const;


@@ -365,17 +371,36 @@ protected:
 #endif // wxHAVE_DYNLIB_ERROR
 
 
 #endif // wxHAVE_DYNLIB_ERROR
 
 

-    // platform specific shared lib suffix.
-    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)
+    wxDECLARE_NO_COPY_CLASS(wxDynamicLibrary);
+};
+
+#ifdef __WINDOWS__
+
+// ----------------------------------------------------------------------------
+// wxLoadedDLL is a MSW-only internal helper class allowing to dynamically bind
+// to a DLL already loaded into the project address space
+// ----------------------------------------------------------------------------
+
+class wxLoadedDLL : public wxDynamicLibrary
+{
+public:
+    wxLoadedDLL(const wxString& dllname)
+        : wxDynamicLibrary(dllname, wxDL_GET_LOADED | wxDL_VERBATIM | wxDL_QUIET)
+    {
+    }
+
+    ~wxLoadedDLL()
+    {
+        Detach();
+    }

 };
 
 };
 

+#endif // __WINDOWS__

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