567e456acd5ab06a217ae20edc4f49e071323b8a
[WebKit-https.git] / Source / WebCore / dom / PopStateEvent.h
1 /*
2  * Copyright (C) 2009-2017 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
27 #pragma once
28
29 #include "Event.h"
30 #include "JSValueInWrappedObject.h"
31
32 namespace WebCore {
33
34 class History;
35 class SerializedScriptValue;
36
37 class PopStateEvent final : public Event {
38 public:
39     virtual ~PopStateEvent();
40     static Ref<PopStateEvent> create(RefPtr<SerializedScriptValue>&&, History*);
41
42     struct Init : EventInit {
43         JSC::JSValue state;
44     };
45
46     static Ref<PopStateEvent> create(const AtomString&, const Init&, IsTrusted = IsTrusted::No);
47     static Ref<PopStateEvent> createForBindings();
48
49     const JSValueInWrappedObject& state() const { return m_state; }
50     SerializedScriptValue* serializedState() const { return m_serializedState.get(); }
51
52     RefPtr<SerializedScriptValue> trySerializeState(JSC::ExecState&);
53     
54     History* history() const { return m_history.get(); }
55
56 private:
57     PopStateEvent() = default;
58     PopStateEvent(const AtomString&, const Init&, IsTrusted);
59     PopStateEvent(RefPtr<SerializedScriptValue>&&, History*);
60
61     EventInterface eventInterface() const final;
62
63     JSValueInWrappedObject m_state;
64     RefPtr<SerializedScriptValue> m_serializedState;
65     bool m_triedToSerialize { false };
66     RefPtr<History> m_history;
67 };
68
69 } // namespace WebCore