src/third_party/WebKit/Source/core/page/PageSerializer.h

   1 /*
   2  * Copyright (C) 2011 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promo te products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef PageSerializer_h
  32 #define PageSerializer_h
  33
  34 #include "platform/weborigin/KURL.h"
  35 #include "platform/weborigin/KURLHash.h"
  36 #include "wtf/HashMap.h"
  37 #include "wtf/ListHashSet.h"
  38 #include "wtf/Vector.h"
  39
  40 namespace blink {
  41
  42 class FontResource;
  43 class ImageResource;
  44 class CSSStyleSheet;
  45 class CSSValue;
  46 class Document;
  47 class LocalFrame;
  48 class Page;
  49 class RenderObject;
  50 class Resource;
  51 class SharedBuffer;
  52 class StylePropertySet;
  53 class StyleRule;
  54 class StyleRuleFontFace;
  55
  56 struct SerializedResource;
  57
  58 // This class is used to serialize a page contents back to text (typically HTML).
  59 // It serializes all the page frames and retrieves resources such as images and CSS stylesheets.
  60 class PageSerializer {
  61 public:
  62     explicit PageSerializer(Vector<SerializedResource>*);
  63
  64     // Initiates the serialization of the frame's page. All serialized content and retrieved
  65     // resources are added to the Vector passed to the constructor. The first resource in that
  66     // vector is the top frame serialized content.
  67     void serialize(Page*);
  68
  69     KURL urlForBlankFrame(LocalFrame*);
  70
  71 private:
  72     void serializeFrame(LocalFrame*);
  73
  74     // Serializes the stylesheet back to text and adds it to the resources if URL is not-empty.
  75     // It also adds any resources included in that stylesheet (including any imported stylesheets and their own resources).
  76     void serializeCSSStyleSheet(CSSStyleSheet&, const KURL&);
  77
  78     bool shouldAddURL(const KURL&);
  79
  80     void addToResources(Resource *, PassRefPtr<SharedBuffer>, const KURL&);
  81     void addImageToResources(ImageResource*, RenderObject*, const KURL&);
  82     void addFontToResources(FontResource*);
  83
  84     void retrieveResourcesForProperties(const StylePropertySet*, Document&);
  85     void retrieveResourcesForCSSValue(CSSValue*, Document&);
  86
  87     Vector<SerializedResource>* m_resources;
  88     ListHashSet<KURL> m_resourceURLs;
  89     HashMap<LocalFrame*, KURL> m_blankFrameURLs;
  90     unsigned m_blankFrameCounter;
  91 };
  92
  93 }
  94
  95 #endif