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 #endif
 105         ~ImplHelper8() SAL_NOEXCEPT {}
 106     };
 107     /** Implementation helper implementing interfaces css::lang::XTypeProvider and
 108         css::uno::XInterface which supports weak mechanism to be held weakly
 109         (supporting css::uno::XWeak through ::cppu::OWeakObject).
 110
 111         @derive
 112         Inherit from this class giving your interface(s) to be implemented as template argument(s).
 113         Your sub class defines method implementations for these interface(s).
 114     */
 115     template< class Ifc1, class Ifc2, class Ifc3, class Ifc4, class Ifc5, class Ifc6, class Ifc7, class Ifc8 >
 116     class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE WeakImplHelper8
 117         : public OWeakObject
 118         , public css::lang::XTypeProvider
 119         , public Ifc1, public Ifc2, public Ifc3, public Ifc4, public Ifc5, public Ifc6, public Ifc7, public Ifc8
 120     {
 121         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> > > {};
 122     public:
 123         virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
 124             { return WeakImplHelper_query( rType, cd::get(), this, static_cast<OWeakObject *>(this) ); }
 125         virtual void SAL_CALL acquire() SAL_NOEXCEPT SAL_OVERRIDE
 126             { OWeakObject::acquire(); }
 127         virtual void SAL_CALL release() SAL_NOEXCEPT SAL_OVERRIDE
 128             { OWeakObject::release(); }
 129         virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
 130             { return WeakImplHelper_getTypes( cd::get() ); }
 131         virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
 132             { return ImplHelper_getImplementationId( cd::get() ); }
 133     };
 134     /** Implementation helper implementing interfaces css::lang::XTypeProvider and
 135         css::uno::XInterface which supports weak mechanism to be held weakly
 136         (supporting css::uno::XWeak through ::cppu::OWeakAggObject).
 137         In addition, it supports also aggregation meaning object of this class can be aggregated
 138         (css::uno::XAggregation through ::cppu::OWeakAggObject).
 139         If a delegator is set (this object is aggregated), then incoming queryInterface()
 140         calls are delegated to the delegator object. If the delegator does not support the
 141         demanded interface, it calls queryAggregation() on its aggregated objects.
 142
 143         @derive
 144         Inherit from this class giving your interface(s) to be implemented as template argument(s).
 145         Your sub class defines method implementations for these interface(s).
 146     */
 147     template< class Ifc1, class Ifc2, class Ifc3, class Ifc4, class Ifc5, class Ifc6, class Ifc7, class Ifc8 >
 148     class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE WeakAggImplHelper8
 149         : public OWeakAggObject
 150         , public css::lang::XTypeProvider
 151         , public Ifc1, public Ifc2, public Ifc3, public Ifc4, public Ifc5, public Ifc6, public Ifc7, public Ifc8
 152     {
 153         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> > > {};
 154     public:
 155         virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
 156             { return OWeakAggObject::queryInterface( rType ); }
 157         virtual css::uno::Any SAL_CALL queryAggregation( css::uno::Type const & rType ) SAL_OVERRIDE
 158             { return WeakAggImplHelper_queryAgg( rType, cd::get(), this, static_cast<OWeakAggObject *>(this) ); }
 159         virtual void SAL_CALL acquire() SAL_NOEXCEPT SAL_OVERRIDE
 160             { OWeakAggObject::acquire(); }
 161         virtual void SAL_CALL release() SAL_NOEXCEPT SAL_OVERRIDE
 162             { OWeakAggObject::release(); }
 163         virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
 164             { return WeakAggImplHelper_getTypes( cd::get() ); }
 165         virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
 166             { return ImplHelper_getImplementationId( cd::get() ); }
 167     };
 168     /** Implementation helper implementing interfaces css::lang::XTypeProvider and
 169         css::uno::XInterface inheriting from a BaseClass.
 170         All acquire() and release() calls are delegated to the BaseClass. Upon queryInterface(),
 171         if a demanded interface is not supported by this class directly, the request is
 172         delegated to the BaseClass.
 173
 174         @attention
 175         The BaseClass has to be complete in a sense, that css::uno::XInterface
 176         and css::lang::XTypeProvider are implemented properly.  The
 177         BaseClass must have at least one ctor that can be called with six or
 178         fewer arguments, of which none is of non-const reference type.
 179
 180         @derive
 181         Inherit from this class giving your additional interface(s) to be implemented as
 182         template argument(s). Your sub class defines method implementations for these interface(s).
 183     */
 184     template< class BaseClass, class Ifc1, class Ifc2, class Ifc3, class Ifc4, class Ifc5, class Ifc6, class Ifc7, class Ifc8 >
 185     class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE ImplInheritanceHelper8
 186         : public BaseClass
 187         , public Ifc1, public Ifc2, public Ifc3, public Ifc4, public Ifc5, public Ifc6, public Ifc7, public Ifc8
 188     {
 189         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> > > {};
 190     protected:
 191         template< typename T1 >
 192         explicit ImplInheritanceHelper8(T1 const & arg1): BaseClass(arg1) {}
 193         template< typename T1, typename T2 >
 194         ImplInheritanceHelper8(T1 const & arg1, T2 const & arg2):
 195             BaseClass(arg1, arg2) {}
 196         template< typename T1, typename T2, typename T3 >
 197         ImplInheritanceHelper8(
 198             T1 const & arg1, T2 const & arg2, T3 const & arg3):
 199             BaseClass(arg1, arg2, arg3) {}
 200         template< typename T1, typename T2, typename T3, typename T4 >
 201         ImplInheritanceHelper8(
 202             T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4):
 203             BaseClass(arg1, arg2, arg3, arg4) {}
 204         template<
 205             typename T1, typename T2, typename T3, typename T4, typename T5 >
 206         ImplInheritanceHelper8(
 207             T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4,
 208             T5 const & arg5):
 209             BaseClass(arg1, arg2, arg3, arg4, arg5) {}
 210         template<
 211             typename T1, typename T2, typename T3, typename T4, typename T5,
 212             typename T6 >
 213         ImplInheritanceHelper8(
 214             T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4,
 215             T5 const & arg5, T6 const & arg6):
 216             BaseClass(arg1, arg2, arg3, arg4, arg5, arg6) {}
 217     public:
 218         ImplInheritanceHelper8() {}
 219         virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
 220             {
 221                 css::uno::Any aRet( ImplHelper_queryNoXInterface( rType, cd::get(), this ) );
 222                 if (aRet.hasValue())
 223                     return aRet;
 224                 return BaseClass::queryInterface( rType );
 225             }
 226         virtual void SAL_CALL acquire() SAL_NOEXCEPT SAL_OVERRIDE
 227             { BaseClass::acquire(); }
 228         virtual void SAL_CALL release() SAL_NOEXCEPT SAL_OVERRIDE
 229             { BaseClass::release(); }
 230         virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
 231             { return ImplInhHelper_getTypes( cd::get(), BaseClass::getTypes() ); }
 232         virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
 233             { return ImplHelper_getImplementationId( cd::get() ); }
 234     };
 235     /** Implementation helper implementing interfaces css::lang::XTypeProvider and
 236         css::uno::XInterface inheriting from a BaseClass.
 237         All acquire(),  release() and queryInterface() calls are delegated to the BaseClass.
 238         Upon queryAggregation(), if a demanded interface is not supported by this class directly,
 239         the request is delegated to the BaseClass.
 240
 241         @attention
 242         The BaseClass has to be complete in a sense, that css::uno::XInterface,
 243         css::uno::XAggregation and css::lang::XTypeProvider
 244         are implemented properly.  The BaseClass must have at least one ctor
 245         that can be called with six or fewer arguments, of which none is of
 246         non-const reference type.
 247
 248         @derive
 249         Inherit from this class giving your additional interface(s) to be implemented as
 250         template argument(s). Your sub class defines method implementations for these interface(s).
 251     */
 252     template< class BaseClass, class Ifc1, class Ifc2, class Ifc3, class Ifc4, class Ifc5, class Ifc6, class Ifc7, class Ifc8 >
 253     class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE AggImplInheritanceHelper8
 254         : public BaseClass
 255         , public Ifc1, public Ifc2, public Ifc3, public Ifc4, public Ifc5, public Ifc6, public Ifc7, public Ifc8
 256     {
 257         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> > > {};
 258     protected:
 259         template< typename T1 >
 260         explicit AggImplInheritanceHelper8(T1 const & arg1): BaseClass(arg1) {}
 261         template< typename T1, typename T2 >
 262         AggImplInheritanceHelper8(T1 const & arg1, T2 const & arg2):
 263             BaseClass(arg1, arg2) {}
 264         template< typename T1, typename T2, typename T3 >
 265         AggImplInheritanceHelper8(
 266             T1 const & arg1, T2 const & arg2, T3 const & arg3):
 267             BaseClass(arg1, arg2, arg3) {}
 268         template< typename T1, typename T2, typename T3, typename T4 >
 269         AggImplInheritanceHelper8(
 270             T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4):
 271             BaseClass(arg1, arg2, arg3, arg4) {}
 272         template<
 273             typename T1, typename T2, typename T3, typename T4, typename T5 >
 274         AggImplInheritanceHelper8(
 275             T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4,
 276             T5 const & arg5):
 277             BaseClass(arg1, arg2, arg3, arg4, arg5) {}
 278         template<
 279             typename T1, typename T2, typename T3, typename T4, typename T5,
 280             typename T6 >
 281         AggImplInheritanceHelper8(
 282             T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4,
 283             T5 const & arg5, T6 const & arg6):
 284             BaseClass(arg1, arg2, arg3, arg4, arg5, arg6) {}
 285     public:
 286         AggImplInheritanceHelper8() {}
 287         virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
 288             { return BaseClass::queryInterface( rType ); }
 289         virtual css::uno::Any SAL_CALL queryAggregation( css::uno::Type const & rType ) SAL_OVERRIDE
 290             {
 291                 css::uno::Any aRet( ImplHelper_queryNoXInterface( rType, cd::get(), this ) );
 292                 if (aRet.hasValue())
 293                     return aRet;
 294                 return BaseClass::queryAggregation( rType );
 295             }
 296         virtual void SAL_CALL acquire() SAL_NOEXCEPT SAL_OVERRIDE
 297             { BaseClass::acquire(); }
 298         virtual void SAL_CALL release() SAL_NOEXCEPT SAL_OVERRIDE
 299             { BaseClass::release(); }
 300         virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
 301             { return ImplInhHelper_getTypes( cd::get(), BaseClass::getTypes() ); }
 302         virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
 303             { return ImplHelper_getImplementationId( cd::get() ); }
 304     };
 305 }
 306
 307 #endif
 308
 309 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */