Added wxPGChoices::Copy(), tweaked related documentation

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

diff --git a/include/wx/dynlib.h b/include/wx/dynlib.h
index 88e58a7c737eb01a5f6d8e1b7fe9023eeb281a5c..24f1020b504e4ca8e191ebaa120bd92cc6c68cc3 100644 (file)
--- a/include/wx/dynlib.h
+++ b/include/wx/dynlib.h
@@ -42,14 +42,15 @@ class WXDLLIMPEXP_FWD_BASE wxDynamicLibraryDetailsCreator;
 // native version, even if configure detected presence of DLOPEN.
 #if defined(__OS2__) || defined(__EMX__) || defined(__WINDOWS__)
     typedef HMODULE             wxDllType;
 // native version, even if configure detected presence of DLOPEN.
 #if defined(__OS2__) || defined(__EMX__) || defined(__WINDOWS__)
     typedef HMODULE             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;


@@ -72,9 +73,21 @@ enum wxDLFlags
     wxDL_VERBATIM   = 0x00000008,   // attempt to load the supplied library
                                     // name without appending the usual dll
                                     // filename extension.
     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_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
 };
 
     wxDL_DEFAULT    = wxDL_NOW      // default flags correspond to Win32
 };
 


@@ -106,6 +119,27 @@ enum wxPluginCategory
     type pfn ## name = (type)(dynlib).GetSymbol(_T(#name))
 
 
     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)
+//
+// 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
 // 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


@@ -344,6 +378,28 @@ protected:
     DECLARE_NO_COPY_CLASS(wxDynamicLibrary)
 };
 
     DECLARE_NO_COPY_CLASS(wxDynamicLibrary)
 };
 

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

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