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