LibreOffice LibreOffice 25.8 SDK C/C++ API Reference

Loading...
Searching...
No Matches
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"
32#include "typelib/typedescription.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 template<class interface_type> class Reference;
48
57 class SAL_WARN_UNUSED SAL_DLLPUBLIC_RTTI Any : public uno_Any
58{
59 public:
61 // these are here to force memory de/allocation to sal lib.
62 static void * SAL_CALL operator new ( size_t nSize )
63 { return ::rtl_allocateMemory( nSize ); }
64 static void SAL_CALL operator delete ( void * pMem )
65 { ::rtl_freeMemory( pMem ); }
66 static void * SAL_CALL operator new ( size_t, void * pMem )
67 { return pMem; }
68 static void SAL_CALL operator delete ( void *, void * )
69 {}
71
74 inline Any();
75
80 template <typename T>
81 explicit inline Any( T const & value );
83 explicit inline Any( bool value );
84
85#if defined LIBO_INTERNAL_ONLY
86 template<typename T1, typename T2>
87 explicit inline Any(rtl::OUStringConcat<T1, T2> && value);
88 template<typename T1, typename T2>
89 explicit Any(rtl::OUStringConcat<T1, T2> const &) = delete;
90 template<std::size_t nBufSize> explicit inline Any(rtl::StringNumber<sal_Unicode, nBufSize> && value);
91 template<std::size_t nBufSize> explicit Any(rtl::StringNumber<sal_Unicode, nBufSize> const &) = delete;
92 template <std::size_t N> explicit inline Any(const rtl::OUStringLiteral<N>& value);
93#endif
94
99 inline Any( const Any & rAny );
100
106 inline Any( const void * pData_, const Type & rType );
107
113 inline Any( const void * pData_, typelib_TypeDescription * pTypeDescr );
114
120 inline Any( const void * pData_, typelib_TypeDescriptionReference * pType_ );
121
122#if defined LIBO_INTERNAL_ONLY
123 Any(bool const *, Type const &) = delete;
124 Any(bool const *, typelib_TypeDescription *) = delete;
125 Any(bool const *, typelib_TypeDescriptionReference *) = delete;
126 Any(sal_Bool const *, Type const &) = delete;
127 Any(sal_Bool const *, typelib_TypeDescription *) = delete;
128 Any(sal_Bool const *, typelib_TypeDescriptionReference *) = delete;
129 Any(std::nullptr_t, Type const & type):
130 Any(static_cast<void *>(nullptr), type) {}
131 Any(std::nullptr_t, typelib_TypeDescription * type):
132 Any(static_cast<void *>(nullptr), type) {}
133 Any(std::nullptr_t, typelib_TypeDescriptionReference * type):
134 Any(static_cast<void *>(nullptr), type) {}
135#endif
136
139 inline ~Any();
140
146 inline Any & SAL_CALL operator = ( const Any & rAny );
147
148#if defined LIBO_INTERNAL_ONLY
149#if !defined(__COVERITY__) // suppress COPY_INSTEAD_OF_MOVE suggestions
150 inline Any(Any && other) noexcept;
151#endif
152 inline Any & operator =(Any && other) noexcept;
153#endif
154
159 const Type & SAL_CALL getValueType() const
160 { return * reinterpret_cast< const Type * >( &pType ); }
161
165 typelib_TypeDescriptionReference * SAL_CALL getValueTypeRef() const
166 { return pType; }
167
173 void SAL_CALL getValueTypeDescription( typelib_TypeDescription ** ppTypeDescr ) const
174 { ::typelib_typedescriptionreference_getDescription( ppTypeDescr, pType ); }
175
180 TypeClass SAL_CALL getValueTypeClass() const
181 { return static_cast<TypeClass>(pType->eTypeClass); }
182
187 inline ::rtl::OUString SAL_CALL getValueTypeName() const;
188
193 bool SAL_CALL hasValue() const
194 { return (typelib_TypeClass_VOID != pType->eTypeClass); }
195
200 const void * SAL_CALL getValue() const
201 { return pData; }
202
215 template <typename T>
216 inline T get() const;
217
224 inline void SAL_CALL setValue( const void * pData_, const Type & rType );
231 inline void SAL_CALL setValue( const void * pData_, typelib_TypeDescriptionReference * pType_ );
238 inline void SAL_CALL setValue( const void * pData_, typelib_TypeDescription * pTypeDescr );
239
240#if defined LIBO_INTERNAL_ONLY
241 void setValue(bool const *, Type const &) = delete;
242 void setValue(bool const *, typelib_TypeDescriptionReference *) = delete;
243 void setValue(bool const *, typelib_TypeDescription *) = delete;
244 void setValue(sal_Bool const *, Type const &) = delete;
245 void setValue(sal_Bool const *, typelib_TypeDescriptionReference *)
246 = delete;
247 void setValue(sal_Bool const *, typelib_TypeDescription *) = delete;
248 void setValue(std::nullptr_t, Type const & type)
249 { setValue(static_cast<void *>(nullptr), type); }
250 void setValue(std::nullptr_t, typelib_TypeDescriptionReference * type)
251 { setValue(static_cast<void *>(nullptr), type); }
252 void setValue(std::nullptr_t, typelib_TypeDescription * type)
253 { setValue(static_cast<void *>(nullptr), type); }
254#endif
255
259 inline void SAL_CALL clear();
260
267 inline bool SAL_CALL isExtractableTo( const Type & rType ) const;
268
275 template <typename T>
276 inline bool has() const;
277
284 inline bool SAL_CALL operator == ( const Any & rAny ) const;
291 inline bool SAL_CALL operator != ( const Any & rAny ) const;
292
293#if defined LIBO_INTERNAL_ONLY
294 // Similar to Reference::query/queryThrow, these allow to simplify calling constructors of
295 // Reference taking Any. queryThrow is functionally similar to get(), but doesn't require
296 // to specify the full Reference type explicitly, only the interface type.
297 template<class interface_type> inline Reference<interface_type> query() const;
298 template<class interface_type> inline Reference<interface_type> queryThrow() const;
299#endif
300
301 private:
302#if !defined LIBO_INTERNAL_ONLY
304 // Forbid use with ambiguous type (sal_Unicode, sal_uInt16):
305 explicit Any(sal_uInt16) SAL_DELETED_FUNCTION;
307#endif
308};
309
310#if !defined LIBO_INTERNAL_ONLY
312// Forbid use with ambiguous type (sal_Unicode, sal_uInt16):
313 template<> sal_uInt16 Any::get<sal_uInt16>() const SAL_DELETED_FUNCTION;
314template<> bool Any::has<sal_uInt16>() const SAL_DELETED_FUNCTION;
316#endif
317
318#if !defined LIBO_INTERNAL_ONLY
330 template< class C >
331 inline Any SAL_CALL makeAny( const C & value );
332
333 template<> inline Any SAL_CALL makeAny(sal_uInt16 const & value);
334
335 template<> Any SAL_CALL makeAny(Any const &) SAL_DELETED_FUNCTION;
336#endif
337
345 template<typename T> inline Any toAny(T const & value);
346
347 template<> inline Any toAny(Any const & value);
348
349#if defined LIBO_INTERNAL_ONLY
350
368 template<typename T> inline bool fromAny(Any const & any, T * value);
369
370 template<> inline bool fromAny(Any const & any, Any * value);
371
372#endif
373
374 class BaseReference;
375
382 template< class C >
383 inline void SAL_CALL operator <<= ( Any & rAny, const C & value );
384
385// additionally for C++ bool:
386 template<>
387 inline void SAL_CALL operator <<= ( Any & rAny, bool const & value );
388
398 template< class C >
399 inline bool SAL_CALL operator >>= ( const Any & rAny, C & value );
400
411 template< class C >
412 inline bool SAL_CALL operator == ( const Any & rAny, const C & value );
423 template< class C >
424 inline bool SAL_CALL operator != ( const Any & rAny, const C & value );
425
426// additional specialized >>= and == operators
427// bool
428 template<>
429 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Bool & value );
430 template<>
431 inline bool SAL_CALL operator == ( const Any & rAny, const sal_Bool & value );
432 template<>
433 inline bool SAL_CALL operator >>= ( Any const & rAny, bool & value );
434 template<>
435 inline bool SAL_CALL operator == ( Any const & rAny, bool const & value );
436// byte
437 template<>
438 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int8 & value );
439// short
440 template<>
441 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int16 & value );
442 template<>
443 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt16 & value );
444// long
445 template<>
446 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int32 & value );
447 template<>
448 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt32 & value );
449// hyper
450 template<>
451 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int64 & value );
452 template<>
453 inline bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt64 & value );
454// float
455 template<>
456 inline bool SAL_CALL operator >>= ( const Any & rAny, float & value );
457// double
458 template<>
459 inline bool SAL_CALL operator >>= ( const Any & rAny, double & value );
460// string
461 template<>
462 inline bool SAL_CALL operator >>= ( const Any & rAny, ::rtl::OUString & value );
463 template<>
464 inline bool SAL_CALL operator == ( const Any & rAny, const ::rtl::OUString & value );
465#if defined LIBO_INTERNAL_ONLY
466 template<std::size_t N>
467 inline bool SAL_CALL operator == (const Any& rAny, const rtl::OUStringLiteral<N>& value);
468#endif
469// type
470 template<>
471 inline bool SAL_CALL operator >>= ( const Any & rAny, Type & value );
472 template<>
473 inline bool SAL_CALL operator == ( const Any & rAny, const Type & value );
474// any
475#if !defined LIBO_INTERNAL_ONLY
476 template<>
477 inline bool SAL_CALL operator >>= ( const Any & rAny, Any & value );
478#endif
479// interface
480 template<>
481 inline bool SAL_CALL operator == ( const Any & rAny, const BaseReference & value );
482
483}
484}
485}
486}
487
500 SAL_DEPRECATED("use cppu::UnoType")
501inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( SAL_UNUSED_PARAMETER const ::com::sun::star::uno::Any * )
502{
503 return ::cppu::UnoType< ::com::sun::star::uno::Any >::get();
504}
505
506#endif
507
508/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
config.h
SAL_DEPRECATED
#define SAL_DEPRECATED(message)
Use as follows: SAL_DEPRECATED("Don't use, it's evil.") void doit(int nPara);.
Definition types.h:492
SAL_DELETED_FUNCTION
#define SAL_DELETED_FUNCTION
short-circuit extra-verbose API namespaces
Definition types.h:396
SAL_UNUSED_PARAMETER
#define SAL_UNUSED_PARAMETER
Annotate unused but required C++ function parameters.
Definition types.h:592
sal_Bool
unsigned char sal_Bool
Definition types.h:38
sal_Int8
signed char sal_Int8
Definition types.h:43
SAL_WARN_UNUSED
#define SAL_WARN_UNUSED
Annotate classes where a compiler should warn if an instance is unused.
Definition types.h:611
ustring.hxx
alloc.h
rtl_freeMemory
SAL_DLLPUBLIC void rtl_freeMemory(void *Ptr) SAL_THROW_EXTERN_C()
Free memory.
typelib_TypeClass_VOID
@ typelib_TypeClass_VOID
type class of void
Definition typeclass.h:32
typedescription.h
typelib_TypeDescription
struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescription typelib_TypeDescription
Full type description of a type.
typelib_typedescriptionreference_getDescription
CPPU_DLLPUBLIC void typelib_typedescriptionreference_getDescription(typelib_TypeDescription **ppRet, typelib_TypeDescriptionReference *pRef) SAL_THROW_EXTERN_C()
Retrieves the type description for a given reference.
typelib_TypeDescriptionReference
struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescriptionReference typelib_TypeDescriptionReference
Holds a weak reference to a type description.
any2.h
uno_Any
struct SAL_DLLPUBLIC_RTTI _uno_Any uno_Any
This is the binary specification of a UNO any.
unotype.hxx
getCppuType
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:501
com
Definition types.h:377
com::sun
Definition types.h:377
com::sun::star
Definition types.h:377
com::sun::star::uno
Definition typedescription.hxx:43
com::sun::star::uno::operator==
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:666
com::sun::star::uno::makeAny
Any makeAny(const C &value)
Template function to generically construct an any from a C++ value.
Definition Any.hxx:238
com::sun::star::uno::operator!=
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:677
com::sun::star::uno::operator>>=
bool operator>>=(const Any &rAny, C &value)
Template binary >>= operator to assign a value from an any.
Definition Any.hxx:329
com::sun::star::uno::toAny
Any toAny(T const &value)
Wrap a value in an Any, if necessary.
Definition Any.hxx:247
com::sun::star::uno::operator<<=
void operator<<=(Any &rAny, const C &value)
Template binary <<= operator to set the value of an any.
Definition Any.hxx:279
rtl::OUString
This String class provides base functionality for C++ like Unicode character array handling.
Definition ustring.hxx:172
com::sun::star::uno::Reference
Template reference class for interface type derived from BaseReference.
Definition Reference.h:184
com::sun::star::uno::Any
C++ class representing an IDL any.
Definition Any.h:58
com::sun::star::uno::Any::getValueType
const Type & getValueType() const
Gets the type of the set value.
Definition Any.h:159
com::sun::star::uno::Any::get
T get() const
Provides a value of specified type, so you can easily write e.g.
Definition Any.hxx:683
com::sun::star::uno::Any::getValueTypeDescription
void getValueTypeDescription(typelib_TypeDescription **ppTypeDescr) const
Gets the type description of the set value.
Definition Any.h:173
com::sun::star::uno::Any::hasValue
bool hasValue() const
Tests if any contains a value.
Definition Any.h:193
com::sun::star::uno::Any::getValueTypeRef
typelib_TypeDescriptionReference * getValueTypeRef() const
Gets the type of the set value.
Definition Any.h:165
com::sun::star::uno::Any::getValue
const void * getValue() const
Gets a pointer to the set value.
Definition Any.h:200
com::sun::star::uno::Any::getValueTypeClass
TypeClass getValueTypeClass() const
Gets the type class of the set value.
Definition Any.h:180
com::sun::star::uno::Any::Any
Any()
Default constructor: Any holds no value; its type is void.
Definition Any.hxx:59
com::sun::star::uno::BaseReference
This base class serves as a base class for all template reference classes and has been introduced due...
Definition Reference.h:67
com::sun::star::uno::Type
C++ class representing an IDL meta type.
Definition Type.h:59