History.pushState causes intense memory pressure.
[WebKit-https.git] / Source / WebCore / page / History.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  * 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 #ifndef History_h
27 #define History_h
28
29 #include "DOMWindowProperty.h"
30 #include "ScriptWrappable.h"
31 #include "SerializedScriptValue.h"
32 #include "URL.h"
33 #include <wtf/Forward.h>
34 #include <wtf/PassRefPtr.h>
35 #include <wtf/RefCounted.h>
36
37 namespace WebCore {
38
39 class Frame;
40 class ScriptExecutionContext;
41 struct ExceptionCodeWithMessage;
42 typedef int ExceptionCode;
43
44 class History : public ScriptWrappable, public RefCounted<History>, public DOMWindowProperty {
45 public:
46     static Ref<History> create(Frame* frame) { return adoptRef(*new History(frame)); }
47
48     unsigned length() const;
49     PassRefPtr<SerializedScriptValue> state();
50     void back();
51     void forward();
52     void go(int distance);
53
54     void back(ScriptExecutionContext*);
55     void forward(ScriptExecutionContext*);
56     void go(ScriptExecutionContext*, int distance);
57
58     bool stateChanged() const;
59     bool isSameAsCurrentState(SerializedScriptValue*) const;
60
61     enum class StateObjectType {
62         Push,
63         Replace
64     };
65     void stateObjectAdded(PassRefPtr<SerializedScriptValue>, const String& title, const String& url, StateObjectType, ExceptionCodeWithMessage&);
66
67 private:
68     explicit History(Frame*);
69
70     URL urlForState(const String& url);
71
72     PassRefPtr<SerializedScriptValue> stateInternal() const;
73
74     RefPtr<SerializedScriptValue> m_lastStateObjectRequested;
75
76     unsigned m_nonUserGestureObjectsAdded { 0 };
77     unsigned m_currentUserGestureObjectsAdded { 0 };
78     double m_currentUserGestureTimestamp { 0 };
79
80     // For the main frame's History object to keep track of all state object usage.
81     uint64_t m_totalStateObjectUsage { 0 };
82
83     // For each individual History object to keep track of the most recent state object added.
84     uint64_t m_mostRecentStateObjectUsage { 0 };
85 };
86
87 } // namespace WebCore
88
89 #endif // History_h