1 /* 2 * Copyright (C) 2007 Henry Mason (hmason (at) 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 COMPUTER, 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 COMPUTER, 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 "bindings/v8/SerializedScriptValue.h" 32 #include "core/events/Event.h" 33 #include "core/events/EventTarget.h" 34 #include "core/dom/MessagePort.h" 35 #include "core/fileapi/Blob.h" 36 #include "core/frame/LocalDOMWindow.h" 37 #include "wtf/ArrayBuffer.h" 38 39 namespace WebCore { 40 41 struct MessageEventInit : public EventInit { 42 MessageEventInit(); 43 44 String origin; 45 String lastEventId; 46 RefPtrWillBeMember<EventTarget> source; 47 MessagePortArray ports; 48 }; 49 50 class MessageEvent FINAL : public Event { 51 public: 52 static PassRefPtrWillBeRawPtr<MessageEvent> create() 53 { 54 return adoptRefWillBeNoop(new MessageEvent); 55 } 56 static PassRefPtrWillBeRawPtr<MessageEvent> create(PassOwnPtr<MessagePortArray> ports, const String& origin = String(), const String& lastEventId = String(), PassRefPtrWillBeRawPtr<EventTarget> source = nullptr) 57 { 58 return adoptRefWillBeNoop(new MessageEvent(origin, lastEventId, source, ports)); 59 } 60 static PassRefPtrWillBeRawPtr<MessageEvent> create(PassOwnPtr<MessagePortArray> ports, PassRefPtr<SerializedScriptValue> data, const String& origin = String(), const String& lastEventId = String(), PassRefPtrWillBeRawPtr<EventTarget> source = nullptr) 61 { 62 return adoptRefWillBeNoop(new MessageEvent(data, origin, lastEventId, source, ports)); 63 } 64 static PassRefPtrWillBeRawPtr<MessageEvent> create(PassOwnPtr<MessagePortChannelArray> channels, PassRefPtr<SerializedScriptValue> data, const String& origin = String(), const String& lastEventId = String(), PassRefPtrWillBeRawPtr<EventTarget> source = nullptr) 65 { 66 return adoptRefWillBeNoop(new MessageEvent(data, origin, lastEventId, source, channels)); 67 } 68 static PassRefPtrWillBeRawPtr<MessageEvent> create(const String& data, const String& origin = String()) 69 { 70 return adoptRefWillBeNoop(new MessageEvent(data, origin)); 71 } 72 static PassRefPtrWillBeRawPtr<MessageEvent> create(PassRefPtrWillBeRawPtr<Blob> data, const String& origin = String()) 73 { 74 return adoptRefWillBeNoop(new MessageEvent(data, origin)); 75 } 76 static PassRefPtrWillBeRawPtr<MessageEvent> create(PassRefPtr<ArrayBuffer> data, const String& origin = String()) 77 { 78 return adoptRefWillBeNoop(new MessageEvent(data, origin)); 79 } 80 static PassRefPtrWillBeRawPtr<MessageEvent> create(const AtomicString& type, const MessageEventInit& initializer, ExceptionState&); 81 virtual ~MessageEvent(); 82 83 void initMessageEvent(const AtomicString& type, bool canBubble, bool cancelable, const String& origin, const String& lastEventId, LocalDOMWindow* source, PassOwnPtr<MessagePortArray>); 84 void initMessageEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<SerializedScriptValue> data, const String& origin, const String& lastEventId, LocalDOMWindow* source, PassOwnPtr<MessagePortArray>); 85 86 const String& origin() const { return m_origin; } 87 const String& lastEventId() const { return m_lastEventId; } 88 EventTarget* source() const { return m_source.get(); } 89 EventTarget* source(bool& isNull) const { isNull = !m_source; return m_source.get(); } 90 MessagePortArray ports() const { return m_ports ? *m_ports : MessagePortArray(); } 91 MessagePortChannelArray* channels() const { return m_channels ? m_channels.get() : 0; } 92 93 virtual const AtomicString& interfaceName() const OVERRIDE; 94 95 enum DataType { 96 DataTypeScriptValue, 97 DataTypeSerializedScriptValue, 98 DataTypeString, 99 DataTypeBlob, 100 DataTypeArrayBuffer 101 }; 102 DataType dataType() const { return m_dataType; } 103 SerializedScriptValue* dataAsSerializedScriptValue() const { ASSERT(m_dataType == DataTypeScriptValue || m_dataType == DataTypeSerializedScriptValue); return m_dataAsSerializedScriptValue.get(); } 104 String dataAsString() const { ASSERT(m_dataType == DataTypeString); return m_dataAsString; } 105 Blob* dataAsBlob() const { ASSERT(m_dataType == DataTypeBlob); return m_dataAsBlob.get(); } 106 ArrayBuffer* dataAsArrayBuffer() const { ASSERT(m_dataType == DataTypeArrayBuffer); return m_dataAsArrayBuffer.get(); } 107 108 void setSerializedData(PassRefPtr<SerializedScriptValue> data) 109 { 110 ASSERT(!m_dataAsSerializedScriptValue); 111 m_dataAsSerializedScriptValue = data; 112 } 113 114 void entangleMessagePorts(ExecutionContext*); 115 116 virtual void trace(Visitor*) OVERRIDE; 117 118 private: 119 MessageEvent(); 120 MessageEvent(const AtomicString&, const MessageEventInit&); 121 MessageEvent(const String& origin, const String& lastEventId, PassRefPtrWillBeRawPtr<EventTarget> source, PassOwnPtr<MessagePortArray>); 122 MessageEvent(PassRefPtr<SerializedScriptValue> data, const String& origin, const String& lastEventId, PassRefPtrWillBeRawPtr<EventTarget> source, PassOwnPtr<MessagePortArray>); 123 MessageEvent(PassRefPtr<SerializedScriptValue> data, const String& origin, const String& lastEventId, PassRefPtrWillBeRawPtr<EventTarget> source, PassOwnPtr<MessagePortChannelArray>); 124 125 MessageEvent(const String& data, const String& origin); 126 MessageEvent(PassRefPtrWillBeRawPtr<Blob> data, const String& origin); 127 MessageEvent(PassRefPtr<ArrayBuffer> data, const String& origin); 128 129 DataType m_dataType; 130 RefPtr<SerializedScriptValue> m_dataAsSerializedScriptValue; 131 String m_dataAsString; 132 RefPtrWillBeMember<Blob> m_dataAsBlob; 133 RefPtr<ArrayBuffer> m_dataAsArrayBuffer; 134 String m_origin; 135 String m_lastEventId; 136 RefPtrWillBeMember<EventTarget> m_source; 137 // m_ports are the MessagePorts in an engtangled state, and m_channels are 138 // the MessageChannels in a disentangled state. Only one of them can be 139 // non-empty at a time. entangleMessagePorts() moves between the states. 140 OwnPtr<MessagePortArray> m_ports; 141 OwnPtr<MessagePortChannelArray> m_channels; 142 }; 143 144 } // namespace WebCore 145 146 #endif // MessageEvent_h 147