YACS::BASES::DynLibLoaderWin Class Reference

#include <DynLibLoaderWin.hxx>

Collaboration diagram for YACS::BASES::DynLibLoaderWin:

Public Member Functions
	DynLibLoaderWin (const std::string &libNameWithoutExtension)
	~DynLibLoaderWin ()
bool	isLibFileFindable () const
std::string	getLibNameWithoutExt () const
int	appendDirInSearchPath (const std::string &dirName)
int	removeDirInSearchPath (const std::string &dirName)
void *	getHandleOnSymbolWithName (const std::string &symbName, bool stopOnError=true)
bool	load ()
bool	reload ()
bool	unload ()

Static Public Member Functions
static const char *	getExtensionForDynLib ()

Private Member Functions
void	loadLib ()
void *	resolveSymb (const std::string &symbName, bool stopOnError)
	load lib without regarding that _libName is reachable More...

Private Attributes
HMODULE	_handleOnLoadedLib
std::string	_libName

Static Private Attributes
static const char	_extForDynLib [] =".dll"

Detailed Description

Definition at line 32 of file DynLibLoaderWin.hxx.

Constructor & Destructor Documentation

DynLibLoaderWin()

DynLibLoaderWin::DynLibLoaderWin

(

const std::string &

libNameWithoutExtension

)

Definition at line 28 of file DynLibLoaderWin.cxx.

                                                                        :_libName(libNameWithoutExtension),
                                                                             _handleOnLoadedLib(0)
{
}

~DynLibLoaderWin()

DynLibLoaderWin::~DynLibLoaderWin

(

)

Definition at line 33 of file DynLibLoaderWin.cxx.

{
  if(_handleOnLoadedLib)
    FreeLibrary(_handleOnLoadedLib);
}

References _handleOnLoadedLib.

Member Function Documentation

appendDirInSearchPath()

int DynLibLoaderWin::appendDirInSearchPath

(

const std::string &

dirName

)

Append a directory with name dirName to the searching paths.

Returns

If append succeeds 0 is returned. If the directory does not exists 1 is returned. If the addition of directory causes some troubles due to seach paths name 2 is returned.

Definition at line 55 of file DynLibLoaderWin.cxx.

{
  return 0;
}

getExtensionForDynLib()

const char * DynLibLoaderWin::getExtensionForDynLib ( )

static

Definition at line 133 of file DynLibLoaderWin.cxx.

{
  return _extForDynLib+1;
}

References _extForDynLib.

getHandleOnSymbolWithName()

void * DynLibLoaderWin::getHandleOnSymbolWithName	(	const std::string &	symbName,
		bool	stopOnError = true
	)

Definition at line 71 of file DynLibLoaderWin.cxx.

{
  if(!_handleOnLoadedLib)
    if(!isLibFileFindable())
      {
        std::cerr << "Dynamic library with name " << symbName << _extForDynLib;
        std::cerr << " not existing in paths specified" << std::endl;
        return 0;
      }
    else
      loadLib();
  return resolveSymb(symbName, stopOnError);
}

References _extForDynLib, _handleOnLoadedLib, isLibFileFindable(), loadLib(), and resolveSymb().

getLibNameWithoutExt()

std::string DynLibLoaderWin::getLibNameWithoutExt

(

)

const

Definition at line 44 of file DynLibLoaderWin.cxx.

{
  return _libName;
}

References _libName.

isLibFileFindable()

bool DynLibLoaderWin::isLibFileFindable

(

)

const

Definition at line 39 of file DynLibLoaderWin.cxx.

{
  return true;
}

Referenced by getHandleOnSymbolWithName().

load()

bool DynLibLoaderWin::load

(

)

Definition at line 85 of file DynLibLoaderWin.cxx.

{
  std::string fullLibName(_libName);
  fullLibName+=_extForDynLib;
#if defined(UNICODE) && defined(WIN32)
  size_t length = strlen(fullLibName.c_str()) + sizeof(char);
  wchar_t* aPath = new wchar_t[length + 1];
  memset(aPath, '\0', length);
  mbstowcs(aPath, fullLibName.c_str(), length);
#else
  const char* aPath = fullLibName.c_str();
#endif
 
  _handleOnLoadedLib=LoadLibrary(aPath);
  return _handleOnLoadedLib != NULL;
}

References _extForDynLib, _handleOnLoadedLib, and _libName.

Referenced by reload().

loadLib()

void YACS::BASES::DynLibLoaderWin::loadLib ( )

inlineprivate

Definition at line 52 of file DynLibLoaderWin.hxx.

{ load(); }

Referenced by getHandleOnSymbolWithName().

reload()

bool DynLibLoaderWin::reload

(

)

Definition at line 112 of file DynLibLoaderWin.cxx.

{
  unload();
  return load();
}

References load(), and unload().

removeDirInSearchPath()

int DynLibLoaderWin::removeDirInSearchPath

(

const std::string &

dirName

)

Removes a directory with name dirName from the searching paths.

Returns

If removal succeeds 0 is returned. If the directory does not exists 1 is returned. If the path were not already in existing paths 2 is returned.

Definition at line 66 of file DynLibLoaderWin.cxx.

{
  return 0;
}

resolveSymb()

void * DynLibLoaderWin::resolveSymb ( const std::string &  symbName, bool  stopOnError  )

private

load lib without regarding that _libName is reachable

Definition at line 118 of file DynLibLoaderWin.cxx.

{
  void *ret=(void*)GetProcAddress(_handleOnLoadedLib,symbName.c_str());
  char *message="Not available here !";
  if(stopOnError && (NULL != message))
    {
      std::cerr << "Error detected on symbol " << symbName << " search in library with name " << _libName << _extForDynLib;
      std::cerr << " with the following internal message"<<  std::endl; 
      std::cerr << message << std::endl;
      return 0;
    }
  else
    return ret;
}

References _extForDynLib, _handleOnLoadedLib, and _libName.

Referenced by getHandleOnSymbolWithName().

unload()

bool DynLibLoaderWin::unload

(

)

Definition at line 102 of file DynLibLoaderWin.cxx.

{
  if (_handleOnLoadedLib) 
    {
      FreeLibrary(_handleOnLoadedLib);
      _handleOnLoadedLib = NULL;
    }
  return 0;
}

References _handleOnLoadedLib.

Referenced by reload().

Member Data Documentation

_extForDynLib

const char DynLibLoaderWin::_extForDynLib =".dll"

staticprivate

Definition at line 37 of file DynLibLoaderWin.hxx.

Referenced by getExtensionForDynLib(), getHandleOnSymbolWithName(), load(), and resolveSymb().

_handleOnLoadedLib

HMODULE YACS::BASES::DynLibLoaderWin::_handleOnLoadedLib

private

Definition at line 35 of file DynLibLoaderWin.hxx.

Referenced by getHandleOnSymbolWithName(), load(), resolveSymb(), unload(), and ~DynLibLoaderWin().

_libName

std::string YACS::BASES::DynLibLoaderWin::_libName

private

Definition at line 36 of file DynLibLoaderWin.hxx.

Referenced by getLibNameWithoutExt(), load(), and resolveSymb().

---

The documentation for this class was generated from the following files:

• src/bases/DynLibLoaderWin.hxx
• src/bases/DynLibLoaderWin.cxx