Part 2 of removing PlatformString.h, remove PlatformString.h
[WebKit-https.git] / Source / WebCore / history / HistoryItem.h
1 /*
2  * Copyright (C) 2006, 2008, 2011 Apple Inc. All rights reserved.
3  * Copyright (C) 2012 Research In Motion Limited. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #ifndef HistoryItem_h
28 #define HistoryItem_h
29
30 #include "IntPoint.h"
31 #include <wtf/HashMap.h>
32 #include <wtf/OwnPtr.h>
33 #include <wtf/PassOwnPtr.h>
34 #include <wtf/RefCounted.h>
35 #include <wtf/text/WTFString.h>
36
37 #if PLATFORM(MAC)
38 #import <wtf/RetainPtr.h>
39 typedef struct objc_object* id;
40 #endif
41
42 #if PLATFORM(QT)
43 #include <QVariant>
44 #include <QByteArray>
45 #include <QDataStream>
46 #endif
47
48 #if PLATFORM(BLACKBERRY)
49 #include "HistoryItemViewState.h"
50 #endif
51
52 namespace WebCore {
53
54 class CachedPage;
55 class Document;
56 class FormData;
57 class HistoryItem;
58 class Image;
59 class KURL;
60 class ResourceRequest;
61 class SerializedScriptValue;
62
63 typedef Vector<RefPtr<HistoryItem> > HistoryItemVector;
64
65 extern void (*notifyHistoryItemChanged)(HistoryItem*);
66
67 enum VisitCountBehavior {
68     IncreaseVisitCount,
69     DoNotIncreaseVisitCount
70 };
71
72 class HistoryItem : public RefCounted<HistoryItem> {
73     friend class PageCache;
74
75 public: 
76     static PassRefPtr<HistoryItem> create() { return adoptRef(new HistoryItem); }
77     static PassRefPtr<HistoryItem> create(const String& urlString, const String& title, double lastVisited)
78     {
79         return adoptRef(new HistoryItem(urlString, title, lastVisited));
80     }
81     static PassRefPtr<HistoryItem> create(const String& urlString, const String& title, const String& alternateTitle, double lastVisited)
82     {
83         return adoptRef(new HistoryItem(urlString, title, alternateTitle, lastVisited));
84     }
85     static PassRefPtr<HistoryItem> create(const KURL& url, const String& target, const String& parent, const String& title)
86     {
87         return adoptRef(new HistoryItem(url, target, parent, title));
88     }
89     
90     ~HistoryItem();
91
92     PassRefPtr<HistoryItem> copy() const;
93
94     // Resets the HistoryItem to its initial state, as returned by create().
95     void reset();
96     
97     void encodeBackForwardTree(Encoder&) const;
98     static PassRefPtr<HistoryItem> decodeBackForwardTree(const String& urlString, const String& title, const String& originalURLString, Decoder&);
99
100     const String& originalURLString() const;
101     const String& urlString() const;
102     const String& title() const;
103     
104     bool isInPageCache() const { return m_cachedPage; }
105     
106     double lastVisitedTime() const;
107     
108     void setAlternateTitle(const String& alternateTitle);
109     const String& alternateTitle() const;
110     
111     const String& parent() const;
112     KURL url() const;
113     KURL originalURL() const;
114     const String& referrer() const;
115     const String& target() const;
116     bool isTargetItem() const;
117     
118     FormData* formData();
119     String formContentType() const;
120     
121     int visitCount() const;
122     bool lastVisitWasFailure() const { return m_lastVisitWasFailure; }
123     bool lastVisitWasHTTPNonGet() const { return m_lastVisitWasHTTPNonGet; }
124
125     void mergeAutoCompleteHints(HistoryItem* otherItem);
126     
127     const IntPoint& scrollPoint() const;
128     void setScrollPoint(const IntPoint&);
129     void clearScrollPoint();
130     
131     float pageScaleFactor() const;
132     void setPageScaleFactor(float);
133     
134     const Vector<String>& documentState() const;
135     void setDocumentState(const Vector<String>&);
136     void clearDocumentState();
137
138     void setURL(const KURL&);
139     void setURLString(const String&);
140     void setOriginalURLString(const String&);
141     void setReferrer(const String&);
142     void setTarget(const String&);
143     void setParent(const String&);
144     void setTitle(const String&);
145     void setIsTargetItem(bool);
146     
147     void setStateObject(PassRefPtr<SerializedScriptValue> object);
148     SerializedScriptValue* stateObject() const { return m_stateObject.get(); }
149
150     void setItemSequenceNumber(long long number) { m_itemSequenceNumber = number; }
151     long long itemSequenceNumber() const { return m_itemSequenceNumber; }
152
153     void setDocumentSequenceNumber(long long number) { m_documentSequenceNumber = number; }
154     long long documentSequenceNumber() const { return m_documentSequenceNumber; }
155
156     void setFormInfoFromRequest(const ResourceRequest&);
157     void setFormData(PassRefPtr<FormData>);
158     void setFormContentType(const String&);
159
160     void recordInitialVisit();
161
162     void setVisitCount(int);
163     void setLastVisitWasFailure(bool wasFailure) { m_lastVisitWasFailure = wasFailure; }
164     void setLastVisitWasHTTPNonGet(bool wasNotGet) { m_lastVisitWasHTTPNonGet = wasNotGet; }
165
166     void addChildItem(PassRefPtr<HistoryItem>);
167     void setChildItem(PassRefPtr<HistoryItem>);
168     HistoryItem* childItemWithTarget(const String&) const;
169     HistoryItem* childItemWithDocumentSequenceNumber(long long number) const;
170     HistoryItem* targetItem();
171     const HistoryItemVector& children() const;
172     bool hasChildren() const;
173     void clearChildren();
174     bool isAncestorOf(const HistoryItem*) const;
175     
176     bool shouldDoSameDocumentNavigationTo(HistoryItem* otherItem) const;
177     bool hasSameFrames(HistoryItem* otherItem) const;
178
179     // This should not be called directly for HistoryItems that are already included
180     // in GlobalHistory. The WebKit api for this is to use -[WebHistory setLastVisitedTimeInterval:forItem:] instead.
181     void setLastVisitedTime(double);
182     void visited(const String& title, double time, VisitCountBehavior);
183
184     void addRedirectURL(const String&);
185     Vector<String>* redirectURLs() const;
186     void setRedirectURLs(PassOwnPtr<Vector<String> >);
187
188     bool isCurrentDocument(Document*) const;
189     
190 #if PLATFORM(MAC)
191     id viewState() const;
192     void setViewState(id);
193     
194     // Transient properties may be of any ObjC type.  They are intended to be used to store state per back/forward list entry.
195     // The properties will not be persisted; when the history item is removed, the properties will be lost.
196     id getTransientProperty(const String&) const;
197     void setTransientProperty(const String&, id);
198 #endif
199
200 #if PLATFORM(QT)
201     QVariant userData() const { return m_userData; }
202     void setUserData(const QVariant& userData) { m_userData = userData; }
203
204     bool restoreState(QDataStream& buffer, int version);
205     QDataStream& saveState(QDataStream& out, int version) const;
206 #endif
207
208 #if PLATFORM(BLACKBERRY)
209     HistoryItemViewState& viewState() { return m_viewState; }
210 #endif
211
212 #ifndef NDEBUG
213     int showTree() const;
214     int showTreeWithIndent(unsigned indentLevel) const;
215 #endif
216
217     void adoptVisitCounts(Vector<int>& dailyCounts, Vector<int>& weeklyCounts);
218     const Vector<int>& dailyVisitCounts() const { return m_dailyVisitCounts; }
219     const Vector<int>& weeklyVisitCounts() const { return m_weeklyVisitCounts; }
220
221 private:
222     HistoryItem();
223     HistoryItem(const String& urlString, const String& title, double lastVisited);
224     HistoryItem(const String& urlString, const String& title, const String& alternateTitle, double lastVisited);
225     HistoryItem(const KURL& url, const String& frameName, const String& parent, const String& title);
226
227     explicit HistoryItem(const HistoryItem&);
228
229     void padDailyCountsForNewVisit(double time);
230     void collapseDailyVisitsToWeekly();
231     void recordVisitAtTime(double, VisitCountBehavior = IncreaseVisitCount);
232     
233     bool hasSameDocumentTree(HistoryItem* otherItem) const;
234
235     HistoryItem* findTargetItem();
236
237     void encodeBackForwardTreeNode(Encoder&) const;
238
239     /* When adding new member variables to this class, please notify the Qt team.
240      * qt/HistoryItemQt.cpp contains code to serialize history items.
241      */
242
243     String m_urlString;
244     String m_originalURLString;
245     String m_referrer;
246     String m_target;
247     String m_parent;
248     String m_title;
249     String m_displayTitle;
250     
251     double m_lastVisitedTime;
252     bool m_lastVisitWasHTTPNonGet;
253
254     IntPoint m_scrollPoint;
255     float m_pageScaleFactor;
256     Vector<String> m_documentState;
257     
258     HistoryItemVector m_children;
259     
260     bool m_lastVisitWasFailure;
261     bool m_isTargetItem;
262     int m_visitCount;
263     Vector<int> m_dailyVisitCounts;
264     Vector<int> m_weeklyVisitCounts;
265
266     OwnPtr<Vector<String> > m_redirectURLs;
267
268     // If two HistoryItems have the same item sequence number, then they are
269     // clones of one another.  Traversing history from one such HistoryItem to
270     // another is a no-op.  HistoryItem clones are created for parent and
271     // sibling frames when only a subframe navigates.
272     int64_t m_itemSequenceNumber;
273
274     // If two HistoryItems have the same document sequence number, then they
275     // refer to the same instance of a document.  Traversing history from one
276     // such HistoryItem to another preserves the document.
277     int64_t m_documentSequenceNumber;
278
279     // Support for HTML5 History
280     RefPtr<SerializedScriptValue> m_stateObject;
281     
282     // info used to repost form data
283     RefPtr<FormData> m_formData;
284     String m_formContentType;
285
286     // PageCache controls these fields.
287     HistoryItem* m_next;
288     HistoryItem* m_prev;
289     RefPtr<CachedPage> m_cachedPage;
290     
291 #if PLATFORM(MAC)
292     RetainPtr<id> m_viewState;
293     OwnPtr<HashMap<String, RetainPtr<id> > > m_transientProperties;
294 #endif
295
296 #if PLATFORM(QT)
297     QVariant m_userData;
298 #endif
299
300 #if PLATFORM(BLACKBERRY)
301     HistoryItemViewState m_viewState;
302 #endif
303 }; //class HistoryItem
304
305 } //namespace WebCore
306
307 #ifndef NDEBUG
308 // Outside the WebCore namespace for ease of invocation from gdb.
309 extern "C" int showTree(const WebCore::HistoryItem*);
310 #endif
311
312 #endif // HISTORYITEM_H