UnoControls/inc/multiplexer.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 #pragma once
  21
  22 #include <com/sun/star/awt/XKeyListener.hpp>
  23 #include <com/sun/star/awt/XPaintListener.hpp>
  24 #include <com/sun/star/awt/XMouseMotionListener.hpp>
  25 #include <com/sun/star/awt/XWindow.hpp>
  26 #include <com/sun/star/awt/XWindowListener.hpp>
  27 #include <com/sun/star/awt/XMouseListener.hpp>
  28 #include <com/sun/star/awt/XFocusListener.hpp>
  29 #include <comphelper/compbase.hxx>
  30 #include <comphelper/interfacecontainer4.hxx>
  31 #include <cppuhelper/weakref.hxx>
  32
  33 #include <type_traits>
  34
  35 namespace unocontrols {
  36
  37 template <class Listener> extern int Add; // dummy
  38 template <class Listener> extern int Remove; // dummy
  39
  40 template <> constexpr inline auto Add<css::awt::XFocusListener> = &css::awt::XWindow::addFocusListener;
  41 template <> constexpr inline auto Remove<css::awt::XFocusListener> = &css::awt::XWindow::removeFocusListener;
  42
  43 template <> constexpr inline auto Add<css::awt::XWindowListener> = &css::awt::XWindow::addWindowListener;
  44 template <> constexpr inline auto Remove<css::awt::XWindowListener> = &css::awt::XWindow::removeWindowListener;
  45
  46 template <> constexpr inline auto Add<css::awt::XKeyListener> = &css::awt::XWindow::addKeyListener;
  47 template <> constexpr inline auto Remove<css::awt::XKeyListener> = &css::awt::XWindow::removeKeyListener;
  48
  49 template <> constexpr inline auto Add<css::awt::XMouseListener> = &css::awt::XWindow::addMouseListener;
  50 template <> constexpr inline auto Remove<css::awt::XMouseListener> = &css::awt::XWindow::removeMouseListener;
  51
  52 template <> constexpr inline auto Add<css::awt::XMouseMotionListener> = &css::awt::XWindow::addMouseMotionListener;
  53 template <> constexpr inline auto Remove<css::awt::XMouseMotionListener> = &css::awt::XWindow::removeMouseMotionListener;
  54
  55 template <> constexpr inline auto Add<css::awt::XPaintListener> = &css::awt::XWindow::addPaintListener;
  56 template <> constexpr inline auto Remove<css::awt::XPaintListener> = &css::awt::XWindow::removePaintListener;
  57
  58 template <class Ifc> class Listeners
  59 {
  60 protected:
  61     comphelper::OInterfaceContainerHelper4<Ifc> list;
  62 };
  63
  64 template <class... Ifc>
  65 class ContainersHolder : public comphelper::WeakImplHelper<Ifc...>, public Listeners<Ifc>...
  66 {
  67 protected:
  68     template <typename F> void for_each_container(F f) { (..., f(Listeners<Ifc>::list)); }
  69
  70     template <class Ifc1>
  71     void notifyPeer(const css::uno::Reference<css::awt::XWindow>& peer,
  72                     void (SAL_CALL css::awt::XWindow::*func)(const css::uno::Reference<Ifc1>&))
  73     {
  74         if (peer)
  75             (peer.get()->*func)(this);
  76     }
  77
  78     template <class Ifc1>
  79     void add(std::unique_lock<std::mutex>& guard, const css::uno::Reference<Ifc1>& listener,
  80              const css::uno::Reference<css::awt::XWindow>& peer)
  81     {
  82         assert(listener);
  83         if (Listeners<Ifc1>::list.addInterface(guard, listener) == 1)
  84         {
  85             // the first listener is added
  86             notifyPeer(peer, Add<Ifc1>);
  87         }
  88     }
  89
  90     template <class Ifc1>
  91     void remove(std::unique_lock<std::mutex>& guard, const css::uno::Reference<Ifc1>& listener,
  92                 const css::uno::Reference<css::awt::XWindow>& peer)
  93     {
  94         if (Listeners<Ifc1>::list.removeInterface(guard, listener) == 0)
  95         {
  96             // the last listener is removed
  97             notifyPeer(peer, Remove<Ifc1>);
  98         }
  99     }
 100 };
 101
 102 class OMRCListenerMultiplexerHelper final : public ContainersHolder< css::awt::XFocusListener
 103                                                                    , css::awt::XWindowListener
 104                                                                    , css::awt::XKeyListener
 105                                                                    , css::awt::XMouseListener
 106                                                                    , css::awt::XMouseMotionListener
 107                                                                    , css::awt::XPaintListener >
 108 {
 109 public:
 110
 111     /**
 112         @short      constructor
 113         @descr      Create a Multiplexer of XWindowEvents.
 114         @param      rControl    The control. All listeners think that this is the original broadcaster.
 115         @param      rPeer       The peer from which the original events are dispatched. Null is allowed.
 116     */
 117
 118     OMRCListenerMultiplexerHelper(  const   css::uno::Reference< css::awt::XWindow >& xControl    ,
 119                                     const   css::uno::Reference< css::awt::XWindow >& xPeer       );
 120
 121     virtual ~OMRCListenerMultiplexerHelper() override;
 122
 123     OMRCListenerMultiplexerHelper& operator= ( const OMRCListenerMultiplexerHelper& aCopyInstance );
 124
 125     //  container methods
 126
 127     /**
 128         @short      Remove all listeners from the previous set peer and add the needed listeners to rPeer.
 129         @param      rPeer       The peer from which the original events are dispatched. Null is allowed.
 130     */
 131
 132     void setPeer( const css::uno::Reference< css::awt::XWindow >& xPeer );
 133
 134     /**
 135         @short      Remove all listeners and send a disposing message.
 136     */
 137
 138     void disposeAndClear();
 139
 140     /**
 141         @short      Add the specified listener to the source.
 142     */
 143
 144     template <class Interface> void advise(const css::uno::Reference<Interface>& xListener)
 145     {
 146         std::unique_lock aGuard(m_aMutex);
 147         add(aGuard, xListener, m_xPeer);
 148     }
 149
 150     /**
 151         @short      Remove the specified listener from the source.
 152     */
 153
 154     template <class Interface> void unadvise(const css::uno::Reference<Interface>& xListener)
 155     {
 156         std::unique_lock aGuard(m_aMutex);
 157         remove(aGuard, xListener, m_xPeer);
 158     }
 159
 160     //  XEventListener
 161
 162     virtual void SAL_CALL disposing(const css::lang::EventObject& aSource) override;
 163
 164     //  XFocusListener
 165
 166     virtual void SAL_CALL focusGained(const css::awt::FocusEvent& aEvent ) override;
 167
 168     virtual void SAL_CALL focusLost(const css::awt::FocusEvent& aEvent ) override;
 169
 170     //  XWindowListener
 171
 172     virtual void SAL_CALL windowResized(const css::awt::WindowEvent& aEvent ) override;
 173
 174     virtual void SAL_CALL windowMoved(const css::awt::WindowEvent& aEvent ) override;
 175
 176     virtual void SAL_CALL windowShown(const css::lang::EventObject& aEvent ) override;
 177
 178     virtual void SAL_CALL windowHidden(const css::lang::EventObject& aEvent ) override;
 179
 180     //  XKeyListener
 181
 182     virtual void SAL_CALL keyPressed( const css::awt::KeyEvent& aEvent ) override;
 183
 184     virtual void SAL_CALL keyReleased( const css::awt::KeyEvent& aEvent ) override;
 185
 186     //  XMouseListener
 187
 188     virtual void SAL_CALL mousePressed(const css::awt::MouseEvent& aEvent ) override;
 189
 190     virtual void SAL_CALL mouseReleased(const css::awt::MouseEvent& aEvent ) override;
 191
 192     virtual void SAL_CALL mouseEntered(const css::awt::MouseEvent& aEvent ) override;
 193
 194     virtual void SAL_CALL mouseExited(const css::awt::MouseEvent& aEvent ) override;
 195
 196     //  XMouseMotionListener
 197
 198     virtual void SAL_CALL mouseDragged(const css::awt::MouseEvent& aEvent ) override;
 199
 200     virtual void SAL_CALL mouseMoved(const css::awt::MouseEvent& aEvent ) override;
 201
 202     //  XPaintListener
 203
 204     virtual void SAL_CALL windowPaint(const css::awt::PaintEvent& aEvent ) override;
 205
 206 private:
 207     template <class Interface, typename Event>
 208     void Multiplex(void (SAL_CALL Interface::*method)(const Event&), const Event& event);
 209
 210 //  private variables
 211
 212 private:
 213     css::uno::Reference< css::awt::XWindow >      m_xPeer;   /// The source of the events. Normally this is the peer object.
 214     css::uno::WeakReference< css::awt::XWindow >  m_xControl;
 215 };
 216
 217 }
 218
 219
 220 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */