1ebc2558612612d55cacf4c4ea2b93ea14ecc73b
[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 const int sharedTimerID = 1000;
45
46 LRESULT CALLBACK TimerWindowWndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
47 {
48     if (message == timerFiredMessage) {
49         processingCustomTimerMessage = true;
50         sharedTimerFiredFunction();
51         processingCustomTimerMessage = false;
52     } else if (message == WM_TIMER && wParam == sharedTimerID)
53         sharedTimerFiredFunction();
54     else
55         return DefWindowProc(hWnd, message, wParam, lParam);
56     return 0;
57 }
58
59 static void initializeOffScreenTimerWindow()
60 {
61     if (timerWindowHandle)
62         return;
63     
64     WNDCLASSEX wcex;
65     memset(&wcex, 0, sizeof(WNDCLASSEX));
66     wcex.cbSize = sizeof(WNDCLASSEX);
67     wcex.lpfnWndProc    = TimerWindowWndProc;
68     wcex.hInstance      = Page::instanceHandle();
69     wcex.lpszClassName  = kTimerWindowClassName;
70     RegisterClassEx(&wcex);
71
72     timerWindowHandle = CreateWindow(kTimerWindowClassName, 0, 0,
73        CW_USEDEFAULT, 0, CW_USEDEFAULT, 0, HWND_MESSAGE, 0, Page::instanceHandle(), 0);
74     timerFiredMessage = RegisterWindowMessage(L"com.apple.WebKit.TimerFired");
75 }
76
77 void setSharedTimerFiredFunction(void (*f)())
78 {
79     sharedTimerFiredFunction = f;
80 }
81
82 void setSharedTimerFireTime(double fireTime)
83 {
84     ASSERT(sharedTimerFiredFunction);
85
86     double interval = fireTime - currentTime();
87     unsigned intervalInMS;
88     if (interval < 0)
89         intervalInMS = 0;
90     else {
91         interval *= 1000;
92         if (interval > USER_TIMER_MAXIMUM)
93             intervalInMS = USER_TIMER_MAXIMUM;
94         else
95             intervalInMS = (unsigned)interval;
96     }
97
98     if (timerID) {
99         KillTimer(0, timerID);
100         timerID = 0;
101     }
102
103     // We don't allow nested PostMessages, since the custom messages will effectively starve
104     // painting and user input. (Win32 has a tri-level queue with application messages > 
105     // user input > WM_PAINT/WM_TIMER.)
106     // In addition, if the queue contains input events that have been there since the last call to
107     // GetQueueStatus, PeekMessage or GetMessage we favor timers.
108     initializeOffScreenTimerWindow();
109     if (intervalInMS < USER_TIMER_MINIMUM && !processingCustomTimerMessage && 
110         !LOWORD(::GetQueueStatus(QS_ALLINPUT))) {
111         // Windows SetTimer does not allow timeouts smaller than 10ms (USER_TIMER_MINIMUM)
112         PostMessage(timerWindowHandle, timerFiredMessage, 0, 0);
113     } else
114         timerID = SetTimer(timerWindowHandle, sharedTimerID, intervalInMS, 0);
115 }
116
117 void stopSharedTimer()
118 {
119     if (timerID) {
120         KillTimer(0, timerID);
121         timerID = 0;
122     }
123 }
124
125 }