chromium/src/third_party/blink/renderer/core/frame/web_frame_serializer_impl.h

/*
 * Copyright (C) 2009 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 THIRD_PARTY_BLINK_RENDERER_CORE_FRAME_WEB_FRAME_SERIALIZER_IMPL_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_FRAME_WEB_FRAME_SERIALIZER_IMPL_H_

#include "third_party/blink/public/platform/web_string.h"
#include "third_party/blink/public/platform/web_url.h"
#include "third_party/blink/public/web/web_frame_serializer.h"
#include "third_party/blink/public/web/web_frame_serializer_client.h"
#include "third_party/blink/renderer/platform/text/web_entities.h"
#include "third_party/blink/renderer/platform/wtf/forward.h"
#include "third_party/blink/renderer/platform/wtf/hash_map.h"
#include "third_party/blink/renderer/platform/wtf/text/string_builder.h"
#include "third_party/blink/renderer/platform/wtf/text/string_hash.h"
#include "third_party/blink/renderer/platform/wtf/text/wtf_string.h"

namespace WTF {
class TextEncoding;
}

namespace blink {

class Document;
class Element;
class Node;
class WebLocalFrame;
class WebLocalFrameImpl;

// Responsible for serializing the specified frame into html
// (replacing links with paths to local files).
class WebFrameSerializerImpl {
  STACK_ALLOCATED();

 public:
  // Do serialization action.
  //
  // Returns false to indicate that no data has been serialized (i.e. because
  // the target frame didn't have a valid url).
  //
  // Synchronously calls WebFrameSerializerClient methods to report
  // serialization results.  See WebFrameSerializerClient comments for more
  // details.
  bool Serialize();

  // The parameter specifies which frame need to be serialized.
  // The parameter delegate specifies the pointer of interface
  // DomSerializerDelegate provide sink interface which can receive the
  // individual chunks of data to be saved.
  WebFrameSerializerImpl(WebLocalFrame*,
                         WebFrameSerializerClient*,
                         WebFrameSerializer::LinkRewritingDelegate*,
                         bool);

 private:
  // Specified frame which need to be serialized;
  WebLocalFrameImpl* specified_web_local_frame_impl_;
  // Pointer of WebFrameSerializerClient
  WebFrameSerializerClient* client_;
  // Pointer of WebFrameSerializer::LinkRewritingDelegate
  WebFrameSerializer::LinkRewritingDelegate* delegate_;
  // Data buffer for saving result of serialized DOM data.
  StringBuilder data_buffer_;
  // Whether frame url should be shown in MOTW in the serialized html.
  bool save_with_empty_url_;

  // Web entities conversion maps.
  WebEntities html_entities_;
  WebEntities xml_entities_;

  class SerializeDomParam {
    STACK_ALLOCATED();

   public:
    SerializeDomParam(const KURL&, const WTF::TextEncoding&, Document*);

    const KURL& url;
    const WTF::TextEncoding& text_encoding;
    Document* document;
    bool is_html_document;  // document.isHTMLDocument()
    bool have_seen_doc_type;
    bool have_added_charset_declaration;
    // This meta element need to be skipped when serializing DOM.
    const Element* skip_meta_element;
    bool have_added_xml_processing_directive;
    // Flag indicates whether we have added additional contents before end tag.
    // This flag will be re-assigned in each call of function
    // PostActionAfterSerializeOpenTag and it could be changed in function
    // PreActionBeforeSerializeEndTag if the function adds new contents into
    // serialization stream.
    bool have_added_contents_before_end;
  };

  // Before we begin serializing open tag of a element, we give the target
  // element a chance to do some work prior to add some additional data.
  WTF::String PreActionBeforeSerializeOpenTag(const Element*,
                                              SerializeDomParam*,
                                              bool* need_skip);

  // After we finish serializing open tag of a element, we give the target
  // element a chance to do some post work to add some additional data.
  WTF::String PostActionAfterSerializeOpenTag(const Element*,
                                              SerializeDomParam*);

  // Before we begin serializing end tag of a element, we give the target
  // element a chance to do some work prior to add some additional data.
  WTF::String PreActionBeforeSerializeEndTag(const Element*,
                                             SerializeDomParam*,
                                             bool* need_skip);

  // After we finish serializing end tag of a element, we give the target
  // element a chance to do some post work to add some additional data.
  WTF::String PostActionAfterSerializeEndTag(const Element*,
                                             SerializeDomParam*);

  // Save generated html content to data buffer.
  void SaveHTMLContentToBuffer(const WTF::String& content, SerializeDomParam*);

  enum FlushOption {
    kForceFlush,
    kDoNotForceFlush,
  };

  // Flushes the content buffer by encoding and sending the content to the
  // WebFrameSerializerClient. Content is not flushed if the buffer is not full
  // unless force is 1.
  void EncodeAndFlushBuffer(WebFrameSerializerClient::FrameSerializationStatus,
                            SerializeDomParam*,
                            FlushOption);

  // Serialize open tag of an specified element.
  void OpenTagToString(Element*, SerializeDomParam*);

  // Serialize end tag of an specified element.
  void EndTagToString(Element*, SerializeDomParam*);

  // Build content for a specified node
  void BuildContentForNode(Node*, SerializeDomParam*);

  // Appends attrName="escapedAttrValue" to result.
  void AppendAttribute(StringBuilder& result,
                       bool is_html_document,
                       const String& attr_name,
                       const String& attr_value);
};

}  // namespace blink

#endif