soloader.h

Go to the documentation of this file.

/*
   For more information, please see: http://software.sci.utah.edu

   The MIT License

   Copyright (c) 2009 Scientific Computing and Imaging Institute,
   University of Utah.

   
   Permission is hereby granted, free of charge, to any person obtaining a
   copy of this software and associated documentation files (the "Software"),
   to deal in the Software without restriction, including without limitation
   the rights to use, copy, modify, merge, publish, distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so, subject to the following conditions:

   The above copyright notice and this permission notice shall be included
   in all copies or substantial portions of the Software.

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
   OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
   DEALINGS IN THE SOFTWARE.
*/

/*
 *@file soloader.h
 *@brief These functions are used to abstract the interface for
 *accessing shared libraries (.so for unix and .dll for windows)
 *
 *@author Chris Moulding
 *@Date Nov 1998 
 */

#ifndef SOLOADER_H_
#define SOLOADER_H_


#include <string>


#ifdef _WIN32
#  define _WINSOCKAPI_   /* Prevent inclusion of winsock.h in windows.h */
#  include <windows.h> // for LoadLibrary(), GetProcAddress() and HINSTANCE
   typedef HINSTANCE LIBRARY_HANDLE;
#else
#  include <dlfcn.h>   // for dlopen() and dlsym()
   typedef void* LIBRARY_HANDLE;
#endif

#include <Core/Utils/Legacy/share.h>
/////////////////////////////////////////////////////////////////
/// GetLibrarySymbolAddress()
/// returns a pointer to the data or function called "symbolname"
/// from within the shared library called "libname"

SCISHARE void* GetLibrarySymbolAddress(const std::string libname, const std::string symbolname, std::string& errormsg);

inline void* GetLibrarySymbolAddress(const std::string libname, const std::string symbolname)
{
  std::string errormsg;
  return (GetLibrarySymbolAddress(libname,symbolname,errormsg));
}


/////////////////////////////////////////////////////////////////
/// GetLibraryHandle()
/// opens, and returns the handle to, the library module
/// called "libname"

SCISHARE LIBRARY_HANDLE GetLibraryHandle(const std::string libname, std::string& errormsg);

inline LIBRARY_HANDLE GetLibraryHandle(const std::string libname)
{
  std::string errormsg;
  return (GetLibraryHandle(libname,errormsg));
}

inline LIBRARY_HANDLE GetLibraryHandle()
{
  std::string errormsg;
  return (GetLibraryHandle("",errormsg));
}

/////////////////////////////////////////////////////////////////
/// GetHandleSymbolAddress()
/// returns a pointer to the data or function called "symbolname"
/// from within the shared library with handle "handle"

SCISHARE void* GetHandleSymbolAddress(LIBRARY_HANDLE handle, const std::string symbolname, std::string& errormsg);

/////////////////////////////////////////////////////////////////
/// CloseLibrary()
///
/// disassociates the given library handle from the calling process.

SCISHARE void CloseLibrary(LIBRARY_HANDLE);


////////////////////////////////////////////////////////////////
/// SOError()
/// returns the last error generated by one of the above functions.
/// SCISHARE const char* SOError();

SCISHARE LIBRARY_HANDLE findLib(std::string lib, std::string& errormsg);

inline  LIBRARY_HANDLE findLib(std::string lib)
{
  std::string errormsg;
  return (findLib(lib,errormsg));
}

SCISHARE LIBRARY_HANDLE FindLibInPath(const std::string& lib, const std::string& path,std::string& errormsg);

inline SCISHARE LIBRARY_HANDLE FindLibInPath(const std::string& lib, const std::string& path)
{
  std::string errormsg;
  return (FindLibInPath(lib,path,errormsg));
}

#endif