[WTF] Drop initializeDate
[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 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 #pragma once
30
31 #include "PageURLRecord.h"
32 #include "SharedBuffer.h"
33 #include <wtf/HashSet.h>
34 #include <wtf/RefCounted.h>
35 #include <wtf/text/StringHash.h>
36 #include <wtf/text/WTFString.h>
37
38 #if OS(SOLARIS)
39 #include <sys/types.h> // For time_t structure.
40 #endif
41
42 namespace WebCore { 
43
44 class IconDataSnapshot;
45 class Image;
46 class IntSize;
47 class SQLDatabase;
48
49 enum ImageDataStatus {
50     ImageDataStatusPresent, ImageDataStatusMissing, ImageDataStatusUnknown
51 };
52
53 class IconSnapshot {
54 public:
55     IconSnapshot() : m_timestamp(0) { }
56     
57     IconSnapshot(const String& iconURL, int timestamp, SharedBuffer* data)
58         : m_iconURL(iconURL)
59         , m_timestamp(timestamp)
60         , m_data(data)
61     { }
62
63     const String& iconURL() const { return m_iconURL; }
64     int timestamp() const { return m_timestamp; }
65     SharedBuffer* data() const { return m_data.get(); }
66
67 private:
68     String m_iconURL;
69     int m_timestamp;
70     RefPtr<SharedBuffer> m_data;
71 };
72     
73 class IconRecord : public RefCounted<IconRecord> {
74     friend class PageURLRecord;
75 public:
76     static Ref<IconRecord> create(const String& url)
77     {
78         return adoptRef(*new IconRecord(url));
79     }
80     ~IconRecord();
81     
82     time_t getTimestamp() { return m_stamp; }
83     void setTimestamp(time_t stamp) { m_stamp = stamp; }
84         
85     void setImageData(RefPtr<SharedBuffer>&&);
86     Image* image(const IntSize&);    
87     
88     String iconURL() { return m_iconURL; }
89
90     void loadImageFromResource(const char*);
91         
92     ImageDataStatus imageDataStatus();
93     
94     const HashSet<String>& retainingPageURLs() { return m_retainingPageURLs; }
95     
96     IconSnapshot snapshot(bool forDeletion = false) const;
97
98 private:
99     IconRecord(const String& url); 
100
101     String m_iconURL;
102     time_t m_stamp;
103     RefPtr<Image> m_image;
104     
105     HashSet<String> m_retainingPageURLs;
106         
107     // This allows us to cache whether or not a SiteIcon has had its data set yet
108     // This helps the IconDatabase know if it has to set the data on a new object or not,
109     // and also to determine if the icon is missing data or if it just hasn't been brought
110     // in from the DB yet
111     bool m_dataSet;
112     
113     // FIXME - Right now WebCore::Image doesn't have a very good API for accessing multiple representations
114     // Even the NSImage way of doing things that we do in WebKit isn't very clean...  once we come up with a 
115     // better way of handling that, we'll likely have a map of size-to-images similar to below
116     // typedef HashMap<IntSize, Image*> SizeImageMap;
117     // SizeImageMap m_images;
118 };
119
120 } //namespace WebCore