Add a setting to toggle DOMTimer throttling support
[WebKit-https.git] / Source / WebCore / page / DOMTimer.h
1 /*
2  * Copyright (C) 2008, 2014 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 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 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 "SuspendableTimer.h"
31 #include <memory>
32 #include <wtf/HashSet.h>
33 #include <wtf/RefCounted.h>
34
35 namespace WebCore {
36
37     class DOMTimerFireState;
38     class Document;
39     class HTMLPlugInElement;
40     class IntRect;
41     class ScheduledAction;
42     class StyledElement;
43
44     class DOMTimer final : public RefCounted<DOMTimer>, public SuspendableTimer {
45         WTF_MAKE_NONCOPYABLE(DOMTimer);
46         WTF_MAKE_FAST_ALLOCATED;
47     public:
48         virtual ~DOMTimer();
49
50         // Creates a new timer owned by specified ScriptExecutionContext, starts it
51         // and returns its Id.
52         static int install(ScriptExecutionContext&, std::unique_ptr<ScheduledAction>, int timeout, bool singleShot);
53         static void removeById(ScriptExecutionContext&, int timeoutId);
54
55         // Notify that the interval may need updating (e.g. because the minimum interval
56         // setting for the context has changed).
57         void updateTimerIntervalIfNecessary();
58         void updateThrottlingStateAfterViewportChange(const IntRect& visibleRect);
59
60         static void scriptDidInteractWithPlugin(HTMLPlugInElement&);
61         static void scriptDidUpdateStyleOfElement(StyledElement&, bool changed);
62
63     private:
64         DOMTimer(ScriptExecutionContext&, std::unique_ptr<ScheduledAction>, int interval, bool singleShot);
65         friend class Internals;
66
67         double intervalClampedToMinimum() const;
68
69         bool isDOMTimersThrottlingEnabled(Document&) const;
70         bool isIntervalDependentOnViewport() const { return m_throttleState == ShouldThrottle && !m_elementsCausingThrottling.isEmpty(); }
71         void registerForViewportChanges();
72         void unregisterForViewportChanges();
73
74         void updateThrottlingStateIfNecessary(const DOMTimerFireState&);
75
76         // SuspendableTimer
77         virtual void fired() override;
78         virtual void didStop() override;
79         virtual double alignedFireTime(double) const override;
80
81         enum TimerThrottleState {
82             Undetermined,
83             ShouldThrottle,
84             ShouldNotThrottle
85         };
86
87         int m_timeoutId;
88         int m_nestingLevel;
89         std::unique_ptr<ScheduledAction> m_action;
90         int m_originalInterval;
91         TimerThrottleState m_throttleState;
92         double m_currentTimerInterval;
93         bool m_shouldForwardUserGesture;
94         // Hold a reference to the elements in case they get removed from the
95         // Document after the timer is throttled.
96         Vector<RefPtr<StyledElement>> m_elementsCausingThrottling;
97     };
98
99 } // namespace WebCore
100
101 #endif // DOMTimer_h
102