stoc/source/corereflection/base.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 //  #define TEST_LIST_CLASSES
  20
  21 #pragma once
  22
  23 #include <sal/config.h>
  24
  25 #include <o3tl/any.hxx>
  26 #include <osl/mutex.hxx>
  27 #include <uno/mapping.hxx>
  28 #include <uno/dispatcher.h>
  29 #include <cppuhelper/implbase.hxx>
  30 #include <cppuhelper/compbase.hxx>
  31 #include <rtl/ustring.hxx>
  32 #include <rtl/ref.hxx>
  33
  34 #include "lrucache.hxx"
  35
  36 #ifdef TEST_LIST_CLASSES
  37 #include <vector>
  38 #include <algorithm>
  39 #endif
  40 #include <unordered_map>
  41 #include <memory>
  42
  43 #include <com/sun/star/lang/XServiceInfo.hpp>
  44 #include <com/sun/star/container/XHierarchicalNameAccess.hpp>
  45
  46 #include <com/sun/star/reflection/XIdlReflection.hpp>
  47
  48 namespace com::sun::star::uno { class XComponentContext; }
  49 namespace com::sun::star::reflection { class XIdlClass; }
  50 namespace com::sun::star::reflection { class XIdlField; }
  51 namespace com::sun::star::reflection { class XIdlMethod; }
  52
  53 namespace stoc_corefl
  54 {
  55
  56 #ifdef TEST_LIST_CLASSES
  57 extern std::vector<OUString> g_aClassNames;
  58 #endif
  59
  60
  61 ::osl::Mutex & getMutexAccess();
  62
  63
  64 inline bool td_equals( typelib_TypeDescription * pTD, typelib_TypeDescriptionReference * pType )
  65 {
  66     return (pTD->pWeakRef == pType ||
  67             (pTD->pTypeName->length == pType->pTypeName->length &&
  68              rtl_ustr_compare( pTD->pTypeName->buffer, pType->pTypeName->buffer ) == 0));
  69 }
  70
  71 typedef std::unordered_map< OUString, css::uno::WeakReference< css::reflection::XIdlField > > OUString2Field;
  72 typedef std::unordered_map< OUString, css::uno::WeakReference< css::reflection::XIdlMethod > > OUString2Method;
  73
  74
  75 class IdlReflectionServiceImpl
  76     : public ::cppu::WeakComponentImplHelper<
  77           css::reflection::XIdlReflection,
  78           css::container::XHierarchicalNameAccess,
  79           css::lang::XServiceInfo>
  80 {
  81     ::osl::Mutex                            _aComponentMutex;
  82     css::uno::Reference< css::container::XHierarchicalNameAccess >    _xTDMgr;
  83
  84     // caching
  85     LRU_CacheAnyByOUString                  _aElements;
  86
  87     css::uno::Mapping                     _aCpp2Uno;
  88     css::uno::Mapping                     _aUno2Cpp;
  89
  90     inline css::uno::Reference< css::reflection::XIdlClass > constructClass( typelib_TypeDescription * pTypeDescr );
  91
  92 public:
  93     /// @throws css::uno::RuntimeException
  94     const css::uno::Mapping & getCpp2Uno();
  95     /// @throws css::uno::RuntimeException
  96     const css::uno::Mapping & getUno2Cpp();
  97     /// @throws css::uno::RuntimeException
  98     uno_Interface * mapToUno( const css::uno::Any & rObj, typelib_InterfaceTypeDescription * pTo );
  99
 100     // ctor/ dtor
 101     explicit IdlReflectionServiceImpl( const css::uno::Reference< css::uno::XComponentContext > & xContext );
 102     virtual ~IdlReflectionServiceImpl() override;
 103
 104     // WeakComponentImplHelper
 105     virtual void SAL_CALL disposing() override;
 106
 107     // XServiceInfo
 108     virtual OUString SAL_CALL getImplementationName() override;
 109     virtual sal_Bool SAL_CALL supportsService( const OUString & rServiceName ) override;
 110     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
 111
 112     // XIdlReflection
 113     virtual css::uno::Reference< css::reflection::XIdlClass > SAL_CALL forName( const OUString & rTypeName ) override;
 114     virtual css::uno::Reference< css::reflection::XIdlClass > SAL_CALL getType( const css::uno::Any & rObj ) override;
 115
 116     // XHierarchicalNameAccess
 117     virtual css::uno::Any SAL_CALL getByHierarchicalName( const OUString & rName ) override;
 118     virtual sal_Bool SAL_CALL hasByHierarchicalName( const OUString & rName ) override;
 119
 120     /// @throws css::uno::RuntimeException
 121     css::uno::Reference< css::reflection::XIdlClass > forType( typelib_TypeDescription * pTypeDescr );
 122     /// @throws css::uno::RuntimeException
 123     css::uno::Reference< css::reflection::XIdlClass > forType( typelib_TypeDescriptionReference * pRef );
 124 };
 125
 126
 127 class IdlClassImpl
 128     : public ::cppu::WeakImplHelper< css::reflection::XIdlClass >
 129 {
 130     rtl::Reference<IdlReflectionServiceImpl>
 131                                  m_xReflection;
 132
 133     OUString                    _aName;
 134     css::uno::TypeClass         _eTypeClass;
 135
 136     typelib_TypeDescription *   _pTypeDescr;
 137
 138 public:
 139     typelib_TypeDescription *   getTypeDescr() const
 140         { return _pTypeDescr; }
 141     IdlReflectionServiceImpl *  getReflection() const
 142         { return m_xReflection.get(); }
 143
 144     // Ctor
 145     IdlClassImpl( IdlReflectionServiceImpl * pReflection,
 146                   OUString aName, typelib_TypeClass eTypeClass,
 147                   typelib_TypeDescription * pTypeDescr );
 148     virtual ~IdlClassImpl() override;
 149
 150     // XIdlClassImpl default implementation
 151     virtual css::uno::TypeClass SAL_CALL getTypeClass() override;
 152     virtual OUString SAL_CALL getName() override;
 153     virtual sal_Bool SAL_CALL equals( const css::uno::Reference< css::reflection::XIdlClass >& xType ) override;
 154
 155     virtual sal_Bool SAL_CALL isAssignableFrom( const css::uno::Reference< css::reflection::XIdlClass > & xType ) override;
 156     virtual void SAL_CALL createObject( css::uno::Any & rObj ) override;
 157
 158     // def impl ????
 159     virtual css::uno::Sequence< css::uno::Reference< css::reflection::XIdlClass > > SAL_CALL getClasses() override;
 160     virtual css::uno::Reference< css::reflection::XIdlClass > SAL_CALL getClass( const OUString & rName ) override;
 161     virtual css::uno::Sequence< css::uno::Reference< css::reflection::XIdlClass > > SAL_CALL getInterfaces() override;
 162
 163     // structs, interfaces
 164     virtual css::uno::Sequence< css::uno::Reference< css::reflection::XIdlClass > > SAL_CALL getSuperclasses() override;
 165     // structs
 166     virtual css::uno::Reference< css::reflection::XIdlField > SAL_CALL getField( const OUString & rName ) override;
 167     virtual css::uno::Sequence< css::uno::Reference< css::reflection::XIdlField > > SAL_CALL getFields() override;
 168     // interfaces
 169     virtual css::uno::Uik SAL_CALL getUik() override;
 170     virtual css::uno::Reference< css::reflection::XIdlMethod > SAL_CALL getMethod( const OUString & rName ) override;
 171     virtual css::uno::Sequence< css::uno::Reference< css::reflection::XIdlMethod > > SAL_CALL getMethods() override;
 172     // array
 173     virtual css::uno::Reference< css::reflection::XIdlClass > SAL_CALL getComponentType() override;
 174     virtual css::uno::Reference< css::reflection::XIdlArray > SAL_CALL getArray() override;
 175 };
 176
 177
 178 class InterfaceIdlClassImpl
 179     : public IdlClassImpl
 180 {
 181     typedef std::pair< OUString, typelib_TypeDescription * > MemberInit;
 182
 183     css::uno::Sequence< css::uno::Reference< css::reflection::XIdlClass > >      _xSuperClasses;
 184
 185     std::unique_ptr<MemberInit[]>           _pSortedMemberInit; // first methods, then attributes
 186     OUString2Field                          _aName2Field;
 187     OUString2Method                         _aName2Method;
 188     sal_Int32                               _nMethods;
 189     sal_Int32                               _nAttributes;
 190
 191     void initMembers();
 192
 193 public:
 194     typelib_InterfaceTypeDescription * getTypeDescr() const
 195         { return reinterpret_cast<typelib_InterfaceTypeDescription *>(IdlClassImpl::getTypeDescr()); }
 196
 197     // ctor/ dtor
 198     InterfaceIdlClassImpl( IdlReflectionServiceImpl * pReflection,
 199                            const OUString & rName, typelib_TypeClass eTypeClass,
 200                            typelib_TypeDescription * pTypeDescr )
 201         : IdlClassImpl( pReflection, rName, eTypeClass, pTypeDescr )
 202         , _nMethods( 0 )
 203         , _nAttributes( 0 )
 204         {}
 205     virtual ~InterfaceIdlClassImpl() override;
 206
 207     // IdlClassImpl modifications
 208     virtual sal_Bool SAL_CALL isAssignableFrom( const css::uno::Reference< css::reflection::XIdlClass > & xType ) override;
 209     virtual css::uno::Sequence< css::uno::Reference< css::reflection::XIdlClass > > SAL_CALL getSuperclasses() override;
 210     virtual css::uno::Uik SAL_CALL getUik() override;
 211     virtual css::uno::Reference< css::reflection::XIdlMethod > SAL_CALL getMethod( const OUString & rName ) override;
 212     virtual css::uno::Sequence< css::uno::Reference< css::reflection::XIdlMethod > > SAL_CALL getMethods() override;
 213     virtual css::uno::Reference< css::reflection::XIdlField > SAL_CALL getField( const OUString & rName ) override;
 214     virtual css::uno::Sequence< css::uno::Reference< css::reflection::XIdlField > > SAL_CALL getFields() override;
 215     virtual void SAL_CALL createObject( css::uno::Any & rObj ) override;
 216 };
 217
 218
 219 class CompoundIdlClassImpl
 220     : public IdlClassImpl
 221 {
 222     css::uno::Reference< css::reflection::XIdlClass >
 223                                              _xSuperClass;
 224     std::optional< css::uno::Sequence< css::uno::Reference< css::reflection::XIdlField > > >
 225                                             m_xFields;
 226     OUString2Field                          _aName2Field;
 227
 228 public:
 229     typelib_CompoundTypeDescription * getTypeDescr() const
 230         { return reinterpret_cast<typelib_CompoundTypeDescription *>(IdlClassImpl::getTypeDescr()); }
 231
 232     // ctor/ dtor
 233     CompoundIdlClassImpl( IdlReflectionServiceImpl * pReflection,
 234                           const OUString & rName, typelib_TypeClass eTypeClass,
 235                           typelib_TypeDescription * pTypeDescr )
 236         : IdlClassImpl( pReflection, rName, eTypeClass, pTypeDescr )
 237         {}
 238     virtual ~CompoundIdlClassImpl() override;
 239
 240     // IdlClassImpl modifications
 241     virtual sal_Bool SAL_CALL isAssignableFrom( const css::uno::Reference< css::reflection::XIdlClass > & xType ) override;
 242     virtual css::uno::Sequence< css::uno::Reference< css::reflection::XIdlClass > > SAL_CALL getSuperclasses() override;
 243     virtual css::uno::Reference< css::reflection::XIdlField > SAL_CALL getField( const OUString & rName ) override;
 244     virtual css::uno::Sequence< css::uno::Reference< css::reflection::XIdlField > > SAL_CALL getFields() override;
 245 };
 246
 247
 248 typedef cppu::ImplInheritanceHelper<IdlClassImpl, css::reflection::XIdlArray> ArrayIdlClassImpl_Base;
 249 class ArrayIdlClassImpl : public ArrayIdlClassImpl_Base
 250 {
 251 public:
 252     typelib_IndirectTypeDescription * getTypeDescr() const
 253         { return reinterpret_cast<typelib_IndirectTypeDescription *>(IdlClassImpl::getTypeDescr()); }
 254
 255     // ctor
 256     ArrayIdlClassImpl( IdlReflectionServiceImpl * pReflection,
 257                        const OUString & rName, typelib_TypeClass eTypeClass,
 258                        typelib_TypeDescription * pTypeDescr )
 259         : ArrayIdlClassImpl_Base( pReflection, rName, eTypeClass, pTypeDescr )
 260         {}
 261
 262     // IdlClassImpl modifications
 263     virtual sal_Bool SAL_CALL isAssignableFrom( const css::uno::Reference< css::reflection::XIdlClass > & xType ) override;
 264     virtual css::uno::Reference< css::reflection::XIdlClass > SAL_CALL getComponentType() override;
 265     virtual css::uno::Reference< css::reflection::XIdlArray > SAL_CALL getArray() override;
 266
 267     // XIdlArray
 268     virtual void SAL_CALL realloc( css::uno::Any & rArray, sal_Int32 nLen ) override;
 269     virtual sal_Int32 SAL_CALL getLen( const css::uno::Any & rArray ) override;
 270     virtual css::uno::Any SAL_CALL get( const css::uno::Any & rArray, sal_Int32 nIndex ) override;
 271     virtual void SAL_CALL set( css::uno::Any & rArray, sal_Int32 nIndex, const css::uno::Any & rNewValue ) override;
 272 };
 273
 274
 275 class EnumIdlClassImpl
 276     : public IdlClassImpl
 277 {
 278     std::optional< css::uno::Sequence< css::uno::Reference< css::reflection::XIdlField > > > m_xFields;
 279     OUString2Field                       _aName2Field;
 280
 281 public:
 282     typelib_EnumTypeDescription * getTypeDescr() const
 283         { return reinterpret_cast<typelib_EnumTypeDescription *>(IdlClassImpl::getTypeDescr()); }
 284
 285     // ctor/ dtor
 286     EnumIdlClassImpl( IdlReflectionServiceImpl * pReflection,
 287                       const OUString & rName, typelib_TypeClass eTypeClass,
 288                       typelib_TypeDescription * pTypeDescr )
 289         : IdlClassImpl( pReflection, rName, eTypeClass, pTypeDescr )
 290         {}
 291     virtual ~EnumIdlClassImpl() override;
 292
 293     // IdlClassImpl modifications
 294     virtual css::uno::Reference< css::reflection::XIdlField > SAL_CALL getField( const OUString & rName ) override;
 295     virtual css::uno::Sequence< css::uno::Reference< css::reflection::XIdlField > > SAL_CALL getFields() override;
 296     virtual void SAL_CALL createObject( css::uno::Any & rObj ) override;
 297 };
 298
 299
 300 class IdlMemberImpl
 301     : public ::cppu::WeakImplHelper< css::reflection::XIdlMember >
 302 {
 303     rtl::Reference<IdlReflectionServiceImpl>
 304                                 m_xReflection;
 305     OUString                    _aName;
 306
 307     typelib_TypeDescription *   _pTypeDescr;
 308     typelib_TypeDescription *   _pDeclTypeDescr;
 309
 310 protected:
 311     css::uno::Reference< css::reflection::XIdlClass >      _xDeclClass;
 312
 313 public:
 314     IdlReflectionServiceImpl *  getReflection() const
 315         { return m_xReflection.get(); }
 316     typelib_TypeDescription *   getTypeDescr() const
 317         { return _pTypeDescr; }
 318     typelib_TypeDescription *   getDeclTypeDescr() const
 319         { return _pDeclTypeDescr; }
 320
 321     // ctor/ dtor
 322     IdlMemberImpl( IdlReflectionServiceImpl * pReflection, OUString aName,
 323                    typelib_TypeDescription * pTypeDescr, typelib_TypeDescription * pDeclTypeDescr );
 324     virtual ~IdlMemberImpl() override;
 325
 326     // XIdlMember
 327     virtual css::uno::Reference< css::reflection::XIdlClass > SAL_CALL getDeclaringClass() override;
 328     virtual OUString SAL_CALL getName() override;
 329 };
 330
 331
 332 // coerces to type descr pTo else queries for it: the interface pointer is returned via rDest
 333 // ## type to XidlClass coercion possible
 334 inline bool extract(
 335     const css::uno::Any & rObj, typelib_InterfaceTypeDescription * pTo,
 336     css::uno::Reference< css::uno::XInterface > & rDest,
 337     IdlReflectionServiceImpl * pRefl )
 338 {
 339     rDest.clear();
 340     if (nullptr != pTo)
 341     {
 342         if (! rObj.hasValue())
 343             return true;
 344         if (rObj.getValueTypeClass() == css::uno::TypeClass_INTERFACE)
 345         {
 346             return ::uno_type_assignData(
 347                 &rDest, pTo->aBase.pWeakRef,
 348                 const_cast< void * >( rObj.getValue() ), rObj.getValueTypeRef(),
 349                 reinterpret_cast< uno_QueryInterfaceFunc >(css::uno::cpp_queryInterface),
 350                 reinterpret_cast< uno_AcquireFunc >(css::uno::cpp_acquire),
 351                 reinterpret_cast< uno_ReleaseFunc >(css::uno::cpp_release) );
 352         }
 353         else if (auto t = o3tl::tryAccess<css::uno::Type>(rObj))
 354         {
 355             rDest = pRefl->forType( t->getTypeLibType() );
 356             return rDest.is();
 357         }
 358     }
 359     return false;
 360 }
 361
 362 inline bool coerce_assign(
 363     void * pDest, typelib_TypeDescription * pTD, const css::uno::Any & rSource,
 364     IdlReflectionServiceImpl * pRefl )
 365 {
 366     if (pTD->eTypeClass == typelib_TypeClass_INTERFACE)
 367     {
 368         css::uno::Reference< css::uno::XInterface > xVal;
 369         if (extract( rSource, reinterpret_cast<typelib_InterfaceTypeDescription *>(pTD), xVal, pRefl ))
 370         {
 371             if (*static_cast<css::uno::XInterface **>(pDest))
 372                 (*static_cast<css::uno::XInterface **>(pDest))->release();
 373             *static_cast<css::uno::XInterface **>(pDest) = xVal.get();
 374             if (*static_cast<css::uno::XInterface **>(pDest))
 375                 (*static_cast<css::uno::XInterface **>(pDest))->acquire();
 376             return true;
 377         }
 378         return false;
 379     }
 380     else if (pTD->eTypeClass == typelib_TypeClass_ANY)
 381     {
 382         return uno_assignData(
 383             pDest, pTD,
 384             const_cast<css::uno::Any *>(&rSource), pTD,
 385             reinterpret_cast< uno_QueryInterfaceFunc >(css::uno::cpp_queryInterface),
 386             reinterpret_cast< uno_AcquireFunc >(css::uno::cpp_acquire),
 387             reinterpret_cast< uno_ReleaseFunc >(css::uno::cpp_release) );
 388     }
 389     else
 390     {
 391         return uno_type_assignData(
 392             pDest, pTD->pWeakRef,
 393             const_cast<void *>(rSource.getValue()), rSource.getValueTypeRef(),
 394             reinterpret_cast< uno_QueryInterfaceFunc >(css::uno::cpp_queryInterface),
 395             reinterpret_cast< uno_AcquireFunc >(css::uno::cpp_acquire),
 396             reinterpret_cast< uno_ReleaseFunc >(css::uno::cpp_release) );
 397     }
 398 }
 399
 400 }
 401
 402 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */