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
|
/*************************************************************************
* Copyright © 2011-2020 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_TREE
#define HEADER_TREE
#include "Item.h"
#include <vector>
#include <iterator>
#include "IOConfig.h"
#include <Poco/DOM/Element.h>
class Branch;
/*!
* \brief Tree of items
*/
class Tree
{
private:
std::vector<Branch*> vChildren;
// pointer to its parent branch
Branch* pParent;
public:
// different possible types of iterating over the items of the model
enum IterationType {itNormal,itUnchecked,itState};
// iterator
class iterator: public std::iterator<std::forward_iterator_tag,Item*>
{
private:
IterationType itType;
Item::State sState;
//! underlying vector of iterators
std::vector<std::vector<Branch*>::const_iterator> qIts;
//! Indices vector
std::vector<int> vIndices;
public:
/*!
* \brief Copy constructor
* \param its Iterator
* \param type Iteration type
* \param state State (used for Item::itState iteration type)
*/
iterator(const std::vector<std::vector<Branch*>::const_iterator>& its, IterationType type=itNormal, Item::State state=Item::sNone);
/*!
* \brief Constructor from a lower level iterator
* \param it Iterator of branches
* \param type Iteration type
* \param state State (used for Item::itState iteration type)
*/
iterator(const std::vector<Branch*>::const_iterator& it, IterationType type=itNormal, Item::State state=Item::sNone);
// accessors
IterationType type() const;
Item::State state() const;
void setType(IterationType type);
// overloaded operators
bool operator!=(const iterator& it) const;
bool operator==(const iterator& it) const;
/*!
* \brief Incrementation operator
* \return The incremented iterator
*/
iterator& operator++();
/*!
* \brief Incrementation operator
* \param i Dummy argument
* \return The iterator before incrementation
*/
iterator operator++(int i);
Item* operator*();
// information about the position of the iterator
int depth() const;
Tree* parent() const;
Branch* branch() const;
/*!
* \brief Getter for the current indices
* \return Indices of the current branch
*/
std::string indices() const;
};
// constructors
Tree(Branch* parent=0);
Tree(const Tree &tree, Branch* parent=0);
/*!
* \brief Constructor which read directly in a XML tree
* \param config IO configuration
* \param root Root of the XML subtree
* \param checkFiles Indicates if the existence of files associated with FileItems is checked
* \param parent Pointer to the parent branch of the tree
*/
Tree(const IOConfig &config, const Poco::XML::Element *root, bool checkFiles, Branch* parent);
// destructor
~Tree();
// copy operator
Tree& operator=(const Tree &tree);
// XML-related methods
/*!
* \brief XML saver
* \param config IO configuration
* \param root Root of the XML subtree
* \param fileMapping Mapping of files associated with items (for archives)
*/
void toXML(const IOConfig &config, Poco::XML::Element *root, FileMapping &fileMapping) const;
/*!
* \brief XML loader
* \param config IO configuration
* \param root Position of the tree in the XML tree
* \param checkFiles Indicates if the existence of files associated with FileItems is checked
*/
void fromXML(const IOConfig &config, const Poco::XML::Element *root, bool checkFiles);
// iterator-related methods
iterator begin() const;
iterator beginUnchecked() const;
iterator beginState(Item::State state) const;
iterator end() const;
iterator endUnchecked() const;
iterator endState(Item::State state) const;
// accessors
/*!
* \brief Getter for tree items
* \param indices Indicies of the item
* \return Item at the given indices
*/
Item* operator[](const std::string &indices);
Branch* parent() const;
unsigned int numberOfChildren() const;
// populating the list
/*!
* \brief Branch insertion
* \param indices Indices of where to insert the branch
* \param branch Branch to insert
*/
void insert(const std::string &indices, Branch *branch);
/*!
* \brief Item insertion
* \param index Index of the new item
* \param item New item
* \return Branch of the new item
*
* Insert a new item at the base of the tree
*/
Branch* insert(int index, Item *item);
Branch* insert(const std::string &indices, Item *item);
/*!
* \brief Setter for items
* \param indices Indices of the item to modify
* \param newItem New item
*/
void setItem(std::string &indices, Item *newItem);
Branch* add(Item *item);
/*!
* \brief Branch removal
* \param index Index of the branch to remove
* \param toDelete If true, also deletes the branch
*/
void remove(int index, bool toDelete=true);
void remove(const std::string &indices, bool toDelete=true);
/*!
* \brief Moves an item
* \param currentIndices Indices of the item to move
* \param newIndices Indices of the future emplacement of the item
* \return True if succeeded, false otherwise
*/
bool move(const std::string ¤tIndices, const std::string &newIndices);
void clear();
/*!
* \brief Index extractor
* \param indices Indices to extract from
* \param forward True to begin from the left, false from the right
* \return Extracted indices
*
* After the call, indices contains only indices that have not been extracted yet
*/
static int extractIndex(std::string &indices, bool forward = true);
// get the index of a branch
int indexOf(Branch *branch) const;
/*!
* \brief Branch search
* \param branch Branch to find
* \return Indices of the branch
*/
std::string indicesOf(Branch *branch) const;
std::string indicesOfNext(Branch *branch) const;
/*!
* \brief Getter for branches
* \param indices Indices of the branch
* \return Branch at the given indices
*/
Branch* branch(const std::string &indices);
};
#include "Branch.h"
#endif
|
