updated to generate ZIP files with DOS line endings

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

diff --git a/include/wx/dynlib.h b/include/wx/dynlib.h
index 428048ce145fa66c974318881abdef3064abff60..e163ae209866aebc2e3276135530710103099de7 100644 (file)
--- a/include/wx/dynlib.h
+++ b/include/wx/dynlib.h
@@ -1,95 +1,341 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        wx/dynlib.h
+// Purpose:     Dynamic library loading classes
+// Author:      Guilhem Lavaux, Vadim Zeitlin, Vaclav Slavik
+// Modified by:
+// Created:     20/07/98
+// RCS-ID:      $Id$
+// Copyright:   (c) 1998 Guilhem Lavaux
+// Licence:     wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
+

 #ifndef _WX_DYNLIB_H__
 #define _WX_DYNLIB_H__
 
 #ifndef _WX_DYNLIB_H__
 #define _WX_DYNLIB_H__
 

-#ifdef __GNUG__
-#pragma interface
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+#   pragma interface "dynlib.h"

 #endif
 
 #endif
 

-#include <wx/string.h>
-#include <wx/list.h>
-#include <wx/dynarray.h>
+#include "wx/setup.h"

 
 

-// ---------------------------------------------------------------------------
-// Some more info on a class
+#if wxUSE_DYNLIB_CLASS

 
 

-typedef struct {
-  wxClassInfo *class_info;
-  wxString path;
-} wxClassLibInfo;
+#include "wx/string.h"

 
 

-// ---------------------------------------------------------------------------
-// Useful arrays
+// FIXME: can this go in private.h or something too??
+#if defined(__WXPM__) || defined(__EMX__)
+#define INCL_DOS
+#include <os2.h>
+#endif
+
+#ifdef __WXMSW__
+#include "wx/msw/private.h"
+#endif
+
+// ----------------------------------------------------------------------------
+// conditional compilation
+// ----------------------------------------------------------------------------
+
+// Note: WXPM/EMX has to be tested first, since we want to use
+// native version, even if configure detected presence of DLOPEN.
+#if defined(__WXPM__) || defined(__EMX__) || defined(__WINDOWS__)
+    typedef HMODULE             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;
+#else
+    #error "Dynamic Loading classes can't be compiled on this platform, sorry."
+#endif
+
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
+enum wxDLFlags
+{
+    wxDL_LAZY       = 0x00000001,   // resolve undefined symbols at first use
+    wxDL_NOW        = 0x00000002,   // resolve undefined symbols on load
+    wxDL_GLOBAL     = 0x00000004,   // export extern symbols to subsequently
+                                    // loaded libs.
+    wxDL_VERBATIM   = 0x00000008,   // Attempt to load the supplied library
+                                    // name without appending the usual dll
+                                    // filename extension.
+
+    wxDL_NOSHARE    = 0x00000010,   // load new DLL, don't reuse already loaded
+
+    // FIXME: why? (VZ)
+#ifdef __osf__
+    wxDL_DEFAULT    = wxDL_LAZY
+#else
+    wxDL_DEFAULT    = wxDL_LAZY | wxDL_GLOBAL
+#endif
+};
+
+enum wxDynamicLibraryCategory
+{
+    wxDL_LIBRARY,       // standard library
+    wxDL_MODULE         // loadable module/plugin
+};
+
+enum wxPluginCategory
+{
+    wxDL_PLUGIN_GUI,    // plugin that uses GUI classes
+    wxDL_PLUGIN_BASE    // wxBase-only plugin
+};

 
 

-WX_DEFINE_ARRAY(wxClassInfo *, wxArrayClassInfo);
-WX_DEFINE_ARRAY(wxClassLibInfo *, wxArrayClassLibInfo);
+// ----------------------------------------------------------------------------
+// macros
+// ----------------------------------------------------------------------------

 
 

+// when loading a function from a DLL you always have to cast the returned
+// "void *" pointer to the correct type and, even more annoyingly, you have to
+// repeat this type twice if you want to declare and define a function pointer
+// all in one line
+//
+// this macro makes this slightly less painful by allowing you to specify the
+// 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))
+
+// ---------------------------------------------------------------------------
+// wxDynamicLibrary

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

-// wxClassLibrary

 
 

-class wxClassLibrary {
+class WXDLLIMPEXP_BASE wxDynamicLibrary
+{
+public:
+    // return 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 the platform standard DLL extension (with leading dot)
+    static const wxChar *GetDllExt() { return ms_dllext; }
+
+    wxDynamicLibrary() : m_handle(0) { }
+    wxDynamicLibrary(const wxString& libname, int flags = wxDL_DEFAULT)
+        : m_handle(0)
+    {
+        Load(libname, flags);
+    }
+
+    // NOTE: this class is (deliberately) not virtual, do not attempt
+    //       to use it polymorphically.
+    ~wxDynamicLibrary() { Unload(); }
+
+    // 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 Load(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
+    // doing this
+    wxDllType Detach() { wxDllType h = m_handle; m_handle = 0; return h; }
+
+    // unload the given library handle (presumably returned by Detach() before)
+    static void Unload(wxDllType handle);
+
+    // unload the library, also done automatically in dtor
+    void Unload() { if ( IsLoaded() ) { Unload(m_handle); m_handle = 0; } }
+
+    // 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)
+    //
+    // Since it is perfectly valid for the returned symbol to actually be NULL,
+    // that is not always indication of an error.  Pass and test the parameter
+    // 'success' for a true indication of success or failure to load the
+    // symbol.
+    //
+    // 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;
+
+
+    // 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 wxWidgets plugin (adds compiler and version info
+    // to the filename):
+    static wxString
+    CanonicalizePluginName(const wxString& name,
+                           wxPluginCategory cat = wxDL_PLUGIN_GUI);
+
+    // return plugin directory on platforms where it makes sense and empty
+    // string on others:
+    static wxString GetPluginsDirectory();
+
+
+#if WXWIN_COMPATIBILITY_2_2
+    operator bool() const { return IsLoaded(); }
+#endif
+

 protected:
 protected:

-  wxArrayClassLibInfo m_list;
+    // the real implementation of GetSymbol()
+    void *DoGetSymbol(const wxString& name, bool *success = 0) const;
+
+
+    // platform specific shared lib suffix.
+    static const wxChar *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)
+    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:
 public:

-  wxClassLibrary(void);
-  ~wxClassLibrary(void);
+    /*
+      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.

 
 

-  // Dynamic (un)register a (new) class in the database
-  void RegisterClass(wxClassInfo *class_info, const wxString& path);
-  void UnregisterClass(wxClassInfo *class_info);
+       Returns the pointer to the symbol or NULL on error.
+     */
+    static void *GetSymbol(wxDllType dllHandle, const wxString &name, bool *success = 0);

 
 

-  // Fetch all infos whose name matches the string (wildcards allowed)
-  bool FetchInfos(const wxString& path, wxArrayClassLibInfo& infos);
+    // return the standard DLL extension (with leading dot) for this platform
+    static wxString GetDllExt() { return wxDynamicLibrary::GetDllExt(); }

 
 

-  // Create all objects whose name matches the string (wildcards allowed)
-  bool CreateObjects(const wxString& path, wxArrayClassInfo& objs);
+private:

 
 

-  // Create one object using the EXACT name
-  wxObject *CreateObject(const wxString& path);
+    wxDllLoader();                    // forbid construction of objects

 };
 
 };
 

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

 // wxLibrary
 // wxLibrary

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

 
 

-class wxLibrary: public wxObject {
-protected:
-  wxClassLibrary *m_liblist;
-  void *m_handle;
+#include "wx/hash.h"
+
+class WXDLLIMPEXP_BASE wxLibrary : public wxObject
+{

 public:
 public:

-  wxLibrary(void *handle);
-  ~wxLibrary(void);
+    wxLibrary(wxDllType handle);
+    virtual ~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);

 
 

-  wxClassLibrary *ClassLib() const;
+protected:
+    void PrepareClasses(wxClassInfo *first);
+
+    wxDllType m_handle;
+
+public:
+    wxHashTable classTable;

 };
 
 };
 

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

 // wxLibraries
 // wxLibraries

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

 
 

-class wxLibraries {
-protected:
-  wxList m_loaded;
+class WXDLLIMPEXP_BASE wxLibraries
+{

 public:
 public:

-  wxLibraries(void);
-  ~wxLibraries(void);
+    wxLibraries();
+    ~wxLibraries();
+
+    // caller is responsible for deleting the returned pointer if !NULL
+    wxLibrary *LoadLibrary(const wxString& basename);
+
+    wxObject *CreateObject(const wxString& name);

 
 

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

 };
 
 };
 

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

 // Global variables
 // Global variables

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

 
 

-extern wxLibraries wxTheLibraries;
+extern WXDLLIMPEXP_DATA_BASE(wxLibraries) wxTheLibraries;

 
 

-// ---------------------------------------------------------------------------
+#endif // WXWIN_COMPATIBILITY_2_2 && wxUSE_DYNAMIC_LOADER
+
+// ----------------------------------------------------------------------------

 // Interesting defines
 // Interesting defines

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

 
 

-#define WXDLL_ENTRY_FUNCTION() extern "C" wxClassLibrary *GetClassList()
-#define WXDLL_EXIT_FUNCTION(param) extern "C" void FreeClassList(wxClassLibrary *param)
+#define WXDLL_ENTRY_FUNCTION() \
+extern "C" WXEXPORT const wxClassInfo *wxGetClassFirst(); \
+const wxClassInfo *wxGetClassFirst() { \
+  return wxClassInfo::GetFirst(); \
+}

 
 

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