RawIntrusiveList.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/common/RawIntrusiveList.h#10 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2005-2009 The Eigenbase Project
// Copyright (C) 2005-2009 SQLstream, Inc.
// Copyright (C) 2005-2009 LucidEra, Inc.
// Portions Copyright (C) 1999-2009 John V. Sichi
//
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 2 of the License, or (at your option)
// any later version approved by The Eigenbase Project.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef Fennel_RawIntrusiveList_Included
#define Fennel_RawIntrusiveList_Included

FENNEL_BEGIN_NAMESPACE

class RawIntrusiveList;
class RawIntrusiveListIter;
class RawIntrusiveListMutator;

class FENNEL_COMMON_EXPORT RawIntrusiveList
{
    friend class RawIntrusiveListIter;
    friend class RawIntrusiveListMutator;

protected:
    uint nNodes;

    IntrusiveListNode *pFront;

    IntrusiveListNode *pBack;

    explicit RawIntrusiveList()
    {
        pFront = NULL;
        pBack = NULL;
        nNodes = 0;
    }

    IntrusiveListNode &front() const
    {
        return *pFront;
    }

    IntrusiveListNode &back() const
    {
        return *pBack;
    }

    void push_front(IntrusiveListNode &t);

    void push_back(IntrusiveListNode &t);

    bool remove(IntrusiveListNode &);

public:
    uint size() const
    {
        return nNodes;
    }

    bool empty() const
    {
        return nNodes ? false : true;
    }

    void clear(bool debugClear = true);
};

class FENNEL_COMMON_EXPORT RawIntrusiveListIter {
protected:
    IntrusiveListNode *pCurr;

    explicit RawIntrusiveListIter()
        : pCurr(NULL)
    {
    }

    explicit RawIntrusiveListIter(RawIntrusiveList const &l)
        : pCurr(l.pFront)
    {
    }

    IntrusiveListNode *getCurrent() const
    {
        return pCurr;
    }

    void repositionToFront(RawIntrusiveList const &l)
    {
        pCurr = l.pFront;
    }

public:
    void operator ++ ()
    {
        if (pCurr) {
            pCurr = pCurr->pNext;
        }
    }
};

class FENNEL_COMMON_EXPORT RawIntrusiveListMutator
{
    friend class RawIntrusiveList;

protected:
    IntrusiveListNode *pCurr,*pPrev;
    RawIntrusiveList *pList;
    bool bJustDeleted;

    explicit RawIntrusiveListMutator()
    {
        pList = NULL;
        pCurr = pPrev = NULL;
        bJustDeleted = 0;
    }

    explicit RawIntrusiveListMutator(RawIntrusiveList &l)
        : pCurr(l.pFront), pPrev(NULL), pList(&l)
    {
        bJustDeleted = 0;
    }

    IntrusiveListNode *getCurrent() const
    {
        return pCurr;
    }

    void repositionToFront(RawIntrusiveList &l)
    {
        pList = &l;
        bJustDeleted = 0;
        pCurr = pList->pFront;
        pPrev = NULL;
    }

    IntrusiveListNode *detach();

public:
    void operator ++ ()
    {
        if (bJustDeleted) {
            bJustDeleted = 0;
        } else {
            pPrev = pCurr;
            if (pCurr) {
                pCurr = pCurr->pNext;
            }
        }
    }

    void promoteCurrToFront();

    void demoteCurrToBack();

    void demoteFrontBeforeCurr();

    void repositionToFront()
    {
        bJustDeleted = 0;
        pCurr = pList->pFront;
        pPrev = NULL;
    }
};

FENNEL_END_NAMESPACE

#endif

// End RawIntrusiveList.h

---