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