third_party/WebKit/Source/core/inspector/DOMPatchSupport.h

/*
 * Copyright (C) 2012 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef DOMPatchSupport_h
#define DOMPatchSupport_h

#include "platform/heap/Handle.h"
#include "wtf/HashMap.h"
#include "wtf/Vector.h"
#include "wtf/text/WTFString.h"

namespace blink {

class ContainerNode;
class DOMEditor;
class Document;
class ExceptionState;
class Node;

class DOMPatchSupport final {
  STACK_ALLOCATED();
  WTF_MAKE_NONCOPYABLE(DOMPatchSupport);

 public:
  static void patchDocument(Document&, const String& markup);

  DOMPatchSupport(DOMEditor*, Document&);

  void patchDocument(const String& markup);
  Node* patchNode(Node*, const String& markup, ExceptionState&);

 private:
  class Digest : public GarbageCollectedFinalized<Digest> {
   public:
    explicit Digest(Node* node) : m_node(node) {}
    DECLARE_TRACE();

    String m_sha1;
    String m_attrsSHA1;
    Member<Node> m_node;
    HeapVector<Member<Digest>> m_children;
  };

  typedef HeapVector<std::pair<Member<Digest>, size_t>> ResultMap;
  typedef HeapHashMap<String, Member<Digest>> UnusedNodesMap;

  bool innerPatchNode(Digest* oldNode, Digest* newNode, ExceptionState&);
  std::pair<ResultMap, ResultMap> diff(
      const HeapVector<Member<Digest>>& oldChildren,
      const HeapVector<Member<Digest>>& newChildren);
  bool innerPatchChildren(ContainerNode*,
                          const HeapVector<Member<Digest>>& oldChildren,
                          const HeapVector<Member<Digest>>& newChildren,
                          ExceptionState&);
  Digest* createDigest(Node*, UnusedNodesMap*);
  bool insertBeforeAndMarkAsUsed(ContainerNode*,
                                 Digest*,
                                 Node* anchor,
                                 ExceptionState&);
  bool removeChildAndMoveToNew(Digest*, ExceptionState&);
  void markNodeAsUsed(Digest*);
#ifdef DEBUG_DOM_PATCH_SUPPORT
  void dumpMap(const ResultMap&, const String& name);
#endif
  Document& document() const { return *m_document; }

  Member<DOMEditor> m_domEditor;
  Member<Document> m_document;

  UnusedNodesMap m_unusedNodesMap;
};

}  // namespace blink

#endif  // !defined(DOMPatchSupport_h)