[WTF] Import std::optional reference implementation as WTF::Optional
[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 #pragma once
28
29 #include "SuspendableTimer.h"
30 #include "UserGestureIndicator.h"
31 #include <memory>
32 #include <wtf/RefCounted.h>
33
34 namespace WebCore {
35
36 class DOMTimerFireState;
37 class Document;
38 class HTMLPlugInElement;
39 class ScheduledAction;
40
41 class DOMTimer final : public RefCounted<DOMTimer>, public SuspendableTimer {
42     WTF_MAKE_NONCOPYABLE(DOMTimer);
43     WTF_MAKE_FAST_ALLOCATED;
44 public:
45     virtual ~DOMTimer();
46
47     static std::chrono::milliseconds defaultMinimumInterval() { return 4ms; }
48     static std::chrono::milliseconds defaultAlignmentInterval() { return 0ms; }
49     static std::chrono::milliseconds hiddenPageAlignmentInterval() { return 1000ms; }
50
51     // Creates a new timer owned by specified ScriptExecutionContext, starts it
52     // and returns its Id.
53     static int install(ScriptExecutionContext&, std::unique_ptr<ScheduledAction>, std::chrono::milliseconds timeout, bool singleShot);
54     static void removeById(ScriptExecutionContext&, int timeoutId);
55
56     // Notify that the interval may need updating (e.g. because the minimum interval
57     // setting for the context has changed).
58     void updateTimerIntervalIfNecessary();
59
60     static void scriptDidInteractWithPlugin(HTMLPlugInElement&);
61
62 private:
63     DOMTimer(ScriptExecutionContext&, std::unique_ptr<ScheduledAction>, std::chrono::milliseconds interval, bool singleShot);
64     friend class Internals;
65
66     std::chrono::milliseconds intervalClampedToMinimum() const;
67
68     bool isDOMTimersThrottlingEnabled(Document&) const;
69     void updateThrottlingStateIfNecessary(const DOMTimerFireState&);
70
71     // SuspendableTimer
72     void fired() override;
73     void didStop() override;
74     std::optional<std::chrono::milliseconds> alignedFireTime(std::chrono::milliseconds) const override;
75
76     // ActiveDOMObject API.
77     const char* activeDOMObjectName() const override;
78
79     enum TimerThrottleState {
80         Undetermined,
81         ShouldThrottle,
82         ShouldNotThrottle
83     };
84
85     int m_timeoutId;
86     int m_nestingLevel;
87     std::unique_ptr<ScheduledAction> m_action;
88     std::chrono::milliseconds m_originalInterval;
89     TimerThrottleState m_throttleState;
90     std::chrono::milliseconds m_currentTimerInterval;
91     RefPtr<UserGestureToken> m_userGestureTokenToForward;
92 };
93
94 } // namespace WebCore