LibreOffice
LibreOffice 6.0 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 #ifndef INCLUDED_COM_SUN_STAR_UNO_TYPE_H
20 #define INCLUDED_COM_SUN_STAR_UNO_TYPE_H
21 
23 #include <com/sun/star/uno/TypeClass.hdl>
24 #include <rtl/ustring.hxx>
25 #include <rtl/alloc.h>
26 
27 
28 namespace com
29 {
30 namespace sun
31 {
32 namespace star
33 {
34 namespace uno
35 {
36 
40 {
45 };
46 
54 class SAL_WARN_UNUSED SAL_DLLPUBLIC_RTTI Type
55 {
59 
60 public:
62  // these are here to force memory de/allocation to sal lib.
63  static void * SAL_CALL operator new ( size_t nSize )
64  { return ::rtl_allocateMemory( nSize ); }
65  static void SAL_CALL operator delete ( void * pMem )
66  { ::rtl_freeMemory( pMem ); }
67  static void * SAL_CALL operator new ( size_t, void * pMem )
68  { return pMem; }
69  static void SAL_CALL operator delete ( void *, void * )
70  {}
72 
75  inline Type();
76 
82  inline Type( TypeClass eTypeClass, const ::rtl::OUString & rTypeName );
83 
89  inline Type( TypeClass eTypeClass, const sal_Char * pTypeName );
90 
95  inline Type( typelib_TypeDescriptionReference * pType );
96 
110  inline Type( typelib_TypeDescriptionReference * pType, __sal_NoAcquire dummy );
111 
116  inline Type( const Type & rType );
117 
122 
128  inline Type & SAL_CALL operator = ( const Type & rType );
129 
134  TypeClass SAL_CALL getTypeClass() const
135  { return (TypeClass)_pType->eTypeClass; }
136 
141  inline ::rtl::OUString SAL_CALL getTypeName() const;
142 
147  void SAL_CALL getDescription( typelib_TypeDescription ** ppDescr ) const
149 
155  { return _pType; }
156 
165  bool SAL_CALL isAssignableFrom( const Type & rType ) const
167 
173  bool SAL_CALL equals( const Type & rType ) const
174  { return ::typelib_typedescriptionreference_equals( _pType, rType._pType ); }
180  bool SAL_CALL operator == ( const Type & rType ) const
181  { return ::typelib_typedescriptionreference_equals( _pType, rType._pType ); }
187  bool SAL_CALL operator != ( const Type & rType ) const
188  { return (! ::typelib_typedescriptionreference_equals( _pType, rType._pType )); }
189 };
190 
193 template< class T >
194 class Array
195 {
196 public:
198 };
199 
200 }
201 }
202 }
203 }
204 
217 SAL_DEPRECATED("use cppu::UnoType")
218 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const ::com::sun::star::uno::Type * );
219 
226 SAL_DEPRECATED("use cppu::UnoType")
227 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuVoidType();
235 SAL_DEPRECATED("use cppu::UnoType")
236 inline const ::com::sun::star::uno::Type & SAL_CALL getVoidCppuType();
237 
245 SAL_DEPRECATED("use cppu::UnoType")
246 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuBooleanType();
254 SAL_DEPRECATED("use cppu::UnoType")
255 inline const ::com::sun::star::uno::Type & SAL_CALL getBooleanCppuType();
268 SAL_DEPRECATED("use cppu::UnoType")
269 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Bool * );
282 SAL_DEPRECATED("use cppu::UnoType")
283 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType(
284  bool const * );
285 
293 SAL_DEPRECATED("use cppu::UnoType")
294 inline const ::com::sun::star::uno::Type & SAL_CALL getCharCppuType();
302 SAL_DEPRECATED("use cppu::UnoType")
303 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuCharType();
304 
317 SAL_DEPRECATED("use cppu::UnoType")
318 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Int8 * );
319 
332 SAL_DEPRECATED("use cppu::UnoType")
333 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const ::rtl::OUString * );
334 
347 SAL_DEPRECATED("use cppu::UnoType")
348 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Int16 * );
349 
362 SAL_DEPRECATED("use cppu::UnoType")
363 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_uInt16 * );
364 
377 SAL_DEPRECATED("use cppu::UnoType")
378 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Int32 * );
379 
392 SAL_DEPRECATED("use cppu::UnoType")
393 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_uInt32 * );
394 
407 SAL_DEPRECATED("use cppu::UnoType")
408 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Int64 * );
409 
422 SAL_DEPRECATED("use cppu::UnoType")
423 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_uInt64 * );
424 
437 SAL_DEPRECATED("use cppu::UnoType")
438 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const float * );
439 
452 SAL_DEPRECATED("use cppu::UnoType")
453 inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const double * );
454 
473 template< typename T > SAL_DEPRECATED("use cppu::UnoType")
474 inline const ::com::sun::star::uno::Type & SAL_CALL
475 getCppuType();
476 
488 template<> SAL_DEPRECATED("use cppu::UnoType")
489 inline const ::com::sun::star::uno::Type & SAL_CALL
490 getCppuType< sal_Unicode >();
491 
492 #endif
493 
494 /* 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
UnoType_NoAcquire
Enum defining UNO_TYPE_NO_ACQUIRE for type description reference transfer.
Definition: Type.h:39
const ::com::sun::star::uno::Type & getCppuBooleanType()
Gets the meta type of IDL type boolean.
Definition: Type.hxx:127
char sal_Char
A legacy synonym for char.
Definition: types.h:121
Definition: Enterable.hxx:26
~Type()
Destructor: Releases acquired C type description reference.
Definition: Type.h:120
This enum value can be used for creating a Type object granting a given type description reference...
Definition: Type.h:44
#define SAL_WARN_UNUSED
Annotate classes where a compiler should warn if an instance is unused.
Definition: types.h:608
CPPU_DLLPUBLIC void typelib_typedescriptionreference_getDescription(typelib_TypeDescription **ppRet, typelib_TypeDescriptionReference *pRef) SAL_THROW_EXTERN_C()
Retrieves the type description for a given reference.
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.
CPPU_DLLPUBLIC void typelib_typedescriptionreference_release(typelib_TypeDescriptionReference *pRef) SAL_THROW_EXTERN_C()
Increments reference count of type description reference.
SAL_DLLPUBLIC void rtl_freeMemory(void *Ptr) SAL_THROW_EXTERN_C()
Free memory.
Definition: types.h:383
unsigned char sal_Bool
Definition: types.h:39
static typelib_TypeDescriptionReference * s_pType
Definition: Type.h:197
const ::com::sun::star::uno::Type & getCppuCharType()
Gets the meta type of IDL type char.
Definition: Type.hxx:150
const ::com::sun::star::uno::Type & getCharCppuType()
Gets the meta type of IDL type char.
Definition: Type.hxx:146
typelib_TypeDescriptionReference * getTypeLibType() const
Gets the C typelib type description reference pointer.
Definition: Type.h:154
const ::com::sun::star::uno::Type & getCppuVoidType()
Gets the meta type of IDL type void.
Definition: Type.hxx:118
void getDescription(typelib_TypeDescription **ppDescr) const
Obtains a full type description of set type.
Definition: Type.h:147
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
bool equals(const Type &rType) const
Compares two types.
Definition: Type.h:173
__sal_NoAcquire
Definition: types.h:376
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
sal_uInt16 sal_Unicode
Definition: types.h:142
TypeClass getTypeClass() const
Gets the type class of set type.
Definition: Type.h:134
Definition: bootstrap.hxx:29
bool isAssignableFrom(const Type &rType) const
Tests if values of this reflected type can be assigned by values of given type.
Definition: Type.h:165
#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
const ::com::sun::star::uno::Type & getBooleanCppuType()
Gets the meta type of IDL type boolean.
Definition: Type.hxx:131
rtl::OUString getTypeName(rtl::OUString const &rEnvDcp)
Get the OBI type part of an environment descriptor.
Definition: EnvDcp.hxx:38
SAL_DLLPUBLIC void * rtl_allocateMemory(sal_Size Bytes) SAL_THROW_EXTERN_C()
Allocate memory.
struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescriptionReference typelib_TypeDescriptionReference
Holds a weak reference to a type description.
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.
Helper class to specify a type pointer for idl arrays.
Definition: Type.h:194
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 & getVoidCppuType()
Gets the meta type of IDL type void.
Definition: Type.hxx:122