bytearraytablecursor.h

Go to the documentation of this file.

/*
    This file is part of the Okteta Gui library, made within the KDE community.

    Copyright 2003,2008-2009 Friedrich W. H. Kossebau <kossebau@kde.org>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) version 3, or any
    later version accepted by the membership of KDE e.V. (or its
    successor approved by the membership of KDE e.V.), which shall
    act as a proxy defined in Section 6 of version 3 of the license.

    This library 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
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef OKTETA_BYTEARRAYTABLECURSOR_H
#define OKTETA_BYTEARRAYTABLECURSOR_H

// lib
#include "coord.h"


namespace Okteta
{
class ArrayChangeMetricsList;
class ByteArrayTableLayout;


class ByteArrayTableCursor
{
  public:
    explicit ByteArrayTableCursor( const ByteArrayTableLayout* layout );
    ~ByteArrayTableCursor();

  public: // modificator
    void setAppendPosEnabled( bool appendPosEnabled = true );

  public: // state value access
    Address index() const;
    LinePosition pos() const;
    Line line() const;
    Coord coord() const;
    bool isBehind() const;
    Address realIndex() const;
    Address validIndex() const;

    //bool isValid() const;
    bool appendPosEnabled() const;

  public: // index calculation service
    Address indexAtLineStart() const;
    Address indexAtLineEnd() const;

  public: // navigation commands
    void gotoIndex( Address index );
    void gotoCoord( const Coord& coord );
    void gotoCIndex( Address index );
    void gotoCCoord( const Coord& coord );
    void gotoRealIndex();

    void gotoPreviousByte();
    void gotoNextByte();
    void gotoPreviousByte( Size indexSteps );
    void gotoNextByte( Size indexSteps );
    void gotoUp();
    void gotoDown();
    void gotoLineStart();
    void gotoLineEnd();
    void gotoStart();
    void gotoEnd();
    void gotoPageUp();
    void gotoPageDown();

    // TODO: make protected again
    void stepBehind();
    void updateCoord();
    void adaptToChanges( const ArrayChangeMetricsList& changeList, Size oldLength );

  public: // logical state access
    bool atStart() const;
    bool atEnd() const;
    bool atAppendPos() const;
    bool atLineStart() const;
    bool atLineEnd() const;


  protected:
    void stepToEnd();

  private:
    const ByteArrayTableLayout* mLayout;

    Address mIndex;
    Coord mCoord;

    bool mBehind :1;

    bool mAppendPosEnabled :1;
};


inline Address ByteArrayTableCursor::index()      const { return mIndex; }
inline LinePosition ByteArrayTableCursor::pos()   const { return mCoord.pos(); }
inline Line ByteArrayTableCursor::line()          const { return mCoord.line(); }
inline Coord ByteArrayTableCursor::coord()        const { return mCoord; }
inline bool ByteArrayTableCursor::isBehind()      const { return mBehind; }
inline Address ByteArrayTableCursor::realIndex()  const { return mBehind ? mIndex + 1 : mIndex; }
inline bool ByteArrayTableCursor::appendPosEnabled() const { return mAppendPosEnabled; }

inline void ByteArrayTableCursor::stepBehind() { mBehind = true; }

//inline bool ByteArrayTableCursor::isValid()  const { return mIndex != -1; }

}

#endif