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
|
/*************************************************************************
*
* $RCSfile: anynoderef.hxx,v $
*
* $Revision: 1.2 $
*
* last change: $Author: jb $ $Date: 2001-07-05 17:05:45 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* 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, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef CONFIGMGR_CONFIGANYNODE_HXX_
#define CONFIGMGR_CONFIGANYNODE_HXX_
#ifndef CONFIGMGR_CONFIGNODE_HXX_
#include "noderef.hxx"
#endif
namespace configmgr
{
namespace configapi { class Factory; }
namespace configuration
{
//-------------------------------------------------------------------------
class Name;
struct Attributes;
//-------------------------------------------------------------------------
namespace argument { struct NoValidate; }
typedef com::sun::star::uno::Type UnoType;
typedef com::sun::star::uno::Any UnoAny;
//-------------------------------------------------------------------------
class NodeRef;
class ValueRef;
class AnyNodeRef;
class NodeID;
class Tree;
class Node;
class TreeImpl;
typedef unsigned int NodeOffset;
typedef unsigned int TreeDepth;
//-------------------------------------------------------------------------
/// represents any node in some tree
class AnyNodeRef
{
public:
/// constructs an empty (invalid) node
AnyNodeRef();
/// converts an inner node
explicit AnyNodeRef(NodeRef const& aInnerNode);
/// converts a value node
explicit AnyNodeRef(ValueRef const& aValueNode);
/// copy a node (with reference semantics)
AnyNodeRef(AnyNodeRef const& rOther);
/// copy a node (with reference semantics)
AnyNodeRef& operator=(AnyNodeRef const& rOther);
void swap(AnyNodeRef& rOther);
~AnyNodeRef();
/// checks, if this represents an existing node
inline bool isValid() const;
/// checks if this a node (rather than a value only)
bool isNode() const;
/// converts this, if it is a value
ValueRef toValue() const;
/// converts this, if it is a inner node
NodeRef toNode() const;
private:
friend class Tree;
friend class TreeImplHelper;
AnyNodeRef(Node* pImpl, NodeOffset nParentPos, TreeDepth m_nDepth);
AnyNodeRef(Name const& aName, Node* pParentImpl, NodeOffset nParentPos);
bool checkValidState() const;
private:
Name m_sNodeName;
Node* m_pUsedImpl;
NodeOffset m_nUsedPos;
TreeDepth m_nDepth;
};
//-------------------------------------------------------------------------
/** checks whether there are any immediate children of <var>aNode</var> (which is in <var>aTree</var>)
@return
<TRUE/> if a child node exists
<FALSE/> otherwise
*/
inline
bool hasChildOrElement(Tree const& aTree, AnyNodeRef const& aNode)
{ return aNode.isNode() && hasChildOrElement(aTree,aNode.toNode()); }
/** checks whether there is an immediate child of <var>aNode</var> (which is in <var>aTree</var>)
specified by <var>aName</var>
@return
<TRUE/> if the child node exists
<FALSE/> otherwise
*/
inline
bool hasChildOrElement(Tree const& aTree, AnyNodeRef const& aNode, Name const& aName)
{ return aNode.isNode() && hasChildOrElement(aTree,aNode.toNode(),aName); }
/** tries to find the immediate child of <var>aNode</var> (which is in <var>aTree</var>)
specified by <var>aName</var>
<p> On return <var>aNode</var> is modified to refer to the node found and
<var>aTree</var> will then refer to the tree that node is in.
<p/>
@return The requested child node, if it exists
(then <var>aTree</var> refers to the tree containing the desired node),
*/
AnyNodeRef getChildOrElement(Tree& aTree, NodeRef const& aParentNode, Name const& aName);
/** tries to find the descendant of <var>aNode</var> specified by <var>aPath</var> within <var>aTree</var>
<p> This function follows the given path stepwise, until a requested node is missing in the tree.</p>
<p> On return <var>aNode</var> is modified to refer to the last inner node found
and <var>aTree</var> will be unchanged (except for deprecated usage).
<p/>
<p> Also, <var>aPath</var> is modified to contain the unresolved part of the original path.
</p>
@return the requested node, if the path could be resolved completely
(so <var>aNode</var> refers to the desired node or its parent,
and <var>aPath</var> is empty)<BR/>
an invalid node otherwise
*/
AnyNodeRef getLocalDescendant(Tree& aTree, NodeRef& aNode, RelativePath& aPath);
/** tries to find the descendant of <var>aNode</var> (which is in <var>aTree</var>) specified by <var>aPath</var>
<p> This function follows the given path stepwise, until a requested node is missing in the tree.</p>
<p> On return <var>aNode</var> is modified to refer to the last inner node found and
<var>aTree</var> will then refer to the tree that node is in.
<p/>
<p> Also, <var>aPath</var> is modified to contain the unresolved part of the original path.
</p>
@return the requested node, if the path could be resolved completely
(so <var>aNode</var> and <var>aTree</var> refer to the desired node or its parent,
and <var>aPath</var> is empty)<BR/>
an invalid node otherwise
*/
AnyNodeRef getDeepDescendant(Tree& aTree, NodeRef& aNode, RelativePath& aPath);
//-------------------------------------------------------------------------
inline bool AnyNodeRef::isValid() const
{
OSL_ASSERT( m_pUsedImpl == 0 || checkValidState() );
return m_pUsedImpl != 0;
}
//-------------------------------------------------------------------------
}
}
#endif // CONFIGMGR_CONFIGANYNODE_HXX_
|
