2 * Copyright (C) 2006, 2008, 2011 Apple Inc. All rights reserved.
3 * Copyright (C) 2012 Research In Motion Limited. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
30 #include "bindings/v8/SerializedScriptValue.h"
31 #include "platform/geometry/IntPoint.h"
32 #include "platform/weborigin/Referrer.h"
33 #include "wtf/RefCounted.h"
34 #include "wtf/text/WTFString.h"
43 class ResourceRequest;
45 typedef Vector<RefPtr<HistoryItem> > HistoryItemVector;
47 class HistoryItem : public RefCounted<HistoryItem> {
49 static PassRefPtr<HistoryItem> create() { return adoptRef(new HistoryItem); }
53 PassRefPtr<HistoryItem> copy() const;
55 // Used when the frame this item represents was navigated to a different
56 // url but a new item wasn't created.
57 void generateNewSequenceNumbers();
59 const String& urlString() const;
62 const Referrer& referrer() const;
63 const String& target() const;
66 const AtomicString& formContentType() const;
68 const IntPoint& scrollPoint() const;
69 void setScrollPoint(const IntPoint&);
70 void clearScrollPoint();
72 float pageScaleFactor() const;
73 void setPageScaleFactor(float);
75 const Vector<String>& documentState() const;
76 void setDocumentState(const Vector<String>&);
77 void clearDocumentState();
79 void setURL(const KURL&);
80 void setURLString(const String&);
81 void setReferrer(const Referrer&);
82 void setTarget(const String&);
84 void setStateObject(PassRefPtr<SerializedScriptValue>);
85 SerializedScriptValue* stateObject() const { return m_stateObject.get(); }
87 void setItemSequenceNumber(long long number) { m_itemSequenceNumber = number; }
88 long long itemSequenceNumber() const { return m_itemSequenceNumber; }
90 void setDocumentSequenceNumber(long long number) { m_documentSequenceNumber = number; }
91 long long documentSequenceNumber() const { return m_documentSequenceNumber; }
93 void setFormInfoFromRequest(const ResourceRequest&);
94 void setFormData(PassRefPtr<FormData>);
95 void setFormContentType(const AtomicString&);
97 void addChildItem(PassRefPtr<HistoryItem>);
98 const HistoryItemVector& children() const;
101 bool isCurrentDocument(Document*) const;
105 explicit HistoryItem(const HistoryItem&);
111 IntPoint m_scrollPoint;
112 float m_pageScaleFactor;
113 Vector<String> m_documentState;
115 HistoryItemVector m_children;
117 // If two HistoryItems have the same item sequence number, then they are
118 // clones of one another. Traversing history from one such HistoryItem to
119 // another is a no-op. HistoryItem clones are created for parent and
120 // sibling frames when only a subframe navigates.
121 int64_t m_itemSequenceNumber;
123 // If two HistoryItems have the same document sequence number, then they
124 // refer to the same instance of a document. Traversing history from one
125 // such HistoryItem to another preserves the document.
126 int64_t m_documentSequenceNumber;
128 // Support for HTML5 History
129 RefPtr<SerializedScriptValue> m_stateObject;
131 // info used to repost form data
132 RefPtr<FormData> m_formData;
133 AtomicString m_formContentType;
135 }; // class HistoryItem
137 } // namespace WebCore
139 #endif // HISTORYITEM_H