vcl/inc/salusereventlist.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_VCL_INC_SALUSEREVENTLIST_HXX
  21 #define INCLUDED_VCL_INC_SALUSEREVENTLIST_HXX
  22
  23 #include <sal/config.h>
  24 #include <vcl/dllapi.h>
  25 #include <osl/mutex.hxx>
  26 #include <osl/thread.hxx>
  27
  28 #include <assert.h>
  29
  30 #include <list>
  31 #include <unordered_set>
  32
  33 class SalFrame;
  34 enum class SalEvent;
  35
  36 struct SalFrameHash : public std::hash<sal_IntPtr>
  37 {
  38     size_t operator()(const SalFrame* frame) const
  39         { return std::hash<sal_IntPtr>::operator()( reinterpret_cast<sal_IntPtr>(frame) ); }
  40 };
  41
  42 typedef std::unordered_set< SalFrame*, SalFrameHash > SalFrameSet;
  43
  44 class VCL_PLUGIN_PUBLIC SalUserEventList
  45 {
  46 public:
  47     struct SalUserEvent
  48     {
  49         SalFrame*     m_pFrame;
  50         void*         m_pData;
  51         SalEvent      m_nEvent;
  52
  53         SalUserEvent( SalFrame* pFrame, void* pData, SalEvent nEvent )
  54                 : m_pFrame( pFrame ),
  55                   m_pData( pData ),
  56                   m_nEvent( nEvent )
  57         {}
  58
  59         bool operator==(const SalUserEvent &aEvent) const
  60         {
  61             return m_pFrame == aEvent.m_pFrame
  62                 && m_pData == aEvent.m_pData
  63                 && m_nEvent== aEvent.m_nEvent;
  64         }
  65     };
  66
  67 protected:
  68     mutable osl::Mutex         m_aUserEventsMutex;
  69     std::list< SalUserEvent >  m_aUserEvents;
  70     std::list< SalUserEvent >  m_aProcessingUserEvents;
  71     bool                       m_bAllUserEventProcessedSignaled;
  72     SalFrameSet                m_aFrames;
  73     oslThreadIdentifier        m_aProcessingThread;
  74
  75     virtual void ProcessEvent( SalUserEvent aEvent ) = 0;
  76     virtual void TriggerUserEventProcessing() = 0;
  77     virtual void TriggerAllUserEventsProcessed() {};
  78
  79 public:
  80     SalUserEventList();
  81     virtual ~SalUserEventList();
  82
  83     inline const SalFrameSet& getFrames() const;
  84     inline SalFrame* anyFrame() const;
  85     void insertFrame( SalFrame* pFrame );
  86     void eraseFrame( SalFrame* pFrame );
  87     inline bool isFrameAlive( const SalFrame* pFrame ) const;
  88
  89     void PostEvent( SalFrame* pFrame, void* pData, SalEvent nEvent );
  90     void RemoveEvent( SalFrame* pFrame, void* pData, SalEvent nEvent );
  91     inline bool HasUserEvents() const;
  92
  93     bool DispatchUserEvents( bool bHandleAllCurrentEvents );
  94 };
  95
  96 inline SalFrame* SalUserEventList::anyFrame() const
  97 {
  98     if ( m_aFrames.empty() )
  99         return nullptr;
 100     return *m_aFrames.begin();
 101 }
 102
 103 inline bool SalUserEventList::isFrameAlive( const SalFrame* pFrame ) const
 104 {
 105     auto it = m_aFrames.find( const_cast<SalFrame*>( pFrame ) );
 106     return it != m_aFrames.end();
 107 }
 108
 109 inline bool SalUserEventList::HasUserEvents() const
 110 {
 111     osl::MutexGuard aGuard( m_aUserEventsMutex );
 112     return !(m_aUserEvents.empty() && m_aProcessingUserEvents.empty());
 113 }
 114
 115 inline void SalUserEventList::PostEvent( SalFrame* pFrame, void* pData, SalEvent nEvent )
 116 {
 117     osl::MutexGuard aGuard( m_aUserEventsMutex );
 118     m_aUserEvents.push_back( SalUserEvent( pFrame, pData, nEvent ) );
 119     m_bAllUserEventProcessedSignaled = false;
 120     TriggerUserEventProcessing();
 121 }
 122
 123 inline const SalFrameSet& SalUserEventList::getFrames() const
 124 {
 125     return m_aFrames;
 126 }
 127
 128 #endif // INCLUDED_VCL_INC_SALUSEREVENTLIST_HXX
 129
 130 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */