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