LibreOffice LibreOffice 6.2 SDK C/C++ API Reference

typedescription.hxx
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_TYPELIB_TYPEDESCRIPTION_HXX
20 #define INCLUDED_TYPELIB_TYPEDESCRIPTION_HXX
21
22 #include "sal/config.h"
23
24 #include <cstddef>
25
26 #include "rtl/alloc.h"
27 #include "rtl/ustring.hxx"
28 #include "com/sun/star/uno/Type.h"
29 #include "typelib/typedescription.h"
30
31
32 namespace com
33 {
34 namespace sun
35 {
36 namespace star
37 {
38 namespace uno
39 {
40
46 class TypeDescription
47 {
50 mutable typelib_TypeDescription * _pTypeDescr;
51
52 public:
54 // these are here to force memory de/allocation to sal lib.
55 static void * SAL_CALL operator new ( size_t nSize )
56 { return ::rtl_allocateMemory( nSize ); }
57 static void SAL_CALL operator delete ( void * pMem )
58 { ::rtl_freeMemory( pMem ); }
59 static void * SAL_CALL operator new ( size_t, void * pMem )
60 { return pMem; }
61 static void SAL_CALL operator delete ( void *, void * )
62 {}
64
69 inline TypeDescription( typelib_TypeDescription * pTypeDescr = NULL );
74 inline TypeDescription( typelib_TypeDescriptionReference * pTypeDescrRef );
79 inline TypeDescription( const css::uno::Type & rType );
84 inline TypeDescription( const TypeDescription & rDescr );
85 #if defined LIBO_INTERNAL_ONLY
86 TypeDescription(TypeDescription && other): _pTypeDescr(other._pTypeDescr)
87 { other._pTypeDescr = nullptr; }
88 #endif
89
93 inline TypeDescription( rtl_uString * pTypeName );
98 inline TypeDescription( const ::rtl::OUString & rTypeName );
101 inline ~TypeDescription();
102
108 inline TypeDescription & SAL_CALL operator = ( typelib_TypeDescription * pTypeDescr );
114 TypeDescription & SAL_CALL operator =( const TypeDescription & rTypeDescr )
115 { return this->operator =( rTypeDescr.get() ); }
116
117 #if defined LIBO_INTERNAL_ONLY
118 TypeDescription & operator =(TypeDescription && other) {
119 if (_pTypeDescr != nullptr) {
120 typelib_typedescription_release(_pTypeDescr);
121 }
122 _pTypeDescr = other._pTypeDescr;
123 other._pTypeDescr = nullptr;
124 return *this;
125 }
126 #endif
127
133 inline bool SAL_CALL equals( const typelib_TypeDescription * pTypeDescr ) const;
139 bool SAL_CALL equals( const TypeDescription & rTypeDescr ) const
140 { return equals( rTypeDescr._pTypeDescr ); }
141
144 inline void SAL_CALL makeComplete() const;
145
150 typelib_TypeDescription * SAL_CALL get() const
151 { return _pTypeDescr; }
156 bool SAL_CALL is() const
157 { return (_pTypeDescr != NULL); }
158 };
159
160 inline TypeDescription::TypeDescription( typelib_TypeDescription * pTypeDescr )
161 : _pTypeDescr( pTypeDescr )
162 {
163 if (_pTypeDescr)
164 typelib_typedescription_acquire( _pTypeDescr );
165 }
166
167 inline TypeDescription::TypeDescription( typelib_TypeDescriptionReference * pTypeDescrRef )
168 : _pTypeDescr( NULL )
169 {
170 if (pTypeDescrRef)
171 typelib_typedescriptionreference_getDescription( &_pTypeDescr, pTypeDescrRef );
172 }
173
174 inline TypeDescription::TypeDescription( const css::uno::Type & rType )
175 : _pTypeDescr( NULL )
176 {
177 if (rType.getTypeLibType())
178 typelib_typedescriptionreference_getDescription( &_pTypeDescr, rType.getTypeLibType() );
179 }
180
181 inline TypeDescription::TypeDescription( const TypeDescription & rTypeDescr )
182 : _pTypeDescr( rTypeDescr._pTypeDescr )
183 {
184 if (_pTypeDescr)
185 typelib_typedescription_acquire( _pTypeDescr );
186 }
187
188 inline TypeDescription::TypeDescription( rtl_uString * pTypeName )
189 : _pTypeDescr( NULL )
190 {
191 typelib_typedescription_getByName( &_pTypeDescr , pTypeName );
192 }
193
194 inline TypeDescription::TypeDescription( const ::rtl::OUString & rTypeName )
195 : _pTypeDescr( NULL )
196 {
197 typelib_typedescription_getByName( &_pTypeDescr , rTypeName.pData );
198 }
199
200 inline TypeDescription::~TypeDescription()
201 {
202 if (_pTypeDescr)
203 typelib_typedescription_release( _pTypeDescr );
204 }
205
206 inline TypeDescription & TypeDescription::operator = ( typelib_TypeDescription * pTypeDescr )
207 {
208 if (pTypeDescr)
209 typelib_typedescription_acquire( pTypeDescr );
210 if (_pTypeDescr)
211 typelib_typedescription_release( _pTypeDescr );
212 _pTypeDescr = pTypeDescr;
213 return *this;
214 }
215
216 inline bool TypeDescription::equals( const typelib_TypeDescription * pTypeDescr ) const
217 {
218 return (_pTypeDescr && pTypeDescr &&
219 typelib_typedescription_equals( _pTypeDescr, pTypeDescr ));
220 }
221
222 inline void TypeDescription::makeComplete() const
223 {
224 if (_pTypeDescr && !_pTypeDescr->bComplete)
225 ::typelib_typedescription_complete( &_pTypeDescr );
226 }
227
228 }
229 }
230 }
231 }
232
233 #endif
234
235 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
typelib_typedescription_complete
CPPU_DLLPUBLIC sal_Bool typelib_typedescription_complete(typelib_TypeDescription **ppTypeDescr) SAL_THROW_EXTERN_C()
Completes a typedescription to be used for, e.g., marshalling values.
Type.h
com::sun::star::uno::TypeDescription::~TypeDescription
~TypeDescription()
Destructor: releases type description.
Definition: typedescription.hxx:200
typelib_TypeDescriptionReference
struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescriptionReference typelib_TypeDescriptionReference
Holds a weak reference to a type description.
com::sun::star::uno::TypeDescription::makeComplete
void makeComplete() const
Makes stored type description complete.
Definition: typedescription.hxx:222
rtl_allocateMemory
SAL_DLLPUBLIC void * rtl_allocateMemory(sal_Size Bytes) SAL_THROW_EXTERN_C()
Allocate memory.
typelib_typedescription_acquire
CPPU_DLLPUBLIC void typelib_typedescription_acquire(typelib_TypeDescription *pDesc) SAL_THROW_EXTERN_C()
Increments reference count of given type description.
ustring.hxx
typelib_typedescription_release
CPPU_DLLPUBLIC void typelib_typedescription_release(typelib_TypeDescription *pDesc) SAL_THROW_EXTERN_C()
Decrements reference count of given type.
typelib_TypeDescription
struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescription typelib_TypeDescription
Full type description of a type.
com
Definition: types.h:377
typelib_typedescription_getByName
CPPU_DLLPUBLIC void typelib_typedescription_getByName(typelib_TypeDescription **ppRet, rtl_uString *pName) SAL_THROW_EXTERN_C()
Retrieves a type description via its fully qualified name.
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.
com::sun::star::uno::TypeDescription::TypeDescription
TypeDescription(typelib_TypeDescription *pTypeDescr=NULL)
Constructor:
Definition: typedescription.hxx:160
com::sun::star::uno::TypeDescription::get
typelib_TypeDescription * get() const
Gets the UNacquired type description pointer.
Definition: typedescription.hxx:150
com::sun::star::uno::TypeDescription::is
bool is() const
Tests if a type description is set.
Definition: typedescription.hxx:156
com::sun::star::uno::TypeDescription::equals
bool equals(const TypeDescription &rTypeDescr) const
Tests whether two type descriptions are equal.
Definition: typedescription.hxx:139
typedescription.h
com::sun::star::uno::TypeDescription::operator=
TypeDescription & operator=(typelib_TypeDescription *pTypeDescr)
Assignment operator: acquires given type description and releases a set one.
Definition: typedescription.hxx:206
config.h
rtl_freeMemory
SAL_DLLPUBLIC void rtl_freeMemory(void *Ptr) SAL_THROW_EXTERN_C()
Free memory.
typelib_typedescription_equals
CPPU_DLLPUBLIC sal_Bool typelib_typedescription_equals(const typelib_TypeDescription *p1, const typelib_TypeDescription *p2) SAL_THROW_EXTERN_C()
Tests whether two types descriptions are equal, i.e.
alloc.h
com::sun::star::uno::TypeDescription::equals
bool equals(const typelib_TypeDescription *pTypeDescr) const
Tests whether two type descriptions are equal.
Definition: typedescription.hxx:216
com::sun::star::uno::TypeDescription
C++ wrapper for typelib_TypeDescription.
Definition: typedescription.hxx:46