blob: cfe03ea352195b06bc31fa13146c275b1e0fdc30 (
plain)
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
|
/*************************************************************************
*
* 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: apitreeaccess.hxx,v $
* $Revision: 1.13 $
*
* 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 CONFIGMGR_API_TREEACCESS_HXX_
#define CONFIGMGR_API_TREEACCESS_HXX_
#include "options.hxx"
#include "utility.hxx"
namespace osl { class Mutex; }
namespace configmgr
{
//-----------------------------------------------------------------------------
struct ServiceImplementationInfo;
//-----------------------------------------------------------------------------
namespace configuration
{
class Name;
class Tree;
class TreeRef;
class ElementRef;
class TemplateInfo;
}
//-----------------------------------------------------------------------------
namespace configapi
{
//-----------------------------------------------------------------------------
namespace uno = com::sun::star::uno;
typedef uno::XInterface UnoInterface;
typedef uno::Any UnoAny;
//-----------------------------------------------------------------------------
class Factory;
class Notifier;
class Committer;
class NodeSetInfoAccess;
//-----------------------------------------------------------------------------
// API object implementation wrappers
//-------------------------------------------------------------------------
class ApiTreeImpl;
class ApiRootTreeImpl;
// these objects just provide the pieces needed to navigate and manipulate trees and nodes
// A common base class for 'element' classes
class NodeElement : Noncopyable
{
public:
typedef ServiceImplementationInfo ServiceInfo;
public:
virtual ~NodeElement() {}
// self-locked methods for dispose handling
void checkAlive() const;
// api object handling
UnoInterface* getUnoInstance() const
{ return doGetUnoInstance(); }
ServiceInfo const * getServiceInfo() const
{ return doGetServiceInfo(); }
private:
virtual UnoInterface* doGetUnoInstance() const = 0;
virtual ServiceInfo const* doGetServiceInfo() const = 0;
virtual ApiTreeImpl& getApiTree() const = 0;
friend class Factory;
};
//-----------------------------------------------------------------------------
// A class for tagging inner nodes
class InnerElement : public NodeElement
{
public:
// Only used as a tag
};
//-----------------------------------------------------------------------------
// A common base class for tree-owning elemnt classes
class TreeElement : public NodeElement
{
public:
// model access
configuration::TreeRef getTreeRef() const;
configuration::Tree getTree() const;
// api object handling
Factory& getFactory();
protected:
virtual ApiTreeImpl& getApiTree() const = 0;
};
//-----------------------------------------------------------------------------
// Info interfaces for Set Elements
class SetElement : public TreeElement
{
public:
// self-locked methods for dispose handling
bool disposeTree(bool bForceDispose);
void haveNewParent(NodeSetInfoAccess* pNewParent);
configuration::ElementRef getElementRef() const;
configuration::TemplateInfo getTemplateInfo() const;
};
//-----------------------------------------------------------------------------
// Info interfaces for Set Elements
class RootElement : public TreeElement
{
public:
bool disposeTree();
protected:
virtual ApiRootTreeImpl& getRootTree() = 0;
};
//-----------------------------------------------------------------------------
// Info interfaces for Set Elements
class UpdateRootElement : public RootElement
{
public:
Committer getCommitter();
};
//-----------------------------------------------------------------------------
/// guards a TreeElement; provides an object (read) lock, ensures object was not disposed
// FIXME: bin this ...
class TreeReadGuardImpl : Noncopyable
{
TreeElement& m_rTree;
public:
TreeReadGuardImpl(TreeElement& rTree);
~TreeReadGuardImpl() throw ();
public:
TreeElement& get() const { return m_rTree; }
};
// Thin Wrappers around TreeElements: Provide guarding and convenient access
/// wraps a TreeElement; provides an object (read) lock, ensures object was not disposed
class GuardedTreeElement
{
UnoApiLock m_aLock;
TreeReadGuardImpl m_aImpl;
public:
GuardedTreeElement(TreeElement& rTree) : m_aImpl(rTree) {}
public:
TreeElement& get() const { return m_aImpl.get(); }
};
class GuardedRootElement
{
UnoApiLock m_aLock;
TreeReadGuardImpl m_aImpl;
public:
GuardedRootElement(RootElement& rTree);
public:
RootElement& get() const { return static_cast<RootElement&>(m_aImpl.get()); }
configuration::Tree getTree() const;
};
//-----------------------------------------------------------------------------
}
}
#endif // CONFIGMGR_API_TREEACCESS_HXX_
|
