GB/GB_ElementList.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Mark Elendt
 *      Side Effects
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        GB library (C++)
 *
 * COMMENTS:    Element List
 *
 */

#ifndef __GB_ElemList_h__
#define __GB_ElemList_h__

#include "GB_API.h"
#include <UT/UT_PtrArray.h>
#include "GB_Element.h"

class GB_Group;

class GB_API GB_ElementList : public UT_PtrArray<GB_Element *>
{
public:
     GB_ElementList(unsigned size = 0) : UT_PtrArray<GB_Element *>(size) {}
    virtual ~GB_ElementList();

    /// THIS DOES NOT DELETE THE GB_ELEMENTS.
    /// detail.points().clearAndDestroy() will thus trigger memory leaks
    /// So do not call this.
    void                 clearAndDestroy()      { resize(0); }

#ifdef METROWERKS_BUILD    
          GB_Element    *rawEntry(unsigned n) const
                         { return n >= entries() ? 0 : (*this)(n); }

          GB_Element    *rawHead() const        { return rawEntry(0); }
          GB_Element    *rawHead(const GB_Group &group) const;

          GB_Element    *rawNext(const GB_Element *item) const
                         { return rawEntry((unsigned)(item->getNum()+1)); }
          GB_Element    *rawNext(const GB_Element *item, const GB_Group &group) const;

          GB_Element    *rawTail() const { return entries() ? last() : 0; }
          GB_Element    *rawTail(const GB_Group &group) const;

          GB_Element    *rawPrev(const GB_Element *item) const
                         { return rawEntry((unsigned)(item->getNum()-1)); }
          GB_Element    *rawPrev(const GB_Element *item, const GB_Group &group) const;
#else    
    const GB_Element    *rawEntry(unsigned n) const
                         { return n >= entries() ? 0 : (*this)(n); }
          GB_Element    *rawEntry(unsigned n)
                         { return n >= entries() ? 0 : (*this)(n); }

    const GB_Element    *rawHead() const        { return rawEntry(0); }
          GB_Element    *rawHead()              { return rawEntry(0); }
    const GB_Element    *rawHead(const GB_Group &group) const;
          GB_Element    *rawHead(const GB_Group &group);

    const GB_Element    *rawNext(const GB_Element *item) const
                         { return rawEntry(item->getNum()+1); }
          GB_Element    *rawNext(GB_Element *item)
                         { return rawEntry(item->getNum()+1); }
    const GB_Element    *rawNext(const GB_Element *, const GB_Group &) const;
          GB_Element    *rawNext(GB_Element *item, const GB_Group &group);

    const GB_Element    *rawTail() const { return entries() ? last() : 0; }
          GB_Element    *rawTail()       { return entries() ? last() : 0; }
    const GB_Element    *rawTail(const GB_Group &group) const;
          GB_Element    *rawTail(const GB_Group &group);

    const GB_Element    *rawPrev(const GB_Element *item) const
                         { return rawEntry(item->getNum()-1); }
          GB_Element    *rawPrev(GB_Element *item)
                         { return rawEntry(item->getNum()-1); }
    const GB_Element    *rawPrev(const GB_Element *, const GB_Group &) const;
          GB_Element    *rawPrev(GB_Element *item, const GB_Group &group);
#endif    
    int                  rawHeadMix(const GB_Group &group,
                                    const GB_Element *&elem,
                                    const GB_Element *&sec) const;

    int                  rawNextMix(const GB_Group &group,
                                    const GB_Element *&elem, 
                                    const GB_Element *&sec,
                                    const GB_Element *&newelem, 
                                    const GB_Element *&newsec)
                                    const;

    int                  rawTailMix(const GB_Group &group,
                                    const GB_Element *&elem,
                                    const GB_Element *&sec) const;

    int                  rawPrevMix(const GB_Group &group,
                                    const GB_Element *&elem, 
                                    const GB_Element *&sec,
                                    const GB_Element *&newelem, 
                                    const GB_Element *&newsec)
                                    const;

};

#endif

---