LibreOffice
LibreOffice 7.2 SDK C/C++ API Reference
Type.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_TYPE_H
24#define INCLUDED_COM_SUN_STAR_UNO_TYPE_H
25
27#include "com/sun/star/uno/TypeClass.hdl"
28#include "rtl/ustring.hxx"
29#include "rtl/alloc.h"
30
31
32namespace com
33{
34namespace sun
35{
36namespace star
37{
38namespace uno
39{
40
44{
49};
50
58class SAL_WARN_UNUSED SAL_DLLPUBLIC_RTTI Type
59{
63
64public:
66 // these are here to force memory de/allocation to sal lib.
67 static void * SAL_CALL operator new ( size_t nSize )
68 { return ::rtl_allocateMemory( nSize ); }
69 static void SAL_CALL operator delete ( void * pMem )
70 { ::rtl_freeMemory( pMem ); }
71 static void * SAL_CALL operator new ( size_t, void * pMem )
72 { return pMem; }
73 static void SAL_CALL operator delete ( void *, void * )
74 {}
76
79 inline Type();
80
86 inline Type( TypeClass eTypeClass, const ::rtl::OUString & rTypeName );
87
93 inline Type( TypeClass eTypeClass, const char * pTypeName );
94
99 inline Type( typelib_TypeDescriptionReference * pType );
100
115
120 inline Type( const Type & rType );
121
126
132 inline Type & SAL_CALL operator = ( const Type & rType );
133
138 TypeClass SAL_CALL getTypeClass() const
139 { return static_cast<TypeClass>(_pType->eTypeClass); }
140
145 inline ::rtl::OUString SAL_CALL getTypeName() const;
146
151 void SAL_CALL getDescription( typelib_TypeDescription ** ppDescr ) const
153
159 { return _pType; }
160
169 bool SAL_CALL isAssignableFrom( const Type & rType ) const
171
177 bool SAL_CALL equals( const Type & rType ) const
178 { return ::typelib_typedescriptionreference_equals( _pType, rType._pType ); }
184 bool SAL_CALL operator == ( const Type & rType ) const
185 { return ::typelib_typedescriptionreference_equals( _pType, rType._pType ); }
191 bool SAL_CALL operator != ( const Type & rType ) const
192 { return (! ::typelib_typedescriptionreference_equals( _pType, rType._pType )); }
193};
194
197template< class T >
198class Array
199{
200public:
202};
203
204}
205}
206}
207}
208
221SAL_DEPRECATED("use cppu::UnoType")
222inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const ::com::sun::star::uno::Type * );
223
230SAL_DEPRECATED("use cppu::UnoType")
231inline const ::com::sun::star::uno::Type & SAL_CALL getCppuVoidType();
239SAL_DEPRECATED("use cppu::UnoType")
240inline const ::com::sun::star::uno::Type & SAL_CALL getVoidCppuType();
241
249SAL_DEPRECATED("use cppu::UnoType")
250inline const ::com::sun::star::uno::Type & SAL_CALL getCppuBooleanType();
258SAL_DEPRECATED("use cppu::UnoType")
259inline const ::com::sun::star::uno::Type & SAL_CALL getBooleanCppuType();
272SAL_DEPRECATED("use cppu::UnoType")
273inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Bool * );
286SAL_DEPRECATED("use cppu::UnoType")
287inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType(
288 bool const * );
289
297SAL_DEPRECATED("use cppu::UnoType")
298inline const ::com::sun::star::uno::Type & SAL_CALL getCharCppuType();
306SAL_DEPRECATED("use cppu::UnoType")
307inline const ::com::sun::star::uno::Type & SAL_CALL getCppuCharType();
308
321SAL_DEPRECATED("use cppu::UnoType")
322inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Int8 * );
323
336SAL_DEPRECATED("use cppu::UnoType")
337inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const ::rtl::OUString * );
338
351SAL_DEPRECATED("use cppu::UnoType")
352inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Int16 * );
353
366SAL_DEPRECATED("use cppu::UnoType")
367inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_uInt16 * );
368
381SAL_DEPRECATED("use cppu::UnoType")
382inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Int32 * );
383
396SAL_DEPRECATED("use cppu::UnoType")
397inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_uInt32 * );
398
411SAL_DEPRECATED("use cppu::UnoType")
412inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Int64 * );
413
426SAL_DEPRECATED("use cppu::UnoType")
427inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_uInt64 * );
428
441SAL_DEPRECATED("use cppu::UnoType")
442inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const float * );
443
456SAL_DEPRECATED("use cppu::UnoType")
457inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const double * );
458
477template< typename T > SAL_DEPRECATED("use cppu::UnoType")
478inline const ::com::sun::star::uno::Type & SAL_CALL
480
492template<> SAL_DEPRECATED("use cppu::UnoType")
493inline const ::com::sun::star::uno::Type & SAL_CALL
495
496#endif
497
498/* 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
__sal_NoAcquire
Definition: types.h:353
unsigned char sal_Bool
Definition: types.h:38
sal_uInt16 sal_Unicode
Definition: types.h:123
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.
struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescription typelib_TypeDescription
Full type description of a type.
CPPU_DLLPUBLIC sal_Bool typelib_typedescriptionreference_isAssignableFrom(typelib_TypeDescriptionReference *pAssignable, typelib_TypeDescriptionReference *pFrom) SAL_THROW_EXTERN_C()
Tests if values of type pAssignable can be assigned by values of type pFrom.
CPPU_DLLPUBLIC void typelib_typedescriptionreference_release(typelib_TypeDescriptionReference *pRef) SAL_THROW_EXTERN_C()
Increments reference count of type description reference.
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.
CPPU_DLLPUBLIC sal_Bool typelib_typedescriptionreference_equals(const typelib_TypeDescriptionReference *p1, const typelib_TypeDescriptionReference *p2) SAL_THROW_EXTERN_C()
Tests whether two types description references are equal, i.e.
const ::com::sun::star::uno::Type & getCppuBooleanType()
Gets the meta type of IDL type boolean.
Definition: Type.hxx:131
const ::com::sun::star::uno::Type & getBooleanCppuType()
Gets the meta type of IDL type boolean.
Definition: Type.hxx:135
const ::com::sun::star::uno::Type & getVoidCppuType()
Gets the meta type of IDL type void.
Definition: Type.hxx:126
const ::com::sun::star::uno::Type & getCppuCharType()
Gets the meta type of IDL type char.
Definition: Type.hxx:154
const ::com::sun::star::uno::Type & getCppuType(const ::com::sun::star::uno::Type *)
Gets the meta type of IDL type "type".
const ::com::sun::star::uno::Type & getCppuVoidType()
Gets the meta type of IDL type void.
Definition: Type.hxx:122
const ::com::sun::star::uno::Type & getCharCppuType()
Gets the meta type of IDL type char.
Definition: Type.hxx:150
Definition: types.h:359
Definition: bootstrap.hxx:34
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
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
UnoType_NoAcquire
Enum defining UNO_TYPE_NO_ACQUIRE for type description reference transfer.
Definition: Type.h:44
@ UNO_TYPE_NO_ACQUIRE
This enum value can be used for creating a Type object granting a given type description reference,...
Definition: Type.h:48
Definition: Enterable.hxx:31
rtl::OUString getTypeName(rtl::OUString const &rEnvDcp)
Get the OBI type part of an environment descriptor.
Definition: EnvDcp.hxx:41
C++ class representing an IDL meta type.
Definition: Type.h:59
bool equals(const Type &rType) const
Compares two types.
Definition: Type.h:177
void getDescription(typelib_TypeDescription **ppDescr) const
Obtains a full type description of set type.
Definition: Type.h:151
~Type()
Destructor: Releases acquired C type description reference.
Definition: Type.h:124
bool isAssignableFrom(const Type &rType) const
Tests if values of this reflected type can be assigned by values of given type.
Definition: Type.h:169
TypeClass getTypeClass() const
Gets the type class of set type.
Definition: Type.h:138
typelib_TypeDescriptionReference * getTypeLibType() const
Gets the C typelib type description reference pointer.
Definition: Type.h:158
Helper class to specify a type pointer for idl arrays.
Definition: Type.h:199
static typelib_TypeDescriptionReference * s_pType
Definition: Type.h:201