CallbackChain Class Reference

Callback chains contain zero or more callbacks. More...

Inheritance diagram for CallbackChain:

Collaboration diagram for CallbackChain:

Classes
class	CallbackNode

Public Member Functions
	CallbackChain (string _name)
	ATTRIB (CallbackChain, cbc_next, CallbackNode)
bool	CallbackChain_Add (CallbackChain this, Callback cb, int order)
bool	CallbackChain_Call (CallbackChain this)
int	CallbackChain_Remove (CallbackChain this, Callback cb)

Public Attributes
int	cbc_order = 0

Detailed Description

Callback chains contain zero or more callbacks.

Definition at line 39 of file base.qh.

Constructor & Destructor Documentation

CallbackChain()

CallbackChain::CallbackChain ( string _name )

inline

Definition at line 53 of file base.qh.

                                             {
        CONSTRUCT(CallbackChain);
        this.netname = _name;
    }

References CallbackChain(), CONSTRUCT, CONSTRUCTOR, and netname.

Referenced by CallbackChain(), ATTRIB(), CallbackChain_Add(), CallbackChain_Call(), and CallbackChain_Remove().

Member Function Documentation

ATTRIB()

CallbackChain::ATTRIB	(	CallbackChain	,
		cbc_next	,
		CallbackNode	)

References CallbackChain(), and ATTRIB().

Referenced by ATTRIB().

CallbackChain_Add()

bool CallbackChain::CallbackChain_Add ( CallbackChain this, Callback cb, int order )

inline

Definition at line 58 of file base.qh.

    {
        if (order & CBC_ORDER_FIRST) {
            if (order & CBC_ORDER_LAST)
                if (this.cbc_order & CBC_ORDER_ANY)
                    return false;
            if (this.cbc_order & CBC_ORDER_FIRST)
                return false;
        } else if (order & CBC_ORDER_LAST) {
            if (this.cbc_order & CBC_ORDER_LAST)
                return false;
        }
        entity node = NEW(CallbackNode, cb, order);
        if (order & CBC_ORDER_FIRST) {
            node.cbc_next = this.cbc_next;
            this.cbc_next = node;
        } else if (order & CBC_ORDER_LAST) {
            CallbackNode prev = NULL, it = this.cbc_next;
            while (it) { prev = it, it = it.cbc_next; }
            if (prev) prev.cbc_next = node;
            else this.cbc_next = node;
        } else {
            // by default we execute last, but before a possible CBC_ORDER_LAST callback
            CallbackNode prev = NULL, it = this.cbc_next;
            while (it && !(it.cbc_order & CBC_ORDER_LAST)) { prev = it, it = it.cbc_next; }
            node.cbc_next = it;
            if (prev) prev.cbc_next = node;
            else this.cbc_next = node;
        }
        this.cbc_order |= (order | CBC_ORDER_ANY);
        return true;
    }

References CallbackChain(), cbc_order, CBC_ORDER_ANY, CBC_ORDER_FIRST, CBC_ORDER_LAST, entity(), NEW, NULL, and prev.

CallbackChain_Call()

bool CallbackChain::CallbackChain_Call ( CallbackChain this )

inline

Definition at line 107 of file base.qh.

    {
        bool r = false;
        for (Callback it = this.cbc_next; it; it = it.cbc_next) {
            CallbackChain_ReturnValue = r;
            r |= it.cbc.cbc_func();
        }
        return r; // callbacks return an error status, so 0 is default return value
    }

References CallbackChain(), and CallbackChain_ReturnValue.

CallbackChain_Remove()

int CallbackChain::CallbackChain_Remove ( CallbackChain this, Callback cb )

inline

Definition at line 90 of file base.qh.

    {
        int n = 0, order = 0;
        for (Callback prev = NULL, it = this.cbc_next; it; prev = it, it = it.cbc_next) {
            if (it.cbc == cb) {
                // remove it from the chain
                Callback next = it.cbc_next;
                if (prev) prev.cbc_next = next;
                else this.cbc_next = next;
                ++n;
            }
            // it is now something we want to keep
            order |= (it.cbc_order & CBC_ORDER_ANY);
        }
        this.cbc_order = order;
        return n;
    }

References CallbackChain(), cbc_order, CBC_ORDER_ANY, next, NULL, and prev.

Member Data Documentation

cbc_order

int CallbackChain::cbc_order = 0

Definition at line 52 of file base.qh.

Referenced by CallbackChain_Add(), and CallbackChain_Remove().

---

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

• common/mutators/base.qh