• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdesdk API Reference
  • KDE Home
  • Contact Us
 

okteta

  • sources
  • kde-4.12
  • kdesdk
  • okteta
  • core
  • piecetable
grouppiecetablechange.h
Go to the documentation of this file.
1 /*
2  This file is part of the Okteta Core library, made within the KDE community.
3 
4  Copyright 2008 Friedrich W. H. Kossebau <kossebau@kde.org>
5 
6  This library is free software; you can redistribute it and/or
7  modify it under the terms of the GNU Lesser General Public
8  License as published by the Free Software Foundation; either
9  version 2.1 of the License, or (at your option) version 3, or any
10  later version accepted by the membership of KDE e.V. (or its
11  successor approved by the membership of KDE e.V.), which shall
12  act as a proxy defined in Section 6 of version 3 of the license.
13 
14  This library is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  Lesser General Public License for more details.
18 
19  You should have received a copy of the GNU Lesser General Public
20  License along with this library. If not, see <http://www.gnu.org/licenses/>.
21 */
22 
23 #ifndef KPIECETABLE_GROUPPIECETABLECHANGE_H
24 #define KPIECETABLE_GROUPPIECETABLECHANGE_H
25 
26 // lib
27 #include "abstractpiecetablechange.h"
28 // Qt
29 #include <QtCore/QStack>
30 #include <QtCore/QString>
31 
32 
33 namespace Okteta {
34 class AddressRangeList;
35 class ArrayChangeMetricsList;
36 }
37 
38 namespace KPieceTable
39 {
40 
41  typedef Okteta::AddressRangeList AddressRangeList;
42  typedef Okteta::ArrayChangeMetricsList ArrayChangeMetricsList;
43 
44 
48 class GroupPieceTableChange : public AbstractPieceTableChange
49 {
50  public:
51  GroupPieceTableChange( GroupPieceTableChange* parent, const QString& description );
52 
53  virtual ~GroupPieceTableChange();
54 
55  public: // AbstractPieceTableChange API
56  virtual int type() const;
57  virtual QString description() const;
58  virtual bool merge( const AbstractPieceTableChange* other );
59  virtual AddressRange apply( PieceTable* pieceTable ) const;
60  virtual AddressRange revert( PieceTable* pieceTable ) const;
61  virtual ArrayChangeMetrics metrics() const;
62  virtual Size dataSize() const;
63 
64  public:
65  void setDescription( const QString& description );
66 
67 // TODO: think about a function to compress a group, that is not going to be handled in detail anymore
68 // e.g. several replaces of the same byte or an insert and replace of the inserted data
69 
70 
71  public:
72  AddressRangeList applyGroup( PieceTable* pieceTable ) const;
73  AddressRangeList revertGroup( PieceTable* pieceTable ) const;
74  ArrayChangeMetricsList groupMetrics( bool reverted = false ) const;
75  GroupPieceTableChange* parent() const;
76 
77  public: // TODO: this interface part is shared with PieceTableChangeHistory, try to use this fact
78  bool appendChange( AbstractPieceTableChange *change );
79  void finishChange();
80  public:
82  int count() const;
84  int appliedChangesCount() const;
86  QString changeDescription( int changeId ) const;
88  QString headChangeDescription() const;
90 // bool isAtBase() const;
92  int appliedChangesDataSize() const;
93 
94  protected:
95  QStack<AbstractPieceTableChange*> mChangeStack;
96  GroupPieceTableChange* mParent;
97 
98  QString mDescription;
100  int mAppliedChangesCount;
102  Size mAppliedChangesDataSize;
104  bool mTryToMergeAppendedChange;
105 };
106 
107 
108 inline GroupPieceTableChange::GroupPieceTableChange( GroupPieceTableChange* parent, const QString& description )
109  : mParent( parent ),
110  mDescription( description ),
111  mAppliedChangesCount( 0 ),
112  mAppliedChangesDataSize( 0 ),
113  mTryToMergeAppendedChange( true )
114 {}
115 
116 inline void GroupPieceTableChange::setDescription( const QString& description ) { mDescription = description; }
117 inline GroupPieceTableChange* GroupPieceTableChange::parent() const { return mParent; }
118 inline void GroupPieceTableChange::finishChange() { mTryToMergeAppendedChange = false; }
119 inline int GroupPieceTableChange::count() const { return mChangeStack.count(); }
120 inline int GroupPieceTableChange::appliedChangesCount() const { return mAppliedChangesCount; }
121 inline QString GroupPieceTableChange::headChangeDescription() const { return changeDescription( count()-1 ); }
122 inline QString GroupPieceTableChange::changeDescription( int changeId ) const
123 {
124  const AbstractPieceTableChange* change = mChangeStack.value( changeId );
125 
126  return change ? change->description() : QString();
127 }
128 
129 }
130 
131 #endif
KPieceTable::AddressRangeList
Okteta::AddressRangeList AddressRangeList
Definition: grouppiecetablechange.h:41
abstractpiecetablechange.h
KPieceTable::GroupPieceTableChange::apply
virtual AddressRange apply(PieceTable *pieceTable) const
Definition: grouppiecetablechange.cpp:54
KPieceTable::GroupPieceTableChange::description
virtual QString description() const
Definition: grouppiecetablechange.cpp:39
KPieceTable::Size
Okteta::Size Size
Definition: piece.h:33
KDE::NumberRange< Address, Size >
KPieceTable::GroupPieceTableChange::type
virtual int type() const
Definition: grouppiecetablechange.cpp:37
KPieceTable::GroupPieceTableChange::revert
virtual AddressRange revert(PieceTable *pieceTable) const
Definition: grouppiecetablechange.cpp:62
KPieceTable::ArrayChangeMetricsList
Okteta::ArrayChangeMetricsList ArrayChangeMetricsList
Definition: grouppiecetablechange.h:42
KPieceTable::GroupPieceTableChange::mParent
GroupPieceTableChange * mParent
Definition: grouppiecetablechange.h:96
KPieceTable::GroupPieceTableChange::changeDescription
QString changeDescription(int changeId) const
Definition: grouppiecetablechange.h:122
KPieceTable::GroupPieceTableChange::appliedChangesCount
int appliedChangesCount() const
Definition: grouppiecetablechange.h:120
KPieceTable::GroupPieceTableChange::mAppliedChangesDataSize
Size mAppliedChangesDataSize
Definition: grouppiecetablechange.h:102
KPieceTable::GroupPieceTableChange::metrics
virtual ArrayChangeMetrics metrics() const
Definition: grouppiecetablechange.cpp:70
KPieceTable::GroupPieceTableChange::groupMetrics
ArrayChangeMetricsList groupMetrics(bool reverted=false) const
Definition: grouppiecetablechange.cpp:153
KPieceTable::GroupPieceTableChange::GroupPieceTableChange
GroupPieceTableChange(GroupPieceTableChange *parent, const QString &description)
Definition: grouppiecetablechange.h:108
KPieceTable::GroupPieceTableChange::count
int count() const
Definition: grouppiecetablechange.h:119
KPieceTable::GroupPieceTableChange::mTryToMergeAppendedChange
bool mTryToMergeAppendedChange
if true, try to merge changes
Definition: grouppiecetablechange.h:104
KPieceTable::AbstractPieceTableChange::description
virtual QString description() const =0
KPieceTable::GroupPieceTableChange::appliedChangesDataSize
int appliedChangesDataSize() const
KPieceTable::GroupPieceTableChange::applyGroup
AddressRangeList applyGroup(PieceTable *pieceTable) const
Definition: grouppiecetablechange.cpp:112
Okteta::ArrayChangeMetricsList
Definition: arraychangemetricslist.h:36
KPieceTable::GroupPieceTableChange::mChangeStack
QStack< AbstractPieceTableChange * > mChangeStack
Definition: grouppiecetablechange.h:95
KPieceTable::GroupPieceTableChange::dataSize
virtual Size dataSize() const
returns the size of the added data. Default returns 0.
Definition: grouppiecetablechange.cpp:178
KPieceTable::GroupPieceTableChange::~GroupPieceTableChange
virtual ~GroupPieceTableChange()
Definition: grouppiecetablechange.cpp:183
KPieceTable::AbstractPieceTableChange
class
Definition: abstractpiecetablechange.h:45
KPieceTable::PieceTable
Definition: piecetable.h:35
KPieceTable::GroupPieceTableChange::mDescription
QString mDescription
Definition: grouppiecetablechange.h:98
KPieceTable::GroupPieceTableChange::headChangeDescription
QString headChangeDescription() const
Definition: grouppiecetablechange.h:121
KPieceTable::GroupPieceTableChange::parent
GroupPieceTableChange * parent() const
Definition: grouppiecetablechange.h:117
KPieceTable::GroupPieceTableChange::appendChange
bool appendChange(AbstractPieceTableChange *change)
Definition: grouppiecetablechange.cpp:75
KPieceTable::GroupPieceTableChange
class
Definition: grouppiecetablechange.h:48
KPieceTable::GroupPieceTableChange::revertGroup
AddressRangeList revertGroup(PieceTable *pieceTable) const
Definition: grouppiecetablechange.cpp:131
Okteta::ArrayChangeMetrics
Definition: arraychangemetrics.h:38
KPieceTable::GroupPieceTableChange::merge
virtual bool merge(const AbstractPieceTableChange *other)
returns true if successful, false otherwise. Default returns false.
Definition: grouppiecetablechange.cpp:44
Okteta::AddressRangeList
Definition: addressrangelist.h:38
KPieceTable::GroupPieceTableChange::mAppliedChangesCount
int mAppliedChangesCount
Definition: grouppiecetablechange.h:100
KPieceTable::GroupPieceTableChange::finishChange
void finishChange()
Definition: grouppiecetablechange.h:118
KPieceTable::GroupPieceTableChange::setDescription
void setDescription(const QString &description)
Definition: grouppiecetablechange.h:116
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:04:08 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

okteta

Skip menu "okteta"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdesdk API Reference

Skip menu "kdesdk API Reference"
  • kapptemplate
  • kcachegrind
  • kompare
  • lokalize
  • okteta
  • umbrello
  •   umbrello

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal