455710d8d71b1286b5e158af25729842b5f74bd6
[WebKit-https.git] / WebCore / platform / win / SharedTimerWin.cpp
1 /*
2  * Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27 #include "SharedTimer.h"
28
29 #include "Page.h"
30 #include "SystemTime.h"
31 #include "Widget.h"
32 #include <wtf/Assertions.h>
33 #include <windows.h>
34
35 namespace WebCore {
36
37 static UINT timerID;
38 static void (*sharedTimerFiredFunction)();
39
40 static HWND timerWindowHandle = 0;
41 static UINT timerFiredMessage = 0;
42 const LPCWSTR kTimerWindowClassName = L"TimerWindowClass";
43 static bool processingCustomTimerMessage = false;
44
45 LRESULT CALLBACK TimerWindowWndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
46 {
47     if (message == timerFiredMessage) {
48         processingCustomTimerMessage = true;
49         sharedTimerFiredFunction();
50         processingCustomTimerMessage = false;
51     } else
52         return DefWindowProc(hWnd, message, wParam, lParam);
53     return 0;
54 }
55
56 static void initializeOffScreenTimerWindow()
57 {
58     if (timerWindowHandle)
59         return;
60     
61     WNDCLASSEX wcex;
62     memset(&wcex, 0, sizeof(WNDCLASSEX));
63     wcex.cbSize = sizeof(WNDCLASSEX);
64     wcex.lpfnWndProc    = TimerWindowWndProc;
65     wcex.hInstance      = Page::instanceHandle();
66     wcex.lpszClassName  = kTimerWindowClassName;
67     RegisterClassEx(&wcex);
68
69     timerWindowHandle = CreateWindow(kTimerWindowClassName, 0, 0,
70        CW_USEDEFAULT, 0, CW_USEDEFAULT, 0, HWND_MESSAGE, 0, Page::instanceHandle(), 0);
71     timerFiredMessage = RegisterWindowMessage(L"com.apple.WebKit.TimerFired");
72 }
73
74 void setSharedTimerFiredFunction(void (*f)())
75 {
76     sharedTimerFiredFunction = f;
77 }
78
79 static void CALLBACK timerFired(HWND, UINT, UINT_PTR, DWORD)
80 {
81     sharedTimerFiredFunction();
82 }
83
84 void setSharedTimerFireTime(double fireTime)
85 {
86     ASSERT(sharedTimerFiredFunction);
87
88     double interval = fireTime - currentTime();
89     unsigned intervalInMS;
90     if (interval < 0)
91         intervalInMS = 0;
92     else {
93         interval *= 1000;
94         if (interval > USER_TIMER_MAXIMUM)
95             intervalInMS = USER_TIMER_MAXIMUM;
96         else
97             intervalInMS = (unsigned)interval;
98     }
99
100     if (timerID) {
101         KillTimer(0, timerID);
102         timerID = 0;
103     }
104
105     // We don't allow nested PostMessages, since the custom messages will effectively starve
106     // painting and user input. (Win32 has a tri-level queue with application messages > 
107     // user input > WM_PAINT/WM_TIMER.)
108     // In addition, if the queue contains input events that have been there since the last call to
109     // GetQueueStatus, PeekMessage or GetMessage we favor timers.
110     if (intervalInMS < USER_TIMER_MINIMUM && !processingCustomTimerMessage && 
111         !LOWORD(::GetQueueStatus(QS_ALLINPUT))) {
112         // Windows SetTimer does not allow timeouts smaller than 10ms (USER_TIMER_MINIMUM)
113         initializeOffScreenTimerWindow();
114         PostMessage(timerWindowHandle, timerFiredMessage, 0, 0);
115     } else
116         timerID = SetTimer(0, 0, intervalInMS, timerFired);
117 }
118
119 void stopSharedTimer()
120 {
121     if (timerID) {
122         KillTimer(0, timerID);
123         timerID = 0;
124     }
125 }
126
127 }