include/typelib/typedescription.hxx

   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
  41 /** C++ wrapper for typelib_TypeDescription.
  42     Constructors by name, type, type description reference will get the full type description.
  43
  44     @see typelib_TypeDescription
  45 */
  46 class TypeDescription
  47 {
  48     /** C typelib type description
  49     */
  50     mutable typelib_TypeDescription * _pTypeDescr;
  51
  52 public:
  53     /// @cond INTERNAL
  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         {}
  63     /// @endcond
  64
  65     /** Constructor:
  66
  67         @param pTypeDescr a type description
  68     */
  69     inline TypeDescription( typelib_TypeDescription * pTypeDescr = NULL );
  70     /** Constructor:
  71
  72         @param pTypeDescrRef a type description reference
  73     */
  74     inline TypeDescription( typelib_TypeDescriptionReference * pTypeDescrRef );
  75     /** Constructor:
  76
  77         @param rType a type
  78     */
  79     inline TypeDescription( const css::uno::Type & rType );
  80     /** Copy constructor:
  81
  82         @param rDescr another TypeDescription
  83     */
  84     inline TypeDescription( const TypeDescription & rDescr );
  85 #if defined LIBO_INTERNAL_ONLY
  86     TypeDescription(TypeDescription && other) noexcept : _pTypeDescr(other._pTypeDescr)
  87     { other._pTypeDescr = nullptr; }
  88 #endif
  89     /** Constructor:
  90
  91         @param pTypeName a type name
  92     */
  93     inline TypeDescription( rtl_uString * pTypeName );
  94     /** Constructor:
  95
  96         @param rTypeName a type name
  97     */
  98     inline TypeDescription( const ::rtl::OUString & rTypeName );
  99     /** Destructor: releases type description
 100     */
 101     inline ~TypeDescription();
 102
 103     /** Assignment operator: acquires given type description and releases a set one.
 104
 105         @param pTypeDescr another type description
 106         @return this TypeDescription
 107     */
 108     inline TypeDescription & SAL_CALL operator = ( typelib_TypeDescription * pTypeDescr );
 109     /** Assignment operator: acquires given type description and releases a set one.
 110
 111         @param rTypeDescr another type description
 112         @return this TypeDescription
 113     */
 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) noexcept {
 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
 128     /** Tests whether two type descriptions are equal.
 129
 130         @param pTypeDescr another type description
 131         @return true, if both type descriptions are equal, false otherwise
 132     */
 133     inline bool SAL_CALL equals( const typelib_TypeDescription * pTypeDescr ) const;
 134     /** Tests whether two type descriptions are equal.
 135
 136         @param rTypeDescr another type description
 137         @return true, if both type descriptions are equal, false otherwise
 138     */
 139     bool SAL_CALL equals( const TypeDescription & rTypeDescr ) const
 140         { return equals( rTypeDescr._pTypeDescr ); }
 141
 142     /** Makes stored type description complete.
 143     */
 144     inline void SAL_CALL makeComplete() const;
 145
 146     /** Gets the UNacquired type description pointer.
 147
 148         @return stored pointer of type description
 149     */
 150     typelib_TypeDescription * SAL_CALL get() const
 151         { return _pTypeDescr; }
 152     /** Tests if a type description is set.
 153
 154         @return true, if a type description is set, false otherwise
 155     */
 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: */