include/cppuhelper/implbase5.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_CPPUHELPER_IMPLBASE5_HXX
  20 #define INCLUDED_CPPUHELPER_IMPLBASE5_HXX
  21
  22 #include "cppuhelper/implbase_ex.hxx"
  23 #include "rtl/instance.hxx"
  24 #include "cppuhelper/weak.hxx"
  25 #include "cppuhelper/weakagg.hxx"
  26 #include "com/sun/star/lang/XTypeProvider.hpp"
  27
  28 namespace cppu
  29 {
  30     /// @cond INTERNAL
  31
  32     struct class_data5
  33     {
  34         sal_Int16 m_nTypes;
  35         sal_Bool m_storedTypeRefs;
  36         sal_Bool m_storedId;
  37         sal_Int8 m_id[ 16 ];
  38         type_entry m_typeEntries[ 5 + 1 ];
  39     };
  40
  41     template< typename Ifc1, typename Ifc2, typename Ifc3, typename Ifc4, typename Ifc5, typename Impl >
  42         struct SAL_WARN_UNUSED ImplClassData5
  43     {
  44         class_data* operator ()()
  45         {
  46             static class_data5 s_cd =
  47             {
  48                 5 +1, false, false,
  49                 { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
  50                 {
  51                     CPPUHELPER_DETAIL_TYPEENTRY(Ifc1),
  52                     CPPUHELPER_DETAIL_TYPEENTRY(Ifc2),
  53                     CPPUHELPER_DETAIL_TYPEENTRY(Ifc3),
  54                     CPPUHELPER_DETAIL_TYPEENTRY(Ifc4),
  55                     CPPUHELPER_DETAIL_TYPEENTRY(Ifc5),
  56                     CPPUHELPER_DETAIL_TYPEENTRY(css::lang::XTypeProvider)
  57                 }
  58             };
  59             return reinterpret_cast< class_data * >(&s_cd);
  60         }
  61     };
  62
  63     /// @endcond
  64
  65     /** Implementation helper implementing interface css::lang::XTypeProvider
  66         and method XInterface::queryInterface(), but no reference counting.
  67
  68         @derive
  69         Inherit from this class giving your interface(s) to be implemented as template argument(s).
  70         Your sub class defines method implementations for these interface(s) including acquire()/
  71         release() and delegates incoming queryInterface() calls to this base class.
  72     */
  73     template< class Ifc1, class Ifc2, class Ifc3, class Ifc4, class Ifc5 >
  74     class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE ImplHelper5
  75         : public css::lang::XTypeProvider
  76         , public Ifc1, public Ifc2, public Ifc3, public Ifc4, public Ifc5
  77     {
  78         struct cd : public rtl::StaticAggregate< class_data, ImplClassData5 < Ifc1, Ifc2, Ifc3, Ifc4, Ifc5, ImplHelper5<Ifc1, Ifc2, Ifc3, Ifc4, Ifc5> > > {};
  79     public:
  80 #if defined LIBO_INTERNAL_ONLY
  81         ImplHelper5() = default;
  82         ImplHelper5(ImplHelper5 const &) = default;
  83         ImplHelper5(ImplHelper5 &&) = default;
  84         ImplHelper5 & operator =(ImplHelper5 const &) = default;
  85         ImplHelper5 & operator =(ImplHelper5 &&) = default;
  86 #endif
  87
  88         virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
  89             { return ImplHelper_query( rType, cd::get(), this ); }
  90         virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
  91             { return ImplHelper_getTypes( cd::get() ); }
  92         virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
  93             { return ImplHelper_getImplementationId( cd::get() ); }
  94
  95 #if !defined _MSC_VER // public -> protected changes mangled names there
  96     protected:
  97 #elif defined __clang__
  98 #pragma clang diagnostic push
  99 #pragma clang diagnostic ignored "-Wnon-virtual-dtor"
 100 #endif
 101         ~ImplHelper5() throw () {}
 102 #if defined _MSC_VER && defined __clang__
 103 #pragma clang diagnostic pop
 104 #endif
 105     };
 106     /** Implementation helper implementing interfaces css::lang::XTypeProvider and
 107         css::uno::XInterface which supports weak mechanism to be held weakly
 108         (supporting css::uno::XWeak thru ::cppu::OWeakObject).
 109
 110         @derive
 111         Inherit from this class giving your interface(s) to be implemented as template argument(s).
 112         Your sub class defines method implementations for these interface(s).
 113     */
 114     template< class Ifc1, class Ifc2, class Ifc3, class Ifc4, class Ifc5 >
 115     class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE WeakImplHelper5
 116         : public OWeakObject
 117         , public css::lang::XTypeProvider
 118         , public Ifc1, public Ifc2, public Ifc3, public Ifc4, public Ifc5
 119     {
 120         struct cd : public rtl::StaticAggregate< class_data, ImplClassData5 < Ifc1, Ifc2, Ifc3, Ifc4, Ifc5, WeakImplHelper5<Ifc1, Ifc2, Ifc3, Ifc4, Ifc5> > > {};
 121     public:
 122         virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
 123             { return WeakImplHelper_query( rType, cd::get(), this, static_cast<OWeakObject *>(this) ); }
 124         virtual void SAL_CALL acquire() throw () SAL_OVERRIDE
 125             { OWeakObject::acquire(); }
 126         virtual void SAL_CALL release() throw () SAL_OVERRIDE
 127             { OWeakObject::release(); }
 128         virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
 129             { return WeakImplHelper_getTypes( cd::get() ); }
 130         virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
 131             { return ImplHelper_getImplementationId( cd::get() ); }
 132     };
 133     /** Implementation helper implementing interfaces css::lang::XTypeProvider and
 134         css::uno::XInterface which supports weak mechanism to be held weakly
 135         (supporting css::uno::XWeak thru ::cppu::OWeakAggObject).
 136         In addition, it supports also aggregation meaning object of this class can be aggregated
 137         (css::uno::XAggregation thru ::cppu::OWeakAggObject).
 138         If a delegator is set (this object is aggregated), then incoming queryInterface()
 139         calls are delegated to the delegator object. If the delegator does not support the
 140         demanded interface, it calls queryAggregation() on its aggregated objects.
 141
 142         @derive
 143         Inherit from this class giving your interface(s) to be implemented as template argument(s).
 144         Your sub class defines method implementations for these interface(s).
 145     */
 146     template< class Ifc1, class Ifc2, class Ifc3, class Ifc4, class Ifc5 >
 147     class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE WeakAggImplHelper5
 148         : public OWeakAggObject
 149         , public css::lang::XTypeProvider
 150         , public Ifc1, public Ifc2, public Ifc3, public Ifc4, public Ifc5
 151     {
 152         struct cd : public rtl::StaticAggregate< class_data, ImplClassData5 < Ifc1, Ifc2, Ifc3, Ifc4, Ifc5, WeakAggImplHelper5<Ifc1, Ifc2, Ifc3, Ifc4, Ifc5> > > {};
 153     public:
 154         virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
 155             { return OWeakAggObject::queryInterface( rType ); }
 156         virtual css::uno::Any SAL_CALL queryAggregation( css::uno::Type const & rType ) SAL_OVERRIDE
 157             { return WeakAggImplHelper_queryAgg( rType, cd::get(), this, static_cast<OWeakAggObject *>(this) ); }
 158         virtual void SAL_CALL acquire() throw () SAL_OVERRIDE
 159             { OWeakAggObject::acquire(); }
 160         virtual void SAL_CALL release() throw () SAL_OVERRIDE
 161             { OWeakAggObject::release(); }
 162         virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
 163             { return WeakAggImplHelper_getTypes( cd::get() ); }
 164         virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
 165             { return ImplHelper_getImplementationId( cd::get() ); }
 166     };
 167     /** Implementation helper implementing interfaces css::lang::XTypeProvider and
 168         css::uno::XInterface inherting from a BaseClass.
 169         All acquire() and release() calls are delegated to the BaseClass. Upon queryInterface(),
 170         if a demanded interface is not supported by this class directly, the request is
 171         delegated to the BaseClass.
 172
 173         @attention
 174         The BaseClass has to be complete in a sense, that css::uno::XInterface
 175         and css::lang::XTypeProvider are implemented properly.  The
 176         BaseClass must have at least one ctor that can be called with six or
 177         fewer arguments, of which none is of non-const reference type.
 178
 179         @derive
 180         Inherit from this class giving your additional interface(s) to be implemented as
 181         template argument(s). Your sub class defines method implementations for these interface(s).
 182     */
 183     template< class BaseClass, class Ifc1, class Ifc2, class Ifc3, class Ifc4, class Ifc5 >
 184     class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE ImplInheritanceHelper5
 185         : public BaseClass
 186         , public Ifc1, public Ifc2, public Ifc3, public Ifc4, public Ifc5
 187     {
 188         struct cd : public rtl::StaticAggregate< class_data, ImplClassData5 < Ifc1, Ifc2, Ifc3, Ifc4, Ifc5, ImplInheritanceHelper5<BaseClass, Ifc1, Ifc2, Ifc3, Ifc4, Ifc5> > > {};
 189     protected:
 190         template< typename T1 >
 191         explicit ImplInheritanceHelper5(T1 const & arg1): BaseClass(arg1) {}
 192         template< typename T1, typename T2 >
 193         ImplInheritanceHelper5(T1 const & arg1, T2 const & arg2):
 194             BaseClass(arg1, arg2) {}
 195         template< typename T1, typename T2, typename T3 >
 196         ImplInheritanceHelper5(
 197             T1 const & arg1, T2 const & arg2, T3 const & arg3):
 198             BaseClass(arg1, arg2, arg3) {}
 199         template< typename T1, typename T2, typename T3, typename T4 >
 200         ImplInheritanceHelper5(
 201             T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4):
 202             BaseClass(arg1, arg2, arg3, arg4) {}
 203         template<
 204             typename T1, typename T2, typename T3, typename T4, typename T5 >
 205         ImplInheritanceHelper5(
 206             T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4,
 207             T5 const & arg5):
 208             BaseClass(arg1, arg2, arg3, arg4, arg5) {}
 209         template<
 210             typename T1, typename T2, typename T3, typename T4, typename T5,
 211             typename T6 >
 212         ImplInheritanceHelper5(
 213             T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4,
 214             T5 const & arg5, T6 const & arg6):
 215             BaseClass(arg1, arg2, arg3, arg4, arg5, arg6) {}
 216     public:
 217         ImplInheritanceHelper5() {}
 218         virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
 219             {
 220                 css::uno::Any aRet( ImplHelper_queryNoXInterface( rType, cd::get(), this ) );
 221                 if (aRet.hasValue())
 222                     return aRet;
 223                 return BaseClass::queryInterface( rType );
 224             }
 225         virtual void SAL_CALL acquire() throw () SAL_OVERRIDE
 226             { BaseClass::acquire(); }
 227         virtual void SAL_CALL release() throw () SAL_OVERRIDE
 228             { BaseClass::release(); }
 229         virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
 230             { return ImplInhHelper_getTypes( cd::get(), BaseClass::getTypes() ); }
 231         virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
 232             { return ImplHelper_getImplementationId( cd::get() ); }
 233     };
 234     /** Implementation helper implementing interfaces css::lang::XTypeProvider and
 235         css::uno::XInterface inherting from a BaseClass.
 236         All acquire(),  release() and queryInterface() calls are delegated to the BaseClass.
 237         Upon queryAggregation(), if a demanded interface is not supported by this class directly,
 238         the request is delegated to the BaseClass.
 239
 240         @attention
 241         The BaseClass has to be complete in a sense, that css::uno::XInterface,
 242         css::uno::XAggregation and css::lang::XTypeProvider
 243         are implemented properly.  The BaseClass must have at least one ctor
 244         that can be called with six or fewer arguments, of which none is of
 245         non-const reference type.
 246
 247         @derive
 248         Inherit from this class giving your additional interface(s) to be implemented as
 249         template argument(s). Your sub class defines method implementations for these interface(s).
 250     */
 251     template< class BaseClass, class Ifc1, class Ifc2, class Ifc3, class Ifc4, class Ifc5 >
 252     class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE AggImplInheritanceHelper5
 253         : public BaseClass
 254         , public Ifc1, public Ifc2, public Ifc3, public Ifc4, public Ifc5
 255     {
 256         struct cd : public rtl::StaticAggregate< class_data, ImplClassData5 < Ifc1, Ifc2, Ifc3, Ifc4, Ifc5, AggImplInheritanceHelper5<BaseClass, Ifc1, Ifc2, Ifc3, Ifc4, Ifc5> > > {};
 257     protected:
 258         template< typename T1 >
 259         explicit AggImplInheritanceHelper5(T1 const & arg1): BaseClass(arg1) {}
 260         template< typename T1, typename T2 >
 261         AggImplInheritanceHelper5(T1 const & arg1, T2 const & arg2):
 262             BaseClass(arg1, arg2) {}
 263         template< typename T1, typename T2, typename T3 >
 264         AggImplInheritanceHelper5(
 265             T1 const & arg1, T2 const & arg2, T3 const & arg3):
 266             BaseClass(arg1, arg2, arg3) {}
 267         template< typename T1, typename T2, typename T3, typename T4 >
 268         AggImplInheritanceHelper5(
 269             T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4):
 270             BaseClass(arg1, arg2, arg3, arg4) {}
 271         template<
 272             typename T1, typename T2, typename T3, typename T4, typename T5 >
 273         AggImplInheritanceHelper5(
 274             T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4,
 275             T5 const & arg5):
 276             BaseClass(arg1, arg2, arg3, arg4, arg5) {}
 277         template<
 278             typename T1, typename T2, typename T3, typename T4, typename T5,
 279             typename T6 >
 280         AggImplInheritanceHelper5(
 281             T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4,
 282             T5 const & arg5, T6 const & arg6):
 283             BaseClass(arg1, arg2, arg3, arg4, arg5, arg6) {}
 284     public:
 285         AggImplInheritanceHelper5() {}
 286         virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
 287             { return BaseClass::queryInterface( rType ); }
 288         virtual css::uno::Any SAL_CALL queryAggregation( css::uno::Type const & rType ) SAL_OVERRIDE
 289             {
 290                 css::uno::Any aRet( ImplHelper_queryNoXInterface( rType, cd::get(), this ) );
 291                 if (aRet.hasValue())
 292                     return aRet;
 293                 return BaseClass::queryAggregation( rType );
 294             }
 295         virtual void SAL_CALL acquire() throw () SAL_OVERRIDE
 296             { BaseClass::acquire(); }
 297         virtual void SAL_CALL release() throw () SAL_OVERRIDE
 298             { BaseClass::release(); }
 299         virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
 300             { return ImplInhHelper_getTypes( cd::get(), BaseClass::getTypes() ); }
 301         virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
 302             { return ImplHelper_getImplementationId( cd::get() ); }
 303     };
 304 }
 305
 306 #endif
 307
 308 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */