Deprecate ActiveDOMObject::canSuspendForDocumentSuspension()
[WebKit-https.git] / Source / WebCore / page / ResizeObserver.h
1 /*
2  * Copyright (C) 2019 Igalia S.L.
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 ENABLE(RESIZE_OBSERVER)
29
30 #include "ActiveDOMObject.h"
31 #include "GCReachableRef.h"
32 #include "ResizeObservation.h"
33 #include "ResizeObserverCallback.h"
34 #include <wtf/RefCounted.h>
35 #include <wtf/WeakPtr.h>
36
37 namespace WebCore {
38
39 class Document;
40 class Element;
41
42 struct ResizeObserverData {
43     WTF_MAKE_STRUCT_FAST_ALLOCATED;
44     Vector<WeakPtr<ResizeObserver>> observers;
45 };
46
47 class ResizeObserver : public RefCounted<ResizeObserver>, public ActiveDOMObject, public CanMakeWeakPtr<ResizeObserver> {
48     WTF_MAKE_FAST_ALLOCATED;
49 public:
50     static Ref<ResizeObserver> create(Document&, Ref<ResizeObserverCallback>&&);
51     ~ResizeObserver();
52
53     bool hasObservations() const { return m_observations.size(); }
54     bool hasActiveObservations() const { return m_activeObservations.size(); }
55
56     void observe(Element&);
57     void unobserve(Element&);
58     void disconnect();
59     void targetDestroyed(Element&);
60
61     static size_t maxElementDepth() { return SIZE_MAX; }
62     size_t gatherObservations(size_t depth);
63     void deliverObservations();
64     bool hasSkippedObservations() const { return m_hasSkippedObservations; }
65     void setHasSkippedObservations(bool skipped) { m_hasSkippedObservations = skipped; }
66
67     // ActiveDOMObject.
68     bool hasPendingActivity() const override;
69     const char* activeDOMObjectName() const override;
70     void stop() override;
71
72 private:
73     ResizeObserver(Document&, Ref<ResizeObserverCallback>&&);
74
75     bool removeTarget(Element&);
76     void removeAllTargets();
77     bool removeObservation(const Element&);
78
79     WeakPtr<Document> m_document;
80     RefPtr<ResizeObserverCallback> m_callback;
81     Vector<Ref<ResizeObservation>> m_observations;
82
83     Vector<Ref<ResizeObservation>> m_activeObservations;
84     Vector<GCReachableRef<Element>> m_pendingTargets;
85     bool m_hasSkippedObservations { false };
86 };
87
88 } // namespace WebCore
89
90 #endif // ENABLE(RESIZE_OBSERVER)