[ContentChangeObserver] Move timer removal code from DOMWindow::clearTimeout to DOMTi...
[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 void startObservingContentChanges();
42     WEBCORE_EXPORT void stopObservingContentChanges();
43     WEBCORE_EXPORT WKContentChange observedContentChange();
44
45     void didInstallDOMTimer(const DOMTimer&, Seconds timeout, bool singleShot);
46     void didRemoveDOMTimer(const DOMTimer&);
47
48     void didScheduleStyleRecalc();
49     void didSuspendActiveDOMObjects();
50     void willDetachPage();
51
52     class StyleChangeScope {
53     public:
54         StyleChangeScope(Page*, const Element&);
55         ~StyleChangeScope();
56
57     private:
58         ContentChangeObserver* m_contentChangeObserver { nullptr };
59         const Element& m_element;
60         bool m_needsObserving { false };
61         DisplayType m_previousDisplay;
62         Visibility m_previousVisibility;
63         Visibility m_previousImplicitVisibility;
64     };
65
66     class StyleRecalcScope {
67     public:
68         StyleRecalcScope(Page*);
69         ~StyleRecalcScope();
70     private:
71         ContentChangeObserver* m_contentChangeObserver { nullptr };
72     };
73
74     class DOMTimerScope {
75     public:
76         DOMTimerScope(Page*, const DOMTimer&);
77         ~DOMTimerScope();
78     private:
79         ContentChangeObserver* m_contentChangeObserver { nullptr };
80         const DOMTimer& m_domTimer;
81     };
82
83 private:
84     void startObservingDOMTimerScheduling();
85     void stopObservingDOMTimerScheduling();
86
87     void startObservingDOMTimerExecute(const DOMTimer&);
88     void stopObservingDOMTimerExecute(const DOMTimer&);
89
90     void startObservingStyleResolve();
91     void stopObservingStyleResolve();
92
93     void addObservedDOMTimer(const DOMTimer&);
94     bool isObservingDOMTimerScheduling();
95     void removeObservedDOMTimer(const DOMTimer&);
96     bool containsObservedDOMTimer(const DOMTimer&);
97
98     void startObservingStyleRecalcScheduling();
99     void stopObservingStyleRecalcScheduling();
100
101     void setShouldObserveNextStyleRecalc(bool);
102     bool shouldObserveNextStyleRecalc();
103
104     bool isObservingContentChanges();
105     bool isObservingStyleRecalcScheduling();
106
107     void setObservedContentChange(WKContentChange);
108     void resetObservedContentChange();
109
110     unsigned countOfObservedDOMTimers();
111     void clearObservedDOMTimers();
112
113     void clearTimersAndReportContentChange();
114
115     Page& m_page;
116     HashSet<const DOMTimer*> m_DOMTimerList;
117     bool m_observingNextStyleRecalc { false };
118     bool m_observingStyleRecalcScheduling { false };
119     bool m_observingDOMTimerScheduling { false };
120     bool m_observingContentChanges { false };
121 };
122
123 }
124 #endif