Class CleanUp

v2/engine/boehm_gc/include/weakpointer.h:112–149

***************************************************************************/

template< class T, class Data > class CleanUp {
public:

static void Set( T* t, void c( Data* d, T* t ), Data* d = 0 )
    /* Sets the clean-up function of object BO(t) to be <c, d>,
       replacing any previously defined clean-up function for BO(t); c
       and d can be null, but t cannot. Sets the clean-up queue for
       BO(t) to be the collector's queue. When t is removed from its
       clean-up queue, its clean-up will be applied by calling c(d,
       t). It is an error if *t is not a collected object. */ 
       {_CleanUp_Set( t, c, d );}

static void Call( T* t )
    /* Sets the new clean-up function for BO(t) to be null and, if the
       old one is non-null, calls it immediately, even if BO(t) is
       still reachable. Deactivates any weak pointers to BO(t). */
       {_CleanUp_Call( t );}

class Queue {public:
    Queue()
        /* Constructs a new queue. */
            {this->head = _CleanUp_Queue_NewHead();}

    void Set( T* t )
        /* q.Set(t) sets the clean-up queue of BO(t) to be q. */
            {_CleanUp_Queue_Set( this->head, t );}

    int Call()
        /* If q is non-empty, q.Call() removes the first object and
           calls its clean-up function; does nothing if q is
           empty. Returns true if there are more objects in the
           queue. */
           {return _CleanUp_Queue_Call( this->head );}

    private:
    void* head;
    };
};

/**********************************************************************