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