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