[WTF] Import std::optional reference implementation as WTF::Optional
[WebKit-https.git] / Source / WebCore / dom / MutationObserver.h
1 /*
2  * Copyright (C) 2011 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #pragma once
32
33 #include "ExceptionOr.h"
34 #include <wtf/Forward.h>
35 #include <wtf/HashSet.h>
36 #include <wtf/Vector.h>
37
38 namespace WebCore {
39
40 class HTMLSlotElement;
41 class MutationCallback;
42 class MutationObserverRegistration;
43 class MutationRecord;
44 class Node;
45
46 using MutationObserverOptions = unsigned char;
47 using MutationRecordDeliveryOptions = unsigned char;
48
49 class MutationObserver : public RefCounted<MutationObserver> {
50     friend class MutationObserverMicrotask;
51 public:
52     enum MutationType {
53         ChildList = 1 << 0,
54         Attributes = 1 << 1,
55         CharacterData = 1 << 2,
56
57         AllMutationTypes = ChildList | Attributes | CharacterData
58     };
59
60     enum ObservationFlags  {
61         Subtree = 1 << 3,
62         AttributeFilter = 1 << 4
63     };
64
65     enum DeliveryFlags {
66         AttributeOldValue = 1 << 5,
67         CharacterDataOldValue = 1 << 6,
68     };
69
70     static Ref<MutationObserver> create(Ref<MutationCallback>&&);
71
72     ~MutationObserver();
73
74     struct Init {
75         bool childList;
76         std::optional<bool> attributes;
77         std::optional<bool> characterData;
78         bool subtree;
79         std::optional<bool> attributeOldValue;
80         std::optional<bool> characterDataOldValue;
81         std::optional<Vector<String>> attributeFilter;
82     };
83
84     ExceptionOr<void> observe(Node&, const Init&);
85     Vector<Ref<MutationRecord>> takeRecords();
86     void disconnect();
87
88     void observationStarted(MutationObserverRegistration&);
89     void observationEnded(MutationObserverRegistration&);
90     void enqueueMutationRecord(Ref<MutationRecord>&&);
91     void setHasTransientRegistration();
92     bool canDeliver();
93
94     HashSet<Node*> observedNodes() const;
95
96     static void enqueueSlotChangeEvent(HTMLSlotElement&);
97
98 private:
99     explicit MutationObserver(Ref<MutationCallback>&&);
100     void deliver();
101
102     static void notifyMutationObservers();
103     static bool validateOptions(MutationObserverOptions);
104
105     Ref<MutationCallback> m_callback;
106     Vector<Ref<MutationRecord>> m_records;
107     HashSet<MutationObserverRegistration*> m_registrations;
108     unsigned m_priority;
109 };
110
111 } // namespace WebCore