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