LibreOffice
LibreOffice 7.4 SDK C/C++ API Reference
unotype.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 
20 /*
21  * This file is part of LibreOffice published API.
22  */
23 
24 #ifndef INCLUDED_CPPU_UNOTYPE_HXX
25 #define INCLUDED_CPPU_UNOTYPE_HXX
26 
27 #include "sal/config.h"
28 
29 #include <cstddef>
30 
31 #if defined LIBO_INTERNAL_ONLY
32 #include <type_traits>
33 #endif
34 
35 #include "sal/types.h"
36 #include "typelib/typeclass.h"
38 
39 namespace com { namespace sun { namespace star { namespace uno {
40  class Type;
41  class Any;
42  class Exception;
43  template< typename > class Reference;
44  template< typename > class Sequence;
45  class XInterface;
46 } } } }
47 namespace rtl { class OUString; }
48 
49 namespace cppu {
50 
51 template< typename > class UnoType;
52 
61 struct UnoVoidType;
62 
74 struct UnoUnsignedShortType;
75 
87 struct UnoCharType;
88 
101 template< typename > struct UnoSequenceType;
102 
103 namespace detail {
104 
105 inline css::uno::Type const & getTypeFromTypeDescriptionReference(
106  ::typelib_TypeDescriptionReference * const * tdr)
107 {
108  return *reinterpret_cast< css::uno::Type const * >(tdr);
109 }
110 
111 inline css::uno::Type const &
115 }
116 
117 }
118 
119 }
120 
121 namespace cppu { namespace detail {
122 
123 inline css::uno::Type const &
124 cppu_detail_getUnoType(SAL_UNUSED_PARAMETER ::cppu::UnoVoidType const *) {
126 }
127 
128 inline css::uno::Type const &
131 }
132 
133 inline css::uno::Type const &
136 }
137 
138 inline css::uno::Type const &
141 }
142 
143 inline css::uno::Type const &
144 cppu_detail_getUnoType(SAL_UNUSED_PARAMETER ::sal_Int16 const *) {
146 }
147 
148 inline css::uno::Type const &
150  SAL_UNUSED_PARAMETER ::cppu::UnoUnsignedShortType const *)
151 {
154 }
155 
156 #if defined LIBO_INTERNAL_ONLY
157  // cf. sal/types.h sal_Unicode
158 inline css::uno::Type const &
159 cppu_detail_getUnoType(SAL_UNUSED_PARAMETER sal_uInt16 const *) {
161 }
162 #endif
163 
164 inline css::uno::Type const &
165 cppu_detail_getUnoType(SAL_UNUSED_PARAMETER ::sal_Int32 const *) {
167 }
168 
169 inline css::uno::Type const &
170 cppu_detail_getUnoType(SAL_UNUSED_PARAMETER ::sal_uInt32 const *) {
173 }
174 
175 inline css::uno::Type const &
176 cppu_detail_getUnoType(SAL_UNUSED_PARAMETER ::sal_Int64 const *) {
178 }
179 
180 inline css::uno::Type const &
181 cppu_detail_getUnoType(SAL_UNUSED_PARAMETER ::sal_uInt64 const *) {
184 }
185 
186 inline css::uno::Type const &
189 }
190 
191 inline css::uno::Type const &
194 }
195 
196 inline css::uno::Type const &
197 cppu_detail_getUnoType(SAL_UNUSED_PARAMETER ::cppu::UnoCharType const *) {
199 }
200 
201 #if defined LIBO_INTERNAL_ONLY
202  // cf. sal/types.h sal_Unicode
203 inline css::uno::Type const &
206 }
207 #endif
208 
209 inline css::uno::Type const &
210 cppu_detail_getUnoType(SAL_UNUSED_PARAMETER ::rtl::OUString const *) {
212 }
213 
214 inline css::uno::Type const &
216 {
218 }
219 
220 inline css::uno::Type const &
222 {
224 }
225 
226 template< typename T > inline css::uno::Type const &
228  SAL_UNUSED_PARAMETER ::cppu::UnoSequenceType< T > const *)
229 {
230  //TODO: depending on memory model, the following might not work reliably
231  static typelib_TypeDescriptionReference * p = NULL;
232  if (p == NULL) {
234  &p, ::cppu::UnoType< T >::get().getTypeLibType());
235  }
237 }
238 
239 template< typename T > inline css::uno::Type const &
241  SAL_UNUSED_PARAMETER css::uno::Sequence< T > const *)
242 {
243  return cppu_detail_getUnoType(
244  static_cast< ::cppu::UnoSequenceType< T > * >(NULL));
245 }
246 
247 inline css::uno::Type const & cppu_detail_getUnoType(
248  SAL_UNUSED_PARAMETER css::uno::Exception const *)
249 {
251 }
252 
253 inline css::uno::Type const & cppu_detail_getUnoType(
254  SAL_UNUSED_PARAMETER css::uno::XInterface const *)
255 {
257 }
258 
259 template< typename T > inline css::uno::Type const &
261  SAL_UNUSED_PARAMETER css::uno::Reference< T > const *)
262 {
263  return ::cppu::UnoType< T >::get();
264 }
265 
266 } }
267 
268 namespace cppu {
269 
290 template< typename T > class UnoType {
291 public:
292  static css::uno::Type const & get() {
293  using namespace ::cppu::detail;
294 #if defined LIBO_INTERNAL_ONLY
295  typedef typename std::remove_reference<T>::type T1;
296  // for certain uses of UnoType<decltype(x)>
297 #else
298  typedef T T1;
299 #endif
300  return cppu_detail_getUnoType(static_cast< T1 * >(NULL));
301  }
302 
303 private:
306  void operator =(UnoType &) SAL_DELETED_FUNCTION;
307 };
308 
309 template<> css::uno::Type inline const & UnoType<void>::get() {
311 }
312 
323 template< typename T > inline css::uno::Type const &
325  return ::cppu::UnoType< T >::get();
326 }
327 
338 inline css::uno::Type const &
339 getTypeFavourUnsigned(SAL_UNUSED_PARAMETER ::sal_uInt16 const *) {
340  return ::cppu::UnoType< ::cppu::UnoUnsignedShortType >::get();
341 }
342 
353 template< typename T > inline css::uno::Type const &
354 getTypeFavourUnsigned(css::uno::Sequence< T > const *);
355  // defined in com/sun/star/uno/Sequence.hxx
356 
358 
370 template< typename T > inline css::uno::Type const &
372  return ::cppu::UnoType< T >::get();
373 }
374 
386 inline css::uno::Type const &
388  return ::cppu::UnoType< ::cppu::UnoCharType >::get();
389 }
390 
402 template< typename T > inline css::uno::Type const &
403 getTypeFavourChar(css::uno::Sequence< T > const *);
404  // defined in com/sun/star/uno/Sequence.hxx
405 
407 
408 }
409 
410 #endif
411 
412 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
#define SAL_DELETED_FUNCTION
short-circuit extra-verbose API namespaces
Definition: types.h:378
#define SAL_UNUSED_PARAMETER
Annotate unused but required C++ function parameters.
Definition: types.h:568
unsigned char sal_Bool
Definition: types.h:38
sal_uInt16 sal_Unicode
Definition: types.h:123
signed char sal_Int8
Definition: types.h:43
@ typelib_TypeClass_VOID
type class of void
Definition: typeclass.h:32
@ typelib_TypeClass_UNSIGNED_SHORT
type class of unsigned short
Definition: typeclass.h:42
@ typelib_TypeClass_CHAR
type class of char
Definition: typeclass.h:34
@ typelib_TypeClass_HYPER
type class of hyper
Definition: typeclass.h:48
@ typelib_TypeClass_BYTE
type class of byte
Definition: typeclass.h:38
@ typelib_TypeClass_BOOLEAN
type class of boolean
Definition: typeclass.h:36
@ typelib_TypeClass_INTERFACE
type class of interface
Definition: typeclass.h:82
@ typelib_TypeClass_STRING
type class of string
Definition: typeclass.h:56
@ typelib_TypeClass_SHORT
type class of short
Definition: typeclass.h:40
@ typelib_TypeClass_FLOAT
type class of float
Definition: typeclass.h:52
@ typelib_TypeClass_DOUBLE
type class of double
Definition: typeclass.h:54
@ typelib_TypeClass_ANY
type class of any
Definition: typeclass.h:60
@ typelib_TypeClass_TYPE
type class of type
Definition: typeclass.h:58
@ typelib_TypeClass_UNSIGNED_HYPER
type class of unsigned hyper
Definition: typeclass.h:50
@ typelib_TypeClass_LONG
type class of long
Definition: typeclass.h:44
@ typelib_TypeClass_UNSIGNED_LONG
type class of unsigned long
Definition: typeclass.h:46
@ typelib_TypeClass_EXCEPTION
type class of exception
Definition: typeclass.h:73
enum _typelib_TypeClass typelib_TypeClass
This type class enum is binary compatible with the IDL enum com.sun.star.uno.TypeClass.
CPPU_DLLPUBLIC void typelib_static_sequence_type_init(typelib_TypeDescriptionReference **ppRef, typelib_TypeDescriptionReference *pElementType) SAL_THROW_EXTERN_C()
Inits static sequence type reference.
struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescriptionReference typelib_TypeDescriptionReference
Holds a weak reference to a type description.
CPPU_DLLPUBLIC typelib_TypeDescriptionReference ** typelib_static_type_getByTypeClass(typelib_TypeClass eTypeClass) SAL_THROW_EXTERN_C()
Gets static type reference of standard types by type class.
Definition: types.h:359
Definition: types.h:359
Definition: bootstrap.hxx:34
Definition: Enterable.hxx:31
::com::sun::star::uno::Type const & getTypeFavourChar(SAL_UNUSED_PARAMETER ::com::sun::star::uno::Sequence< T > const *)
Definition: Sequence.hxx:343
css::uno::Type const & getTypeFavourUnsigned(SAL_UNUSED_PARAMETER T const *)
A working replacement for getCppuType (see there).
Definition: unotype.hxx:324
Definition: unotype.hxx:103
css::uno::Type const & getTypeFromTypeDescriptionReference(::typelib_TypeDescriptionReference *const *tdr)
Definition: unotype.hxx:105
css::uno::Type const & getTypeFromTypeClass(::typelib_TypeClass tc)
Definition: unotype.hxx:112
css::uno::Type const & cppu_detail_getUnoType(SAL_UNUSED_PARAMETER css::uno::Reference< T > const *)
Definition: unotype.hxx:260
css::uno::Type const & cppu_detail_getUnoType(SAL_UNUSED_PARAMETER ::cppu::UnoVoidType const *)
Definition: unotype.hxx:124
Get the css::uno::Type instance representing a certain UNO type.
Definition: unotype.hxx:290
static css::uno::Type const & get()
Definition: unotype.hxx:292
A unique C++ type template representing the UNO sequence types in cppu::UnoType.
Definition: unotype.hxx:101