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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: symtreenode.hxx,v $
* $Revision: 1.3 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef ARY_SYMTREE_NODE_HXX
#define ARY_SYMTREE_NODE_HXX
// USED SERVICES
// BASE CLASSES
// OTHER
namespace ary
{
namespace symtree
{
/** Represents a node in a tree of symbols like a namespace tree or a
directory tree.
@tpl NODE_TRAITS
Needs to define the types:
entity_base_type: The type of the entities in that storage,
e.g. ->ary::cpp::CodeEntity.
id_type: The type of the ids of those entities,
e.g. ->ary::cpp::Ce_id.
Needs to define the functions:
1. static entity_base_type &
EntityOf_(
id_type i_id );
2. static symtree::Node<LeNode_Traits> *
NodeOf_(
const entity_base_type &
i_entity );
3. static const String &
LocalNameOf_(
const entity_base_type &
i_entity );
4. static entity_base_type *
ParentOf_(
const entity_base_type &
i_entity );
5. template <class KEY>
static id_t Search_(
const entity_base_type &
i_entity,
const KEY & i_localKey );
*/
template <class NODE_TRAITS>
class Node
{
public:
typedef Node<NODE_TRAITS> node_self;
typedef typename NODE_TRAITS::entity_base_type entity_t;
typedef typename NODE_TRAITS::id_type id_t;
// LIFECYCLE
/// @attention Always needs to be followed by ->Assign_Entity()!
Node();
explicit Node(
entity_t & i_entity );
void Assign_Entity(
entity_t & i_entity );
~Node();
// INQUIRY
id_t Id();
const String Name() const;
int Depth() const;
const entity_t & Entity() const;
const node_self * Parent() const;
/** Gets a child with a specific name and of a specific type.
There may be more childs with the same name.
@return id_t(0), if no matching child is found.
*/
template <class KEY>
typename NODE_TRAITS::id_type
Search(
const KEY & i_localKey ) const
{
// Inline here to workaround SUNW8 compiler bug, works in SUNW12.
return NODE_TRAITS::Search_(Entity(), i_localKey);
}
/** Gets a child with a specific qualified name below this node.
The child may not exists.
*/
template <class KEY>
void SearchBelow(
id_t & o_return, // Workaround SUNW8 compiler bug
StringVector::const_iterator
i_qualifiedSearchedName_begin,
StringVector::const_iterator
i_qualifiedSearchedName_end,
const KEY & i_localKey ) const;
/** Gets a child with a specific qualified name, either below this node
or below any of the parent nodes.
The child may not exists.
*/
template <class KEY>
void SearchUp(
id_t & o_return, // Workaround SUNW8 compiler bug
StringVector::const_iterator
i_qualifiedSearchedName_begin,
StringVector::const_iterator
i_qualifiedSearchedName_end,
const KEY & i_localKey ) const;
// ACCESS
entity_t & Entity();
node_self * Parent();
private:
// Forbid copying:
Node(const node_self&);
node_self& operator=(const node_self&);
// Locals
void InitDepth();
node_self * Get_Parent() const;
node_self * NodeOf(
id_t i_id ) const;
// DATA
entity_t * pEntity;
int nDepth;
};
// IMPLEMENTATION
template <class NODE_TRAITS>
inline const typename Node<NODE_TRAITS>::entity_t &
Node<NODE_TRAITS>::Entity() const
{
csv_assert(pEntity != 0);
return *pEntity;
}
template <class NODE_TRAITS>
inline Node<NODE_TRAITS> *
Node<NODE_TRAITS>::NodeOf(id_t i_id) const
{
if (i_id.IsValid())
return NODE_TRAITS::NodeOf_(NODE_TRAITS::EntityOf_(i_id));
return 0;
}
template <class NODE_TRAITS>
inline Node<NODE_TRAITS> *
Node<NODE_TRAITS>::Get_Parent() const
{
entity_t *
parent = NODE_TRAITS::ParentOf_(Entity());
if (parent != 0)
return NODE_TRAITS::NodeOf_(*parent);
return 0;
}
template <class NODE_TRAITS>
Node<NODE_TRAITS>::Node()
: pEntity(0),
nDepth(0)
{
}
template <class NODE_TRAITS>
Node<NODE_TRAITS>::Node(entity_t & i_entity)
: pEntity(&i_entity),
nDepth(0)
{
InitDepth();
}
template <class NODE_TRAITS>
void
Node<NODE_TRAITS>::Assign_Entity(entity_t & i_entity)
{
pEntity = &i_entity;
InitDepth();
}
template <class NODE_TRAITS>
Node<NODE_TRAITS>::~Node()
{
}
template <class NODE_TRAITS>
inline typename Node<NODE_TRAITS>::id_t
Node<NODE_TRAITS>::Id()
{
return NODE_TRAITS::IdOf(Entity());
}
template <class NODE_TRAITS>
inline const String
Node<NODE_TRAITS>::Name() const
{
return NODE_TRAITS::LocalNameOf_(Entity());
}
template <class NODE_TRAITS>
inline int
Node<NODE_TRAITS>::Depth() const
{
return nDepth;
}
template <class NODE_TRAITS>
inline const Node<NODE_TRAITS> *
Node<NODE_TRAITS>::Parent() const
{
return Get_Parent();
}
template <class NODE_TRAITS>
template <class KEY>
void
Node<NODE_TRAITS>::SearchBelow(
id_t & o_return, // Workaround SUNW8 compiler bug
StringVector::const_iterator i_qualifiedSearchedName_begin,
StringVector::const_iterator i_qualifiedSearchedName_end,
const KEY & i_localKey ) const
{
if (i_qualifiedSearchedName_begin != i_qualifiedSearchedName_end)
{
id_t
next = Search(*i_qualifiedSearchedName_begin);
if (next.IsValid())
{
const node_self *
subnode = NodeOf(next);
if (subnode != 0)
{
subnode->SearchBelow( o_return,
i_qualifiedSearchedName_begin+1,
i_qualifiedSearchedName_end ,
i_localKey );
return;
}
}
o_return = id_t(0);
return;
}
o_return = Search(i_localKey);
}
template <class NODE_TRAITS>
template <class KEY>
void
Node<NODE_TRAITS>::SearchUp(
id_t & o_return, // Workaround SUNW8 compiler bug
StringVector::const_iterator i_qualifiedSearchedName_begin,
StringVector::const_iterator i_qualifiedSearchedName_end,
const KEY & i_localKey ) const
{
SearchBelow( o_return,
i_qualifiedSearchedName_begin,
i_qualifiedSearchedName_end,
i_localKey );
if (o_return.IsValid())
return;
node_self *
parent = Get_Parent();
if (parent != 0)
{
parent->SearchUp( o_return,
i_qualifiedSearchedName_begin,
i_qualifiedSearchedName_end,
i_localKey );
}
}
template <class NODE_TRAITS>
typename Node<NODE_TRAITS>::entity_t &
Node<NODE_TRAITS>::Entity()
{
csv_assert(pEntity != 0);
return *pEntity;
}
template <class NODE_TRAITS>
inline Node<NODE_TRAITS> *
Node<NODE_TRAITS>::Parent()
{
return Get_Parent();
}
template <class NODE_TRAITS>
void
Node<NODE_TRAITS>::InitDepth()
{
Node<NODE_TRAITS> *
pp = Get_Parent();
if (pp != 0)
nDepth = pp->Depth() + 1;
else
nDepth = 0;
}
} // namespace symtree
} // namespace ary
#endif
|
