Home | History | Annotate | Download | only in page 
      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 "weborigin/KURL.h"
     35 #include "weborigin/KURLHash.h"
     36 #include "wtf/HashMap.h"
     37 #include "wtf/ListHashSet.h"
     38 #include "wtf/Vector.h"
     39 
     40 namespace WebCore {
     41 
     42 class ImageResource;
     43 class CSSStyleSheet;
     44 class Document;
     45 class Frame;
     46 class Page;
     47 class RenderObject;
     48 class StylePropertySet;
     49 class StyleRule;
     50 
     51 struct SerializedResource;
     52 
     53 // This class is used to serialize a page contents back to text (typically HTML).
     54 // It serializes all the page frames and retrieves resources such as images and CSS stylesheets.
     55 class PageSerializer {
     56 public:
     57     explicit PageSerializer(Vector<SerializedResource>*);
     58 
     59     // Initiates the serialization of the frame's page. All serialized content and retrieved
     60     // resources are added to the Vector passed to the constructor. The first resource in that
     61     // vector is the top frame serialized content.
     62     void serialize(Page*);
     63 
     64     KURL urlForBlankFrame(Frame*);
     65 
     66 private:
     67     void serializeFrame(Frame*);
     68 
     69     // Serializes the stylesheet back to text and adds it to the resources if URL is not-empty.
     70     // It also adds any resources included in that stylesheet (including any imported stylesheets and their own resources).
     71     void serializeCSSStyleSheet(CSSStyleSheet*, const KURL&);
     72 
     73     void addImageToResources(ImageResource*, RenderObject*, const KURL&);
     74     void retrieveResourcesForProperties(const StylePropertySet*, Document*);
     75     void retrieveResourcesForRule(StyleRule*, Document*);
     76 
     77     Vector<SerializedResource>* m_resources;
     78     ListHashSet<KURL> m_resourceURLs;
     79     HashMap<Frame*, KURL> m_blankFrameURLs;
     80     unsigned m_blankFrameCounter;
     81 };
     82 
     83 }
     84 
     85 #endif
     86