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
|
/*************************************************************************
*
* $RCSfile: configset.hxx,v $
*
* $Revision: 1.13 $
*
* last change: $Author: hr $ $Date: 2003-03-19 16:18:57 $
*
* 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_CONFIGSET_HXX_
#define CONFIGMGR_CONFIGSET_HXX_
#ifndef CONFIGMGR_CONFIGEXCEPT_HXX_
#include "configexcept.hxx"
#endif
#ifndef CONFIGMGR_CONFIG_DEFAULTPROVIDER_HXX_
#include "configdefaultprovider.hxx"
#endif
#ifndef CONFIGMGR_CONFIGTEMPLATE_HXX_
#include "template.hxx"
#endif
#ifndef CONFIGMGR_CONFIGNODE_HXX_
#include "noderef.hxx"
#endif
#ifndef _RTL_REF_HXX_
#include <rtl/ref.hxx>
#endif
#ifndef INCLUDED_MEMORY
#include <memory>
#define INCLUDED_MEMORY
#endif
namespace com { namespace sun { namespace star {
namespace script { class XTypeConverter; }
} } }
namespace configmgr
{
namespace data { class TreeSegment; }
namespace configuration
{
//-----------------------------------------------------------------------------
class ElementRef;
class ElementTree;
//---------------------------------------------------------------------
class Name;
class AbsolutePath;
namespace Path { class Component; }
//---------------------------------------------------------------------
typedef com::sun::star::uno::Type UnoType;
typedef com::sun::star::uno::Any UnoAny;
typedef com::sun::star::uno::Reference<com::sun::star::script::XTypeConverter> UnoTypeConverter;
//---------------------------------------------------------------------
class ElementTreeImpl;
typedef rtl::Reference<ElementTreeImpl> ElementTreeHolder;
class NodeChange;
class Template;
typedef rtl::Reference<Template> TemplateHolder;
//-----------------------------------------------------------------------------
/// identifies a <type>Node</type> that is a element of a Container ("set").
class ElementRef
{
ElementTreeHolder m_aTreeHolder;
public:
explicit ElementRef(ElementTreeImpl* pTree);
ElementRef(ElementRef const& aOther);
ElementRef& operator=(ElementRef const& aOther);
~ElementRef();
bool isValid() const;
Path::Component getFullName() const;
Name getName() const;
TemplateHolder getTemplate() const;
ElementTree getElementTree(data::Accessor const& _accessor) const;
osl::Mutex& getTreeLock() const;
TreeRef getTreeRef() const;
static ElementRef extract(TreeRef const& aTree);
};
//-----------------------------------------------------------------------------
/// provides information about a <type>Node</type> that is a element of a Container ("set").
class ElementTree
{
ElementTreeHolder m_aTreeHolder;
data::Accessor m_accessor;
public:
static ElementTree emptyElement() { return ElementTree(); }
ElementTree(data::Accessor const& _accessor, ElementTreeImpl* pTree);
ElementTree(data::Accessor const& _accessor, ElementTreeHolder const& pTree);
ElementTree(ElementTree const& aOther);
ElementTree& operator=(ElementTree const& aOther);
~ElementTree();
bool isValid() const;
ElementTreeHolder get() const;
ElementTreeImpl* getImpl() const;
TemplateHolder getTemplate() const;
ElementTreeImpl* operator->() const;
ElementTreeImpl& operator*() const;
Tree getTree() const;
static ElementTree extract(Tree const& aTree);
/** if the element tree owns it's node tree, access to the segment is given to the caller.
*/
static data::TreeSegment getOwnedElement(ElementTree const& aElementTree);
private:
ElementTree();
};
//-----------------------------------------------------------------------------
/// provides information about the elements of a <type>Node</type> that is a Container ("set").
class TemplateInfo
{
TemplateHolder m_aTemplate;
public:
explicit TemplateInfo(TemplateHolder const& aTemplate);
TemplateHolder getTemplate() const;
UnoType getType() const;
Name getTemplateName() const;
Name getTemplatePackage() const;
OUString getTemplatePathString() const;
};
//-----------------------------------------------------------------------------
/// provides information about the elements of a <type>Node</type> that is a Container ("set").
class SetElementInfo
{
TemplateInfo m_aTemplateInfo;
data::Accessor m_aSetAccessor;
public:
SetElementInfo(data::Accessor const& _aSetAccessor, TemplateHolder const& aTemplate);
TemplateHolder getTemplate() const;
TemplateInfo getTemplateInfo() const;
UnoType getElementType() const { return m_aTemplateInfo.getType(); }
data::Accessor getSetDataAccessor() const { return m_aSetAccessor; }
static TemplateHolder extractElementInfo(Tree const& aTree, NodeRef const& aNode);
};
//-----------------------------------------------------------------------------
class SetElementFactory
{
TemplateProvider m_aProvider;
data::Accessor m_aDataAccessor;
data::Accessor const& getDataAccessor() const { return m_aDataAccessor; };
public:
SetElementFactory(data::Accessor const& _aDataAccessor, TemplateProvider const& aProvider);
SetElementFactory(SetElementFactory const& aOther);
SetElementFactory& operator=(SetElementFactory const& aOther);
~SetElementFactory();
ElementTree instantiateTemplate(TemplateHolder const& aTemplate);
ElementTree instantiateOnDefault(data::TreeSegment const& _aTree, TemplateHolder const& aDummyTemplate);
static TemplateProvider findTemplateProvider(Tree const& aTree, NodeRef const& aNode);
};
//-----------------------------------------------------------------------------
/// allows to insert,remove and replace an element of a <type>Node</type> that is a Container ("set") of full-fledged trees.
class TreeSetUpdater
{
Tree m_aParentTree;
NodeRef m_aSetNode;
TemplateHolder m_aTemplate;
public:
TreeSetUpdater(Tree const& aParentTree, NodeRef const& aSetNode, SetElementInfo const& aInfo);
NodeChange validateInsertElement (Name const& aName, ElementTree const& aNewElement);
NodeChange validateReplaceElement(ElementRef const& aElement, ElementTree const& aNewElement);
NodeChange validateRemoveElement (ElementRef const& aElement);
private:
void implValidateSet();
Path::Component implValidateElement(ElementRef const& aElement);
void implValidateTree(ElementTree const& aElementTree);
};
//-----------------------------------------------------------------------------
/// allows to insert,remove and replace an element of a <type>Node</type> that is a Container ("set") of simple values.
class ValueSetUpdater
{
Tree m_aParentTree;
NodeRef m_aSetNode;
TemplateHolder m_aTemplate;
UnoTypeConverter m_xTypeConverter;
public:
ValueSetUpdater(Tree const& aParentTree, NodeRef const& aSetNode,
SetElementInfo const& aInfo, UnoTypeConverter const& xConverter);
NodeChange validateInsertElement (Name const& aName, UnoAny const& aNewValue);
NodeChange validateReplaceElement(ElementRef const& aElement, UnoAny const& aNewValue);
NodeChange validateRemoveElement (ElementRef const& aElement);
private:
typedef Tree ElementNodeRef;
void implValidateSet();
Path::Component implValidateElement(ElementRef const& aElement);
UnoAny implValidateValue(ElementNodeRef const& aElementTree, UnoAny const& aValue);
UnoAny implValidateValue(UnoAny const& aValue);
ElementTreeHolder makeValueElement(Name const& aName, ElementNodeRef const& aElementTree, UnoAny const& aValue);
ElementTreeHolder makeValueElement(Name const& aName, UnoAny const& aValue);
ElementNodeRef extractElementNode(ElementRef const& aElement);
};
//-----------------------------------------------------------------------------
/// allows to restore to its default state a <type>Node</type> that is a Container ("set") of full-fledged trees.
class SetDefaulter
{
Tree m_aParentTree;
NodeRef m_aSetNode;
DefaultProvider m_aDefaultProvider;
public:
SetDefaulter(Tree const& aParentTree, NodeRef const& aSetNode, DefaultProvider const& aDefaultProvider);
NodeChange validateSetToDefaultState();
private:
void implValidateSet();
};
//-----------------------------------------------------------------------------
}
}
#endif // CONFIGMGR_CONFIGSET_HXX_
|
