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

third_party/WebKit/Source/web/WebFrameSerializer.cpp

 /*
  * 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
@@ skipping 10 matching lines @@
  * 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.
  */
 
-#include "public/web/WebPageSerializer.h"
+#include "public/web/WebFrameSerializer.h"
 
 #include "core/HTMLNames.h"
 #include "core/dom/Document.h"
 #include "core/dom/Element.h"
 #include "core/frame/Frame.h"
+#include "core/frame/FrameSerializer.h"
 #include "core/frame/LocalFrame.h"
 #include "core/frame/RemoteFrame.h"
 #include "core/html/HTMLAllCollection.h"
 #include "core/html/HTMLFrameElementBase.h"
 #include "core/html/HTMLFrameOwnerElement.h"
 #include "core/html/HTMLInputElement.h"
 #include "core/html/HTMLTableElement.h"
 #include "core/loader/DocumentLoader.h"
-#include "core/page/PageSerializer.h"
 #include "platform/SerializedResource.h"
 #include "platform/SharedBuffer.h"
 #include "platform/mhtml/MHTMLArchive.h"
 #include "platform/mhtml/MHTMLParser.h"
 #include "platform/weborigin/KURL.h"
 #include "public/platform/WebCString.h"
 #include "public/platform/WebString.h"
 #include "public/platform/WebURL.h"
 #include "public/platform/WebVector.h"
 #include "public/web/WebDocument.h"
 #include "public/web/WebFrame.h"
-#include "public/web/WebPageSerializerClient.h"
+#include "public/web/WebFrameSerializerClient.h"
+#include "web/WebFrameSerializerImpl.h"
 #include "web/WebLocalFrameImpl.h"
-#include "web/WebPageSerializerImpl.h"
 #include "web/WebRemoteFrameImpl.h"
 #include "wtf/Assertions.h"
 #include "wtf/HashMap.h"
 #include "wtf/HashSet.h"
 #include "wtf/Noncopyable.h"
 #include "wtf/Vector.h"
 #include "wtf/text/StringConcatenate.h"
 
 namespace blink {
 
 namespace {
 
-class MHTMLPageSerializerDelegate final : public PageSerializer::Delegate {
-    WTF_MAKE_NONCOPYABLE(MHTMLPageSerializerDelegate);
+class MHTMLFrameSerializerDelegate final : public FrameSerializer::Delegate {
+    WTF_MAKE_NONCOPYABLE(MHTMLFrameSerializerDelegate);
 public:
-    explicit MHTMLPageSerializerDelegate(WebPageSerializer::MHTMLPartsGenerationDelegate&);
+    explicit MHTMLFrameSerializerDelegate(WebFrameSerializer::MHTMLPartsGenerationDelegate&);
     bool shouldIgnoreAttribute(const Attribute&) override;
     bool rewriteLink(const Element&, String& rewrittenLink) override;
     bool shouldSkipResource(const KURL&) override;
 
 private:
-    WebPageSerializer::MHTMLPartsGenerationDelegate& m_webDelegate;
+    WebFrameSerializer::MHTMLPartsGenerationDelegate& m_webDelegate;
 };
 
-MHTMLPageSerializerDelegate::MHTMLPageSerializerDelegate(
-    WebPageSerializer::MHTMLPartsGenerationDelegate& webDelegate)
+MHTMLFrameSerializerDelegate::MHTMLFrameSerializerDelegate(
+    WebFrameSerializer::MHTMLPartsGenerationDelegate& webDelegate)
     : m_webDelegate(webDelegate)
 {
 }
 
-bool MHTMLPageSerializerDelegate::shouldIgnoreAttribute(const Attribute& attribute)
+bool MHTMLFrameSerializerDelegate::shouldIgnoreAttribute(const Attribute& attribute)
 {
     // TODO(fgorski): Presence of srcset attribute causes MHTML to not display images, as only the value of src
     // is pulled into the archive. Discarding srcset prevents the problem. Long term we should make sure to MHTML
     // plays nicely with srcset.
     return attribute.localName() == HTMLNames::srcsetAttr;
 }
 
-bool MHTMLPageSerializerDelegate::rewriteLink(
+bool MHTMLFrameSerializerDelegate::rewriteLink(
     const Element& element,
     String& rewrittenLink)
 {
     if (!element.isFrameOwnerElement())
         return false;
 
     auto* frameOwnerElement = toHTMLFrameOwnerElement(&element);
     Frame* frame = frameOwnerElement->contentFrame();
     if (!frame)
         return false;
@@ skipping 13 matching lines @@
             || doc->isXHTMLDocument() || doc->isImageDocument();
         if (isHandledBySerializer) {
             rewrittenLink = cidURI.string();
             return true;
         }
     }
 
     return false;
 }
 
-bool MHTMLPageSerializerDelegate::shouldSkipResource(const KURL& url)
+bool MHTMLFrameSerializerDelegate::shouldSkipResource(const KURL& url)
 {
     return m_webDelegate.shouldSkipResource(url);
 }
 
 } // namespace
 
-WebData WebPageSerializer::generateMHTMLHeader(
+WebData WebFrameSerializer::generateMHTMLHeader(
     const WebString& boundary, WebLocalFrame* frame)
 {
     Document* document = toWebLocalFrameImpl(frame)->frame()->document();
 
     RefPtr<SharedBuffer> buffer = SharedBuffer::create();
     MHTMLArchive::generateMHTMLHeader(
         boundary, document->title(), document->suggestedMIMEType(),
         *buffer);
     return buffer.release();
 }
 
-WebData WebPageSerializer::generateMHTMLParts(
+WebData WebFrameSerializer::generateMHTMLParts(
     const WebString& boundary, WebLocalFrame* webFrame, bool useBinaryEncoding,
     MHTMLPartsGenerationDelegate* webDelegate)
 {
     ASSERT(webFrame);
     ASSERT(webDelegate);
 
     // Translate arguments from public to internal blink APIs.
     LocalFrame* frame = toWebLocalFrameImpl(webFrame)->frame();
     MHTMLArchive::EncodingPolicy encodingPolicy = useBinaryEncoding
         ? MHTMLArchive::EncodingPolicy::UseBinaryEncoding
         : MHTMLArchive::EncodingPolicy::UseDefaultEncoding;
 
     // Serialize.
     Vector<SerializedResource> resources;
-    MHTMLPageSerializerDelegate coreDelegate(*webDelegate);
-    PageSerializer serializer(resources, coreDelegate);
+    MHTMLFrameSerializerDelegate coreDelegate(*webDelegate);
+    FrameSerializer serializer(resources, coreDelegate);
     serializer.serializeFrame(*frame);
 
     // Get Content-ID for the frame being serialized.
     String frameContentID = webDelegate->getContentID(*webFrame);
     ASSERT(!frameContentID.isEmpty());
 
     // Encode serializer's output as MHTML.
     RefPtr<SharedBuffer> output = SharedBuffer::create();
     bool isFirstResource = true;
     for (const SerializedResource& resource : resources) {
-        // Frame is the 1st resource (see PageSerializer::serializeFrame doc
+        // Frame is the 1st resource (see FrameSerializer::serializeFrame doc
         // comment). Frames get a Content-ID header.
         String contentID = isFirstResource ? frameContentID : String();
 
         MHTMLArchive::generateMHTMLPart(
             boundary, contentID, encodingPolicy, resource, *output);
 
         isFirstResource = false;
     }
     return output.release();
 }
 
-WebData WebPageSerializer::generateMHTMLFooter(const WebString& boundary)
+WebData WebFrameSerializer::generateMHTMLFooter(const WebString& boundary)
 {
     RefPtr<SharedBuffer> buffer = SharedBuffer::create();
     MHTMLArchive::generateMHTMLFooter(boundary, *buffer);
     return buffer.release();
 }
 
-bool WebPageSerializer::serialize(
+bool WebFrameSerializer::serialize(
     WebLocalFrame* frame,
-    WebPageSerializerClient* client,
+    WebFrameSerializerClient* client,
     const WebVector<std::pair<WebURL, WebString>>& urlsToLocalPaths)
 {
-    WebPageSerializerImpl serializerImpl(frame, client, urlsToLocalPaths);
+    WebFrameSerializerImpl serializerImpl(frame, client, urlsToLocalPaths);
     return serializerImpl.serialize();
 }
 
-WebString WebPageSerializer::generateMetaCharsetDeclaration(const WebString& charset)
+WebString WebFrameSerializer::generateMetaCharsetDeclaration(const WebString& charset)
 {
-    // TODO(yosin) We should call |PageSerializer::metaCharsetDeclarationOf()|.
+    // TODO(yosin) We should call |FrameSerializer::metaCharsetDeclarationOf()|.
     String charsetString = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=" + static_cast<const String&>(charset) + "\">";
     return charsetString;
 }
 
-WebString WebPageSerializer::generateMarkOfTheWebDeclaration(const WebURL& url)
+WebString WebFrameSerializer::generateMarkOfTheWebDeclaration(const WebURL& url)
 {
     StringBuilder builder;
     builder.append("\n<!-- ");
-    builder.append(PageSerializer::markOfTheWebDeclaration(url));
+    builder.append(FrameSerializer::markOfTheWebDeclaration(url));
     builder.append(" -->\n");
     return builder.toString();
 }
 
-WebString WebPageSerializer::generateBaseTagDeclaration(const WebString& baseTarget)
+WebString WebFrameSerializer::generateBaseTagDeclaration(const WebString& baseTarget)
 {
-    // TODO(yosin) We should call |PageSerializer::baseTagDeclarationOf()|.
+    // TODO(yosin) We should call |FrameSerializer::baseTagDeclarationOf()|.
     if (baseTarget.isEmpty())
         return String("<base href=\".\">");
     String baseString = "<base href=\".\" target=\"" + static_cast<const String&>(baseTarget) + "\">";
     return baseString;
 }
 
 } // namespace blink