JEEP::JFunctionAdaptorHelper< __pF__ > Struct Template Reference

Auxiliary base class for function adaptor. More...

#include <JFunctionAdaptor.hh>

Inheritance diagram for JEEP::JFunctionAdaptorHelper< __pF__ >:

Public Member Functions
virtual	~JFunctionAdaptorHelper ()
	Virtual destructor. More...
bool	is_valid () const
	Check validity of function. More...
void	reset ()
	Reset function adaptor helper. More...
void	set (__pF__ pf)
	Set function. More...
void	get (const char *symbol)
	Get function with given name according to specific protocol. More...
bool	is_open () const
	Check if shared library file is open. More...
void	open (const char *file_name)
	Open file. More...
void	close ()
	Close file. More...
void	load (const std::string &file_name, const std::string &symbol)
	Load function from shared library. More...
void	load (const std::string &buffer)
	Load function from shared library. More...
void	initialise ()
	Initialise counter. More...
void	attach (const JSharedCounter &object)
	Attach this counter to given shared counter object. More...
bool	detach ()
	Detach. More...
const int	getCount ()
	Get count. More...

Static Public Attributes
static const char	SEPARATOR = ':'
	Separation character between library file name and function name. More...

Protected Member Functions
	JFunctionAdaptorHelper ()
	Default constructor. More...
	JFunctionAdaptorHelper (__pF__ pf)
	Constructor. More...
	JFunctionAdaptorHelper (const std::string &file_name, const std::string &symbol)
	Constructor. More...
	JFunctionAdaptorHelper (const JFunctionAdaptorHelper &helper)
	Copy constructor. More...

Protected Attributes
void *	handle
__pF__	function
int *	counter

Friends
std::istream &	operator>> (std::istream &in, JFunctionAdaptorHelper &object)
	Read function adaptor helper from input stream. More...
std::ostream &	operator<< (std::ostream &out, const JFunctionAdaptorHelper &object)
	Write function adaptor helper to output stream. More...

Detailed Description

template<class __pF__>
struct JEEP::JFunctionAdaptorHelper< __pF__ >

Auxiliary base class for function adaptor.

Note that the dynamic load library internally maintains link counts for the file handles.

Definition at line 33 of file JFunctionAdaptor.hh.

Constructor & Destructor Documentation

template<class __pF__>

virtual JEEP::JFunctionAdaptorHelper< __pF__ >::~JFunctionAdaptorHelper ( )

inlinevirtual

Virtual destructor.

Definition at line 45 of file JFunctionAdaptor.hh.

    {
      reset();
    }

template<class __pF__>

JEEP::JFunctionAdaptorHelper< __pF__ >::JFunctionAdaptorHelper ( )

inlineprotected

Default constructor.

Definition at line 237 of file JFunctionAdaptor.hh.

                             :
      handle  (NULL),
      function(NULL)
    {}

template<class __pF__>

JEEP::JFunctionAdaptorHelper< __pF__ >::JFunctionAdaptorHelper ( __pF__  pf )

inlineprotected

Constructor.

Parameters

pf	pointer to function

Definition at line 248 of file JFunctionAdaptor.hh.

                                      :
      handle  (NULL),
      function(pf)
    {}

template<class __pF__>

JEEP::JFunctionAdaptorHelper< __pF__ >::JFunctionAdaptorHelper ( const std::string &  file_name, const std::string &  symbol  )

inlineprotected

Constructor.

Parameters

file_name	file name
symbol	function name

Definition at line 260 of file JFunctionAdaptor.hh.

                                                    :
      handle  (NULL),
      function(NULL)
    {
      this->load(file_name, symbol);
    }

template<class __pF__>

JEEP::JFunctionAdaptorHelper< __pF__ >::JFunctionAdaptorHelper ( const JFunctionAdaptorHelper< __pF__ > &  helper )

inlineprotected

Copy constructor.

Parameters

helper

helper

Definition at line 274 of file JFunctionAdaptor.hh.

                                                                 :
      handle  (helper.handle),
      function(helper.function)
    {
      if (is_open()) {
        attach(helper);
      }
    }

Member Function Documentation

template<class __pF__>

bool JEEP::JFunctionAdaptorHelper< __pF__ >::is_valid ( ) const

inline

Check validity of function.

Returns

true if valid function; else false

Definition at line 56 of file JFunctionAdaptor.hh.

    {
      return (function != NULL);
    }

template<class __pF__>

void JEEP::JFunctionAdaptorHelper< __pF__ >::reset ( )

inline

Reset function adaptor helper.

Definition at line 65 of file JFunctionAdaptor.hh.

    {
      if (detach()) {
        close();
      }
      
      function = NULL;
    }

template<class __pF__>

void JEEP::JFunctionAdaptorHelper< __pF__ >::set ( __pF__  pf )

inline

Set function.

Parameters

pf	pointer to function

Definition at line 80 of file JFunctionAdaptor.hh.

    {
      close();
      
      function = pf;
    }

template<class __pF__>

void JEEP::JFunctionAdaptorHelper< __pF__ >::get ( const char *  symbol )

inline

Get function with given name according to specific protocol.

Parameters

symbol

function name

Definition at line 93 of file JFunctionAdaptor.hh.

    {
      function = NULL;

      if (handle != NULL) {

        dlerror();                 // reset errors

        function = (__pF__) dlsym(handle, symbol);

        const char* error = dlerror();

        if (error != NULL) {
          THROW(JFileReadException, error);
        }

      } else {

        THROW(JFileReadException, "Invalid handle.");
      }
    }

template<class __pF__>

bool JEEP::JFunctionAdaptorHelper< __pF__ >::is_open ( ) const

inline

Check if shared library file is open.

Returns

true if open; else false

Definition at line 121 of file JFunctionAdaptor.hh.

    {
      return (handle != NULL);
    }

template<class __pF__>

void JEEP::JFunctionAdaptorHelper< __pF__ >::open ( const char *  file_name )

inline

Open file.

Parameters

file_name

file name

Definition at line 132 of file JFunctionAdaptor.hh.

    {
      reset();
      
      handle = dlopen(file_name, RTLD_LOCAL | RTLD_LAZY);

      if (!handle) {
        THROW(JFileOpenException, dlerror());
      }

      initialise();
    }

template<class __pF__>

void JEEP::JFunctionAdaptorHelper< __pF__ >::close ( )

inline

Close file.

Note that the file should remain open as long as the library function is used.

Definition at line 151 of file JFunctionAdaptor.hh.

    {
      if (handle != NULL) {
        dlclose(handle);
        dlclose(handle);
      }

      handle = NULL;
    }

template<class __pF__>

void JEEP::JFunctionAdaptorHelper< __pF__ >::load ( const std::string &  file_name, const std::string &  symbol  )

inline

Load function from shared library.

Parameters

file_name	file name
symbol	function name

Definition at line 168 of file JFunctionAdaptor.hh.

    {
      open(file_name.c_str());

      get(symbol.c_str());
    }

template<class __pF__>

void JEEP::JFunctionAdaptorHelper< __pF__ >::load ( const std::string &  buffer )

inline

Load function from shared library.

The input buffer should consist of <file name>SEPARATOR<symbol>.

Parameters

buffer

input

Definition at line 183 of file JFunctionAdaptor.hh.

    {
      using namespace std;

      const string::size_type pos = buffer.rfind(SEPARATOR);

      if (pos != string::npos) {

        load(buffer.substr(0,pos).c_str(), buffer.substr(pos+1).c_str());

      } else {

        THROW(JParseError, "Missing separator " << SEPARATOR << " in " << buffer);
      }
    }

void JLANG::JSharedCounter::initialise ( )

inlineinherited

Initialise counter.

Definition at line 33 of file JSharedCounter.hh.

    {
      detach();

      counter = new int(1);
    }

void JLANG::JSharedCounter::attach ( const JSharedCounter &  object )

inlineinherited

Attach this counter to given shared counter object.

Parameters

object

shared counter

Definition at line 46 of file JSharedCounter.hh.

    {
      detach();

      counter = object.counter;

      if (counter != NULL) {
        ++(*counter);
      }
    }

bool JLANG::JSharedCounter::detach ( )

inlineinherited

Detach.

Returns

true if counter at zero; else false

Definition at line 63 of file JSharedCounter.hh.

    {
      if (counter != NULL) {

        if (--(*counter) == 0) {

          delete counter;

          counter = NULL;

          return true;
        }

        counter = NULL;
      }

      return false;
    }

const int JLANG::JSharedCounter::getCount ( )

inlineinherited

Get count.

Returns

count

Definition at line 88 of file JSharedCounter.hh.

    {
      return (counter != NULL ? *counter : 0);
    }

Friends And Related Function Documentation

template<class __pF__>

std::istream& operator>> ( std::istream &  in, JFunctionAdaptorHelper< __pF__ > &  object  )

friend

Read function adaptor helper from input stream.

Parameters

in	input stream
object	function adaptor helper

Returns

input stream

Definition at line 207 of file JFunctionAdaptor.hh.

    {
      object.reset();

      std::string buffer;

      if (in >> buffer) {
        object.load(buffer);
      }
      
      return in;
    }

template<class __pF__>

std::ostream& operator<< ( std::ostream &  out, const JFunctionAdaptorHelper< __pF__ > &  object  )

friend

Write function adaptor helper to output stream.

Parameters

out	output stream
object	function adaptor helper

Returns

output stream

Definition at line 228 of file JFunctionAdaptor.hh.

    {
      return out;
    }

Member Data Documentation

template<class __pF__>

const char JEEP::JFunctionAdaptorHelper< __pF__ >::SEPARATOR = ':'

static

Separation character between library file name and function name.

Definition at line 39 of file JFunctionAdaptor.hh.

template<class __pF__>

void* JEEP::JFunctionAdaptorHelper< __pF__ >::handle

protected

Definition at line 283 of file JFunctionAdaptor.hh.

template<class __pF__>

__pF__ JEEP::JFunctionAdaptorHelper< __pF__ >::function

protected

Definition at line 284 of file JFunctionAdaptor.hh.

int* JLANG::JSharedCounter::counter

protectedinherited

Definition at line 94 of file JSharedCounter.hh.

---

The documentation for this struct was generated from the following file:

• JFunctionAdaptor.hh