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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
|
/* -*- 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 _COM_SUN_STAR_UNO_ANY_H_
#define _COM_SUN_STAR_UNO_ANY_H_
#include <uno/any2.h>
#include <typelib/typedescription.h>
#include <com/sun/star/uno/Type.h>
#include "cppu/unotype.hxx"
#include <rtl/alloc.h>
namespace com
{
namespace sun
{
namespace star
{
namespace uno
{
/** C++ class representing an IDL any.
This class is used to transport any type defined in IDL. The class inherits from the
binary C representation of uno_Any.
You can insert a value by either using the <<= operators or the template function makeAny().
No any can hold an any. You can extract values from an any by using the >>= operators which
return true if the any contains an assignable value (no data loss), e.g. the any contains a
short and you >>= it into a long variable.
*/
class Any : public uno_Any
{
public:
// these are here to force memory de/allocation to sal lib.
/** @internal */
inline static void * SAL_CALL operator new ( size_t nSize ) SAL_THROW( () )
{ return ::rtl_allocateMemory( nSize ); }
/** @internal */
inline static void SAL_CALL operator delete ( void * pMem ) SAL_THROW( () )
{ ::rtl_freeMemory( pMem ); }
/** @internal */
inline static void * SAL_CALL operator new ( size_t, void * pMem ) SAL_THROW( () )
{ return pMem; }
/** @internal */
inline static void SAL_CALL operator delete ( void *, void * ) SAL_THROW( () )
{}
/** Default constructor: Any holds no value; its type is void.
*/
inline Any() SAL_THROW( () );
/** Templated ctor. Sets a copy of the given value.
@param value value of the Any
*/
template <typename T>
explicit inline Any( T const & value );
/// Ctor support for C++ bool.
explicit inline Any( bool value );
/** Copy constructor: Sets value of the given any.
@param rAny another any
*/
inline Any( const Any & rAny ) SAL_THROW( () );
/** Constructor: Sets a copy of the given data.
@param pData_ value
@param rType type of value
*/
inline Any( const void * pData_, const Type & rType ) SAL_THROW( () );
/** Constructor: Sets a copy of the given data.
@param pData_ value
@param pTypeDescr type of value
*/
inline Any( const void * pData_, typelib_TypeDescription * pTypeDescr ) SAL_THROW( () );
/** Constructor: Sets a copy of the given data.
@param pData_ value
@param pType type of value
*/
inline Any( const void * pData_, typelib_TypeDescriptionReference * pType ) SAL_THROW( () );
/** Destructor: Destructs any content and frees memory.
*/
inline ~Any() SAL_THROW( () );
/** Assignment operator: Sets the value of the given any.
@param rAny another any (right side)
@return this any
*/
inline Any & SAL_CALL operator = ( const Any & rAny ) SAL_THROW( () );
/** Gets the type of the set value.
@return a Type object of the set value
*/
inline const Type & SAL_CALL getValueType() const SAL_THROW( () )
{ return * reinterpret_cast< const Type * >( &pType ); }
/** Gets the type of the set value.
@return the UNacquired type description reference of the set value
*/
inline typelib_TypeDescriptionReference * SAL_CALL getValueTypeRef() const SAL_THROW( () )
{ return pType; }
/** Gets the type description of the set value. Provides ownership of the type description!
Call an explicit typelib_typedescription_release() to release afterwards.
@param a pointer to type description pointer
*/
inline void SAL_CALL getValueTypeDescription( typelib_TypeDescription ** ppTypeDescr ) const SAL_THROW( () )
{ ::typelib_typedescriptionreference_getDescription( ppTypeDescr, pType ); }
/** Gets the type class of the set value.
@return the type class of the set value
*/
inline TypeClass SAL_CALL getValueTypeClass() const SAL_THROW( () )
{ return (TypeClass)pType->eTypeClass; }
/** Gets the type name of the set value.
@return the type name of the set value
*/
inline ::rtl::OUString SAL_CALL getValueTypeName() const SAL_THROW( () );
/** Tests if any contains a value.
@return true if any has a value, false otherwise
*/
inline sal_Bool SAL_CALL hasValue() const SAL_THROW( () )
{ return (typelib_TypeClass_VOID != pType->eTypeClass); }
/** Gets a pointer to the set value.
@return a pointer to the set value
*/
inline const void * SAL_CALL getValue() const SAL_THROW( () )
{ return pData; }
#if ! defined(EXCEPTIONS_OFF)
/** Provides a value of specified type, so you can easily write e.g.
<pre>
sal_Int32 myVal = myAny.get<sal_Int32>();
</pre>
Widening conversion without data loss is taken into account.
Throws a
<type scope="com::sun::star::uno">RuntimeException</type>
if the specified type cannot be provided.
@return value of specified type
@exception <type scope="com::sun::star::uno">RuntimeException</type>
in case the specified type cannot be provided
*/
template <typename T>
inline T get() const;
#endif // ! defined(EXCEPTIONS_OFF)
/** Sets a value. If the any already contains a value, that value will be destructed
and its memory freed.
@param pData_ pointer to value
@param rType type of value
*/
inline void SAL_CALL setValue( const void * pData_, const Type & rType ) SAL_THROW( () );
/** Sets a value. If the any already contains a value, that value will be destructed
and its memory freed.
@param pData_ pointer to value
@param pType type of value
*/
inline void SAL_CALL setValue( const void * pData_, typelib_TypeDescriptionReference * pType ) SAL_THROW( () );
/** Sets a value. If the any already contains a value, that value will be destructed
and its memory freed.
@param pData_ pointer to value
@param pTypeDescr type description of value
*/
inline void SAL_CALL setValue( const void * pData_, typelib_TypeDescription * pTypeDescr ) SAL_THROW( () );
/** Clears this any. If the any already contains a value, that value will be destructed
and its memory freed. After this has been called, the any does not contain a value.
*/
inline void SAL_CALL clear() SAL_THROW( () );
/** Tests whether this any is extractable to a value of given type.
Widening conversion without data loss is taken into account.
@param rType destination type
@return true if this any is extractable to value of given type (e.g. using >>= operator)
*/
inline sal_Bool SAL_CALL isExtractableTo( const Type & rType ) const SAL_THROW( () );
/** Tests whether this any can provide a value of specified type.
Widening conversion without data loss is taken into account.
@return true if this any can provide a value of specified type
(e.g. using >>= operator)
*/
template <typename T>
inline bool has() const;
/** Equality operator: compares two anys.
The values need not be of equal type, e.g. a short integer is compared to a long integer.
@param rAny another any (right side)
@return true if both any contains equal values
*/
inline sal_Bool SAL_CALL operator == ( const Any & rAny ) const SAL_THROW( () );
/** Unequality operator: compares two anys.
The values need not be of equal type, e.g. a short integer is compared to a long integer.
@param rAny another any (right side)
@return true if both any contains unequal values
*/
inline sal_Bool SAL_CALL operator != ( const Any & rAny ) const SAL_THROW( () );
private:
// not impl: forbid use with ambiguous type (sal_Unicode, sal_uInt16)
explicit Any( sal_uInt16 );
#if defined(_MSC_VER)
// Omitting the following private declarations leads to an internal compiler
// error on MSVC (version 1310).
// not impl: forbid use with ambiguous type (sal_Unicode, sal_uInt16)
#if ! defined(EXCEPTIONS_OFF)
template <>
sal_uInt16 get<sal_uInt16>() const;
#endif // ! defined(EXCEPTIONS_OFF)
template <>
bool has<sal_uInt16>() const;
#endif // defined(_MSC_VER)
};
/** Template function to generically construct an any from a C++ value.
@tplparam C value type
@param value a value
@return an any
*/
template< class C >
inline Any SAL_CALL makeAny( const C & value ) SAL_THROW( () );
// additionally specialized for C++ bool
template<>
inline Any SAL_CALL makeAny( bool const & value ) SAL_THROW( () );
class BaseReference;
class Type;
/** Template binary <<= operator to set the value of an any.
@tplparam C value type
@param rAny destination any (left side)
@param value source value (right side)
*/
template< class C >
inline void SAL_CALL operator <<= ( Any & rAny, const C & value ) SAL_THROW( () );
// additionally for C++ bool:
inline void SAL_CALL operator <<= ( Any & rAny, bool const & value )
SAL_THROW( () );
/** Template binary >>= operator to assign a value from an any.
If the any does not contain a value that can be assigned without data loss, then this
operation will fail returning false.
@tplparam C value type
@param rAny source any (left side)
@param value destination value (right side)
@return true if assignment was possible without data loss
*/
template< class C >
inline sal_Bool SAL_CALL operator >>= ( const Any & rAny, C & value ) SAL_THROW( () );
/** Template equality operator: compares set value of left side any to right side value.
The values need not be of equal type, e.g. a short integer is compared to a long integer.
This operator can be implemented as template member function, if all supported compilers
can cope with template member functions.
@tplparam C value type
@param rAny another any (left side)
@param value a value (right side)
@return true if values are equal, false otherwise
*/
template< class C >
inline sal_Bool SAL_CALL operator == ( const Any & rAny, const C & value ) SAL_THROW( () );
/** Template unequality operator: compares set value of left side any to right side value.
The values need not be of equal type, e.g. a short integer is compared to a long integer.
This operator can be implemented as template member function, if all supported compilers
can cope with template member functions.
@tplparam C value type
@param rAny another any (left side)
@param value a value (right side)
@return true if values are unequal, false otherwise
*/
template< class C >
inline sal_Bool SAL_CALL operator != ( const Any & rAny, const C & value ) SAL_THROW( () );
// additional specialized >>= and == operators
// bool
inline sal_Bool SAL_CALL operator >>= ( const Any & rAny, sal_Bool & value ) SAL_THROW( () );
inline sal_Bool SAL_CALL operator == ( const Any & rAny, const sal_Bool & value ) SAL_THROW( () );
template<>
inline sal_Bool SAL_CALL operator >>= ( Any const & rAny, bool & value )
SAL_THROW( () );
template<>
inline sal_Bool SAL_CALL operator == ( Any const & rAny, bool const & value )
SAL_THROW( () );
// byte
inline sal_Bool SAL_CALL operator >>= ( const Any & rAny, sal_Int8 & value ) SAL_THROW( () );
// short
inline sal_Bool SAL_CALL operator >>= ( const Any & rAny, sal_Int16 & value ) SAL_THROW( () );
inline sal_Bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt16 & value ) SAL_THROW( () );
// long
inline sal_Bool SAL_CALL operator >>= ( const Any & rAny, sal_Int32 & value ) SAL_THROW( () );
inline sal_Bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt32 & value ) SAL_THROW( () );
// hyper
inline sal_Bool SAL_CALL operator >>= ( const Any & rAny, sal_Int64 & value ) SAL_THROW( () );
inline sal_Bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt64 & value ) SAL_THROW( () );
// float
inline sal_Bool SAL_CALL operator >>= ( const Any & rAny, float & value ) SAL_THROW( () );
// double
inline sal_Bool SAL_CALL operator >>= ( const Any & rAny, double & value ) SAL_THROW( () );
// string
inline sal_Bool SAL_CALL operator >>= ( const Any & rAny, ::rtl::OUString & value ) SAL_THROW( () );
inline sal_Bool SAL_CALL operator == ( const Any & rAny, const ::rtl::OUString & value ) SAL_THROW( () );
// type
inline sal_Bool SAL_CALL operator >>= ( const Any & rAny, Type & value ) SAL_THROW( () );
inline sal_Bool SAL_CALL operator == ( const Any & rAny, const Type & value ) SAL_THROW( () );
// any
inline sal_Bool SAL_CALL operator >>= ( const Any & rAny, Any & value ) SAL_THROW( () );
// interface
inline sal_Bool SAL_CALL operator == ( const Any & rAny, const BaseReference & value ) SAL_THROW( () );
}
}
}
}
/** Gets the meta type of IDL type any.
There are cases (involving templates) where uses of getCppuType are known to
not compile. Use cppu::UnoType or cppu::getTypeFavourUnsigned instead.
@param dummy typed pointer for function signature
@return type of IDL type any
*/
inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const ::com::sun::star::uno::Any * ) SAL_THROW( () )
{
return ::cppu::UnoType< ::com::sun::star::uno::Any >::get();
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|