LibreOffice
LibreOffice 7.3 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 #endif
90 
95  inline Any( const Any & rAny );
96 
102  inline Any( const void * pData_, const Type & rType );
103 
109  inline Any( const void * pData_, typelib_TypeDescription * pTypeDescr );
110 
116  inline Any( const void * pData_, typelib_TypeDescriptionReference * pType_ );
117 
118 #if defined LIBO_INTERNAL_ONLY
119  Any(bool const *, Type const &) = delete;
120  Any(bool const *, typelib_TypeDescription *) = delete;
121  Any(bool const *, typelib_TypeDescriptionReference *) = delete;
122  Any(sal_Bool const *, Type const &) = delete;
123  Any(sal_Bool const *, typelib_TypeDescription *) = delete;
124  Any(sal_Bool const *, typelib_TypeDescriptionReference *) = delete;
125  Any(std::nullptr_t, Type const & type):
126  Any(static_cast<void *>(nullptr), type) {}
127  Any(std::nullptr_t, typelib_TypeDescription * type):
128  Any(static_cast<void *>(nullptr), type) {}
129  Any(std::nullptr_t, typelib_TypeDescriptionReference * type):
130  Any(static_cast<void *>(nullptr), type) {}
131 #endif
132 
135  inline ~Any();
136 
142  inline Any & SAL_CALL operator = ( const Any & rAny );
143 
144 #if defined LIBO_INTERNAL_ONLY
145  inline Any(Any && other) noexcept;
146  inline Any & operator =(Any && other) noexcept;
147 #endif
148 
153  const Type & SAL_CALL getValueType() const
154  { return * reinterpret_cast< const Type * >( &pType ); }
160  { return pType; }
161 
167  void SAL_CALL getValueTypeDescription( typelib_TypeDescription ** ppTypeDescr ) const
168  { ::typelib_typedescriptionreference_getDescription( ppTypeDescr, pType ); }
169 
174  TypeClass SAL_CALL getValueTypeClass() const
175  { return static_cast<TypeClass>(pType->eTypeClass); }
176 
181  inline ::rtl::OUString SAL_CALL getValueTypeName() const;
182 
187  bool SAL_CALL hasValue() const
188  { return (typelib_TypeClass_VOID != pType->eTypeClass); }
189 
194  const void * SAL_CALL getValue() const
195  { return pData; }
196 
209  template <typename T>
210  inline T get() const;
211 
218  inline void SAL_CALL setValue( const void * pData_, const Type & rType );
225  inline void SAL_CALL setValue( const void * pData_, typelib_TypeDescriptionReference * pType_ );
232  inline void SAL_CALL setValue( const void * pData_, typelib_TypeDescription * pTypeDescr );
233 
234 #if defined LIBO_INTERNAL_ONLY
235  void setValue(bool const *, Type const &) = delete;
236  void setValue(bool const *, typelib_TypeDescriptionReference *) = delete;
237  void setValue(bool const *, typelib_TypeDescription *) = delete;
238  void setValue(sal_Bool const *, Type const &) = delete;
239  void setValue(sal_Bool const *, typelib_TypeDescriptionReference *)
240  = delete;
241  void setValue(sal_Bool const *, typelib_TypeDescription *) = delete;
242  void setValue(std::nullptr_t, Type const & type)
243  { setValue(static_cast<void *>(nullptr), type); }
244  void setValue(std::nullptr_t, typelib_TypeDescriptionReference * type)
245  { setValue(static_cast<void *>(nullptr), type); }
246  void setValue(std::nullptr_t, typelib_TypeDescription * type)
247  { setValue(static_cast<void *>(nullptr), type); }
248 #endif
249 
253  inline void SAL_CALL clear();
254 
261  inline bool SAL_CALL isExtractableTo( const Type & rType ) const;
262 
269  template <typename T>
270  inline bool has() const;
271 
278  inline bool SAL_CALL operator == ( const Any & rAny ) const;
285  inline bool SAL_CALL operator != ( const Any & rAny ) const;
286 
287 private:
288 #if !defined LIBO_INTERNAL_ONLY
289  // Forbid use with ambiguous type (sal_Unicode, sal_uInt16):
291  explicit Any(sal_uInt16) SAL_DELETED_FUNCTION;
293 #endif
294 };
295 
296 #if !defined LIBO_INTERNAL_ONLY
297 // Forbid use with ambiguous type (sal_Unicode, sal_uInt16):
299 template<> sal_uInt16 Any::get<sal_uInt16>() const SAL_DELETED_FUNCTION;
300 template<> bool Any::has<sal_uInt16>() const SAL_DELETED_FUNCTION;
302 #endif
303 
315 template< class C >
316 inline Any SAL_CALL makeAny( const C & value );
317 
318 #if !defined LIBO_INTERNAL_ONLY
319 template<> inline Any SAL_CALL makeAny(sal_uInt16 const & value);
320 #endif
321 
322 template<> Any SAL_CALL makeAny(Any const &) SAL_DELETED_FUNCTION;
323 
331 template<typename T> inline Any toAny(T const & value);
332 
333 template<> inline Any toAny(Any const & value);
334 
335 #if defined LIBO_INTERNAL_ONLY
336 
354 template<typename T> inline bool fromAny(Any const & any, T * value);
355 
356 template<> inline bool fromAny(Any const & any, Any * value);
357 
358 #endif
359 
360 class BaseReference;
361 
368 template< class C >
369 inline void SAL_CALL operator <<= ( Any & rAny, const C & value );
370 
371 // additionally for C++ bool:
372 template<>
373 inline void SAL_CALL operator <<= ( Any & rAny, bool const & value );
374 
384 template< class C >
385 inline bool SAL_CALL operator >>= ( const Any & rAny, C & value );
386 
397 template< class C >
398 inline bool SAL_CALL operator == ( const Any & rAny, const C & value );
409 template< class C >
410 inline bool SAL_CALL operator != ( const Any & rAny, const C & value );
411 
412 // additional specialized >>= and == operators
413 // bool
414 template<>
415 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Bool & value );
416 template<>
417 inline bool SAL_CALL operator == ( const Any & rAny, const sal_Bool & value );
418 template<>
419 inline bool SAL_CALL operator >>= ( Any const & rAny, bool & value );
420 template<>
421 inline bool SAL_CALL operator == ( Any const & rAny, bool const & value );
422 // byte
423 template<>
424 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int8 & value );
425 // short
426 template<>
427 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int16 & value );
428 template<>
429 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt16 & value );
430 // long
431 template<>
432 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int32 & value );
433 template<>
434 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt32 & value );
435 // hyper
436 template<>
437 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int64 & value );
438 template<>
439 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt64 & value );
440 // float
441 template<>
442 inline bool SAL_CALL operator >>= ( const Any & rAny, float & value );
443 // double
444 template<>
445 inline bool SAL_CALL operator >>= ( const Any & rAny, double & value );
446 // string
447 template<>
448 inline bool SAL_CALL operator >>= ( const Any & rAny, ::rtl::OUString & value );
449 template<>
450 inline bool SAL_CALL operator == ( const Any & rAny, const ::rtl::OUString & value );
451 // type
452 template<>
453 inline bool SAL_CALL operator >>= ( const Any & rAny, Type & value );
454 template<>
455 inline bool SAL_CALL operator == ( const Any & rAny, const Type & value );
456 // any
457 #if !defined LIBO_INTERNAL_ONLY
458 template<>
459 inline bool SAL_CALL operator >>= ( const Any & rAny, Any & value );
460 #endif
461 // interface
462 template<>
463 inline bool SAL_CALL operator == ( const Any & rAny, const BaseReference & value );
464 
465 }
466 }
467 }
468 }
469 
482 SAL_DEPRECATED("use cppu::UnoType")
483 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( SAL_UNUSED_PARAMETER const ::com::sun::star::uno::Any * )
484 {
485  return ::cppu::UnoType< ::com::sun::star::uno::Any >::get();
486 }
487 
488 #endif
489 
490 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
typelib_TypeDescriptionReference * getValueTypeRef() const
Gets the type of the set value.
Definition: Any.h:159
bool hasValue() const
Tests if any contains a value.
Definition: Any.h:187
signed char sal_Int8
Definition: types.h:43
Any toAny(T const &value)
Wrap a value in an Any, if necessary.
Definition: Any.hxx:242
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:483
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:668
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:657
#define SAL_DELETED_FUNCTION
short-circuit extra-verbose API namespaces
Definition: types.h:378
struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescriptionReference typelib_TypeDescriptionReference
Holds a weak reference to a type description.
#define SAL_UNUSED_PARAMETER
Annotate unused but required C++ function parameters.
Definition: types.h:568
bool operator>>=(const Any &rAny, C &value)
Template binary >>= operator to assign a value from an any.
Definition: Any.hxx:328
#define SAL_DEPRECATED(message)
Use as follows: SAL_DEPRECATED("Don&#39;t use, it&#39;s evil.") void doit(int nPara);.
Definition: types.h:474
#define SAL_WARN_UNUSED
Annotate classes where a compiler should warn if an instance is unused.
Definition: types.h:587
const void * getValue() const
Gets a pointer to the set value.
Definition: Any.h:194
C++ class representing an IDL any.
Definition: Any.h:56
SAL_DLLPUBLIC void * rtl_allocateMemory(sal_Size Bytes) SAL_THROW_EXTERN_C()
Allocate memory.
CPPU_DLLPUBLIC void typelib_typedescriptionreference_getDescription(typelib_TypeDescription **ppRet, typelib_TypeDescriptionReference *pRef) SAL_THROW_EXTERN_C()
Retrieves the type description for a given reference.
Definition: types.h:359
unsigned char sal_Bool
Definition: types.h:38
type class of void
Definition: typeclass.h:32
void operator<<=(Any &rAny, const C &value)
Template binary <<= operator to set the value of an any.
Definition: Any.hxx:278
struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescription typelib_TypeDescription
Full type description of a type.
This String class provides base functionality for C++ like Unicode character array handling...
Definition: ustring.hxx:203
void getValueTypeDescription(typelib_TypeDescription **ppTypeDescr) const
Gets the type description of the set value.
Definition: Any.h:167
struct SAL_DLLPUBLIC_RTTI _uno_Any uno_Any
This is the binary specification of a UNO any.
SAL_DLLPUBLIC void rtl_freeMemory(void *Ptr) SAL_THROW_EXTERN_C()
Free memory.
const Type & getValueType() const
Gets the type of the set value.
Definition: Any.h:153
C++ class representing an IDL meta type.
Definition: Type.h:58
TypeClass getValueTypeClass() const
Gets the type class of the set value.
Definition: Any.h:174
Any makeAny(const C &value)
Template function to generically construct an any from a C++ value.
Definition: Any.hxx:232