ad110f0c6777f685062bdecb31bd702f27929b79
[WebKit-https.git] / Source / WebCore / dom / MessageEvent.h
1 /*
2  * Copyright (C) 2007 Henry Mason (hmason@mac.com)
3  * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 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 "DOMWindow.h"
31 #include "Event.h"
32 #include "MessagePort.h"
33 #include "SerializedScriptValue.h"
34 #include "ServiceWorker.h"
35 #include <bindings/ScriptValue.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<DOMWindow>, RefPtr<MessagePort>, RefPtr<ServiceWorker>>;
44 #else
45 using MessageEventSource = Variant<RefPtr<DOMWindow>, RefPtr<MessagePort>>;
46 #endif
47
48 class MessageEvent final : public Event {
49 public:
50     static Ref<MessageEvent> create(Vector<RefPtr<MessagePort>>&&, RefPtr<SerializedScriptValue>&&, const String& origin = { }, const String& lastEventId = { }, std::optional<MessageEventSource>&& source = std::nullopt);
51     static Ref<MessageEvent> create(const AtomicString& type, RefPtr<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         std::optional<MessageEventSource> source;
62         Vector<RefPtr<MessagePort>> ports;
63     };
64     static Ref<MessageEvent> create(JSC::ExecState&, const AtomicString& type, Init&&, IsTrusted = IsTrusted::No);
65
66     virtual ~MessageEvent();
67
68     void initMessageEvent(JSC::ExecState&, const AtomicString& type, bool canBubble, bool cancelable, JSC::JSValue data, const String& origin, const String& lastEventId, std::optional<MessageEventSource>&&, Vector<RefPtr<MessagePort>>&&);
69
70     const String& origin() const { return m_origin; }
71     const String& lastEventId() const { return m_lastEventId; }
72     const std::optional<MessageEventSource>& source() const { return m_source; }
73     const Vector<RefPtr<MessagePort>>& ports() const { return m_ports; }
74
75     // FIXME: Remove this when we have custom ObjC binding support.
76     SerializedScriptValue* data() const;
77
78     enum DataType {
79         DataTypeScriptValue,
80         DataTypeSerializedScriptValue,
81         DataTypeString,
82         DataTypeBlob,
83         DataTypeArrayBuffer
84     };
85     DataType dataType() const { return m_dataType; }
86     JSC::JSValue dataAsScriptValue() const { ASSERT(m_dataType == DataTypeScriptValue); return m_dataAsScriptValue; }
87     SerializedScriptValue* dataAsSerializedScriptValue() const { ASSERT(m_dataType == DataTypeSerializedScriptValue); return m_dataAsSerializedScriptValue.get(); }
88     String dataAsString() const { ASSERT(m_dataType == DataTypeString); return m_dataAsString; }
89     Blob* dataAsBlob() const { ASSERT(m_dataType == DataTypeBlob); return m_dataAsBlob.get(); }
90     ArrayBuffer* dataAsArrayBuffer() const { ASSERT(m_dataType == DataTypeArrayBuffer); return m_dataAsArrayBuffer.get(); }
91
92     RefPtr<SerializedScriptValue> trySerializeData(JSC::ExecState*);
93
94 private:
95     MessageEvent();
96     MessageEvent(JSC::ExecState&, const AtomicString&, Init&&, IsTrusted);
97     MessageEvent(RefPtr<SerializedScriptValue>&& data, const String& origin, const String& lastEventId, std::optional<MessageEventSource>&&, Vector<RefPtr<MessagePort>>&&);
98     MessageEvent(const AtomicString& type, RefPtr<SerializedScriptValue>&& data, const String& origin, const String& lastEventId);
99     MessageEvent(const String& data, const String& origin);
100     MessageEvent(Ref<Blob>&& data, const String& origin);
101     MessageEvent(Ref<ArrayBuffer>&& data, const String& origin);
102
103     EventInterface eventInterface() const final;
104
105     DataType m_dataType;
106     Deprecated::ScriptValue m_dataAsScriptValue;
107     RefPtr<SerializedScriptValue> m_dataAsSerializedScriptValue;
108     bool m_triedToSerialize { false };
109     String m_dataAsString;
110     RefPtr<Blob> m_dataAsBlob;
111     RefPtr<ArrayBuffer> m_dataAsArrayBuffer;
112     String m_origin;
113     String m_lastEventId;
114     std::optional<MessageEventSource> m_source;
115     Vector<RefPtr<MessagePort>> m_ports;
116 };
117
118 } // namespace WebCore