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
|
/*************************************************************************
*
* $RCSfile: treeprovider.hxx,v $
*
* $Revision: 1.18 $
*
* last change: $Author: jb $ $Date: 2002-10-10 09:27:46 $
*
* 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): _______________________________________
*
*
************************************************************************/
/* PLEASE DON'T DELETE ANY COMMENT LINES, ALSO IT'S UNNECESSARY. */
#ifndef CONFIGMGR_TREEPROVIDER_HXX
#define CONFIGMGR_TREEPROVIDER_HXX
#ifndef _CONFIGMGR_COMMONTYPES_HXX_
#include "commontypes.hxx"
#endif
#ifndef _CONFIGMGR_TREE_VALUENODE_HXX
#include "valuenode.hxx"
#endif
#ifndef CONFIGMGR_MISC_OPTIONS_HXX_
#include <options.hxx>
#endif
#ifndef CONFIGMGR_UTILITY_HXX_
#include "utility.hxx"
#endif
#ifndef _COM_SUN_STAR_UNO_EXCEPTION_HPP_
#include <com/sun/star/uno/Exception.hpp>
#endif
#ifndef _COM_SUN_STAR_UNO_RUNTIMEEXCEPTION_HPP_
#include <com/sun/star/uno/RuntimeException.hpp>
#endif
#ifndef _VOS_REF_HXX_
#include <vos/ref.hxx>
#endif
#ifndef INCLUDED_MEMORY
#include <memory>
#define INCLUDED_MEMORY
#endif
namespace configmgr
{
namespace uno = com::sun::star::uno;
using ::rtl::OUString;
////////////////////////////////////////////////////////////////////////////////
namespace configuration
{
class Name;
class AbsolutePath;
}
//-------------------------
namespace memory
{
class Segment;
class Accessor;
class UpdateAccessor;
}
//-------------------------
namespace data
{
class NodeAccess;
class TreeAccessor;
}
//-------------------------
class ISubtree;
struct TreeChangeList;
//==========================================================================
//= ITreeProvider
//==========================================================================
struct SAL_NO_VTABLE ITreeProvider
{
typedef configuration::AbsolutePath AbsolutePath;
enum { ALL_LEVELS = -1 };
/// load the tree named by a path using certain options and requiring a specific loading depth - return it yielding ownership
virtual std::auto_ptr<ISubtree> loadSubtree(AbsolutePath const& aSubtreePath,
const vos::ORef < OOptions >& _xOptions,
sal_Int16 nMinLevels = ALL_LEVELS) CFG_UNO_THROW_ALL( ) = 0;
/// update the stored data according to a changes list
virtual void updateTree(TreeChangeList& aChanges) CFG_UNO_THROW_ALL( ) = 0;
};
//==========================================================================
//= ITreeManager
//==========================================================================
// a ITreeProvider which can notify changes that were done, and manages the lifetime of subtrees
class SAL_NO_VTABLE ITreeManager
{
public:
typedef configuration::AbsolutePath AbsolutePath;
enum { ALL_LEVELS = ITreeProvider::ALL_LEVELS };
/// get a data segment to host the given location
virtual memory::Segment* getDataSegment( AbsolutePath const& _rAccessor,
const vos::ORef < OOptions >& _xOptions) = 0;
/** request that the tree named by a path is added to the collection of managed trees
respecting certain options and requiring a specific loading depth.
Return a reference to that managed tree.
The reference must later be released by calling releaseSubtree with the same path and options.
*/
virtual data::NodeAccess requestSubtree(AbsolutePath const& aSubtreePath,
const vos::ORef < OOptions >& _xOptions,
sal_Int16 nMinLevels = ALL_LEVELS) CFG_UNO_THROW_ALL( ) = 0;
/** request that the tree named by a path is added to the collection of managed trees
respecting certain options and requiring a specific loading depth.
*/
virtual void fetchSubtree(AbsolutePath const& aSubtreePath,
const vos::ORef < OOptions >& _xOptions,
sal_Int16 nMinLevels = ALL_LEVELS) CFG_NOTHROW() = 0;
/// update the managed data according to a changes list - update the changes list accordingly with old values
virtual void updateTree(memory::UpdateAccessor& _aAccessToken, TreeChangeList& aChanges) CFG_UNO_THROW_ALL( ) = 0;
// notification
virtual void saveAndNotifyUpdate(memory::Accessor const& _aChangedDataAccessor, TreeChangeList const& aChanges ) CFG_UNO_THROW_ALL( ) = 0;
// bookkeeping support
virtual void releaseSubtree(AbsolutePath const& aSubtreePath,
const vos::ORef < OOptions >& _xOptions ) CFG_NOTHROW() = 0;
/** data for the given options may not be used any more
<p>all clients of such data must be disposed</p>
<p>If the locale is not set, the whole user has become invalid</p>
*/
virtual void disposeData(const vos::ORef < OOptions >& _xOptions) CFG_NOTHROW() = 0;
};
//==========================================================================
//= ITemplateProvider
//==========================================================================
struct SAL_NO_VTABLE ITemplateProvider
{
typedef configuration::Name Name;
virtual ::std::auto_ptr<INode> loadTemplate(
Name const& aName, Name const& aModule,
const vos::ORef < OOptions >& _xOptions
) CFG_UNO_THROW_ALL( ) = 0;
};
//==========================================================================
//= ITemplateManager
//==========================================================================
class SAL_NO_VTABLE ITemplateManager
{
public:
typedef configuration::Name Name;
virtual data::TreeAccessor requestTemplate(
memory::Accessor const& _aAccessor,
Name const& aName, Name const& aModule
) CFG_UNO_THROW_ALL( ) = 0;
};
////////////////////////////////////////////////////////////////////////////////
//==========================================================================
//= INotifyListener
//==========================================================================
/** a listener on configuration nodes. able to receive all changes in one or more
specific registry sub trees.
*/
struct SAL_NO_VTABLE INotifyListener : public IInterface
{
/** called whenever another session modified a node which the listener is registered for
@param _rChanges The list of changes for a node.
*/
virtual void nodeUpdated(TreeChangeList& _rChanges) = 0;
};
//==========================================================================
//= INotifyBroadcaster
//==========================================================================
/** a broadcaster of changes on configuration nodes. Able to broadcast all changes in one or more
specific registry sub trees.
*/
struct SAL_NO_VTABLE INotifyBroadcaster
{
/** registers a listener for node changes.
*/
virtual void setNotifyListener(const ::vos::ORef< INotifyListener >& _rListener) = 0;
};
//==========================================================================
/// a refcounted TemplateManager
struct SAL_NO_VTABLE IConfigTemplateManager
: public Refcounted
, public ITemplateManager
{};
//==========================================================================
/// a complete combined TreeManager
struct SAL_NO_VTABLE IConfigTreeManager
: public IConfigTemplateManager
, public ITreeManager
{};
//==========================================================================
} // namespace configmgr
#endif
|
