Class for opening shared libraries. More...

#include <LibraryManager.h>

Public Types
enum	LoadLibraries { Recursive , NonRecursive }

Public Member Functions
	LibraryManagerImpl (const LibraryManagerImpl &)=delete

int	openLibraries (const std::string &libpath, LoadLibraries loadingBehaviour, const std::vector< std::string > &excludes)
	Opens suitable DLLs on a given path.

LibraryManagerImpl &	operator= (const LibraryManagerImpl &)=delete

Private Member Functions
bool	isExcluded (const std::string &filename, const std::vector< std::string > &excludes) const
	Returns true if the library has been requested to be excluded.

bool	isLoaded (const std::string &filename) const
	Check if the library has already been loaded.

	LibraryManagerImpl ()
	Private Constructor.

int	openLibraries (const std::filesystem::path &libpath, LoadLibraries loadingBehaviour, const std::vector< std::string > &excludes)
	Load libraries from the given filesystem path Private so filesystem implementation doesn't leak to the public interface.

int	openLibrary (const std::filesystem::path &filepath, const std::string &cacheKey)
	Load a given library.

bool	shouldBeLoaded (const std::string &filename, const std::vector< std::string > &excludes) const
	Check if the library should be loaded.

	~LibraryManagerImpl ()=default
	Private Destructor.

Private Attributes
std::unordered_map< std::string, LibraryWrapper >	m_openedLibs
	Storage for the LibraryWrappers.

Friends
struct	Mantid::Kernel::CreateUsingNew< LibraryManagerImpl >

Detailed Description

Class for opening shared libraries.

Author: ISIS, STFC

Date: 15/10/2007

Definition at line 29 of file LibraryManager.h.

Member Enumeration Documentation

◆ LoadLibraries

enum Mantid::Kernel::LibraryManagerImpl::LoadLibraries

Enumerator
Recursive
NonRecursive

Definition at line 31 of file LibraryManager.h.

Constructor & Destructor Documentation

◆ LibraryManagerImpl() [1/2]

Mantid::Kernel::LibraryManagerImpl::LibraryManagerImpl ( const LibraryManagerImpl & )

delete

◆ LibraryManagerImpl() [2/2]

Mantid::Kernel::LibraryManagerImpl::LibraryManagerImpl ( )

private

Private Constructor.

Constructor.

Definition at line 22 of file LibraryManager.cpp.

References Mantid::Kernel::Logger::debug(), and Mantid::Kernel::DateAndTimeHelpers::g_log.

◆ ~LibraryManagerImpl()

Mantid::Kernel::LibraryManagerImpl::~LibraryManagerImpl ( )

privatedefault

Private Destructor.

Member Function Documentation

◆ isExcluded()

bool Mantid::Kernel::LibraryManagerImpl::isExcluded	(	const std::string &	filename,
		const std::vector< std::string > &	excludes
	)		const

private

Returns true if the library has been requested to be excluded.

Returns true if the name contains one of the strings given in the exclude list.

Each string from the variable is searched for with the filename so an exact match is not necessary. This avoids having to specify prefixes and suffixes for different platforms, i.e. 'plugins.exclude = MantidKernel' will exclude libMantidKernel.so

Parameters

filename	The filename of the library (no directory)
excludes	A list of substrings to exclude library from loading

Returns: True if the library should be skipped

Definition at line 115 of file LibraryManager.cpp.

Referenced by shouldBeLoaded().

◆ isLoaded()

bool Mantid::Kernel::LibraryManagerImpl::isLoaded ( const std::string & filename ) const

private

Check if the library has already been loaded.

Check if the library been loaded already?

Parameters

filename The filename of the library, i.e no directory

Returns: True if the library has been seen before

Definition at line 101 of file LibraryManager.cpp.

References m_openedLibs.

Referenced by shouldBeLoaded().

◆ openLibraries() [1/2]

int Mantid::Kernel::LibraryManagerImpl::openLibraries	(	const std::filesystem::path &	libpath,
		LibraryManagerImpl::LoadLibraries	loadingBehaviour,
		const std::vector< std::string > &	excludes
	)

private

Load libraries from the given filesystem path Private so filesystem implementation doesn't leak to the public interface.

Opens suitable DLLs on a given path.

Parameters

libpath	An std::filesystem::path object pointing to a directory where the libraries are.
loadingBehaviour	Control how libraries are searched for
excludes	If not empty then each string is considered as a substring to search within each library to be opened. If the substring is found then the library is not opened.

Returns: The number of libraries opened.

Definition at line 60 of file LibraryManager.cpp.

References Mantid::Kernel::Logger::error(), Mantid::Kernel::DateAndTimeHelpers::g_log, openLibraries(), openLibrary(), Recursive, and shouldBeLoaded().

◆ openLibraries() [2/2]

int Mantid::Kernel::LibraryManagerImpl::openLibraries	(	const std::string &	filepath,
		LoadLibraries	loadingBehaviour,
		const std::vector< std::string > &	excludes
	)

Opens suitable DLLs on a given path.

Parameters

filepath	The filepath to the directory where the libraries are.
loadingBehaviour	Control how libraries are searched for
excludes	If not empty then each string is considered as a substring to search within each library to be opened. If the substring is found then the library is not opened.

Returns: The number of libraries opened.

Definition at line 33 of file LibraryManager.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::Kernel::Logger::error(), Mantid::Kernel::DateAndTimeHelpers::g_log, and openLibraries().

Referenced by openLibraries(), and openLibraries().

◆ openLibrary()

int Mantid::Kernel::LibraryManagerImpl::openLibrary	(	const std::filesystem::path &	filepath,
		const std::string &	cacheKey
	)

private

Load a given library.

Load a library.

Parameters

filepath	:: An std::filesystem::path The full path to a library as a string
cacheKey	:: An identifier for the cache if loading is successful

Returns: 1 if the file loaded successfully, 0 otherwise

Definition at line 126 of file LibraryManager.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::Kernel::DateAndTimeHelpers::g_log, Mantid::Kernel::Logger::is(), m_openedLibs, and Mantid::Kernel::LibraryWrapper::openLibrary().

Referenced by openLibraries().

◆ operator=()

LibraryManagerImpl & Mantid::Kernel::LibraryManagerImpl::operator= ( const LibraryManagerImpl & )

delete

◆ shouldBeLoaded()

bool Mantid::Kernel::LibraryManagerImpl::shouldBeLoaded	(	const std::string &	filename,
		const std::vector< std::string > &	excludes
	)		const

private

Check if the library should be loaded.

Parameters

filename	The filename of the library, i.e no directory
excludes	If not empty then each string is considered as a substring to search within each library to be opened. If the substring is found then the library is not opened.

Returns: True if loading should be attempted

Definition at line 92 of file LibraryManager.cpp.

References isExcluded(), isLoaded(), and Mantid::Kernel::DllOpen::isValidFilename().

Referenced by openLibraries().

Friends And Related Symbol Documentation

◆ Mantid::Kernel::CreateUsingNew< LibraryManagerImpl >

friend struct Mantid::Kernel::CreateUsingNew< LibraryManagerImpl >

friend

Definition at line 35 of file LibraryManager.h.

Member Data Documentation

◆ m_openedLibs

std::unordered_map<std::string, LibraryWrapper> Mantid::Kernel::LibraryManagerImpl::m_openedLibs

private

Storage for the LibraryWrappers.

Definition at line 59 of file LibraryManager.h.

Referenced by isLoaded(), and openLibrary().

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

Framework/Kernel/inc/MantidKernel/LibraryManager.h
Framework/Kernel/src/LibraryManager.cpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ LoadLibraries

Constructor & Destructor Documentation

◆ LibraryManagerImpl() [1/2]

◆ LibraryManagerImpl() [2/2]

◆ ~LibraryManagerImpl()

Member Function Documentation

◆ isExcluded()

◆ isLoaded()

◆ openLibraries() [1/2]

◆ openLibraries() [2/2]

◆ openLibrary()

◆ operator=()

◆ shouldBeLoaded()

Friends And Related Symbol Documentation

◆ Mantid::Kernel::CreateUsingNew< LibraryManagerImpl >

Member Data Documentation

◆ m_openedLibs