Replace WTF::move with WTFMove
[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 #ifndef MessageEvent_h
29 #define MessageEvent_h
30
31 #include "Blob.h"
32 #include "DOMWindow.h"
33 #include "Event.h"
34 #include "MessagePort.h"
35 #include "SerializedScriptValue.h"
36 #include <bindings/ScriptValue.h>
37 #include <memory>
38 #include <runtime/ArrayBuffer.h>
39
40 namespace WebCore {
41
42 class EventTarget;
43
44 struct MessageEventInit : public EventInit {
45     MessageEventInit();
46
47     Deprecated::ScriptValue data;
48     String origin;
49     String lastEventId;
50     RefPtr<EventTarget> source;
51     MessagePortArray ports;
52 };
53
54 class MessageEvent final : public Event {
55 public:
56     static Ref<MessageEvent> create()
57     {
58         return adoptRef(*new MessageEvent);
59     }
60     static Ref<MessageEvent> create(std::unique_ptr<MessagePortArray> ports, const Deprecated::ScriptValue& data = Deprecated::ScriptValue(), const String& origin = String(), const String& lastEventId = String(), PassRefPtr<EventTarget> source = nullptr)
61     {
62         return adoptRef(*new MessageEvent(data, origin, lastEventId, source, WTFMove(ports)));
63     }
64     static Ref<MessageEvent> create(std::unique_ptr<MessagePortArray> ports, PassRefPtr<SerializedScriptValue> data, const String& origin = String(), const String& lastEventId = String(), PassRefPtr<EventTarget> source = nullptr)
65     {
66         return adoptRef(*new MessageEvent(data, origin, lastEventId, source, WTFMove(ports)));
67     }
68     static Ref<MessageEvent> create(const String& data, const String& origin = String())
69     {
70         return adoptRef(*new MessageEvent(data, origin));
71     }
72     static Ref<MessageEvent> create(PassRefPtr<Blob> data, const String& origin = String())
73     {
74         return adoptRef(*new MessageEvent(data, origin));
75     }
76     static Ref<MessageEvent> create(PassRefPtr<ArrayBuffer> data, const String& origin = String())
77     {
78         return adoptRef(*new MessageEvent(data, origin));
79     }
80     static Ref<MessageEvent> create(const AtomicString& type, const MessageEventInit& initializer)
81     {
82         return adoptRef(*new MessageEvent(type, initializer));
83     }
84     virtual ~MessageEvent();
85
86     void initMessageEvent(const AtomicString& type, bool canBubble, bool cancelable, const Deprecated::ScriptValue& data, const String& origin, const String& lastEventId, DOMWindow* source, std::unique_ptr<MessagePortArray>);
87     void initMessageEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<SerializedScriptValue> data, const String& origin, const String& lastEventId, DOMWindow* source, std::unique_ptr<MessagePortArray>);
88
89     const String& origin() const { return m_origin; }
90     const String& lastEventId() const { return m_lastEventId; }
91     EventTarget* source() const { return m_source.get(); }
92     MessagePortArray ports() const { return m_ports ? *m_ports : MessagePortArray(); }
93
94     // FIXME: Remove this when we have custom ObjC binding support.
95     SerializedScriptValue* data() const;
96
97     // Needed for Objective-C bindings (see bug 28774).
98     MessagePort* messagePort();
99     void initMessageEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<SerializedScriptValue> data, const String& origin, const String& lastEventId, DOMWindow* source, MessagePort*);
100
101     virtual EventInterface eventInterface() const override;
102
103     enum DataType {
104         DataTypeScriptValue,
105         DataTypeSerializedScriptValue,
106         DataTypeString,
107         DataTypeBlob,
108         DataTypeArrayBuffer
109     };
110     DataType dataType() const { return m_dataType; }
111     const Deprecated::ScriptValue& dataAsScriptValue() const { ASSERT(m_dataType == DataTypeScriptValue); return m_dataAsScriptValue; }
112     PassRefPtr<SerializedScriptValue> dataAsSerializedScriptValue() const { ASSERT(m_dataType == DataTypeSerializedScriptValue); return m_dataAsSerializedScriptValue; }
113     String dataAsString() const { ASSERT(m_dataType == DataTypeString); return m_dataAsString; }
114     Blob* dataAsBlob() const { ASSERT(m_dataType == DataTypeBlob); return m_dataAsBlob.get(); }
115     ArrayBuffer* dataAsArrayBuffer() const { ASSERT(m_dataType == DataTypeArrayBuffer); return m_dataAsArrayBuffer.get(); }
116
117     RefPtr<SerializedScriptValue> trySerializeData(JSC::ExecState*);
118     
119 private:
120     MessageEvent();
121     MessageEvent(const AtomicString&, const MessageEventInit&);
122     MessageEvent(const Deprecated::ScriptValue& data, const String& origin, const String& lastEventId, PassRefPtr<EventTarget> source, std::unique_ptr<MessagePortArray>);
123     MessageEvent(PassRefPtr<SerializedScriptValue> data, const String& origin, const String& lastEventId, PassRefPtr<EventTarget> source, std::unique_ptr<MessagePortArray>);
124
125     explicit MessageEvent(const String& data, const String& origin);
126     explicit MessageEvent(PassRefPtr<Blob> data, const String& origin);
127     explicit MessageEvent(PassRefPtr<ArrayBuffer> data, const String& origin);
128
129     DataType m_dataType;
130     Deprecated::ScriptValue m_dataAsScriptValue;
131     RefPtr<SerializedScriptValue> m_dataAsSerializedScriptValue;
132     bool m_triedToSerialize { false };
133     String m_dataAsString;
134     RefPtr<Blob> m_dataAsBlob;
135     RefPtr<ArrayBuffer> m_dataAsArrayBuffer;
136     String m_origin;
137     String m_lastEventId;
138     RefPtr<EventTarget> m_source;
139     std::unique_ptr<MessagePortArray> m_ports;
140 };
141
142 } // namespace WebCore
143
144 #endif // MessageEvent_h