blob: f92bea0cd9cbd72e03b51be58a53c4917618663d (
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
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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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 _RTL_REF_HXX_
#define _RTL_REF_HXX_
#include <sal/types.h>
#include <osl/diagnose.h>
#include <osl/interlck.h>
namespace rtl
{
/** Interface for a reference type.
*/
class IReference
{
public:
/** @see osl_incrementInterlockedCount.
*/
virtual oslInterlockedCount SAL_CALL acquire() = 0;
/** @see osl_decrementInterlockedCount.
*/
virtual oslInterlockedCount SAL_CALL release() = 0;
};
/** Template reference class for reference type derived from IReference.
*/
template <class reference_type>
class Reference
{
/** The <b>reference_type</b> body pointer.
*/
reference_type * m_pBody;
public:
/** Constructor...
*/
inline Reference()
: m_pBody (0)
{}
/** Constructor...
*/
inline Reference (reference_type * pBody)
: m_pBody (pBody)
{
if (m_pBody)
m_pBody->acquire();
}
/** Copy constructor...
*/
inline Reference (const Reference<reference_type> & handle)
: m_pBody (handle.m_pBody)
{
if (m_pBody)
m_pBody->acquire();
}
/** Destructor...
*/
inline ~Reference()
{
if (m_pBody)
m_pBody->release();
}
/** Set...
Similar to assignment.
*/
inline Reference<reference_type> &
SAL_CALL set (reference_type * pBody)
{
if (pBody)
pBody->acquire();
reference_type * const pOld = m_pBody;
m_pBody = pBody;
if (pOld)
pOld->release();
return *this;
}
/** Assignment.
Unbinds this instance from its body (if bound) and
bind it to the body represented by the handle.
*/
inline Reference<reference_type> &
SAL_CALL operator= (const Reference<reference_type> & handle)
{
return set( handle.m_pBody );
}
/** Assignment...
*/
inline Reference<reference_type> &
SAL_CALL operator= (reference_type * pBody)
{
return set( pBody );
}
/** Unbind the body from this handle.
Note that for a handle representing a large body,
"handle.clear().set(new body());" _might_
perform a little bit better than "handle.set(new body());",
since in the second case two large objects exist in memory
(the old body and the new body).
*/
inline Reference<reference_type> & SAL_CALL clear()
{
if (m_pBody)
{
reference_type * const pOld = m_pBody;
m_pBody = 0;
pOld->release();
}
return *this;
}
/** Get the body. Can be used instead of operator->().
I.e. handle->someBodyOp() and handle.get()->someBodyOp()
are the same.
*/
inline reference_type * SAL_CALL get() const
{
return m_pBody;
}
/** Probably most common used: handle->someBodyOp().
*/
inline reference_type * SAL_CALL operator->() const
{
OSL_PRECOND(m_pBody, "Reference::operator->() : null body");
return m_pBody;
}
/** Allows (*handle).someBodyOp().
*/
inline reference_type & SAL_CALL operator*() const
{
OSL_PRECOND(m_pBody, "Reference::operator*() : null body");
return *m_pBody;
}
/** Returns True if the handle does point to a valid body.
*/
inline sal_Bool SAL_CALL is() const
{
return (m_pBody != 0);
}
/** Returns True if this points to pBody.
*/
inline sal_Bool SAL_CALL operator== (const reference_type * pBody) const
{
return (m_pBody == pBody);
}
/** Returns True if handle points to the same body.
*/
inline sal_Bool
SAL_CALL operator== (const Reference<reference_type> & handle) const
{
return (m_pBody == handle.m_pBody);
}
/** Needed to place References into STL collection.
*/
inline sal_Bool
SAL_CALL operator!= (const Reference<reference_type> & handle) const
{
return (m_pBody != handle.m_pBody);
}
/** Needed to place References into STL collection.
*/
inline sal_Bool
SAL_CALL operator< (const Reference<reference_type> & handle) const
{
return (m_pBody < handle.m_pBody);
}
/** Needed to place References into STL collection.
*/
inline sal_Bool
SAL_CALL operator> (const Reference<reference_type> & handle) const
{
return (m_pBody > handle.m_pBody);
}
};
/** @internal
Enables boost::mem_fn and boost::bind to recognize Reference.
*/
template <typename T>
inline T * get_pointer( Reference<T> const& r )
{
return r.get();
}
} // namespace rtl
#endif /* !_RTL_REF_HXX_ */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
