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. More...
void	reset ()
	Reset function adaptor helper. More...
void	set (pF pf)
	Set function. More...
void	open (const char *file_name)
	Open file. More...
void	close ()
	Close file. 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...

Protected Member Functions
	JFunctionAdaptorHelper ()
	Default constructor. More...
	JFunctionAdaptorHelper (const JFunctionAdaptorHelper &helper)
	Copy constructor. More...
	JFunctionAdaptorHelper (pF pf)
	Constructor. More...
	JFunctionAdaptorHelper (const char *file_name, const char *function_name)
	Constructor. More...
void	get (const char *function_name)
	Get function with given name according to specific protocol. 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.

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 39 of file JFunctionAdaptor.hh.

    {
      if (detach()) {
        close();
      }
    }

template<class pF>

JEEP::JFunctionAdaptorHelper< pF >::JFunctionAdaptorHelper ( )

inlineprotected

Default constructor.

Definition at line 160 of file JFunctionAdaptor.hh.

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

template<class pF>

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

inlineprotected

Copy constructor.

Parameters

helper

helper

Definition at line 171 of file JFunctionAdaptor.hh.

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

template<class pF>

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

inlineprotected

Constructor.

Parameters

pf	pointer to function

Definition at line 184 of file JFunctionAdaptor.hh.

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

template<class pF>

JEEP::JFunctionAdaptorHelper< pF >::JFunctionAdaptorHelper ( const char *  file_name, const char *  function_name  )

inlineprotected

Constructor.

Parameters

file_name	file name
function_name	function name

Definition at line 196 of file JFunctionAdaptor.hh.

                                                      :
      handle  (NULL),
      function(NULL)
    {
      this->open(file_name);

      this->get(function_name);
    }

Member Function Documentation

template<class pF>

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

inline

Check validity.

Returns

true if valid function; else false

Definition at line 52 of file JFunctionAdaptor.hh.

    {
      return (function != NULL);
    }

template<class pF>

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

inline

Reset function adaptor helper.

Definition at line 61 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 76 of file JFunctionAdaptor.hh.

    {
      reset();
      
      function = pf;
    }

template<class pF>

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

inline

Open file.

Parameters

file_name

file name

Definition at line 89 of file JFunctionAdaptor.hh.

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

      if (!handle) {
        THROW(JLANG::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 method is used.

Definition at line 108 of file JFunctionAdaptor.hh.

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

      handle = NULL;
    }

template<class pF>

void JEEP::JFunctionAdaptorHelper< pF >::get ( const char *  function_name )

inlineprotected

Get function with given name according to specific protocol.

Parameters

function_name

function name

Definition at line 212 of file JFunctionAdaptor.hh.

    {
      function = NULL;

      if (handle != NULL) {
      
        dlerror();  // reset errors
      
        function = (pF) dlsym(handle, function_name);
        
        const char* error = dlerror();
        
        if (error != NULL) {
          THROW(JLANG::JFileReadException, error);
        }
        
      } else {

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

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 125 of file JFunctionAdaptor.hh.

    {
      using namespace std;

      object.reset();
      
      string file_name, function_name;
      
      if (in >> file_name >> function_name) {

        object.open(file_name.c_str());

        object.get(function_name.c_str());
      }
      
      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 151 of file JFunctionAdaptor.hh.

    {
      return out;
    }

Member Data Documentation

template<class pF>

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

protected

Definition at line 234 of file JFunctionAdaptor.hh.

template<class pF>

pF JEEP::JFunctionAdaptorHelper< pF >::function

protected

Definition at line 235 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