Renameing funktions to prevent name clashes

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

diff --git a/include/wx/dynlib.h b/include/wx/dynlib.h
index 39db5aa6adc5863850ac377b2c610bce8c9a8d36..e6b0bc8c141a7bc55e7fbd9d153a08015d24b295 100644 (file)
--- a/include/wx/dynlib.h
+++ b/include/wx/dynlib.h
@@ -1,73 +1,162 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        dynlib.cpp
+// Purpose:     Dynamic library management
+// Author:      Guilhem Lavaux
+// Modified by:
+// Created:     20/07/98
+// RCS-ID:      $Id$
+// Copyright:   (c) Guilhem Lavaux
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+

 #ifndef _WX_DYNLIB_H__
 #define _WX_DYNLIB_H__
 
 #ifdef __GNUG__
 #ifndef _WX_DYNLIB_H__
 #define _WX_DYNLIB_H__
 
 #ifdef __GNUG__

-#pragma interface
+#   pragma interface

 #endif
 
 #endif
 

-#include <wx/string.h>
-#include <wx/list.h>
-#include <wx/dynarray.h>
-#include <wx/hash.h>
-
-#ifdef LoadLibrary
-#undef LoadLibrary
+#include "wx/setup.h"
+
+#if wxUSE_DYNLIB_CLASS
+
+#include "wx/string.h"
+#include "wx/list.h"
+#include "wx/hash.h"
+
+// this is normally done by configure, but I leave it here for now...
+#if defined(__UNIX__) && !(defined(HAVE_DLOPEN) || defined(HAVE_SHL_LOAD))
+#   if defined(__LINUX__) || defined(__SOLARIS__) || defined(__SUNOS__) || defined(__FREEBSD__)
+#      define HAVE_DLOPEN
+#   elif defined(__HPUX__)
+#      define HAVE_SHL_LOAD
+#   endif // Unix flavour
+#endif // !Unix or already have some HAVE_xxx defined
+
+#if defined(HAVE_DLOPEN)
+#   include <dlfcn.h>
+    typedef void *wxDllType;
+#elif defined(HAVE_SHL_LOAD)
+#   include <dl.h>
+    typedef shl_t wxDllType;
+#elif defined(__WINDOWS__)
+#   include <windows.h>
+    typedef HMODULE wxDllType;
+#elif defined(__OS2__)
+#   define INCL_DOS
+#   include <os2.h>
+    typedef HMODULE wxDllType;
+#elif defined(__WXMAC__)
+    typedef CFragConnectionID wxDllType;
+#else
+#   error "wxLibrary can't be compiled on this platform, sorry."
+#endif // OS
+
+// LoadLibrary is defined in windows.h as LoadLibraryA, but wxDllLoader method
+// should be called LoadLibrary, not LoadLibraryA or LoadLibraryW!
+#if defined(__WIN32__) && defined(LoadLibrary)
+#   include "wx/msw/winundef.h"

 #endif
 
 #endif
 

-// ---------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
+// wxDllLoader
+// ----------------------------------------------------------------------------
+/** wxDllLoader is a class providing an interface similar to unix's
+    dlopen(). It is used by the wxLibrary framework 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 wxDllLoader
+{
+ public:
+   /** This function loads a shared library into memory, with libname
+       being the basename of the library, without the filename
+       extension. No initialisation of the library will be done.
+       @param libname Name of the shared object to load.
+       @param success Must point to a bool variable which will be set to TRUE or FALSE.
+       @return A handle to the loaded DLL. Use success parameter to test if it is valid.
+   */
+   static wxDllType LoadLibrary(const wxString & libname, bool *success = NULL);
+   /** This function unloads the shared library. */
+   static void UnloadLibrary(wxDllType dll);
+   /** This function returns a valid handle for the main program
+       itself. */
+   static wxDllType GetProgramHandle(void);
+   /** This function resolves a symbol in a loaded DLL, such as a
+       variable or function name.
+       @param dllHandle Handle of the DLL, as returned by LoadDll().
+       @param name Name of the symbol.
+       @return A pointer to the symbol.
+   */
+   static void * GetSymbol(wxDllType dllHandle, const wxString &name);
+ private:
+   /// forbid construction of objects
+   wxDllLoader();
+};
+
+// ----------------------------------------------------------------------------

 // wxLibrary
 // wxLibrary

+// ----------------------------------------------------------------------------

 
 

-class wxLibrary: public wxObject {
- protected:
-  void *m_handle;
-  bool m_destroy;
- public:
-  wxHashTable classTable;
+class wxLibrary : public wxObject
+{
+public:
+    wxHashTable classTable;

 
 

- public:
-  wxLibrary(void *handle);
-  ~wxLibrary(void);
+public:
+    wxLibrary(wxDllType handle);
+    ~wxLibrary();

 
 

-  // Get a symbol from the dynamic library
-  void *GetSymbol(const wxString& symbname);
+    // Get a symbol from the dynamic library
+    void *GetSymbol(const wxString& symbname);

 
 

-  // Create the object whose classname is "name"
-  wxObject *CreateObject(const wxString& name);
+    // Create the object whose classname is "name"
+    wxObject *CreateObject(const wxString& name);

 
 

-  // Merge the symbols with the main symbols: WARNING! the library will not
-  // be unloaded.
-  void MergeWithSystem();
+protected:
+    void PrepareClasses(wxClassInfo *first);

 
 

- protected:
-  void PrepareClasses(wxClassInfo **first);
+    wxDllType m_handle;

 };
 
 };
 

-// ---------------------------------------------------------------------------
+
+
+// ----------------------------------------------------------------------------

 // wxLibraries
 // wxLibraries

+// ----------------------------------------------------------------------------

 
 

-class wxLibraries {
- protected:
-  wxList m_loaded;
- public:
-  wxLibraries(void);
-  ~wxLibraries(void);
+class wxLibraries
+{
+public:
+    wxLibraries();
+    ~wxLibraries();
+
+    // caller is responsible for deleting the returned pointer if !NULL
+    wxLibrary *LoadLibrary(const wxString& basename);

 
 

-  wxLibrary *LoadLibrary(const wxString& name);
-  wxObject *CreateObject(const wxString& name);
+    wxObject *CreateObject(const wxString& name);
+
+protected:
+    wxList m_loaded;

 };
 
 };
 

-// ---------------------------------------------------------------------------
+// ----------------------------------------------------------------------------

 // Global variables
 // Global variables

+// ----------------------------------------------------------------------------

 
 extern wxLibraries wxTheLibraries;
 
 
 extern wxLibraries wxTheLibraries;
 

-// ---------------------------------------------------------------------------
+// ----------------------------------------------------------------------------

 // Interesting defines
 // Interesting defines

+// ----------------------------------------------------------------------------

 
 #define WXDLL_ENTRY_FUNCTION() \
 
 #define WXDLL_ENTRY_FUNCTION() \

-extern "C" wxClassInfo **wxGetClassFirst(); \
-wxClassInfo **wxGetClassFirst() { \
-  return &wxClassInfo::first; \
+extern "C" wxClassInfo *wxGetClassFirst(); \
+wxClassInfo *wxGetClassFirst() { \
+  return wxClassInfo::GetFirst(); \

 }
 
 }
 

-#endif
+#endif // wxUSE_DYNLIB_CLASS
+
+#endif // _WX_DYNLIB_H__