LibreOffice
LibreOffice 7.4 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 
20 /*
21  * This file is part of LibreOffice published API.
22  */
23 #ifndef INCLUDED_COM_SUN_STAR_UNO_ANY_H
24 #define INCLUDED_COM_SUN_STAR_UNO_ANY_H
25 
26 #include "sal/config.h"
27 
28 #include <cstddef>
29 
30 #include "rtl/ustring.hxx"
31 #include "uno/any2.h"
33 #include "cppu/unotype.hxx"
34 #include "com/sun/star/uno/TypeClass.hdl"
35 #include "rtl/alloc.h"
36 
37 namespace com
38 {
39 namespace sun
40 {
41 namespace star
42 {
43 namespace uno
44 {
45 
46 class Type;
47 
56 class SAL_WARN_UNUSED SAL_DLLPUBLIC_RTTI Any : public uno_Any
57 {
58 public:
60  // these are here to force memory de/allocation to sal lib.
61  static void * SAL_CALL operator new ( size_t nSize )
62  { return ::rtl_allocateMemory( nSize ); }
63  static void SAL_CALL operator delete ( void * pMem )
64  { ::rtl_freeMemory( pMem ); }
65  static void * SAL_CALL operator new ( size_t, void * pMem )
66  { return pMem; }
67  static void SAL_CALL operator delete ( void *, void * )
68  {}
70 
73  inline Any();
74 
79  template <typename T>
80  explicit inline Any( T const & value );
82  explicit inline Any( bool value );
83 
84 #if defined LIBO_INTERNAL_ONLY
85  template<typename T1, typename T2>
86  explicit inline Any(rtl::OUStringConcat<T1, T2> && value);
87  template<typename T1, typename T2>
88  explicit Any(rtl::OUStringConcat<T1, T2> const &) = delete;
89  template<typename T> explicit inline Any(rtl::OUStringNumber<T> && value);
90  template<typename T> explicit Any(rtl::OUStringNumber<T> const &) = delete;
91  template <std::size_t N> explicit inline Any(const rtl::OUStringLiteral<N>& value);
92 #endif
93 
98  inline Any( const Any & rAny );
99 
105  inline Any( const void * pData_, const Type & rType );
106 
112  inline Any( const void * pData_, typelib_TypeDescription * pTypeDescr );
113 
119  inline Any( const void * pData_, typelib_TypeDescriptionReference * pType_ );
120 
121 #if defined LIBO_INTERNAL_ONLY
122  Any(bool const *, Type const &) = delete;
123  Any(bool const *, typelib_TypeDescription *) = delete;
124  Any(bool const *, typelib_TypeDescriptionReference *) = delete;
125  Any(sal_Bool const *, Type const &) = delete;
126  Any(sal_Bool const *, typelib_TypeDescription *) = delete;
127  Any(sal_Bool const *, typelib_TypeDescriptionReference *) = delete;
128  Any(std::nullptr_t, Type const & type):
129  Any(static_cast<void *>(nullptr), type) {}
130  Any(std::nullptr_t, typelib_TypeDescription * type):
131  Any(static_cast<void *>(nullptr), type) {}
132  Any(std::nullptr_t, typelib_TypeDescriptionReference * type):
133  Any(static_cast<void *>(nullptr), type) {}
134 #endif
135 
138  inline ~Any();
139 
145  inline Any & SAL_CALL operator = ( const Any & rAny );
146 
147 #if defined LIBO_INTERNAL_ONLY
148  inline Any(Any && other) noexcept;
149  inline Any & operator =(Any && other) noexcept;
150 #endif
151 
156  const Type & SAL_CALL getValueType() const
157  { return * reinterpret_cast< const Type * >( &pType ); }
163  { return pType; }
164 
170  void SAL_CALL getValueTypeDescription( typelib_TypeDescription ** ppTypeDescr ) const
171  { ::typelib_typedescriptionreference_getDescription( ppTypeDescr, pType ); }
172 
177  TypeClass SAL_CALL getValueTypeClass() const
178  { return static_cast<TypeClass>(pType->eTypeClass); }
179 
184  inline ::rtl::OUString SAL_CALL getValueTypeName() const;
185 
190  bool SAL_CALL hasValue() const
191  { return (typelib_TypeClass_VOID != pType->eTypeClass); }
192 
197  const void * SAL_CALL getValue() const
198  { return pData; }
199 
212  template <typename T>
213  inline T get() const;
214 
221  inline void SAL_CALL setValue( const void * pData_, const Type & rType );
228  inline void SAL_CALL setValue( const void * pData_, typelib_TypeDescriptionReference * pType_ );
235  inline void SAL_CALL setValue( const void * pData_, typelib_TypeDescription * pTypeDescr );
236 
237 #if defined LIBO_INTERNAL_ONLY
238  void setValue(bool const *, Type const &) = delete;
239  void setValue(bool const *, typelib_TypeDescriptionReference *) = delete;
240  void setValue(bool const *, typelib_TypeDescription *) = delete;
241  void setValue(sal_Bool const *, Type const &) = delete;
242  void setValue(sal_Bool const *, typelib_TypeDescriptionReference *)
243  = delete;
244  void setValue(sal_Bool const *, typelib_TypeDescription *) = delete;
245  void setValue(std::nullptr_t, Type const & type)
246  { setValue(static_cast<void *>(nullptr), type); }
247  void setValue(std::nullptr_t, typelib_TypeDescriptionReference * type)
248  { setValue(static_cast<void *>(nullptr), type); }
249  void setValue(std::nullptr_t, typelib_TypeDescription * type)
250  { setValue(static_cast<void *>(nullptr), type); }
251 #endif
252 
256  inline void SAL_CALL clear();
257 
264  inline bool SAL_CALL isExtractableTo( const Type & rType ) const;
265 
272  template <typename T>
273  inline bool has() const;
274 
281  inline bool SAL_CALL operator == ( const Any & rAny ) const;
288  inline bool SAL_CALL operator != ( const Any & rAny ) const;
289 
290 private:
291 #if !defined LIBO_INTERNAL_ONLY
293  // Forbid use with ambiguous type (sal_Unicode, sal_uInt16):
294  explicit Any(sal_uInt16) SAL_DELETED_FUNCTION;
296 #endif
297 };
298 
299 #if !defined LIBO_INTERNAL_ONLY
301 // Forbid use with ambiguous type (sal_Unicode, sal_uInt16):
302 template<> sal_uInt16 Any::get<sal_uInt16>() const SAL_DELETED_FUNCTION;
303 template<> bool Any::has<sal_uInt16>() const SAL_DELETED_FUNCTION;
305 #endif
306 
307 #if !defined LIBO_INTERNAL_ONLY
319 template< class C >
320 inline Any SAL_CALL makeAny( const C & value );
321 
322 template<> inline Any SAL_CALL makeAny(sal_uInt16 const & value);
323 
324 template<> Any SAL_CALL makeAny(Any const &) SAL_DELETED_FUNCTION;
325 #endif
326 
334 template<typename T> inline Any toAny(T const & value);
335 
336 template<> inline Any toAny(Any const & value);
337 
338 #if defined LIBO_INTERNAL_ONLY
339 
357 template<typename T> inline bool fromAny(Any const & any, T * value);
358 
359 template<> inline bool fromAny(Any const & any, Any * value);
360 
361 #endif
362 
363 class BaseReference;
364 
371 template< class C >
372 inline void SAL_CALL operator <<= ( Any & rAny, const C & value );
373 
374 // additionally for C++ bool:
375 template<>
376 inline void SAL_CALL operator <<= ( Any & rAny, bool const & value );
377 
387 template< class C >
388 inline bool SAL_CALL operator >>= ( const Any & rAny, C & value );
389 
400 template< class C >
401 inline bool SAL_CALL operator == ( const Any & rAny, const C & value );
412 template< class C >
413 inline bool SAL_CALL operator != ( const Any & rAny, const C & value );
414 
415 // additional specialized >>= and == operators
416 // bool
417 template<>
418 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Bool & value );
419 template<>
420 inline bool SAL_CALL operator == ( const Any & rAny, const sal_Bool & value );
421 template<>
422 inline bool SAL_CALL operator >>= ( Any const & rAny, bool & value );
423 template<>
424 inline bool SAL_CALL operator == ( Any const & rAny, bool const & value );
425 // byte
426 template<>
427 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int8 & value );
428 // short
429 template<>
430 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int16 & value );
431 template<>
432 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt16 & value );
433 // long
434 template<>
435 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int32 & value );
436 template<>
437 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt32 & value );
438 // hyper
439 template<>
440 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int64 & value );
441 template<>
442 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt64 & value );
443 // float
444 template<>
445 inline bool SAL_CALL operator >>= ( const Any & rAny, float & value );
446 // double
447 template<>
448 inline bool SAL_CALL operator >>= ( const Any & rAny, double & value );
449 // string
450 template<>
451 inline bool SAL_CALL operator >>= ( const Any & rAny, ::rtl::OUString & value );
452 template<>
453 inline bool SAL_CALL operator == ( const Any & rAny, const ::rtl::OUString & value );
454 // type
455 template<>
456 inline bool SAL_CALL operator >>= ( const Any & rAny, Type & value );
457 template<>
458 inline bool SAL_CALL operator == ( const Any & rAny, const Type & value );
459 // any
460 #if !defined LIBO_INTERNAL_ONLY
461 template<>
462 inline bool SAL_CALL operator >>= ( const Any & rAny, Any & value );
463 #endif
464 // interface
465 template<>
466 inline bool SAL_CALL operator == ( const Any & rAny, const BaseReference & value );
467 
468 }
469 }
470 }
471 }
472 
485 SAL_DEPRECATED("use cppu::UnoType")
486 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( SAL_UNUSED_PARAMETER const ::com::sun::star::uno::Any * )
487 {
488  return ::cppu::UnoType< ::com::sun::star::uno::Any >::get();
489 }
490 
491 #endif
492 
493 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
#define SAL_DEPRECATED(message)
Use as follows: SAL_DEPRECATED("Don't use, it's evil.") void doit(int nPara);.
Definition: types.h:474
#define SAL_DELETED_FUNCTION
short-circuit extra-verbose API namespaces
Definition: types.h:378
#define SAL_UNUSED_PARAMETER
Annotate unused but required C++ function parameters.
Definition: types.h:568
unsigned char sal_Bool
Definition: types.h:38
signed char sal_Int8
Definition: types.h:43
#define SAL_WARN_UNUSED
Annotate classes where a compiler should warn if an instance is unused.
Definition: types.h:587
SAL_DLLPUBLIC void rtl_freeMemory(void *Ptr) SAL_THROW_EXTERN_C()
Free memory.
SAL_DLLPUBLIC void * rtl_allocateMemory(sal_Size Bytes) SAL_THROW_EXTERN_C()
Allocate memory.
@ typelib_TypeClass_VOID
type class of void
Definition: typeclass.h:32
struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescription typelib_TypeDescription
Full type description of a type.
CPPU_DLLPUBLIC void typelib_typedescriptionreference_getDescription(typelib_TypeDescription **ppRet, typelib_TypeDescriptionReference *pRef) SAL_THROW_EXTERN_C()
Retrieves the type description for a given reference.
struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescriptionReference typelib_TypeDescriptionReference
Holds a weak reference to a type description.
struct SAL_DLLPUBLIC_RTTI _uno_Any uno_Any
This is the binary specification of a UNO any.
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:486
Definition: types.h:359
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:654
Any makeAny(const C &value)
Template function to generically construct an any from a C++ value.
Definition: Any.hxx:236
bool operator!=(const Any &rAny, const C &value)
Template inequality operator: compares set value of left side any to right side value.
Definition: Any.hxx:665
bool operator>>=(const Any &rAny, C &value)
Template binary >>= operator to assign a value from an any.
Definition: Any.hxx:325
Any toAny(T const &value)
Wrap a value in an Any, if necessary.
Definition: Any.hxx:245
void operator<<=(Any &rAny, const C &value)
Template binary <<= operator to set the value of an any.
Definition: Any.hxx:275
This String class provides base functionality for C++ like Unicode character array handling.
Definition: ustring.hxx:203
C++ class representing an IDL any.
Definition: Any.h:57
void getValueTypeDescription(typelib_TypeDescription **ppTypeDescr) const
Gets the type description of the set value.
Definition: Any.h:170
bool hasValue() const
Tests if any contains a value.
Definition: Any.h:190
const void * getValue() const
Gets a pointer to the set value.
Definition: Any.h:197
const Type & getValueType() const
Gets the type of the set value.
Definition: Any.h:156
typelib_TypeDescriptionReference * getValueTypeRef() const
Gets the type of the set value.
Definition: Any.h:162
TypeClass getValueTypeClass() const
Gets the type class of the set value.
Definition: Any.h:177
This base class serves as a base class for all template reference classes and has been introduced due...
Definition: Reference.h:67
C++ class representing an IDL meta type.
Definition: Type.h:59