2011-03-13 Andy Estes <aestes@apple.com>
[WebKit-https.git] / Source / WebCore / page / DOMTimer.h
1 /*
2  * Copyright (C) 2008 Apple 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
27 #ifndef DOMTimer_h
28 #define DOMTimer_h
29
30 #include "ScheduledAction.h"
31 #include "SuspendableTimer.h"
32 #include <wtf/OwnPtr.h>
33 #include <wtf/PassOwnPtr.h>
34
35 namespace WebCore {
36
37     class Settings;
38
39     class DOMTimer : public SuspendableTimer {
40         friend class Settings;
41     public:
42         virtual ~DOMTimer();
43         // Creates a new timer owned by specified ScriptExecutionContext, starts it
44         // and returns its Id.
45         static int install(ScriptExecutionContext*, PassOwnPtr<ScheduledAction>, int timeout, bool singleShot);
46         static void removeById(ScriptExecutionContext*, int timeoutId);
47
48         // ActiveDOMObject
49         virtual void contextDestroyed();
50         virtual void stop();
51
52         // Adjust to a change in the ScriptExecutionContext's minimum timer interval.
53         // This allows the minimum allowable interval time to be changed in response
54         // to events like moving a tab to the background.
55         void adjustMinimumTimerInterval(double oldMinimumTimerInterval);
56
57     private:
58         DOMTimer(ScriptExecutionContext*, PassOwnPtr<ScheduledAction>, int interval, bool singleShot);
59         virtual void fired();
60
61         double intervalClampedToMinimum(int timeout, double minimumTimerInterval) const;
62
63         // The default minimum allowable timer setting (in seconds, 0.001 == 1 ms).
64         // These are only modified via static methods in Settings.
65         static double defaultMinTimerInterval() { return s_minDefaultTimerInterval; }
66         static void setDefaultMinTimerInterval(double value) { s_minDefaultTimerInterval = value; }
67
68         int m_timeoutId;
69         int m_nestingLevel;
70         OwnPtr<ScheduledAction> m_action;
71         int m_originalInterval;
72         bool m_shouldForwardUserGesture;
73         static double s_minDefaultTimerInterval;
74     };
75
76 } // namespace WebCore
77
78 #endif // DOMTimer_h
79