[ContentChangeObserver] Introduce ContentChangeObserver::MouseMovedScope
[WebKit-https.git] / Source / WebCore / page / ios / ContentChangeObserver.h
1 /*
2  * Copyright (C) 2019 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if PLATFORM(IOS_FAMILY)
29
30 #include "WKContentObservation.h"
31
32 namespace WebCore {
33
34 class DOMTimer;
35 class Page;
36
37 class ContentChangeObserver {
38 public:
39     ContentChangeObserver(Page&);
40
41     WEBCORE_EXPORT WKContentChange observedContentChange() const;
42
43     void didInstallDOMTimer(const DOMTimer&, Seconds timeout, bool singleShot);
44     void didRemoveDOMTimer(const DOMTimer&);
45     void contentVisibilityDidChange();
46     void didSuspendActiveDOMObjects();
47     void willDetachPage();
48
49     class StyleChangeScope {
50     public:
51         StyleChangeScope(Page*, const Element&);
52         ~StyleChangeScope();
53
54     private:
55         ContentChangeObserver* m_contentChangeObserver { nullptr };
56         const Element& m_element;
57         bool m_needsObserving { false };
58         DisplayType m_previousDisplay;
59         Visibility m_previousVisibility;
60         Visibility m_previousImplicitVisibility;
61     };
62
63     class MouseMovedScope {
64     public:
65         WEBCORE_EXPORT MouseMovedScope(Page*);
66         WEBCORE_EXPORT ~MouseMovedScope();
67     private:
68         ContentChangeObserver* m_contentChangeObserver { nullptr };
69     };
70
71     class StyleRecalcScope {
72     public:
73         StyleRecalcScope(Page*);
74         ~StyleRecalcScope();
75     private:
76         ContentChangeObserver* m_contentChangeObserver { nullptr };
77     };
78
79     class DOMTimerScope {
80     public:
81         DOMTimerScope(Page*, const DOMTimer&);
82         ~DOMTimerScope();
83     private:
84         ContentChangeObserver* m_contentChangeObserver { nullptr };
85         const DOMTimer& m_domTimer;
86     };
87
88 private:
89     void startObservingMouseMoved();
90     void stopObservingMouseMoved();
91
92     void startObservingDOMTimerScheduling() { m_isObservingDOMTimerScheduling = true; }
93     void stopObservingDOMTimerScheduling() { m_isObservingDOMTimerScheduling = false; }
94
95     void startObservingDOMTimerExecute(const DOMTimer&);
96     void stopObservingDOMTimerExecute(const DOMTimer&);
97
98     void startObservingStyleRecalc();
99     void stopObservingStyleRecalc();
100
101     void registerDOMTimer(const DOMTimer&);
102     void unregisterDOMTimer(const DOMTimer&);
103     bool isObservingDOMTimerScheduling() const { return m_isObservingDOMTimerScheduling; }
104     bool containsObservedDOMTimer(const DOMTimer& timer) const { return m_DOMTimerList.contains(&timer); }
105
106     void setShouldObserveStyleRecalc(bool);
107     bool shouldObserveStyleRecalc() const { return m_shouldObserveStyleRecalc; }
108
109     bool isObservingContentChanges() const { return m_isObservingContentChanges; }
110
111     void clearObservedDOMTimers() { m_DOMTimerList.clear(); }
112     void clearTimersAndReportContentChange();
113
114     void setHasIndeterminateState();
115     void setHasVisibleChangeState();
116     void setHasNoChangeState();
117
118     bool hasVisibleChangeState() const { return observedContentChange() == WKContentVisibilityChange; }
119     bool hasObservedDOMTimer() const { return !m_DOMTimerList.isEmpty(); }
120     bool hasDeterminateState() const;
121
122     void notifyContentChangeIfNeeded();
123
124     enum class Event {
125         ContentObservationStarted,
126         InstalledDOMTimer,
127         RemovedDOMTimer,
128         StyleRecalcFinished,
129         ContentVisibilityChanged
130     };
131     void adjustObservedState(Event);
132
133     Page& m_page;
134     HashSet<const DOMTimer*> m_DOMTimerList;
135     bool m_shouldObserveStyleRecalc { false };
136     bool m_isObservingDOMTimerScheduling { false };
137     bool m_isObservingContentChanges { false };
138 };
139
140 inline void ContentChangeObserver::setHasNoChangeState()
141 {
142     WKSetObservedContentChange(WKContentNoChange);
143 }
144
145 inline void ContentChangeObserver::setHasIndeterminateState()
146 {
147     ASSERT(!hasVisibleChangeState());
148     WKSetObservedContentChange(WKContentIndeterminateChange);
149 }
150
151 inline void ContentChangeObserver::setHasVisibleChangeState()
152 {
153     WKSetObservedContentChange(WKContentVisibilityChange);
154 }
155
156 }
157 #endif