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