Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / page / History.h
1 /*
2  * Copyright (C) 2007-2018 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "DOMWindowProperty.h"
29 #include "ExceptionOr.h"
30 #include "JSValueInWrappedObject.h"
31 #include "ScriptWrappable.h"
32 #include "SerializedScriptValue.h"
33 #include <wtf/WallTime.h>
34
35 namespace WebCore {
36
37 class Document;
38
39 class History final : public ScriptWrappable, public RefCounted<History>, public DOMWindowProperty {
40 public:
41     static Ref<History> create(DOMWindow& window) { return adoptRef(*new History(window)); }
42
43     unsigned length() const;
44     
45     enum class ScrollRestoration {
46         Auto,
47         Manual
48     };
49
50     ExceptionOr<ScrollRestoration> scrollRestoration() const;
51     ExceptionOr<void> setScrollRestoration(ScrollRestoration);
52
53     SerializedScriptValue* state();
54     JSValueInWrappedObject& cachedState();
55
56     void back();
57     void forward();
58     void go(int);
59
60     void back(Document&);
61     void forward(Document&);
62     void go(Document&, int);
63
64     bool isSameAsCurrentState(SerializedScriptValue*) const;
65
66     ExceptionOr<void> pushState(RefPtr<SerializedScriptValue>&& data, const String& title, const String& urlString);
67     ExceptionOr<void> replaceState(RefPtr<SerializedScriptValue>&& data, const String& title, const String& urlString);
68
69 private:
70     explicit History(DOMWindow&);
71
72     enum class StateObjectType { Push, Replace };
73     ExceptionOr<void> stateObjectAdded(RefPtr<SerializedScriptValue>&&, const String& title, const String& url, StateObjectType);
74     bool stateChanged() const;
75
76     URL urlForState(const String& url);
77
78     SerializedScriptValue* stateInternal() const;
79
80     RefPtr<SerializedScriptValue> m_lastStateObjectRequested;
81     JSValueInWrappedObject m_cachedState;
82
83     unsigned m_currentStateObjectTimeSpanObjectsAdded { 0 };
84     WallTime m_currentStateObjectTimeSpanStart;
85
86     // For the main frame's History object to keep track of all state object usage.
87     uint64_t m_totalStateObjectUsage { 0 };
88
89     // For each individual History object to keep track of the most recent state object added.
90     uint64_t m_mostRecentStateObjectUsage { 0 };
91 };
92
93 inline ExceptionOr<void> History::pushState(RefPtr<SerializedScriptValue>&& data, const String& title, const String& urlString)
94 {
95     return stateObjectAdded(WTFMove(data), title, urlString, StateObjectType::Push);
96 }
97
98 inline ExceptionOr<void> History::replaceState(RefPtr<SerializedScriptValue>&& data, const String& title, const String& urlString)
99 {
100     return stateObjectAdded(WTFMove(data), title, urlString, StateObjectType::Replace);
101 }
102
103 } // namespace WebCore