Rename [Web]PageSerializer[Test|Client|Impl] to ...FrameSerializer...

third_party/WebKit/Source/web/WebPageSerializerImpl.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 WebPageSerializerImpl_h
-#define WebPageSerializerImpl_h
-
-#include "wtf/Forward.h"
-#include "wtf/HashMap.h"
-#include "wtf/Vector.h"
-#include "wtf/text/StringBuilder.h"
-#include "wtf/text/StringHash.h"
-#include "wtf/text/WTFString.h"
-
-#include "public/platform/WebString.h"
-#include "public/platform/WebURL.h"
-#include "public/web/WebPageSerializer.h"
-#include "public/web/WebPageSerializerClient.h"
-#include "web/WebEntities.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 WebPageSerializerImpl {
-    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 WebPageSerializerClient methods to report
-    // serialization results.  See WebPageSerializerClient 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.
-    // The parameter urlsToLocalPaths contains a mapping between original URLs
-    // of saved resources and corresponding local file paths.
-    WebPageSerializerImpl(
-        WebLocalFrame*,
-        WebPageSerializerClient*,
-        const WebVector<std::pair<WebURL, WebString>>& urlsToLocalPaths);
-
-private:
-    // Specified frame which need to be serialized;
-    RawPtrWillBeMember<WebLocalFrameImpl> m_specifiedWebLocalFrameImpl;
-    // Pointer of WebPageSerializerClient
-    WebPageSerializerClient* m_client;
-    // This hash map is used to map resource URL of original link to its local
-    // file path.
-    typedef HashMap<WTF::String, WTF::String> LinkLocalPathMap;
-    // local_links_ include all pair of local resource path and corresponding
-    // original link.
-    LinkLocalPathMap m_localLinks;
-    // Data buffer for saving result of serialized DOM data.
-    StringBuilder m_dataBuffer;
-
-    // Web entities conversion maps.
-    WebEntities m_htmlEntities;
-    WebEntities m_xmlEntities;
-
-    class SerializeDomParam {
-        STACK_ALLOCATED();
-    public:
-        SerializeDomParam(const KURL&, const WTF::TextEncoding&, Document*);
-
-        const KURL& url;
-        const WTF::TextEncoding& textEncoding;
-        RawPtrWillBeMember<Document> document;
-        bool isHTMLDocument; // document.isHTMLDocument()
-        bool haveSeenDocType;
-        bool haveAddedCharsetDeclaration;
-        // This meta element need to be skipped when serializing DOM.
-        RawPtrWillBeMember<const Element> skipMetaElement;
-        // Flag indicates we are in script or style tag.
-        bool isInScriptOrStyleTag;
-        bool haveAddedXMLProcessingDirective;
-        // 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 haveAddedContentsBeforeEnd;
-    };
-
-    // 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* param,
-                                                    bool* needSkip);
-    // 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* param);
-    // 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* param,
-                                                   bool* needSkip);
-    // 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* param);
-    // Save generated html content to data buffer.
-    void saveHTMLContentToBuffer(const WTF::String& content,
-                                 SerializeDomParam* param);
-
-    enum FlushOption {
-        ForceFlush,
-        DoNotForceFlush,
-    };
-
-    // Flushes the content buffer by encoding and sending the content to the
-    // WebPageSerializerClient. Content is not flushed if the buffer is not full
-    // unless force is 1.
-    void encodeAndFlushBuffer(WebPageSerializerClient::PageSerializationStatus status,
-                              SerializeDomParam* param,
-                              FlushOption);
-    // Serialize open tag of an specified element.
-    void openTagToString(Element*,
-                         SerializeDomParam* param);
-    // Serialize end tag of an specified element.
-    void endTagToString(Element*,
-                        SerializeDomParam* param);
-    // Build content for a specified node
-    void buildContentForNode(Node*,
-                             SerializeDomParam* param);
-};
-
-} // namespace blink
-
-#endif