1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
/*************************************************************************
* Copyright © 2012-2014 Vincent Prat & Simon Nicolas
*
* 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 3 of the License, or
* (at your option) any later version.
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*************************************************************************/
#ifndef HEADER_TREEMODIFICATION
#define HEADER_TREEMODIFICATION
#include "Modification.h"
#include "Tree.h"
/*!
* \brief Modification of a tree
*/
class TreeModification: public Modification
{
public:
/*!
* \brief Type of edition
*/
enum EditionType
{
//! Full edition
etFull,
//! Content-only edition
etContent,
//! State-only edition
etState
};
/*!
* \brief Constructor for additions
* \param tree Modified tree
* \param newItem Copy of the new item
* \param indices Indices of the item
*/
TreeModification(Tree &tree, Item *newItem, const std::string &indices);
/*!
* \brief Constructor for deletions
* \param tree Modified tree
* \param branch Copy of the deleted branch
* \param indices Indices of the branch
*/
TreeModification(Tree &tree, Branch *branch, const std::string &indices);
/*!
* \brief Constructor for full editions
* \param tree Modified tree
* \param item Copy of the previous item
* \param newItem Copy of the new item
* \param indices Indices of the item
*/
TreeModification(Tree &tree, Item *item, Item *newItem, const std::string &indices);
/*!
* \brief Constructor for content-only editions
* \param tree Modified tree
* \param content Previous content
* \param newContent New content
* \param indices Indices of the item
*/
TreeModification(Tree &tree, const std::string &content, const std::string &newContent, const std::string &indices);
/*!
* \brief Constructor for state-only editions
* \param tree Modified tree
* \param state Previous state
* \param newState New state
* \param indices Indices of the item
*/
TreeModification(Tree &tree, Item::State state, Item::State newState, const std::string &indices);
/*!
* \brief Constructor for movements
* \param tree Modified tree
* \param indices Indices of the moved branch
* \param newIndices New indices of the branch
*/
TreeModification(Tree &tree, const std::string &indices, const std::string &newIndices);
/*!
* \brief Destructor
*/
virtual ~TreeModification();
// inherited pure virtual getter
inline Type type() const;
/*!
* \brief Getter for the tree
* \return Modified tree
*/
inline Tree& tree();
// inherited pure virtual methods
void undo();
void redo();
/*!
* \brief Getter for the indices
* \return Indices of the modification
*/
inline std::string indices() const;
/*!
* \brief Modified indices for undoing a movement
* \return Indices where to put back the moved branch
*/
std::string modifiedIndices() const;
/*!
* \brief Modified new indices for undoing a movement
* \return Indices of the moved branch after the movement
*/
std::string modifiedNewIndices() const;
/*!
* \brief Modified indices for deletions/additions
* \return Indices of the nearest item to the deleted one
*/
std::string deletedIndices() const;
/*!
* \brief Getter for the modified item (or the previous when undoing an addition)
* \return Modified item or just undone added item (to be deleted separately by freeItem))
*/
inline Item* item() const;
/*!
* \brief Getter for the newly added item
* \return New item
*/
inline Item* newItem() const;
/*!
* \brief Deletion of the undone item
*/
void freeUndoneItem();
/*!
* \brief Getter for the deleted branch
* \return Deleted branch
*/
inline Branch* branch() const;
/*!
* \brief Getter for the item to be undone (for additions and full editions)
* \return Item to be undone (to be deleted separately by freeItem)
*/
inline Item* undoneItem() const;
/*!
* \brief Getter for the edition type (if edition)
* \return Edition type (if edition only)
*/
inline EditionType editionType() const;
/*!
* \brief Getter for the current copy of the item (for editions)
* \return Current item
*
* Is non null only after undo has been called at least once
*/
inline Item* currentItem() const;
private:
//! Type of edition (if this is the case)
EditionType etEditType;
//! Indices of the modification
std::string sIndices;
//! Indices of the destination
std::string sNewIndices;
//! Tree modified
Tree &rTree;
//! Copy of the deleted branch
Branch *pBranch;
//! Copy of the modified item
Item *pItem;
//! Copy of the new item
Item *pNewItem;
//! Previous content
std::string sContent;
//! New content
std::string sNewContent;
//! Previous state
Item::State sState;
//! New state
Item::State sNewState;
//! Item to be undone (for undoing additions and full editions)
Item *pUndoneItem;
//! Current copy of the item (for editions)
Item *pCurrentItem;
};
Modification::Type TreeModification::type() const
{
return tTree;
}
std::string TreeModification::indices() const
{
return sIndices;
}
Tree& TreeModification::tree()
{
return rTree;
}
Item* TreeModification::item() const
{
return pItem;
}
Item* TreeModification::newItem() const
{
return pNewItem;
}
Branch* TreeModification::branch() const
{
return pBranch;
}
Item* TreeModification::undoneItem() const
{
return pUndoneItem;
}
TreeModification::EditionType TreeModification::editionType() const
{
return etEditType;
}
Item* TreeModification::currentItem() const
{
return pCurrentItem;
}
#endif
|
