1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef THIRD_PARTY_BLINK_RENDERER_CORE_DOM_SYNCHRONOUS_MUTATION_OBSERVER_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_DOM_SYNCHRONOUS_MUTATION_OBSERVER_H_
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/platform/heap/handle.h"
namespace blink {
class CharacterData;
class ContainerNode;
class Document;
class NodeWithIndex;
class Text;
// This class is a base class for classes which observe DOM tree mutation
// synchronously. If you want to observe DOM tree mutation asynchronously see
// MutationObserver Web API.
// Note: if you only need to observe Document shutdown,
// ExecutionContextLifecycleObserver::ContextDestroyed provides this same
// functionality more efficiently (since it doesn't observe the other events).
//
// TODO(yosin): Following classes should be derived from this class to
// simplify Document class.
// - DragCaret
// - DocumentMarkerController
// - EventHandler
// - FrameCaret
// - InputMethodController
// - SelectionController
// - Range set
// - NodeIterator set
class CORE_EXPORT SynchronousMutationObserver : public GarbageCollectedMixin {
public:
// TODO(yosin): We will have following member functions:
// - dataWillBeChanged(const CharacterData&);
// - didMoveTreeToNewDocument(const Node& root);
// - didInsertText(Node*, unsigned offset, unsigned length);
// - didRemoveText(Node*, unsigned offset, unsigned length);
// Called after child nodes changed.
virtual void DidChangeChildren(const ContainerNode&) {}
// Called after characters in |nodeToBeRemoved| is appended into |mergedNode|.
// |oldLength| holds length of |mergedNode| before merge.
virtual void DidMergeTextNodes(
const Text& merged_node,
const NodeWithIndex& node_to_be_removed_with_index,
unsigned old_length) {}
// Called just after node tree |root| is moved to new document.
virtual void DidMoveTreeToNewDocument(const Node& root) {}
// Called when |Text| node is split, next sibling |oldNode| contains
// characters after split point.
virtual void DidSplitTextNode(const Text& old_node) {}
// Called when |CharacterData| is updated at |offset|, |oldLength| is a
// number of deleted character and |newLength| is a number of added
// characters.
virtual void DidUpdateCharacterData(CharacterData*,
unsigned offset,
unsigned old_length,
unsigned new_length) {}
// Called before removing container node.
virtual void NodeChildrenWillBeRemoved(ContainerNode&) {}
// Called before removing node.
virtual void NodeWillBeRemoved(Node&) {}
// Called when detaching document.
virtual void ContextDestroyed() {}
// Call before clearing an observer list.
void ObserverListWillBeCleared();
Document* GetDocument() const { return document_; }
void SetDocument(Document*);
void Trace(Visitor*) const override;
protected:
SynchronousMutationObserver() = default;
private:
WeakMember<Document> document_;
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_CORE_DOM_SYNCHRONOUS_MUTATION_OBSERVER_H_
|
