GA_RTIPageList.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.
 *
 * NAME:        GA_RTIPageList.h ( GA Library, C++)
 *
 * COMMENTS:    This is similar to GA_RangeOffset, except instead of
 *              specifying a range of offsets, we specify a list of pages.
 */

#ifndef __GA_RTIPageList__
#define __GA_RTIPageList__

#include "GA_API.h"
#include "GA_RangeTypeInterface.h"
#include "GA_Types.h"

#include <UT/UT_SharedPtr.h>
#include <UT/UT_VectorTypes.h>


class GA_IndexMap;
class GA_IteratorState;
class GA_Range;


/// @brief Define a range based on a specific offset list
class GA_API GA_RTIPageList : public GA_RangeTypeInterface 
{
public:
    // Iterate over the entire range of the offset list
    GA_RTIPageList(GA_IndexMap &list, const UT_SharedPtr<const UT_IntArray> &pages,
                   GA_Offset start=GA_Offset(0), GA_Offset end=GA_INVALID_OFFSET);
    GA_RTIPageList(const GA_IndexMap &list, const UT_SharedPtr<const UT_IntArray> &pages,
                   GA_Offset start=GA_Offset(0), GA_Offset end=GA_INVALID_OFFSET);

    // Copy c-tor
    GA_RTIPageList(const GA_RTIPageList &src);

    ~GA_RTIPageList() override;

    /// @{
    /// RangeTypeInterface implementation
    GA_RangeTypeInterface       *copy() const override;
    bool        isSplittable() const override   { return false; }
    bool        isEmpty() const override;
    GA_Size     getMaxEntries() const override;
    GA_Size     getEntries() const override;
    bool        split(GA_RangeTypeInterface *list[2]) const override;
    bool        isEqual(const GA_RangeTypeInterface &src) const override;
    void        iterateCopy(GA_IteratorState &dest,
                            const GA_IteratorState &src) const override;
    void        iterateRewind(GA_IteratorState &state,
                              GA_Offset &start, GA_Offset &end) const override;
    void        iterateNext(GA_IteratorState &state,
                            GA_Offset &start, GA_Offset &end) const override;
    bool        areTraversalDeletionsSafe() const override { return true; }
    GA_Size     getPageCount() const override   { return -1; }
    bool        getPageElementRange(GA_Range &, GA_Size, GA_Size) const override
                            { return getPageElementRangeNonSplittable(); }
    GA_Offset   getFirstOffsetInPage(GA_Size) const override
                            { return getFirstOffsetInPageNonSplittable(); }
    /// @}

private:
    UT_SharedPtr<const UT_IntArray> myPages;
    GA_Offset            myStart, myEnd;        // Range of offset list
};

#endif