DOM timer throttling for hidden plugins
[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 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/RefCounted.h>
33
34 namespace WebCore {
35
36     class HTMLPlugInElement;
37     class ScheduledAction;
38
39     class DOMTimer final : public RefCounted<DOMTimer>, public SuspendableTimer {
40         WTF_MAKE_NONCOPYABLE(DOMTimer);
41         WTF_MAKE_FAST_ALLOCATED;
42     public:
43         // Creates a new timer owned by specified ScriptExecutionContext, starts it
44         // and returns its Id.
45         static int install(ScriptExecutionContext*, std::unique_ptr<ScheduledAction>, int timeout, bool singleShot);
46         static void removeById(ScriptExecutionContext*, int timeoutId);
47
48         // Notify that the interval may need updating (e.g. because the minimum interval
49         // setting for the context has changed).
50         void updateTimerIntervalIfNecessary();
51
52         static void scriptDidInteractWithPlugin(HTMLPlugInElement&);
53
54     private:
55         DOMTimer(ScriptExecutionContext*, std::unique_ptr<ScheduledAction>, int interval, bool singleShot);
56         double intervalClampedToMinimum() const;
57
58         // SuspendableTimer
59         virtual void fired() override;
60         virtual void didStop() override;
61         virtual double alignedFireTime(double) const override;
62
63         enum TimerThrottleState {
64             Undetermined,
65             ShouldThrottle,
66             ShouldNotThrottle
67         };
68
69         int m_timeoutId;
70         int m_nestingLevel;
71         std::unique_ptr<ScheduledAction> m_action;
72         int m_originalInterval;
73         TimerThrottleState m_throttleState;
74         double m_currentTimerInterval;
75         bool m_shouldForwardUserGesture;
76     };
77
78 } // namespace WebCore
79
80 #endif // DOMTimer_h
81