LibreOffice
LibreOffice 6.0 SDK C/C++ API Reference
Any.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 #ifndef INCLUDED_COM_SUN_STAR_UNO_ANY_H
20 #define INCLUDED_COM_SUN_STAR_UNO_ANY_H
21 
22 #include <sal/config.h>
23 
24 #include <cstddef>
25 
26 #include <rtl/ustring.hxx>
27 #include <uno/any2.h>
29 #include <cppu/unotype.hxx>
30 #include <com/sun/star/uno/TypeClass.hdl>
31 #include <rtl/alloc.h>
32 
33 namespace com
34 {
35 namespace sun
36 {
37 namespace star
38 {
39 namespace uno
40 {
41 
42 class Type;
43 
52 class SAL_WARN_UNUSED SAL_DLLPUBLIC_RTTI Any : public uno_Any
53 {
54 public:
56  // these are here to force memory de/allocation to sal lib.
57  static void * SAL_CALL operator new ( size_t nSize )
58  { return ::rtl_allocateMemory( nSize ); }
59  static void SAL_CALL operator delete ( void * pMem )
60  { ::rtl_freeMemory( pMem ); }
61  static void * SAL_CALL operator new ( size_t, void * pMem )
62  { return pMem; }
63  static void SAL_CALL operator delete ( void *, void * )
64  {}
66 
69  inline Any();
70 
75  template <typename T>
76  explicit inline Any( T const & value );
78  explicit inline Any( bool value );
79 
80 #if defined LIBO_INTERNAL_ONLY
81  template<typename T1, typename T2>
82  explicit inline Any(rtl::OUStringConcat<T1, T2> const & value);
83 #endif
84 
89  inline Any( const Any & rAny );
90 
96  inline Any( const void * pData_, const Type & rType );
97 
103  inline Any( const void * pData_, typelib_TypeDescription * pTypeDescr );
104 
110  inline Any( const void * pData_, typelib_TypeDescriptionReference * pType_ );
111 
112 #if defined LIBO_INTERNAL_ONLY
113  Any(bool const *, Type const &) = delete;
114  Any(bool const *, typelib_TypeDescription *) = delete;
115  Any(bool const *, typelib_TypeDescriptionReference *) = delete;
116  Any(sal_Bool const *, Type const &) = delete;
117  Any(sal_Bool const *, typelib_TypeDescription *) = delete;
118  Any(sal_Bool const *, typelib_TypeDescriptionReference *) = delete;
119  Any(std::nullptr_t, Type const & type):
120  Any(static_cast<void *>(nullptr), type) {}
121  Any(std::nullptr_t, typelib_TypeDescription * type):
122  Any(static_cast<void *>(nullptr), type) {}
123  Any(std::nullptr_t, typelib_TypeDescriptionReference * type):
124  Any(static_cast<void *>(nullptr), type) {}
125 #endif
126 
129  inline ~Any();
130 
136  inline Any & SAL_CALL operator = ( const Any & rAny );
137 
138 #if defined LIBO_INTERNAL_ONLY
139  inline Any(Any && other);
140  inline Any & operator =(Any && other);
141 #endif
142 
147  const Type & SAL_CALL getValueType() const
148  { return * reinterpret_cast< const Type * >( &pType ); }
154  { return pType; }
155 
161  void SAL_CALL getValueTypeDescription( typelib_TypeDescription ** ppTypeDescr ) const
162  { ::typelib_typedescriptionreference_getDescription( ppTypeDescr, pType ); }
163 
168  TypeClass SAL_CALL getValueTypeClass() const
169  { return (TypeClass)pType->eTypeClass; }
170 
175  inline ::rtl::OUString SAL_CALL getValueTypeName() const;
176 
181  bool SAL_CALL hasValue() const
182  { return (typelib_TypeClass_VOID != pType->eTypeClass); }
183 
188  const void * SAL_CALL getValue() const
189  { return pData; }
190 
203  template <typename T>
204  inline T get() const;
205 
212  inline void SAL_CALL setValue( const void * pData_, const Type & rType );
219  inline void SAL_CALL setValue( const void * pData_, typelib_TypeDescriptionReference * pType_ );
226  inline void SAL_CALL setValue( const void * pData_, typelib_TypeDescription * pTypeDescr );
227 
228 #if defined LIBO_INTERNAL_ONLY
229  void setValue(bool const *, Type const &) = delete;
230  void setValue(bool const *, typelib_TypeDescriptionReference *) = delete;
231  void setValue(bool const *, typelib_TypeDescription *) = delete;
232  void setValue(sal_Bool const *, Type const &) = delete;
233  void setValue(sal_Bool const *, typelib_TypeDescriptionReference *)
234  = delete;
235  void setValue(sal_Bool const *, typelib_TypeDescription *) = delete;
236  void setValue(std::nullptr_t, Type const & type)
237  { setValue(static_cast<void *>(nullptr), type); }
238  void setValue(std::nullptr_t, typelib_TypeDescriptionReference * type)
239  { setValue(static_cast<void *>(nullptr), type); }
240  void setValue(std::nullptr_t, typelib_TypeDescription * type)
241  { setValue(static_cast<void *>(nullptr), type); }
242 #endif
243 
247  inline void SAL_CALL clear();
248 
255  inline bool SAL_CALL isExtractableTo( const Type & rType ) const;
256 
263  template <typename T>
264  inline bool has() const;
265 
272  inline bool SAL_CALL operator == ( const Any & rAny ) const;
279  inline bool SAL_CALL operator != ( const Any & rAny ) const;
280 
281 private:
282 #if !defined LIBO_INTERNAL_ONLY
283  // Forbid use with ambiguous type (sal_Unicode, sal_uInt16):
285  explicit Any(sal_uInt16) SAL_DELETED_FUNCTION;
287 #endif
288 };
289 
290 #if !defined LIBO_INTERNAL_ONLY
291 // Forbid use with ambiguous type (sal_Unicode, sal_uInt16):
293 template<> sal_uInt16 Any::get<sal_uInt16>() const SAL_DELETED_FUNCTION;
294 template<> bool Any::has<sal_uInt16>() const SAL_DELETED_FUNCTION;
296 #endif
297 
309 template< class C >
310 inline Any SAL_CALL makeAny( const C & value );
311 
312 #if !defined LIBO_INTERNAL_ONLY
313 template<> inline Any SAL_CALL makeAny(sal_uInt16 const & value);
314 #endif
315 
316 template<> Any SAL_CALL makeAny(Any const &) SAL_DELETED_FUNCTION;
317 
325 template<typename T> inline Any toAny(T const & value);
326 
327 template<> inline Any toAny(Any const & value);
328 
329 #if defined LIBO_INTERNAL_ONLY
330 
348 template<typename T> inline bool fromAny(Any const & any, T * value);
349 
350 template<> inline bool fromAny(Any const & any, Any * value);
351 
352 #endif
353 
354 class BaseReference;
355 
362 template< class C >
363 inline void SAL_CALL operator <<= ( Any & rAny, const C & value );
364 
365 // additionally for C++ bool:
366 template<>
367 inline void SAL_CALL operator <<= ( Any & rAny, bool const & value );
368 
378 template< class C >
379 inline bool SAL_CALL operator >>= ( const Any & rAny, C & value );
380 
391 template< class C >
392 inline bool SAL_CALL operator == ( const Any & rAny, const C & value );
403 template< class C >
404 inline bool SAL_CALL operator != ( const Any & rAny, const C & value );
405 
406 // additional specialized >>= and == operators
407 // bool
408 template<>
409 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Bool & value );
410 template<>
411 inline bool SAL_CALL operator == ( const Any & rAny, const sal_Bool & value );
412 template<>
413 inline bool SAL_CALL operator >>= ( Any const & rAny, bool & value );
414 template<>
415 inline bool SAL_CALL operator == ( Any const & rAny, bool const & value );
416 // byte
417 template<>
418 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int8 & value );
419 // short
420 template<>
421 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int16 & value );
422 template<>
423 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt16 & value );
424 // long
425 template<>
426 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int32 & value );
427 template<>
428 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt32 & value );
429 // hyper
430 template<>
431 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int64 & value );
432 template<>
433 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt64 & value );
434 // float
435 template<>
436 inline bool SAL_CALL operator >>= ( const Any & rAny, float & value );
437 // double
438 template<>
439 inline bool SAL_CALL operator >>= ( const Any & rAny, double & value );
440 // string
441 template<>
442 inline bool SAL_CALL operator >>= ( const Any & rAny, ::rtl::OUString & value );
443 template<>
444 inline bool SAL_CALL operator == ( const Any & rAny, const ::rtl::OUString & value );
445 // type
446 template<>
447 inline bool SAL_CALL operator >>= ( const Any & rAny, Type & value );
448 template<>
449 inline bool SAL_CALL operator == ( const Any & rAny, const Type & value );
450 // any
451 #if !defined LIBO_INTERNAL_ONLY
452 template<>
453 inline bool SAL_CALL operator >>= ( const Any & rAny, Any & value );
454 #endif
455 // interface
456 template<>
457 inline bool SAL_CALL operator == ( const Any & rAny, const BaseReference & value );
458 
459 }
460 }
461 }
462 }
463 
476 SAL_DEPRECATED("use cppu::UnoType")
477 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( SAL_UNUSED_PARAMETER const ::com::sun::star::uno::Any * )
478 {
479  return ::cppu::UnoType< ::com::sun::star::uno::Any >::get();
480 }
481 
482 #endif
483 
484 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
bool operator==(const Any &rAny, const C &value)
Template equality operator: compares set value of left side any to right side value.
Definition: Any.hxx:622
const void * getValue() const
Gets a pointer to the set value.
Definition: Any.h:188
#define SAL_DELETED_FUNCTION
short-circuit extra-verbose API namespaces
Definition: types.h:402
#define SAL_WARN_UNUSED
Annotate classes where a compiler should warn if an instance is unused.
Definition: types.h:608
void operator<<=(Any &rAny, const C &value)
Template binary <<= operator to set the value of an any.
Definition: Any.hxx:256
CPPU_DLLPUBLIC void typelib_typedescriptionreference_getDescription(typelib_TypeDescription **ppRet, typelib_TypeDescriptionReference *pRef) SAL_THROW_EXTERN_C()
Retrieves the type description for a given reference.
C++ class representing an IDL any.
Definition: Any.h:52
SAL_DLLPUBLIC void rtl_freeMemory(void *Ptr) SAL_THROW_EXTERN_C()
Free memory.
struct SAL_DLLPUBLIC_RTTI _uno_Any uno_Any
This is the binary specification of an UNO any.
Definition: types.h:383
const ::com::sun::star::uno::Type & getCppuType(SAL_UNUSED_PARAMETER const ::com::sun::star::uno::Any *)
Gets the meta type of IDL type any.
Definition: Any.h:477
unsigned char sal_Bool
Definition: types.h:39
typelib_TypeDescriptionReference * getValueTypeRef() const
Gets the type of the set value.
Definition: Any.h:153
bool operator!=(const Any &rAny, const C &value)
Template unequality operator: compares set value of left side any to right side value.
Definition: Any.hxx:633
#define SAL_UNUSED_PARAMETER
Annotate unused but required C++ function parameters.
Definition: types.h:587
C++ class representing an IDL meta type.
Definition: Type.h:54
struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescription typelib_TypeDescription
Full type description of a type.
signed char sal_Int8
Definition: types.h:44
const Type & getValueType() const
Gets the type of the set value.
Definition: Any.h:147
bool hasValue() const
Tests if any contains a value.
Definition: Any.h:181
TypeClass getValueTypeClass() const
Gets the type class of the set value.
Definition: Any.h:168
This String class provides base functionality for C++ like Unicode character array handling...
Definition: ustring.hxx:120
#define SAL_DEPRECATED(message)
Use as follows: SAL_DEPRECATED("Don&#39;t use, it&#39;s evil.") void doit(int nPara);.
Definition: types.h:493
void getValueTypeDescription(typelib_TypeDescription **ppTypeDescr) const
Gets the type description of the set value.
Definition: Any.h:161
SAL_DLLPUBLIC void * rtl_allocateMemory(sal_Size Bytes) SAL_THROW_EXTERN_C()
Allocate memory.
Any makeAny(const C &value)
Template function to generically construct an any from a C++ value.
Definition: Any.hxx:226
struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescriptionReference typelib_TypeDescriptionReference
Holds a weak reference to a type description.
This base class serves as a base class for all template reference classes and has been introduced due...
Definition: Reference.h:58
Any toAny(T const &value)
Wrap a value in an Any, if necessary.
Definition: Any.hxx:236
bool operator>>=(const Any &rAny, C &value)
Template binary >>= operator to assign a value from an any.
Definition: Any.hxx:293
type class of void
Definition: typeclass.h:29