interface class for libraries. More...

#include <LibraryInterface.h>

Inheritance diagram for etiss::LibraryInterface:

Collaboration diagram for etiss::LibraryInterface:

[legend]

Public Member Functions
	LibraryInterface (std::string name)

virtual	~LibraryInterface ()

virtual std::string	versionInfo ()
	simple version info string. intended to present information in a human readable way.

virtual unsigned	countPlugins ()

virtual unsigned	countCPUArchs ()

virtual unsigned	countJITs ()

virtual std::string	nameJIT (unsigned index)

virtual std::string	namePlugin (unsigned index)

virtual std::string	nameCPUArch (unsigned index)

virtual etiss::JIT *	createJIT (unsigned index, std::map< std::string, std::string > options=std::map< std::string, std::string >())

virtual etiss::CPUArch *	createCPUArch (unsigned index, std::map< std::string, std::string > options=std::map< std::string, std::string >())

virtual etiss::Plugin *	createPlugin (unsigned index, std::map< std::string, std::string > options=std::map< std::string, std::string >())

virtual void	deleteJIT (etiss::JIT *)

virtual void	deleteCPUArch (etiss::CPUArch *)

virtual void	deletePlugin (etiss::Plugin *)

virtual bool	isEmpty ()
	returns true if this library provides nothing

virtual const std::string &	getName ()

Static Public Member Functions
static std::shared_ptr< LibraryInterface >	openSharedLibrary (std::string path, std::string name)

static std::shared_ptr< LibraryInterface >	openIntegratedLibrary ()

static unsigned	getCurrentLibraryVersion ()

static void	addSearchPath (const std::string &path)

Private Attributes
std::string	name_

Detailed Description

interface class for libraries.

override functions as needed.

it is neccessary to override all function of the same category. e.g. for plugins: countPlugins(),namePlugin(1),createPlugin(1),deletePlugin(1). isEmpty() uses countXXXXXX() functions to assess its return value and doesn't need to be implemented.

to implement a dynamic library do NOT use this class. Refer to etiss/helper/CPUArchLibrary.h , etiss/helper/JITLibrary.h , etiss/helper/PluginLibrary.h for library functions to implement and use etiss::LibraryInterface::openSharedLibrary to load the dynamic library

Definition at line 47 of file LibraryInterface.h.

Constructor & Destructor Documentation

◆ LibraryInterface()

LibraryInterface::LibraryInterface ( std::string name )

Parameters

name	name of the library
path	location of the library and its files

Definition at line 28 of file LibraryInterface.cpp.

◆ ~LibraryInterface()

LibraryInterface::~LibraryInterface ( )

virtual

Definition at line 29 of file LibraryInterface.cpp.

Member Function Documentation

◆ addSearchPath()

void LibraryInterface::addSearchPath ( const std::string & path )

static

Definition at line 567 of file LibraryInterface.cpp.

References int.

Referenced by TCCJIT::translate().

Here is the caller graph for this function:

◆ countCPUArchs()

unsigned LibraryInterface::countCPUArchs ( )

virtual

Reimplemented in IntegratedLibrary.

Definition at line 40 of file LibraryInterface.cpp.

Referenced by isEmpty().

Here is the caller graph for this function:

◆ countJITs()

unsigned LibraryInterface::countJITs ( )

virtual

Reimplemented in IntegratedLibrary.

Definition at line 44 of file LibraryInterface.cpp.

Referenced by isEmpty().

Here is the caller graph for this function:

◆ countPlugins()

unsigned LibraryInterface::countPlugins ( )

virtual

Reimplemented in IntegratedLibrary.

Definition at line 36 of file LibraryInterface.cpp.

Referenced by isEmpty().

Here is the caller graph for this function:

◆ createCPUArch()

etiss::CPUArch * LibraryInterface::createCPUArch	(	unsigned	index,
		std::map< std::string, std::string >	options = `std::map<std::string, std::string>()`
	)

virtual

Reimplemented in IntegratedLibrary.

Definition at line 66 of file LibraryInterface.cpp.

◆ createJIT()

etiss::JIT * LibraryInterface::createJIT	(	unsigned	index,
		std::map< std::string, std::string >	options = `std::map<std::string, std::string>()`
	)

virtual

Reimplemented in IntegratedLibrary.

Definition at line 62 of file LibraryInterface.cpp.

◆ createPlugin()

etiss::Plugin * LibraryInterface::createPlugin	(	unsigned	index,
		std::map< std::string, std::string >	options = `std::map<std::string, std::string>()`
	)

virtual

Reimplemented in IntegratedLibrary.

Definition at line 70 of file LibraryInterface.cpp.

◆ deleteCPUArch()

void LibraryInterface::deleteCPUArch ( etiss::CPUArch * )

virtual

Reimplemented in IntegratedLibrary.

Definition at line 76 of file LibraryInterface.cpp.

◆ deleteJIT()

void LibraryInterface::deleteJIT ( etiss::JIT * )

virtual

Reimplemented in IntegratedLibrary.

Definition at line 75 of file LibraryInterface.cpp.

◆ deletePlugin()

void LibraryInterface::deletePlugin ( etiss::Plugin * )

virtual

Reimplemented in IntegratedLibrary.

Definition at line 77 of file LibraryInterface.cpp.

◆ getCurrentLibraryVersion()

unsigned etiss::LibraryInterface::getCurrentLibraryVersion ( )

static

Definition at line 145 of file IntegratedLibrary.cpp.

◆ getName()

const std::string & LibraryInterface::getName ( )

virtual

Returns: name of this library

Definition at line 84 of file LibraryInterface.cpp.

References name_.

◆ isEmpty()

bool LibraryInterface::isEmpty ( )

virtual

returns true if this library provides nothing

Definition at line 79 of file LibraryInterface.cpp.

References countCPUArchs(), countJITs(), and countPlugins().

Here is the call graph for this function:

◆ nameCPUArch()

std::string LibraryInterface::nameCPUArch ( unsigned index )

virtual

Reimplemented in IntegratedLibrary.

Definition at line 57 of file LibraryInterface.cpp.

◆ nameJIT()

std::string LibraryInterface::nameJIT ( unsigned index )

virtual

Reimplemented in IntegratedLibrary.

Definition at line 49 of file LibraryInterface.cpp.

◆ namePlugin()

std::string LibraryInterface::namePlugin ( unsigned index )

virtual

Reimplemented in IntegratedLibrary.

Definition at line 53 of file LibraryInterface.cpp.

◆ openIntegratedLibrary()

std::shared_ptr< etiss::LibraryInterface > etiss::LibraryInterface::openIntegratedLibrary ( )

static

Definition at line 86 of file IntegratedLibraryHelper.cpp.

Referenced by etiss_initialize().

Here is the caller graph for this function:

◆ openSharedLibrary()

std::shared_ptr< LibraryInterface > LibraryInterface::openSharedLibrary	(	std::string	path,
		std::string	name
	)

static

Definition at line 489 of file LibraryInterface.cpp.

References etiss::ERROR, ETISS_SRCLOC, ETISS_VARVAL, etiss::INFO, etiss::log(), etiss::VERBOSE, and etiss::WARNING.

Referenced by etiss::loadLibrary().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ versionInfo()

std::string LibraryInterface::versionInfo ( )

virtual

simple version info string. intended to present information in a human readable way.

Reimplemented in IntegratedLibrary.

Definition at line 31 of file LibraryInterface.cpp.

Member Data Documentation

◆ name_

std::string etiss::LibraryInterface::name_

private

Definition at line 103 of file LibraryInterface.h.

Referenced by getName().

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

/home/runner/work/etiss/etiss/include/etiss/LibraryInterface.h
/home/runner/work/etiss/etiss/src/IntegratedLibrary.cpp
/home/runner/work/etiss/etiss/src/IntegratedLibraryHelper.cpp
/home/runner/work/etiss/etiss/src/LibraryInterface.cpp

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LibraryInterface()

◆ ~LibraryInterface()

Member Function Documentation

◆ addSearchPath()

◆ countCPUArchs()

◆ countJITs()

◆ countPlugins()

◆ createCPUArch()

◆ createJIT()

◆ createPlugin()

◆ deleteCPUArch()

◆ deleteJIT()

◆ deletePlugin()

◆ getCurrentLibraryVersion()

◆ getName()

◆ isEmpty()

◆ nameCPUArch()

◆ nameJIT()

◆ namePlugin()

◆ openIntegratedLibrary()

◆ openSharedLibrary()

◆ versionInfo()

Member Data Documentation

◆ name_