Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / 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 #pragma once
32
33 #include "SharedBuffer.h"
34 #include <wtf/Forward.h>
35 #include <wtf/HashMap.h>
36 #include <wtf/ListHashSet.h>
37 #include <wtf/URLHash.h>
38
39 namespace WebCore {
40
41 class CachedImage;
42 class CSSStyleSheet;
43 class Document;
44 class Frame;
45 class Page;
46 class RenderElement;
47 class StyleProperties;
48 class StyleRule;
49
50 // This class is used to serialize a page contents back to text (typically HTML).
51 // It serializes all the page frames and retrieves resources such as images and CSS stylesheets.
52 class PageSerializer {
53 public:
54     struct Resource {
55         URL url;
56         String mimeType;
57         RefPtr<SharedBuffer> data;
58     };
59
60     explicit PageSerializer(Vector<Resource>&);
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 private:
68     class SerializerMarkupAccumulator;
69
70     URL urlForBlankFrame(Frame*);
71
72     void serializeFrame(Frame*);
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 URL&);
77
78     void addImageToResources(CachedImage*, RenderElement*, const URL&);
79     void retrieveResourcesForProperties(const StyleProperties*, Document*);
80     void retrieveResourcesForRule(StyleRule&, Document*);
81
82     Vector<Resource>& m_resources;
83     ListHashSet<URL> m_resourceURLs;
84     HashMap<Frame*, URL> m_blankFrameURLs;
85     unsigned m_blankFrameCounter { 0 };
86 };
87
88 } // namespace WebCore