blob: 242db9e4cb437f503f4b66509da322ba177680e5 (
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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_XMLOFF_UNIREF_HXX
#define INCLUDED_XMLOFF_UNIREF_HXX
#include <sal/config.h>
#include <xmloff/dllapi.h>
#include <sal/types.h>
#include <osl/interlck.h>
/**
* An instance of this class holds a pointer to an object. The lifetime of
* the object is controled by the instance. The constructor calls
* acquire() and the destructor calls release().
* You could derive your class from the baseclass UniRefBase which implements
* the methods acquire and release, yet.
*/
template< class T > class UniReference
{
private:
T* mpElement;
public:
/** Create an empty reference.*/
UniReference()
: mpElement( NULL )
{}
/** Destroy the reference and releases the element.*/
inline ~UniReference();
/** Create a new reference with the same element as in rRef and acquire this one.*/
inline UniReference( const UniReference< T > & rRef );
/**
* Create a new reference with the given element pElement and acquire this one.
*/
inline UniReference( T * pElement );
/**
* Release the reference and set the new one pObj.
*/
inline UniReference< T > & operator = ( T * pElement );
/**
* Release the reference and set the new one from rObj.
*/
inline UniReference< T > & operator = ( const UniReference< T > & rRef );
/**
* Return the pointer to the element, may be null.
*/
inline T* operator -> () const;
/**
* Returns true if the pointer to the element is valid.
*/
inline bool is() const;
/**
* Return true if both elements refer to the same object.
*/
inline bool operator == ( const UniReference & rRef ) const;
/**
* Return true if both elements does not refer to the same object.
*/
inline bool operator != ( const UniReference & rRef ) const;
/** Gets implementation pointer.
This call does <b>not</b> acquire the implementation.
<br>
@return <b>un</b>acquired implementation pointer
*/
inline T* get() const;
};
class XMLOFF_DLLPUBLIC UniRefBase
{
private:
/**
* The reference counter.
*/
oslInterlockedCount m_refCount;
public:
UniRefBase() : m_refCount( 0 )
{}
virtual ~UniRefBase();
void acquire() { osl_atomic_increment( &m_refCount ); }
void release();
};
// Inline-implementations of UniReference
/** Create a new reference with the same element as in rRef and acquire this one.*/
template< class T >
inline UniReference< T >::UniReference( const UniReference< T > & rRef )
: mpElement( rRef.mpElement )
{
if( mpElement )
mpElement->acquire();
}
template< class T >
inline UniReference< T >::~UniReference()
{
if( mpElement )
mpElement->release();
}
/**
* Create a new reference with the given element pElement and acquire this one.
* @param pInterface the interface, pointer may be null.
*/
template< class T >
inline UniReference< T >::UniReference( T * pElement )
: mpElement( pElement )
{
if( mpElement )
mpElement->acquire();
}
/**
* Release the reference and set the new one pObj.<BR>
* <B>The operation is not thread save. You must protect all assigns to a reference class.</B>
*/
template< class T >
inline UniReference< T > & UniReference< T >::operator = ( T * pElement )
{
if( pElement )
pElement->acquire();
if( mpElement )
mpElement->release();
mpElement = pElement;
return *this;
}
/**
* Release the reference and set the new one from rObj.<BR>
* <B>The operation is not thread save. You must protect all assigns to a reference class.</B>
*/
template< class T >
inline UniReference< T > & UniReference< T >::operator = ( const UniReference< T > & rRef )
{
return operator = ( rRef.mpElement );
}
/**
* Return the pointer to the interface, may be null.
*/
template< class T >
inline T* UniReference< T >::operator -> () const
{
return get();
}
/**
* Return the pointer to the interface, may be null.
*/
template< class T >
inline T* UniReference< T >::get () const
{
return static_cast< T * >( mpElement );
}
/**
* Returns true if the pointer to the interface is valid.
*/
template< class T >
inline bool UniReference< T >::is() const
{
return (mpElement != 0);
}
/**
* Return true if both interfaces refer to the same object. The operation can be
* much more expensive than a pointer comparision.<BR>
*
* @param rRef another interface reference
*/
template< class T >
inline bool UniReference< T >::operator == ( const UniReference & rRef ) const
{
return ( mpElement == rRef.mpElement );
}
/**
* Return true if both interfaces does not refer to the same object. The operation can be
* much more expensive than a pointer comparision.<BR>
*
* @param rRef another interface reference
*/
template< class T >
inline bool UniReference< T >::operator != ( const UniReference & rRef ) const
{
return ( ! operator == ( rRef ) );
}
#endif // INCLUDED_XMLOFF_UNIREF_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
