include/cppuhelper/compbase.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 #ifndef INCLUDED_CPPUHELPER_COMPBASE_HXX
  21 #define INCLUDED_CPPUHELPER_COMPBASE_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <exception>
  26
  27 #include <com/sun/star/lang/XTypeProvider.hpp>
  28 #include <com/sun/star/uno/Any.hxx>
  29 #include <com/sun/star/uno/Reference.hxx>
  30 #include <com/sun/star/uno/RuntimeException.hpp>
  31 #include <com/sun/star/uno/Sequence.hxx>
  32 #include <com/sun/star/uno/Type.hxx>
  33 #include <cppuhelper/compbase_ex.hxx>
  34 #include <cppuhelper/implbase.hxx>
  35 #include <rtl/instance.hxx>
  36 #include <sal/types.h>
  37
  38 namespace com { namespace sun { namespace star { namespace lang {
  39     class XEventListener;
  40 } } } }
  41 namespace osl { class Mutex; }
  42
  43 #if defined LIBO_INTERNAL_ONLY
  44
  45 // A replacement for WeakAggComponentImplHelper1 has deliberately been left out,
  46 // as the underlying aggregation mechanism is known broken in general and should
  47 // not be used.
  48
  49 namespace cppu {
  50
  51 /** Implementation helper implementing interfaces
  52     css::uno::XInterface, css::lang::XTypeProvider, and
  53     css::lang::XComponent.
  54
  55     Like WeakComponentImplHelper, but does not define
  56     XComponent::add/removeEventListener.  Use for classes deriving from multiple
  57     UNO interfaces with competing add/removeEventListener methods, to avoid
  58     warnings about hiding of overloaded virtual functions.
  59
  60     Upon disposing objects of this class, sub-classes receive a disposing()
  61     call.
  62
  63     @attention
  64     The mutex reference passed to the constructor has to outlive the constructed
  65     instance.
  66 */
  67 template<typename... Ifc>
  68 class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE PartialWeakComponentImplHelper:
  69     public WeakComponentImplHelperBase, public css::lang::XTypeProvider,
  70     public Ifc...
  71 {
  72     struct cd:
  73         rtl::StaticAggregate<
  74             class_data,
  75             detail::ImplClassData<PartialWeakComponentImplHelper, Ifc...>>
  76     {};
  77
  78 public:
  79     PartialWeakComponentImplHelper(osl::Mutex & mutex) throw ():
  80         WeakComponentImplHelperBase(mutex) {}
  81
  82     css::uno::Any SAL_CALL queryInterface(css::uno::Type const & aType) SAL_OVERRIDE
  83     { return WeakComponentImplHelper_query(aType, cd::get(), this, this); }
  84
  85     void SAL_CALL acquire() throw () SAL_OVERRIDE
  86     { WeakComponentImplHelperBase::acquire(); }
  87
  88     void SAL_CALL release() throw () SAL_OVERRIDE
  89     { WeakComponentImplHelperBase::release(); }
  90
  91     void SAL_CALL dispose()
  92         SAL_OVERRIDE
  93     { WeakComponentImplHelperBase::dispose(); }
  94
  95     css::uno::Sequence<css::uno::Type> SAL_CALL getTypes() SAL_OVERRIDE
  96     { return WeakComponentImplHelper_getTypes(cd::get()); }
  97
  98     css::uno::Sequence<sal_Int8> SAL_CALL getImplementationId() SAL_OVERRIDE
  99     { return css::uno::Sequence<sal_Int8>(); }
 100 };
 101
 102 /** Implementation helper implementing interfaces
 103     css::uno::XInterface, css::lang::XTypeProvider, and
 104     css::lang::XComponent.
 105
 106     Upon disposing objects of this class, sub-classes receive a disposing()
 107     call.
 108
 109     @attention
 110     The mutex reference passed to the constructor has to outlive the constructed
 111     instance.
 112 */
 113 template<typename... Ifc>
 114 class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE WeakComponentImplHelper:
 115     public PartialWeakComponentImplHelper<Ifc...>
 116 {
 117 public:
 118     WeakComponentImplHelper(osl::Mutex & mutex) throw ():
 119         PartialWeakComponentImplHelper<Ifc...>(mutex) {}
 120
 121     void SAL_CALL addEventListener(
 122         css::uno::Reference<css::lang::XEventListener> const & xListener) SAL_OVERRIDE
 123     { WeakComponentImplHelperBase::addEventListener(xListener); }
 124
 125     void SAL_CALL removeEventListener(
 126         css::uno::Reference<css::lang::XEventListener> const & aListener) SAL_OVERRIDE
 127     { WeakComponentImplHelperBase::removeEventListener(aListener); }
 128 };
 129
 130 }
 131
 132 #endif
 133
 134 #endif
 135
 136 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */