src/third_party/WebKit/Source/modules/webmidi/MIDIPort.h

   1 /*
   2  * Copyright (C) 2013 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef MIDIPort_h
  32 #define MIDIPort_h
  33
  34 #include "bindings/v8/ScriptWrappable.h"
  35 #include "core/events/EventTarget.h"
  36 #include "wtf/RefCounted.h"
  37 #include "wtf/RefPtr.h"
  38 #include "wtf/Vector.h"
  39
  40 namespace WebCore {
  41
  42 class MIDIAccess;
  43
  44 class MIDIPort : public RefCounted<MIDIPort>, public ScriptWrappable, public EventTargetWithInlineData {
  45     REFCOUNTED_EVENT_TARGET(MIDIPort);
  46 public:
  47     enum MIDIPortTypeCode {
  48         MIDIPortTypeInput,
  49         MIDIPortTypeOutput
  50     };
  51
  52     virtual ~MIDIPort() { }
  53
  54     String id() const { return m_id; }
  55     String manufacturer() const { return m_manufacturer; }
  56     String name() const { return m_name; }
  57     String type() const;
  58     String version() const { return m_version; }
  59
  60     MIDIAccess* midiAccess() const { return m_access; }
  61
  62     DEFINE_ATTRIBUTE_EVENT_LISTENER(disconnect);
  63
  64     // EventTarget
  65     virtual const AtomicString& interfaceName() const OVERRIDE { return EventTargetNames::MIDIPort; }
  66     virtual ExecutionContext* executionContext() const OVERRIDE FINAL;
  67
  68 protected:
  69     MIDIPort(MIDIAccess*, const String& id, const String& manufacturer, const String& name, MIDIPortTypeCode, const String& version);
  70
  71 private:
  72     String m_id;
  73     String m_manufacturer;
  74     String m_name;
  75     MIDIPortTypeCode m_type;
  76     String m_version;
  77     // Hold a raw pointer to avoid a circular reference.
  78     // Lifecycle is guaranteed by SetWrapperReferenceTo() IDL annotation.
  79     // This will be improved by the oilpan.
  80     MIDIAccess* m_access;
  81 };
  82
  83 typedef Vector<RefPtr<MIDIPort> > MIDIPortVector;
  84
  85 } // namespace WebCore
  86
  87 #endif // MIDIPort_h