148831a601c4729b06b1dc494302e85c5010f7fb
[WebKit-https.git] / Source / WebCore / dom / MessageEvent.h
1 /*
2  * Copyright (C) 2007 Henry Mason (hmason@mac.com)
3  * Copyright (C) 2003-2018 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE 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 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. 
25  *
26  */
27
28 #pragma once
29
30 #include "Event.h"
31 #include "JSValueInWrappedObject.h"
32 #include "MessagePort.h"
33 #include "SerializedScriptValue.h"
34 #include "ServiceWorker.h"
35 #include "WindowProxy.h"
36 #include <wtf/Variant.h>
37
38 namespace WebCore {
39
40 class Blob;
41
42 #if ENABLE(SERVICE_WORKER)
43 using MessageEventSource = Variant<RefPtr<WindowProxy>, RefPtr<MessagePort>, RefPtr<ServiceWorker>>;
44 #else
45 using MessageEventSource = Variant<RefPtr<WindowProxy>, RefPtr<MessagePort>>;
46 #endif
47
48 class MessageEvent final : public Event {
49 public:
50     static Ref<MessageEvent> create(Vector<RefPtr<MessagePort>>&&, Ref<SerializedScriptValue>&&, const String& origin = { }, const String& lastEventId = { }, Optional<MessageEventSource>&& source = WTF::nullopt);
51     static Ref<MessageEvent> create(const AtomString& type, Ref<SerializedScriptValue>&&, const String& origin, const String& lastEventId);
52     static Ref<MessageEvent> create(const String& data, const String& origin = { });
53     static Ref<MessageEvent> create(Ref<Blob>&& data, const String& origin);
54     static Ref<MessageEvent> create(Ref<ArrayBuffer>&& data, const String& origin = { });
55     static Ref<MessageEvent> createForBindings();
56
57     struct Init : EventInit {
58         JSC::JSValue data;
59         String origin;
60         String lastEventId;
61         Optional<MessageEventSource> source;
62         Vector<RefPtr<MessagePort>> ports;
63     };
64     static Ref<MessageEvent> create(const AtomString& type, Init&&, IsTrusted = IsTrusted::No);
65
66     virtual ~MessageEvent();
67
68     void initMessageEvent(const AtomString& type, bool canBubble, bool cancelable, JSC::JSValue data, const String& origin, const String& lastEventId, Optional<MessageEventSource>&&, Vector<RefPtr<MessagePort>>&&);
69
70     const String& origin() const { return m_origin; }
71     const String& lastEventId() const { return m_lastEventId; }
72     const Optional<MessageEventSource>& source() const { return m_source; }
73     const Vector<RefPtr<MessagePort>>& ports() const { return m_ports; }
74
75     using DataType = Variant<JSValueInWrappedObject, Ref<SerializedScriptValue>, String, Ref<Blob>, Ref<ArrayBuffer>>;
76     const DataType& data() const { return m_data; }
77
78     JSValueInWrappedObject& cachedData() { return m_cachedData; }
79     JSValueInWrappedObject& cachedPorts() { return m_cachedPorts; }
80
81 private:
82     MessageEvent();
83     MessageEvent(const AtomString& type, Init&&, IsTrusted);
84     MessageEvent(const AtomString& type, Ref<SerializedScriptValue>&& data, const String& origin, const String& lastEventId);
85     MessageEvent(DataType&&, const String& origin, const String& lastEventId = { }, Optional<MessageEventSource>&& = WTF::nullopt, Vector<RefPtr<MessagePort>>&& = { });
86
87     EventInterface eventInterface() const final;
88
89     DataType m_data;
90     String m_origin;
91     String m_lastEventId;
92     Optional<MessageEventSource> m_source;
93     Vector<RefPtr<MessagePort>> m_ports;
94
95     JSValueInWrappedObject m_cachedData;
96     JSValueInWrappedObject m_cachedPorts;
97 };
98
99 } // namespace WebCore