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 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 "SerializedScriptValue.h"
  36
  37 namespace WebCore {
  38
  39     class DOMWindow;
  40
  41     class MessageEvent : public Event {
  42     public:
  43         static PassRefPtr<MessageEvent> create()
  44         {
  45             return adoptRef(new MessageEvent);
  46         }
  47         static PassRefPtr<MessageEvent> create(PassOwnPtr<MessagePortArray> ports, PassRefPtr<SerializedScriptValue> data = 0, const String& origin = "", const String& lastEventId = "", PassRefPtr<DOMWindow> source = 0)
  48         {
  49             return adoptRef(new MessageEvent(data, origin, lastEventId, source, ports));
  50         }
  51         static PassRefPtr<MessageEvent> create(const String& data)
  52         {
  53             return adoptRef(new MessageEvent(data));
  54         }
  55         static PassRefPtr<MessageEvent> create(PassRefPtr<Blob> data)
  56         {
  57             return adoptRef(new MessageEvent(data));
  58         }
  59         virtual ~MessageEvent();
  60
  61         void initMessageEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<SerializedScriptValue> data, const String& origin, const String& lastEventId, DOMWindow* source, PassOwnPtr<MessagePortArray>);
  62
  63         const String& origin() const { return m_origin; }
  64         const String& lastEventId() const { return m_lastEventId; }
  65         DOMWindow* source() const { return m_source.get(); }
  66         MessagePortArray* ports() const { return m_ports.get(); }
  67
  68         // FIXME: Remove this when we have custom ObjC binding support.
  69         SerializedScriptValue* data() const;
  70
  71         // FIXME: remove this when we update the ObjC bindings (bug #28774).
  72         MessagePort* messagePort();
  73         // FIXME: remove this when we update the ObjC bindings (bug #28774).
  74         void initMessageEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<SerializedScriptValue> data, const String& origin, const String& lastEventId, DOMWindow* source, MessagePort*);
  75
  76         virtual bool isMessageEvent() const;
  77
  78         enum DataType {
  79             DataTypeSerializedScriptValue,
  80             DataTypeString,
  81             DataTypeBlob
  82         };
  83         DataType dataType() const { return m_dataType; }
  84         SerializedScriptValue* dataAsSerializedScriptValue() const { return m_dataAsSerializedScriptValue.get(); }
  85         String dataAsString() const { return m_dataAsString; }
  86         Blob* dataAsBlob() const { return m_dataAsBlob.get(); }
  87
  88     private:
  89         MessageEvent();
  90         MessageEvent(PassRefPtr<SerializedScriptValue> data, const String& origin, const String& lastEventId, PassRefPtr<DOMWindow> source, PassOwnPtr<MessagePortArray>);
  91         explicit MessageEvent(const String& data);
  92         explicit MessageEvent(PassRefPtr<Blob> data);
  93
  94         DataType m_dataType;
  95         RefPtr<SerializedScriptValue> m_dataAsSerializedScriptValue;
  96         String m_dataAsString;
  97         RefPtr<Blob> m_dataAsBlob;
  98         String m_origin;
  99         String m_lastEventId;
 100         RefPtr<DOMWindow> m_source;
 101         OwnPtr<MessagePortArray> m_ports;
 102     };
 103
 104 } // namespace WebCore
 105
 106 #endif // MessageEvent_h