Part 2 of removing PlatformString.h, remove PlatformString.h
[WebKit-https.git] / Source / WebCore / loader / icon / IconRecord.h
1 /*
2  * Copyright (C) 2007 Apple 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
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28  
29 #ifndef IconRecord_h
30 #define IconRecord_h
31
32 #include "PageURLRecord.h"
33 #include "SharedBuffer.h"
34 #include <wtf/HashSet.h>
35 #include <wtf/OwnPtr.h>
36 #include <wtf/RefCounted.h>
37 #include <wtf/text/StringHash.h>
38 #include <wtf/text/WTFString.h>
39
40 #if OS(SOLARIS)
41 #include <sys/types.h> // For time_t structure.
42 #endif
43
44 namespace WebCore { 
45
46 class IconDataSnapshot;
47 class Image;
48 class IntSize;
49 class SQLDatabase;
50
51 enum ImageDataStatus {
52     ImageDataStatusPresent, ImageDataStatusMissing, ImageDataStatusUnknown
53 };
54
55 class IconSnapshot {
56 public:
57     IconSnapshot() : m_timestamp(0) { }
58     
59     IconSnapshot(const String& iconURL, int timestamp, SharedBuffer* data)
60         : m_iconURL(iconURL)
61         , m_timestamp(timestamp)
62         , m_data(data)
63     { }
64
65     const String& iconURL() const { return m_iconURL; }
66     int timestamp() const { return m_timestamp; }
67     SharedBuffer* data() const { return m_data.get(); }
68
69 private:
70     String m_iconURL;
71     int m_timestamp;
72     RefPtr<SharedBuffer> m_data;
73 };
74     
75 class IconRecord : public RefCounted<IconRecord> {
76     friend class PageURLRecord;
77 public:
78     static PassRefPtr<IconRecord> create(const String& url)
79     {
80         return adoptRef(new IconRecord(url));
81     }
82     ~IconRecord();
83     
84     time_t getTimestamp() { return m_stamp; }
85     void setTimestamp(time_t stamp) { m_stamp = stamp; }
86         
87     void setImageData(PassRefPtr<SharedBuffer> data);
88     Image* image(const IntSize&);    
89     
90     String iconURL() { return m_iconURL; }
91
92     void loadImageFromResource(const char*);
93         
94     ImageDataStatus imageDataStatus();
95     
96     const HashSet<String>& retainingPageURLs() { return m_retainingPageURLs; }
97     
98     IconSnapshot snapshot(bool forDeletion = false) const;
99
100 private:
101     IconRecord(const String& url); 
102
103     String m_iconURL;
104     time_t m_stamp;
105     RefPtr<Image> m_image;
106     
107     HashSet<String> m_retainingPageURLs;
108         
109     // This allows us to cache whether or not a SiteIcon has had its data set yet
110     // This helps the IconDatabase know if it has to set the data on a new object or not,
111     // and also to determine if the icon is missing data or if it just hasn't been brought
112     // in from the DB yet
113     bool m_dataSet;
114     
115     // FIXME - Right now WebCore::Image doesn't have a very good API for accessing multiple representations
116     // Even the NSImage way of doing things that we do in WebKit isn't very clean...  once we come up with a 
117     // better way of handling that, we'll likely have a map of size-to-images similar to below
118     // typedef HashMap<IntSize, Image*> SizeImageMap;
119     // SizeImageMap m_images;
120 };
121
122
123 } //namespace WebCore
124
125 #endif