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
40namespace blink {
41
42class FontResource;
43class ImageResource;
44class CSSStyleSheet;
45class CSSValue;
46class Document;
47class LocalFrame;
48class Page;
49class RenderObject;
50class Resource;
51class SharedBuffer;
52class StylePropertySet;
53
54struct SerializedResource;
55
56// This class is used to serialize a page contents back to text (typically HTML).
57// It serializes all the page frames and retrieves resources such as images and CSS stylesheets.
58class PageSerializer {
59public:
60    explicit PageSerializer(Vector<SerializedResource>*);
61
62    // Initiates the serialization of the frame's page. All serialized content and retrieved
63    // resources are added to the Vector passed to the constructor. The first resource in that
64    // vector is the top frame serialized content.
65    void serialize(Page*);
66
67    KURL urlForBlankFrame(LocalFrame*);
68
69private:
70    void serializeFrame(LocalFrame*);
71
72    // Serializes the stylesheet back to text and adds it to the resources if URL is not-empty.
73    // It also adds any resources included in that stylesheet (including any imported stylesheets and their own resources).
74    void serializeCSSStyleSheet(CSSStyleSheet&, const KURL&);
75
76    bool shouldAddURL(const KURL&);
77
78    void addToResources(Resource *, PassRefPtr<SharedBuffer>, const KURL&);
79    void addImageToResources(ImageResource*, RenderObject*, const KURL&);
80    void addFontToResources(FontResource*);
81
82    void retrieveResourcesForProperties(const StylePropertySet*, Document&);
83    void retrieveResourcesForCSSValue(CSSValue*, Document&);
84
85    Vector<SerializedResource>* m_resources;
86    ListHashSet<KURL> m_resourceURLs;
87    HashMap<LocalFrame*, KURL> m_blankFrameURLs;
88    unsigned m_blankFrameCounter;
89};
90
91}
92
93#endif
94