DynamicLoader.hxx.in 3.05 KB
Newer Older
1 2
/* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   file Copyright.txt or https://cmake.org/licensing#kwsys for details.  */
3 4 5
#ifndef @KWSYS_NAMESPACE@_DynamicLoader_hxx
#define @KWSYS_NAMESPACE@_DynamicLoader_hxx

Brad King's avatar
Brad King committed
6
#include <@KWSYS_NAMESPACE@/Configure.hxx>
7

Brad King's avatar
Brad King committed
8
#include <string>
9

10
#if defined(__hpux)
11
#include <dl.h>
12
#elif defined(_WIN32) && !defined(__CYGWIN__)
13
#include <windows.h>
14
#elif defined(__APPLE__)
15 16 17 18
#include <AvailabilityMacros.h>
#if MAC_OS_X_VERSION_MAX_ALLOWED < 1030
#include <mach-o/dyld.h>
#endif
19
#elif defined(__BEOS__)
20
#include <be/kernel/image.h>
21 22
#endif

23
namespace @KWSYS_NAMESPACE@ {
24 25 26 27 28 29 30 31
/** \class DynamicLoader
 * \brief Portable loading of dynamic libraries or dll's.
 *
 * DynamicLoader provides a portable interface to loading dynamic
 * libraries or dll's into a process.
 *
 * Directory currently works with Windows, Apple, HP-UX and Unix (POSIX)
 * operating systems
32 33
 *
 * \warning dlopen on *nix system works the following way:
34 35 36 37 38 39
 * If filename contains a slash ("/"), then it is interpreted as a (relative
 * or absolute) pathname.  Otherwise, the dynamic linker searches for the
 * library as follows : see ld.so(8) for further details):
 * Whereas this distinction does not exist on Win32. Therefore ideally you
 * should be doing full path to garantee to have a consistent way of dealing
 * with dynamic loading of shared library.
40 41 42
 *
 * \warning the Cygwin implementation do not use the Win32 HMODULE. Put extra
 * condition so that we can include the correct declaration (POSIX)
43 44 45 46 47
 */

class @KWSYS_NAMESPACE@_EXPORT DynamicLoader
{
public:
48 49 50 51
// Ugly stuff for library handles
// They are different on several different OS's
#if defined(__hpux)
  typedef shl_t LibraryHandle;
52
#elif defined(_WIN32) && !defined(__CYGWIN__)
53 54
  typedef HMODULE LibraryHandle;
#elif defined(__APPLE__)
55 56 57 58 59
#if MAC_OS_X_VERSION_MAX_ALLOWED < 1030
  typedef NSModule LibraryHandle;
#else
  typedef void* LibraryHandle;
#endif
60 61
#elif defined(__BEOS__)
  typedef image_id LibraryHandle;
62
#else // POSIX
63 64 65 66 67 68
  typedef void* LibraryHandle;
#endif

  // Return type from DynamicLoader::GetSymbolAddress.
  typedef void (*SymbolPointer)();

69
  /** Load a dynamic library into the current process.
70
   * The returned LibraryHandle can be used to access the symbols in the
71
   * library. */
Brad King's avatar
Brad King committed
72
  static LibraryHandle OpenLibrary(const std::string&);
73 74 75

  /** Attempt to detach a dynamic library from the
   * process.  A value of true is returned if it is sucessful. */
76
  static int CloseLibrary(LibraryHandle);
77 78

  /** Find the address of the symbol in the given library. */
Brad King's avatar
Brad King committed
79
  static SymbolPointer GetSymbolAddress(LibraryHandle, const std::string&);
80

81 82
  /** Return the default module prefix for the current platform.  */
  static const char* LibPrefix() { return "@KWSYS_DynamicLoader_PREFIX@"; }
83

84 85
  /** Return the default module suffix for the current platform.  */
  static const char* LibExtension() { return "@KWSYS_DynamicLoader_SUFFIX@"; }
86 87 88 89 90 91 92 93

  /** Return the last error produced from a calls made on this class. */
  static const char* LastError();
}; // End Class: DynamicLoader

} // namespace @KWSYS_NAMESPACE@

#endif