bytearraytablelayout.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_BYTEARRAYTABLELAYOUT_H
#define OKTETA_BYTEARRAYTABLELAYOUT_H

// lib
#include "coordrange.h"
#include "oktetagui_export.h"
// Okteta core
#include "addressrange.h"


// TODO: rename things like startOffset and firstLineOffset, not really descriptive
namespace Okteta
{

class OKTETAGUI_EXPORT ByteArrayTableLayout
{
  public:
    ByteArrayTableLayout( Size noOfBytesPerLine, Address firstLineOffset, Address startOffset, Address byteArrayOffset, Size byteArrayLength );
    //ByteArrayTableLayout();

    ~ByteArrayTableLayout();


  public: // given values
    Address startOffset() const;
    Address firstLineOffset() const;
    Size noOfBytesPerLine() const;
    Address byteArrayOffset() const;
    Size length() const;
    LineSize noOfLinesPerPage() const;

  public: // calculated values
    Line startLine() const;
    LinePosition firstStartLinePosition() const;
    Coord startCoord() const;

    Line finalLine() const;
    LinePosition lastFinalLinePosition() const;
    Coord finalCoord() const;

    Address lastByteArrayOffset() const;
    LineSize noOfLines() const;


  public: // value calculation service
    Address indexAtCCoord( const Coord& coord ) const;
    Address indexAtCFirstLinePosition( Line line ) const;
    Address indexAtCLastLinePosition( Line line ) const;
    Line lineAtCIndex( Address index ) const;
    Coord coordOfCIndex( Address index ) const;

    Address indexAtCoord( const Coord& coord ) const;
    Address indexAtFirstLinePosition( Line line ) const;
    Address indexAtLastLinePosition( Line line ) const;
    Line lineAtIndex( Address index ) const;
    Coord coordOfIndex( Address index ) const;
    CoordRange coordRangeOfIndizes( const AddressRange& indizes ) const;

    LinePositionRange linePositions( Line line ) const;
    LinePosition firstLinePosition( Line line ) const;
    LinePosition lastLinePosition( Line line ) const;
    LinePosition firstLinePosition( const Coord& coord ) const;
    LinePosition lastLinePosition( const Coord& coord ) const;
    bool hasContent( Line line ) const;
    bool atFirstLinePosition( const Coord& coord ) const;
    bool atLastLinePosition( const Coord& coord ) const;

    Address correctIndex( Address index ) const;
    Coord correctCoord( const Coord& coord ) const;


  public: // modification access; return true if changes
    bool setStartOffset( Address startOffset );
    bool setFirstLineOffset( Address firstLineOffset );
    bool setNoOfBytesPerLine( LineSize noOfBytesPerLine );
    bool setByteArrayOffset( Address byteArrayOffset );
    bool setLength( Size length );
    void setNoOfLinesPerPage( LineSize noOfLinesPerPage );


  protected:
    void calcStart();
    void calcEnd();


 protected:
    Size mNoOfBytesPerLine;
    Address mFirstLineOffset;
    Address mStartOffset;
    Address mRelativeStartOffset;
    Address mByteArrayOffset;
    Address mLastByteArrayOffset;
    LineSize mNoOfLinesPerPage;

  protected: // calculated values, buffered
    CoordRange mCoordRange;
};


inline Address ByteArrayTableLayout::startOffset()         const { return mStartOffset; }
inline Address ByteArrayTableLayout::firstLineOffset()     const { return mFirstLineOffset; }
inline Size ByteArrayTableLayout::noOfBytesPerLine()       const { return mNoOfBytesPerLine; }
inline Address ByteArrayTableLayout::byteArrayOffset()     const { return mByteArrayOffset; }
inline Size ByteArrayTableLayout::length()                 const { return mLastByteArrayOffset-mByteArrayOffset+1; }
inline Address ByteArrayTableLayout::lastByteArrayOffset() const { return mLastByteArrayOffset; }

inline Coord ByteArrayTableLayout::finalCoord()               const { return mCoordRange.end(); }
inline Coord ByteArrayTableLayout::startCoord()               const { return mCoordRange.start(); }
inline LinePosition ByteArrayTableLayout::firstStartLinePosition() const { return startCoord().pos(); }
inline LinePosition ByteArrayTableLayout::lastFinalLinePosition() const { return finalCoord().pos(); }
inline Line ByteArrayTableLayout::startLine()                 const { return startCoord().line(); }
inline Line ByteArrayTableLayout::finalLine()                 const { return finalCoord().line(); }
inline LineSize ByteArrayTableLayout::noOfLinesPerPage()      const { return mNoOfLinesPerPage; }
inline LineSize ByteArrayTableLayout::noOfLines()             const { return mByteArrayOffset>mLastByteArrayOffset?0:finalLine()+1; }

}

#endif