include/cppuhelper/compbase2.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 #ifndef INCLUDED_CPPUHELPER_COMPBASE2_HXX
  20 #define INCLUDED_CPPUHELPER_COMPBASE2_HXX
  21
  22 #include <cppuhelper/implbase2.hxx>
  23 #include <cppuhelper/compbase_ex.hxx>
  24
  25 namespace cppu
  26 {
  27
  28     /** Implementation helper supporting css::lang::XTypeProvider and
  29         css::lang::XComponent.
  30
  31         Upon disposing objects of this class, sub-classes receive a disposing()
  32         call.  Objects of this class can be held weakly, i.e. by a
  33         css::uno::WeakReference.
  34
  35         @attention
  36         The life-cycle of the passed mutex reference has to be longer than objects of this class.
  37
  38         @derive
  39         Inherit from this class giving your interface(s) to be implemented as template argument(s).
  40         Your sub class defines method implementations for these interface(s).
  41     */
  42     template< class Ifc1, class Ifc2 >
  43     class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE WeakComponentImplHelper2
  44         : public WeakComponentImplHelperBase
  45         , public css::lang::XTypeProvider
  46         , public Ifc1, public Ifc2
  47     {
  48         struct cd : public rtl::StaticAggregate< class_data, ImplClassData2 < Ifc1, Ifc2, WeakComponentImplHelper2<Ifc1, Ifc2> > > {};
  49     public:
  50         WeakComponentImplHelper2( ::osl::Mutex & rMutex ) throw ()
  51             : WeakComponentImplHelperBase( rMutex )
  52             {}
  53         virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
  54             { return WeakComponentImplHelper_query( rType, cd::get(), this, static_cast<WeakComponentImplHelperBase *>(this) ); }
  55         virtual void SAL_CALL acquire() throw () SAL_OVERRIDE
  56             { WeakComponentImplHelperBase::acquire(); }
  57         virtual void SAL_CALL release() throw () SAL_OVERRIDE
  58             { WeakComponentImplHelperBase::release(); }
  59         virtual void SAL_CALL dispose() SAL_OVERRIDE
  60             { WeakComponentImplHelperBase::dispose(); }
  61         virtual void SAL_CALL addEventListener(const css::uno::Reference< css::lang::XEventListener > & xListener) SAL_OVERRIDE
  62             { WeakComponentImplHelperBase::addEventListener(xListener); }
  63         virtual void SAL_CALL removeEventListener(const css::uno::Reference< css::lang::XEventListener > & xListener) SAL_OVERRIDE
  64             { WeakComponentImplHelperBase::removeEventListener(xListener); }
  65         virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
  66             { return WeakComponentImplHelper_getTypes( cd::get() ); }
  67         virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
  68             { return ImplHelper_getImplementationId( cd::get() ); }
  69     };
  70
  71     /** Same as WeakComponentImplHelper2, except doesn't implement
  72         addEventListener, removeEventListener and dispose.
  73
  74         This requires derived classes to implement those three methods.
  75         This makes it possible to implement classes which are required to
  76         implement methods from multiple bases which have different
  77         addEventListener/removeEventListener signatures without triggering
  78         the g++ overloaded-virtual warning
  79     */
  80     template< class Ifc1, class Ifc2 >
  81     class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE PartialWeakComponentImplHelper2
  82         : public WeakComponentImplHelperBase
  83         , public css::lang::XTypeProvider
  84         , public Ifc1, public Ifc2
  85     {
  86         struct cd : public rtl::StaticAggregate< class_data, ImplClassData2 < Ifc1, Ifc2, PartialWeakComponentImplHelper2<Ifc1, Ifc2> > > {};
  87     public:
  88         PartialWeakComponentImplHelper2( ::osl::Mutex & rMutex ) throw ()
  89             : WeakComponentImplHelperBase( rMutex )
  90             {}
  91         virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
  92             { return WeakComponentImplHelper_query( rType, cd::get(), this, static_cast<WeakComponentImplHelperBase *>(this) ); }
  93         virtual void SAL_CALL acquire() throw () SAL_OVERRIDE
  94             { WeakComponentImplHelperBase::acquire(); }
  95         virtual void SAL_CALL release() throw () SAL_OVERRIDE
  96             { WeakComponentImplHelperBase::release(); }
  97         virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
  98             { return WeakComponentImplHelper_getTypes( cd::get() ); }
  99         virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
 100             { return ImplHelper_getImplementationId( cd::get() ); }
 101     };
 102
 103
 104     /** Implementation helper supporting css::lang::XTypeProvider and
 105         css::lang::XComponent.
 106
 107         Upon disposing objects of this class, sub-classes receive a disposing()
 108         call.  Objects of this class can be held weakly, i.e. by a
 109         css::uno::WeakReference.  Object of this class can be
 110         aggregated, i.e. incoming queryInterface() calls are delegated.
 111
 112         @attention
 113         The life-cycle of the passed mutex reference has to be longer than objects of this class.
 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         @deprecated
 120     */
 121     template< class Ifc1, class Ifc2 >
 122     class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE WeakAggComponentImplHelper2
 123         : public WeakAggComponentImplHelperBase
 124         , public css::lang::XTypeProvider
 125         , public Ifc1, public Ifc2
 126     {
 127         struct cd : public rtl::StaticAggregate< class_data, ImplClassData2 < Ifc1, Ifc2, WeakAggComponentImplHelper2<Ifc1, Ifc2> > > {};
 128     public:
 129         WeakAggComponentImplHelper2( ::osl::Mutex & rMutex ) throw ()
 130             : WeakAggComponentImplHelperBase( rMutex )
 131             {}
 132         virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
 133             { return WeakAggComponentImplHelperBase::queryInterface( rType ); }
 134         virtual css::uno::Any SAL_CALL queryAggregation( css::uno::Type const & rType ) SAL_OVERRIDE
 135             { return WeakAggComponentImplHelper_queryAgg( rType, cd::get(), this, static_cast<WeakAggComponentImplHelperBase *>(this) ); }
 136         virtual void SAL_CALL acquire() throw () SAL_OVERRIDE
 137             { WeakAggComponentImplHelperBase::acquire(); }
 138         virtual void SAL_CALL release() throw () SAL_OVERRIDE
 139             { WeakAggComponentImplHelperBase::release(); }
 140         virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
 141             { return WeakAggComponentImplHelper_getTypes( cd::get() ); }
 142         virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
 143             { return ImplHelper_getImplementationId( cd::get() ); }
 144     };
 145 }
 146
 147 #endif
 148
 149 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */