1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <sal/config.h>
#include <tools/time.hxx>
#include <svsys.h>
#include <win/saldata.hxx>
#include <win/saltimer.h>
#include <win/salinst.h>
static void CALLBACK SalTimerProc(PVOID pParameter, BOOLEAN bTimerOrWaitFired);
// See http://msdn.microsoft.com/en-us/library/windows/desktop/ms687003%28v=vs.85%29.aspx
// (and related pages) for details about the Timer Queues.
// in order to prevent concurrent execution of ImplSalStartTimer and double
// deletion of timer (which is extremely likely, given that
// INVALID_HANDLE_VALUE waits for the callback to run on the main thread),
// this must run on the main thread too
void WinSalTimer::ImplStop()
{
SalData *const pSalData = GetSalData();
const WinSalInstance *pInst = pSalData->mpFirstInstance;
assert( !pInst || pSalData->mnAppThreadId == GetCurrentThreadId() );
const HANDLE hTimer = m_nTimerId;
if ( nullptr == hTimer )
return;
m_nTimerId = nullptr;
m_nTimerStartTicks = 0;
DeleteTimerQueueTimer( nullptr, hTimer, INVALID_HANDLE_VALUE );
m_bPollForMessage = false;
// remove as many pending SAL_MSG_TIMER_CALLBACK messages as possible
// PM_QS_POSTMESSAGE is needed, so we don't process the SendMessage from DoYield!
MSG aMsg;
while ( PeekMessageW(&aMsg, pInst->mhComWnd, SAL_MSG_TIMER_CALLBACK,
SAL_MSG_TIMER_CALLBACK, PM_REMOVE | PM_NOYIELD | PM_QS_POSTMESSAGE) );
}
void WinSalTimer::ImplStart( sal_uLong nMS )
{
SalData* pSalData = GetSalData();
assert( !pSalData->mpFirstInstance || pSalData->mnAppThreadId == GetCurrentThreadId() );
// DueTime parameter is a DWORD, which is always an unsigned 32bit
if (nMS > SAL_MAX_UINT32)
nMS = SAL_MAX_UINT32;
// cannot change a one-shot timer, so delete it and create a new one
ImplStop();
// keep the yield running, if a 0ms Idle is scheduled
m_bPollForMessage = ( 0 == nMS );
m_nTimerStartTicks = tools::Time::GetMonotonicTicks() % SAL_MAX_UINT32;
// probably WT_EXECUTEONLYONCE is not needed, but it enforces Period
// to be 0 and should not hurt; also see
// https://www.microsoft.com/msj/0499/pooling/pooling.aspx
CreateTimerQueueTimer(&m_nTimerId, nullptr, SalTimerProc,
(void*) m_nTimerStartTicks,
nMS, 0, WT_EXECUTEINTIMERTHREAD | WT_EXECUTEONLYONCE);
}
WinSalTimer::WinSalTimer()
: m_nTimerId( nullptr )
, m_nTimerStartTicks( 0 )
, m_bPollForMessage( false )
{
}
WinSalTimer::~WinSalTimer()
{
Stop();
}
void WinSalTimer::Start( sal_uLong nMS )
{
WinSalInstance *pInst = GetSalData()->mpFirstInstance;
if ( pInst && !pInst->IsMainThread() )
{
BOOL const ret = PostMessageW(pInst->mhComWnd,
SAL_MSG_STARTTIMER, 0, (LPARAM) tools::Time::GetSystemTicks() + nMS);
SAL_WARN_IF(0 == ret, "vcl", "ERROR: PostMessage() failed!");
}
else
ImplStart( nMS );
}
void WinSalTimer::Stop()
{
WinSalInstance *pInst = GetSalData()->mpFirstInstance;
if ( pInst && !pInst->IsMainThread() )
{
BOOL const ret = PostMessageW(pInst->mhComWnd,
SAL_MSG_STOPTIMER, 0, 0);
SAL_WARN_IF(0 == ret, "vcl", "ERROR: PostMessage() failed!");
}
else
ImplStop();
}
/** This gets invoked from a Timer Queue thread.
Don't acquire the SolarMutex to avoid deadlocks, just wake up the main thread
at better resolution than 10ms.
*/
static void CALLBACK SalTimerProc(PVOID data, BOOLEAN)
{
__try
{
// always post message when the timer fires, we will remove the ones
// that happened during execution of the callback later directly from
// the message queue
BOOL const ret = PostMessageW(GetSalData()->mpFirstInstance->mhComWnd,
SAL_MSG_TIMER_CALLBACK, (WPARAM) data, 0);
#if OSL_DEBUG_LEVEL > 0
if (0 == ret) // SEH prevents using SAL_WARN here?
fputs("ERROR: PostMessage() failed!\n", stderr);
#endif
}
__except(WinSalInstance::WorkaroundExceptionHandlingInUSER32Lib(GetExceptionCode(), GetExceptionInformation()))
{
}
}
void WinSalTimer::ImplEmitTimerCallback()
{
// Test for MouseLeave
SalTestMouseLeave();
m_bPollForMessage = false;
ImplSalYieldMutexAcquireWithWait();
CallCallback();
ImplSalYieldMutexRelease();
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
