Web MIDI: final IDL updates to conform the latest WD for shipping

Source/modules/webmidi/MIDIPort.cpp

 /*
  * Copyright (C) 2013 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 22 matching lines @@
 
 #include "bindings/core/v8/ScriptPromise.h"
 #include "core/dom/DOMException.h"
 #include "modules/webmidi/MIDIAccess.h"
 #include "modules/webmidi/MIDIConnectionEvent.h"
 
 namespace blink {
 
 using PortState = MIDIAccessor::MIDIPortState;
 
-MIDIPort::MIDIPort(MIDIAccess* access, const String& id, const String& manufacturer, const String& name, MIDIPortTypeCode type, const String& version, PortState state)
+MIDIPort::MIDIPort(MIDIAccess* access, const String& id, const String& manufacturer, const String& name, TypeCode type, const String& version, PortState state)
     : m_id(id)
     , m_manufacturer(manufacturer)
     , m_name(name)
     , m_type(type)
     , m_version(version)
     , m_access(access)
+    , m_connection(ConnectionStateClosed)
 {
     ASSERT(access);
-    ASSERT(type == MIDIPortTypeInput || type == MIDIPortTypeOutput);
+    ASSERT(type == TypeInput || type == TypeOutput);
     ASSERT(state == PortState::MIDIPortStateDisconnected
         || state == PortState::MIDIPortStateConnected
         || state == PortState::MIDIPortStateOpened);
-    // FIXME: Remove following code once blink API has a real open and close
-    // operations.
+    // TODO(toyoshim): Remove following code once blink API has a real open and
+    // close operations.
     if (state == PortState::MIDIPortStateOpened)
         state = PortState::MIDIPortStateConnected;
     m_state = state;
 }
 
+String MIDIPort::connection() const
+{
+    switch (m_connection) {
+    case ConnectionStateOpen:
+        return "open";
+    case ConnectionStateClosed:
+        return "closed";
+    case ConnectionStatePending:
+        return "pending";
+    }
+    return emptyString();
+}
+
 String MIDIPort::state() const
 {
     switch (m_state) {
     case PortState::MIDIPortStateDisconnected:
         return "disconnected";
     case PortState::MIDIPortStateConnected:
+    case PortState::MIDIPortStateOpened:
         return "connected";
-    case PortState::MIDIPortStateOpened:
-        return "opened";
-    default:
-        ASSERT_NOT_REACHED();
     }
     return emptyString();
 }
 
 String MIDIPort::type() const
 {
     switch (m_type) {
-    case MIDIPortTypeInput:
+    case TypeInput:
         return "input";
-    case MIDIPortTypeOutput:
+    case TypeOutput:
         return "output";
-    default:
-        ASSERT_NOT_REACHED();
     }
     return emptyString();
 }
 
 ScriptPromise MIDIPort::open(ScriptState* scriptState)
 {
+    // TODO(toyoshim): Implement the latest open() algorithm.
     switch (m_state) {
     case PortState::MIDIPortStateDisconnected:
         return reject(scriptState, InvalidStateError, "The port has been disconnected.");
     case PortState::MIDIPortStateConnected:
-        // FIXME: Add blink API to perform a real open operation.
-        setState(PortState::MIDIPortStateOpened);
-        // fall through
+        // TODO(toyoshim): Add blink API to perform a real open operation.
+        return setStates(m_state, ConnectionStateOpen)->accept(scriptState);
     case PortState::MIDIPortStateOpened:
-        return accept(scriptState);
-    default:
+        // TODO(toyoshim): Remove PortState::MIDIPortStateOpened.
         ASSERT_NOT_REACHED();
     }
     return reject(scriptState, InvalidStateError, "The port is in unknown state.");
 }
 
 ScriptPromise MIDIPort::close(ScriptState* scriptState)
 {
+    // TODO(toyoshim): Implement the latest close() algorithm.
     switch (m_state) {
     case PortState::MIDIPortStateDisconnected:
         return reject(scriptState, InvalidStateError, "The port has been disconnected.");
+    case PortState::MIDIPortStateConnected:
+        // TODO(toyoshim): Add blink API to perform a real close operation.
+        return setStates(m_state, ConnectionStateClosed)->accept(scriptState);
     case PortState::MIDIPortStateOpened:
-        // FIXME: Add blink API to perform a real close operation.
-        setState(PortState::MIDIPortStateConnected);
-        // fall through
-    case PortState::MIDIPortStateConnected:
-        return accept(scriptState);
-    default:
+        // TODO(toyoshim): Remove PortState::MIDIPortStateOpened.
         ASSERT_NOT_REACHED();
     }
     return reject(scriptState, InvalidStateError, "The port is in unknown state.");
 }
 
 void MIDIPort::setState(PortState state)
 {
-    if (m_state == state)
-        return;
-    m_state = state;
-    dispatchEvent(MIDIConnectionEvent::create(this));
+    setStates(state, m_connection);
 }
 
 ExecutionContext* MIDIPort::executionContext() const
 {
     return m_access->executionContext();
 }
 
 DEFINE_TRACE(MIDIPort)
 {
     visitor->trace(m_access);
     RefCountedGarbageCollectedEventTargetWithInlineData<MIDIPort>::trace(visitor);
 }
 
 ScriptPromise MIDIPort::accept(ScriptState* scriptState)
 {
     return ScriptPromise::cast(scriptState, toV8(this, scriptState->context()->Global(), scriptState->isolate()));
 }
 
 ScriptPromise MIDIPort::reject(ScriptState* scriptState, ExceptionCode ec, const String& message)
 {
     return ScriptPromise::rejectWithDOMException(scriptState, DOMException::create(ec, message));
 }
 
+// Note: setStates() dispatches a event and JavaScript may release this object
+// inside the handler. Caller should consider to retain |this|.
+MIDIPort* MIDIPort::setStates(PortState state, ConnectionState connection)
+{
+    // Retain |this| since an event handler may release it inside setStates().
+    MIDIPort* self = this;

[tkent, 2015/03/31 01:26:10]

Ah, MIDIPort is already on Oilpan.  Then you need to do nothing.  Oilpan ensures
|this| is not collected while the stack or a CPU register contains |this|.

[yhirano, 2015/03/31 02:23:37]

But I think we should protect the wrapper in order to retain event listeners.
That means We need to make MIDIPort inherit ActiveDOMObject. Please add a TODO.

+
+    if (m_state == state && m_connection == connection)
+        return self;
+    m_state = state;
+    m_connection = connection;
+    dispatchEvent(MIDIConnectionEvent::create(this));
+    return self;
+}
+
 } // namespace blink