utils::InterfaceTable Class Reference

The InterfaceTable contains a list of interfaces. From this class caller can add and query a given interface. More...

#include <interfaces_utils.h>

Collaboration diagram for utils::InterfaceTable:

[legend]

Public Member Functions
	InterfaceTable ()
	~InterfaceTable ()
template<class T >
void	add_entry (T *ptr)
bool	query_interface (const char *name, void **return_ptr)
template<class T >
bool	contain_interface (T *ptr)
	InterfaceTable ()
	~InterfaceTable ()
template<class T >
void	add_entry (T *ptr)
bool	query_interface (const char *name, void **return_ptr)
template<class T >
bool	contain_interface (T *ptr)
	InterfaceTable ()
	~InterfaceTable ()
template<class T >
void	add_entry (T *ptr)
bool	query_interface (const char *name, void **return_ptr)
template<class T >
bool	contain_interface (T *ptr)

---

Detailed Description

The InterfaceTable contains a list of interfaces. From this class caller can add and query a given interface.

Definition at line 102 of file images/plugin_impl/interfaces_utils.h.

---

Constructor & Destructor Documentation

utils::InterfaceTable::InterfaceTable

(

)

[inline]

Definition at line 105 of file images/plugin_impl/interfaces_utils.h.

    {
    }

utils::InterfaceTable::~InterfaceTable

(

)

[inline]

Definition at line 109 of file images/plugin_impl/interfaces_utils.h.

    {
        clear();
    }

utils::InterfaceTable::InterfaceTable

(

)

[inline]

Definition at line 105 of file pdf/plugin_impl/interfaces_utils.h.

    {
    }

utils::InterfaceTable::~InterfaceTable

(

)

[inline]

Definition at line 109 of file pdf/plugin_impl/interfaces_utils.h.

    {
        clear();
    }

utils::InterfaceTable::InterfaceTable

(

)

[inline]

Definition at line 105 of file plaintext/plugin_impl/interfaces_utils.h.

    {
    }

utils::InterfaceTable::~InterfaceTable

(

)

[inline]

Definition at line 109 of file plaintext/plugin_impl/interfaces_utils.h.

    {
        clear();
    }

---

Member Function Documentation

template<class T >

void utils::InterfaceTable::add_entry

(

T *

ptr

)

[inline]

Definition at line 116 of file plaintext/plugin_impl/interfaces_utils.h.

References ERRORPRINTF, utils::MAX_INTERFACES, and name.

    {
        interfaces.push_back(new InterfaceEntry<T>(ptr));
        unsigned int size = interfaces.size();
        if (size > MAX_INTERFACES)
        {
            ERRORPRINTF("Too many interfaces for class %s: interfaces.size [%u] max [%u]",
                        typeid(T).name(), size, MAX_INTERFACES);
        }
    }

template<class T >

void utils::InterfaceTable::add_entry

(

T *

ptr

)

[inline]

Definition at line 116 of file pdf/plugin_impl/interfaces_utils.h.

References ERRORPRINTF, utils::MAX_INTERFACES, and name.

    {
        interfaces.push_back(new InterfaceEntry<T>(ptr));
        unsigned int size = interfaces.size();
        if (size > MAX_INTERFACES)
        {
            ERRORPRINTF("Too many interfaces for class %s: interfaces.size [%u] max [%u]",
                        typeid(T).name(), size, MAX_INTERFACES);
        }
    }

template<class T >

void utils::InterfaceTable::add_entry

(

T *

ptr

)

[inline]

Definition at line 116 of file images/plugin_impl/interfaces_utils.h.

References ERRORPRINTF, utils::MAX_INTERFACES, and name.

Referenced by utils::ObjectTable< PluginRenderResultImpl >::add_interface().

    {
        interfaces.push_back(new InterfaceEntry<T>(ptr));
        unsigned int size = interfaces.size();
        if (size > MAX_INTERFACES)
        {
            ERRORPRINTF("Too many interfaces for class %s: interfaces.size [%u] max [%u]",
                        typeid(T).name(), size, MAX_INTERFACES);
        }
    }

Here is the caller graph for this function:

template<class T >

bool utils::InterfaceTable::contain_interface

(

T *

ptr

)

[inline]

Definition at line 145 of file plaintext/plugin_impl/interfaces_utils.h.

    {
        Iter begin = interfaces.begin();
        Iter end   = interfaces.end();
        for(Iter it = begin; it != end; ++it)
        {
            if (ptr == (*it)->get_pointer())
            {
                return true;
            }
        }
        return false;
    }

template<class T >

bool utils::InterfaceTable::contain_interface

(

T *

ptr

)

[inline]

Definition at line 145 of file pdf/plugin_impl/interfaces_utils.h.

    {
        Iter begin = interfaces.begin();
        Iter end   = interfaces.end();
        for(Iter it = begin; it != end; ++it)
        {
            if (ptr == (*it)->get_pointer())
            {
                return true;
            }
        }
        return false;
    }

template<class T >

bool utils::InterfaceTable::contain_interface

(

T *

ptr

)

[inline]

Definition at line 145 of file images/plugin_impl/interfaces_utils.h.

    {
        Iter begin = interfaces.begin();
        Iter end   = interfaces.end();
        for(Iter it = begin; it != end; ++it)
        {
            if (ptr == (*it)->get_pointer())
            {
                return true;
            }
        }
        return false;
    }

bool utils::InterfaceTable::query_interface	(	const char *	name,
		void **	return_ptr
	)			[inline]

Definition at line 127 of file plaintext/plugin_impl/interfaces_utils.h.

    {
        Iter begin = interfaces.begin();
        Iter end   = interfaces.end();
        for(Iter it = begin; it != end; ++it)
        {
            if ((*it)->is_name_equal(name))
            {
                *return_ptr = (*it)->get_pointer();
                return true;
            }
        }
        // This could happen when caller wants to query a optional
        // interface. Should not use assert here.
        return false;
    }

bool utils::InterfaceTable::query_interface	(	const char *	name,
		void **	return_ptr
	)			[inline]

Definition at line 127 of file pdf/plugin_impl/interfaces_utils.h.

    {
        Iter begin = interfaces.begin();
        Iter end   = interfaces.end();
        for(Iter it = begin; it != end; ++it)
        {
            if ((*it)->is_name_equal(name))
            {
                *return_ptr = (*it)->get_pointer();
                return true;
            }
        }
        // This could happen when caller wants to query a optional
        // interface. Should not use assert here.
        return false;
    }

bool utils::InterfaceTable::query_interface	(	const char *	name,
		void **	return_ptr
	)			[inline]

Definition at line 127 of file images/plugin_impl/interfaces_utils.h.

    {
        Iter begin = interfaces.begin();
        Iter end   = interfaces.end();
        for(Iter it = begin; it != end; ++it)
        {
            if ((*it)->is_name_equal(name))
            {
                *return_ptr = (*it)->get_pointer();
                return true;
            }
        }
        // This could happen when caller wants to query a optional
        // interface. Should not use assert here.
        return false;
    }

---

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

• images/plugin_impl/interfaces_utils.h
• pdf/plugin_impl/interfaces_utils.h
• plaintext/plugin_impl/interfaces_utils.h