File: SynchronousMutationObserver.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (85 lines) | stat: -rw-r--r-- 2,882 bytes parent folder | download
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
// 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 SynchronousMutationObserver_h
#define SynchronousMutationObserver_h

#include "base/macros.h"
#include "core/CoreExport.h"
#include "platform/LifecycleObserver.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.
//
// TODO(yosin): Following classes should be derived from this class to
// simplify Document class.
//  - DragCaretController
//  - DocumentMarkerController
//  - EventHandler
//  - FrameCaret
//  - InputMethodController
//  - SelectionController
//  - Range set
//  - NodeIterator set
class CORE_EXPORT SynchronousMutationObserver
    : public LifecycleObserver<Document, SynchronousMutationObserver> {
 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& mergedNode,
                                 const NodeWithIndex& nodeToBeRemovedWithIndex,
                                 unsigned oldLength);

  // 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& oldNode);

  // 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 oldLength,
                                      unsigned newLength);

  // Called before removing container node.
  virtual void nodeChildrenWillBeRemoved(ContainerNode&);

  // Called before removing node.
  virtual void nodeWillBeRemoved(Node&);

  // Called when detaching document.
  virtual void contextDestroyed(Document*) {}

 protected:
  SynchronousMutationObserver();

 private:
  DISALLOW_COPY_AND_ASSIGN(SynchronousMutationObserver);
};

}  // namespace blink

#endif  // SynchronousMutationObserver_h