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