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