[WTF] Import std::optional reference implementation as WTF::Optional
[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 <bindings/ScriptValue.h>
35 #include <wtf/Variant.h>
36
37 namespace WebCore {
38
39 class Blob;
40
41 using MessageEventSource = Variant<RefPtr<DOMWindow>, RefPtr<MessagePort>>;
42
43 class MessageEvent final : public Event {
44 public:
45     static Ref<MessageEvent> create(Vector<RefPtr<MessagePort>>&&, RefPtr<SerializedScriptValue>&&, const String& origin = { }, const String& lastEventId = { }, std::optional<MessageEventSource>&& source = std::nullopt);
46     static Ref<MessageEvent> create(const AtomicString& type, RefPtr<SerializedScriptValue>&&, const String& origin, const String& lastEventId);
47     static Ref<MessageEvent> create(const String& data, const String& origin = { });
48     static Ref<MessageEvent> create(Ref<Blob>&& data, const String& origin);
49     static Ref<MessageEvent> create(Ref<ArrayBuffer>&& data, const String& origin = { });
50     static Ref<MessageEvent> createForBindings();
51
52     struct Init : EventInit {
53         JSC::JSValue data;
54         String origin;
55         String lastEventId;
56         std::optional<MessageEventSource> source;
57         Vector<RefPtr<MessagePort>> ports;
58     };
59     static Ref<MessageEvent> create(JSC::ExecState&, const AtomicString& type, Init&&, IsTrusted = IsTrusted::No);
60
61     virtual ~MessageEvent();
62
63     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>>&&);
64     void initMessageEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<SerializedScriptValue> data, const String& origin, const String& lastEventId, std::optional<MessageEventSource>&&, Vector<RefPtr<MessagePort>>&&);
65
66     const String& origin() const { return m_origin; }
67     const String& lastEventId() const { return m_lastEventId; }
68     EventTarget* source() const;
69     const Vector<RefPtr<MessagePort>>& ports() const { return m_ports; }
70
71     // FIXME: Remove this when we have custom ObjC binding support.
72     SerializedScriptValue* data() const;
73
74     EventInterface eventInterface() const override;
75
76     enum DataType {
77         DataTypeScriptValue,
78         DataTypeSerializedScriptValue,
79         DataTypeString,
80         DataTypeBlob,
81         DataTypeArrayBuffer
82     };
83     DataType dataType() const { return m_dataType; }
84     JSC::JSValue dataAsScriptValue() const { ASSERT(m_dataType == DataTypeScriptValue); return m_dataAsScriptValue; }
85     PassRefPtr<SerializedScriptValue> dataAsSerializedScriptValue() const { ASSERT(m_dataType == DataTypeSerializedScriptValue); return m_dataAsSerializedScriptValue; }
86     String dataAsString() const { ASSERT(m_dataType == DataTypeString); return m_dataAsString; }
87     Blob* dataAsBlob() const { ASSERT(m_dataType == DataTypeBlob); return m_dataAsBlob.get(); }
88     ArrayBuffer* dataAsArrayBuffer() const { ASSERT(m_dataType == DataTypeArrayBuffer); return m_dataAsArrayBuffer.get(); }
89
90     RefPtr<SerializedScriptValue> trySerializeData(JSC::ExecState*);
91     
92 private:
93     MessageEvent();
94     MessageEvent(JSC::ExecState&, const AtomicString&, Init&&, IsTrusted);
95     MessageEvent(RefPtr<SerializedScriptValue>&& data, const String& origin, const String& lastEventId, std::optional<MessageEventSource>&&, Vector<RefPtr<MessagePort>>&&);
96     MessageEvent(const AtomicString& type, RefPtr<SerializedScriptValue>&& data, const String& origin, const String& lastEventId);
97     MessageEvent(const String& data, const String& origin);
98     MessageEvent(Ref<Blob>&& data, const String& origin);
99     MessageEvent(Ref<ArrayBuffer>&& data, const String& origin);
100
101     DataType m_dataType;
102     Deprecated::ScriptValue m_dataAsScriptValue;
103     RefPtr<SerializedScriptValue> m_dataAsSerializedScriptValue;
104     bool m_triedToSerialize { false };
105     String m_dataAsString;
106     RefPtr<Blob> m_dataAsBlob;
107     RefPtr<ArrayBuffer> m_dataAsArrayBuffer;
108     String m_origin;
109     String m_lastEventId;
110     std::optional<MessageEventSource> m_source;
111     Vector<RefPtr<MessagePort>> m_ports;
112 };
113
114 } // namespace WebCore