vcl/win/app/saltimer.cxx

   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 #include <sal/config.h>
  21 #include <sal/log.hxx>
  22
  23 #include <tools/time.hxx>
  24
  25 #include <svsys.h>
  26 #include <win/saldata.hxx>
  27 #include <win/saltimer.h>
  28 #include <win/salinst.h>
  29
  30 void CALLBACK SalTimerProc(PVOID pParameter, BOOLEAN bTimerOrWaitFired);
  31
  32 // See http://msdn.microsoft.com/en-us/library/windows/desktop/ms687003%28v=vs.85%29.aspx
  33 // (and related pages) for details about the Timer Queues.
  34
  35 // in order to prevent concurrent execution of ImplSalStartTimer and double
  36 // deletion of timer (which is extremely likely, given that
  37 // INVALID_HANDLE_VALUE waits for the callback to run on the main thread),
  38 // this must run on the main thread too
  39 void WinSalTimer::ImplStop()
  40 {
  41     SalData *const pSalData = GetSalData();
  42     const WinSalInstance *pInst = pSalData->mpInstance;
  43     assert( !pInst || pSalData->mnAppThreadId == GetCurrentThreadId() );
  44
  45     if ( m_bSetTimerRunning )
  46     {
  47         m_bSetTimerRunning = false;
  48         KillTimer( GetSalData()->mpInstance->mhComWnd, m_aWmTimerId );
  49     }
  50     m_bDirectTimeout = false;
  51
  52     const HANDLE hTimer = m_nTimerId;
  53     if ( nullptr == hTimer )
  54         return;
  55
  56     m_nTimerId = nullptr;
  57     DeleteTimerQueueTimer( nullptr, hTimer, INVALID_HANDLE_VALUE );
  58     // Keep InvalidateEvent after DeleteTimerQueueTimer, because the event id
  59     // is set in SalTimerProc, which DeleteTimerQueueTimer will finish or cancel.
  60     InvalidateEvent();
  61 }
  62
  63 void WinSalTimer::ImplStart( sal_uInt64 nMS )
  64 {
  65     SalData* pSalData = GetSalData();
  66     assert( !pSalData->mpInstance || pSalData->mnAppThreadId == GetCurrentThreadId() );
  67
  68     // DueTime parameter is a DWORD, which is always an unsigned 32bit
  69     if (nMS > SAL_MAX_UINT32)
  70         nMS = SAL_MAX_UINT32;
  71
  72     // cannot change a one-shot timer, so delete it and create a new one
  73     ImplStop();
  74
  75     // directly indicate an elapsed timer
  76     m_bDirectTimeout = ( 0 == nMS );
  77     // probably WT_EXECUTEONLYONCE is not needed, but it enforces Period
  78     // to be 0 and should not hurt; also see
  79     // https://www.microsoft.com/msj/0499/pooling/pooling.aspx
  80     if ( !m_bDirectTimeout )
  81         CreateTimerQueueTimer(&m_nTimerId, nullptr, SalTimerProc, this,
  82                               nMS, 0, WT_EXECUTEINTIMERTHREAD | WT_EXECUTEONLYONCE);
  83     else if ( m_bForceRealTimer )
  84     {
  85         // so we don't block the nested message queue in move and resize
  86         // with posted 0ms SAL_MSG_TIMER_CALLBACK messages
  87         SetTimer( GetSalData()->mpInstance->mhComWnd, m_aWmTimerId,
  88                   USER_TIMER_MINIMUM, nullptr );
  89         m_bSetTimerRunning = true;
  90     }
  91     // we don't need any wakeup message, as this code can just run in the
  92     // main thread!
  93 }
  94
  95 WinSalTimer::WinSalTimer()
  96     : m_nTimerId( nullptr )
  97     , m_bDirectTimeout( false )
  98     , m_bForceRealTimer( false )
  99     , m_bSetTimerRunning( false )
 100 {
 101 }
 102
 103 WinSalTimer::~WinSalTimer()
 104 {
 105     Stop();
 106 }
 107
 108 void WinSalTimer::Start( sal_uInt64 nMS )
 109 {
 110     WinSalInstance *pInst = GetSalData()->mpInstance;
 111     if ( pInst && !pInst->IsMainThread() )
 112     {
 113         bool const ret = PostMessageW(pInst->mhComWnd,
 114             SAL_MSG_STARTTIMER, 0, static_cast<LPARAM>(tools::Time::GetSystemTicks()) + nMS);
 115         SAL_WARN_IF(!ret, "vcl", "ERROR: PostMessage() failed!");
 116     }
 117     else
 118         ImplStart( nMS );
 119 }
 120
 121 void WinSalTimer::Stop()
 122 {
 123     WinSalInstance *pInst = GetSalData()->mpInstance;
 124     if ( pInst && !pInst->IsMainThread() )
 125     {
 126         bool const ret = PostMessageW(pInst->mhComWnd,
 127             SAL_MSG_STOPTIMER, 0, 0);
 128         SAL_WARN_IF(!ret, "vcl", "ERROR: PostMessage() failed!");
 129     }
 130     else
 131         ImplStop();
 132 }
 133
 134 /**
 135  * This gets invoked from a Timer Queue thread.
 136  * Don't acquire the SolarMutex to avoid deadlocks.
 137  */
 138 void CALLBACK SalTimerProc(PVOID data, BOOLEAN)
 139 {
 140     __try
 141     {
 142         WinSalTimer *pTimer = static_cast<WinSalTimer*>( data );
 143         bool const ret = PostMessageW(
 144             GetSalData()->mpInstance->mhComWnd, SAL_MSG_TIMER_CALLBACK,
 145             static_cast<WPARAM>(pTimer->GetNextEventVersion()), 0 );
 146 #if OSL_DEBUG_LEVEL > 0
 147         if (!ret) // SEH prevents using SAL_WARN here?
 148             fputs("ERROR: PostMessage() failed!\n", stderr);
 149 #endif
 150     }
 151     __except(WinSalInstance::WorkaroundExceptionHandlingInUSER32Lib(GetExceptionCode(), GetExceptionInformation()))
 152     {
 153     }
 154 }
 155
 156 void WinSalTimer::ImplHandleElapsedTimer()
 157 {
 158     // Test for MouseLeave
 159     SalTestMouseLeave();
 160
 161     m_bDirectTimeout = false;
 162     ImplSalYieldMutexAcquireWithWait();
 163     CallCallback();
 164     ImplSalYieldMutexRelease();
 165 }
 166
 167 void WinSalTimer::ImplHandleTimerEvent( const WPARAM aWPARAM )
 168 {
 169     assert( aWPARAM <= SAL_MAX_INT32 );
 170     if ( !IsValidEventVersion( static_cast<sal_Int32>( aWPARAM ) ) )
 171         return;
 172
 173     ImplHandleElapsedTimer();
 174 }
 175
 176 void WinSalTimer::SetForceRealTimer( const bool bVal )
 177 {
 178     if ( m_bForceRealTimer == bVal )
 179         return;
 180
 181     m_bForceRealTimer = bVal;
 182
 183     // we need a real timer, as m_bDirectTimeout won't be processed
 184     if ( bVal && m_bDirectTimeout )
 185         Start( 0 );
 186 }
 187
 188 void WinSalTimer::ImplHandle_WM_TIMER( const WPARAM aWPARAM )
 189 {
 190     assert( m_aWmTimerId == aWPARAM );
 191     if ( !(m_aWmTimerId == aWPARAM && m_bSetTimerRunning) )
 192         return;
 193
 194     m_bSetTimerRunning = false;
 195     KillTimer( GetSalData()->mpInstance->mhComWnd, m_aWmTimerId );
 196     ImplHandleElapsedTimer();
 197 }
 198
 199 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */