Blame dom/midi/MIDIPort.cpp

Packit f0b94e
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
Packit f0b94e
/* vim:set ts=2 sw=2 sts=2 et cindent: */
Packit f0b94e
/* This Source Code Form is subject to the terms of the Mozilla Public
Packit f0b94e
 * License, v. 2.0. If a copy of the MPL was not distributed with this
Packit f0b94e
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
Packit f0b94e
Packit f0b94e
#include "mozilla/dom/MIDIPort.h"
Packit f0b94e
#include "mozilla/dom/MIDIPortChild.h"
Packit f0b94e
#include "mozilla/dom/MIDIAccess.h"
Packit f0b94e
#include "mozilla/dom/MIDITypes.h"
Packit f0b94e
#include "mozilla/ipc/PBackgroundChild.h"
Packit f0b94e
#include "mozilla/ipc/BackgroundChild.h"
Packit f0b94e
#include "mozilla/dom/Promise.h"
Packit f0b94e
#include "mozilla/dom/MIDITypes.h"
Packit f0b94e
#include "mozilla/Unused.h"
Packit f0b94e
#include "nsISupportsImpl.h"  // for MOZ_COUNT_CTOR, MOZ_COUNT_DTOR
Packit f0b94e
Packit f0b94e
using namespace mozilla::ipc;
Packit f0b94e
Packit f0b94e
namespace mozilla {
Packit f0b94e
namespace dom {
Packit f0b94e
Packit f0b94e
NS_IMPL_CYCLE_COLLECTION_INHERITED(MIDIPort, DOMEventTargetHelper,
Packit f0b94e
                                   mOpeningPromise, mClosingPromise)
Packit f0b94e
Packit f0b94e
NS_IMPL_CYCLE_COLLECTION_TRACE_BEGIN_INHERITED(MIDIPort, DOMEventTargetHelper)
Packit f0b94e
NS_IMPL_CYCLE_COLLECTION_TRACE_END
Packit f0b94e
Packit f0b94e
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(MIDIPort)
Packit f0b94e
  NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY
Packit f0b94e
NS_INTERFACE_MAP_END_INHERITING(DOMEventTargetHelper)
Packit f0b94e
Packit f0b94e
NS_IMPL_ADDREF_INHERITED(MIDIPort, DOMEventTargetHelper)
Packit f0b94e
NS_IMPL_RELEASE_INHERITED(MIDIPort, DOMEventTargetHelper)
Packit f0b94e
Packit f0b94e
MIDIPort::MIDIPort(nsPIDOMWindowInner* aWindow, MIDIAccess* aMIDIAccessParent)
Packit f0b94e
    : DOMEventTargetHelper(aWindow), mMIDIAccessParent(aMIDIAccessParent) {
Packit f0b94e
  MOZ_ASSERT(aWindow);
Packit f0b94e
  MOZ_ASSERT(aMIDIAccessParent);
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
MIDIPort::~MIDIPort() {
Packit f0b94e
  if (mMIDIAccessParent) {
Packit f0b94e
    mMIDIAccessParent->RemovePortListener(this);
Packit f0b94e
    mMIDIAccessParent = nullptr;
Packit f0b94e
  }
Packit f0b94e
  if (mPort) {
Packit f0b94e
    // If the IPC port channel is still alive at this point, it means we're
Packit f0b94e
    // probably CC'ing this port object. Send the shutdown message to also clean
Packit f0b94e
    // up the IPC channel.
Packit f0b94e
    mPort->SendShutdown();
Packit f0b94e
    // This will unset the IPC Port pointer. Don't call anything after this.
Packit f0b94e
    mPort->Teardown();
Packit f0b94e
  }
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
bool MIDIPort::Initialize(const MIDIPortInfo& aPortInfo, bool aSysexEnabled) {
Packit f0b94e
  RefPtr<MIDIPortChild> port =
Packit f0b94e
      new MIDIPortChild(aPortInfo, aSysexEnabled, this);
Packit f0b94e
  PBackgroundChild* b = BackgroundChild::GetForCurrentThread();
Packit f0b94e
  MOZ_ASSERT(b,
Packit f0b94e
             "Should always have a valid BackgroundChild when creating a port "
Packit f0b94e
             "object!");
Packit f0b94e
  if (!b->SendPMIDIPortConstructor(port, aPortInfo, aSysexEnabled)) {
Packit f0b94e
    return false;
Packit f0b94e
  }
Packit f0b94e
  mPort = port;
Packit f0b94e
  // Make sure to increase the ref count for the port, so it can be cleaned up
Packit f0b94e
  // by the IPC manager.
Packit f0b94e
  mPort->SetActorAlive();
Packit f0b94e
  return true;
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
void MIDIPort::UnsetIPCPort() { mPort = nullptr; }
Packit f0b94e
Packit f0b94e
JSObject* MIDIPort::WrapObject(JSContext* aCx,
Packit f0b94e
                               JS::Handle<JSObject*> aGivenProto) {
Packit f0b94e
  return MIDIPortBinding::Wrap(aCx, this, aGivenProto);
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
void MIDIPort::GetId(nsString& aRetVal) const {
Packit f0b94e
  MOZ_ASSERT(mPort);
Packit f0b94e
  aRetVal = mPort->MIDIPortInterface::Id();
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
void MIDIPort::GetManufacturer(nsString& aRetVal) const {
Packit f0b94e
  MOZ_ASSERT(mPort);
Packit f0b94e
  aRetVal = mPort->Manufacturer();
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
void MIDIPort::GetName(nsString& aRetVal) const {
Packit f0b94e
  MOZ_ASSERT(mPort);
Packit f0b94e
  aRetVal = mPort->Name();
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
void MIDIPort::GetVersion(nsString& aRetVal) const {
Packit f0b94e
  MOZ_ASSERT(mPort);
Packit f0b94e
  aRetVal = mPort->Version();
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
MIDIPortType MIDIPort::Type() const {
Packit f0b94e
  MOZ_ASSERT(mPort);
Packit f0b94e
  return mPort->Type();
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
MIDIPortConnectionState MIDIPort::Connection() const {
Packit f0b94e
  MOZ_ASSERT(mPort);
Packit f0b94e
  return mPort->ConnectionState();
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
MIDIPortDeviceState MIDIPort::State() const {
Packit f0b94e
  MOZ_ASSERT(mPort);
Packit f0b94e
  return mPort->DeviceState();
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
bool MIDIPort::SysexEnabled() const {
Packit f0b94e
  MOZ_ASSERT(mPort);
Packit f0b94e
  return mPort->SysexEnabled();
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
already_AddRefed<Promise> MIDIPort::Open() {
Packit f0b94e
  MOZ_ASSERT(mPort);
Packit f0b94e
  RefPtr<Promise> p;
Packit f0b94e
  if (mOpeningPromise) {
Packit f0b94e
    p = mOpeningPromise;
Packit f0b94e
    return p.forget();
Packit f0b94e
  }
Packit f0b94e
  ErrorResult rv;
Packit f0b94e
  nsCOMPtr<nsIGlobalObject> go = do_QueryInterface(GetOwner());
Packit f0b94e
  p = Promise::Create(go, rv);
Packit f0b94e
  if (rv.Failed()) {
Packit f0b94e
    return nullptr;
Packit f0b94e
  }
Packit f0b94e
  mOpeningPromise = p;
Packit f0b94e
  mPort->SendOpen();
Packit f0b94e
  return p.forget();
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
already_AddRefed<Promise> MIDIPort::Close() {
Packit f0b94e
  MOZ_ASSERT(mPort);
Packit f0b94e
  RefPtr<Promise> p;
Packit f0b94e
  if (mClosingPromise) {
Packit f0b94e
    p = mClosingPromise;
Packit f0b94e
    return p.forget();
Packit f0b94e
  }
Packit f0b94e
  ErrorResult rv;
Packit f0b94e
  nsCOMPtr<nsIGlobalObject> go = do_QueryInterface(GetOwner());
Packit f0b94e
  p = Promise::Create(go, rv);
Packit f0b94e
  if (rv.Failed()) {
Packit f0b94e
    return nullptr;
Packit f0b94e
  }
Packit f0b94e
  mClosingPromise = p;
Packit f0b94e
  mPort->SendClose();
Packit f0b94e
  return p.forget();
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
void MIDIPort::Notify(const void_t& aVoid) {
Packit f0b94e
  // If we're getting notified, it means the MIDIAccess parent object is dead.
Packit f0b94e
  // Nullify our copy.
Packit f0b94e
  mMIDIAccessParent = nullptr;
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
void MIDIPort::FireStateChangeEvent() {
Packit f0b94e
  MOZ_ASSERT(mPort);
Packit f0b94e
  if (mPort->ConnectionState() == MIDIPortConnectionState::Open ||
Packit f0b94e
      mPort->ConnectionState() == MIDIPortConnectionState::Pending) {
Packit f0b94e
    if (mOpeningPromise) {
Packit f0b94e
      mOpeningPromise->MaybeResolve(this);
Packit f0b94e
      mOpeningPromise = nullptr;
Packit f0b94e
    }
Packit f0b94e
  } else if (mPort->ConnectionState() == MIDIPortConnectionState::Closed) {
Packit f0b94e
    if (mOpeningPromise) {
Packit f0b94e
      mOpeningPromise->MaybeReject(NS_ERROR_DOM_INVALID_ACCESS_ERR);
Packit f0b94e
      mOpeningPromise = nullptr;
Packit f0b94e
    }
Packit f0b94e
    if (mClosingPromise) {
Packit f0b94e
      mClosingPromise->MaybeResolve(this);
Packit f0b94e
      mClosingPromise = nullptr;
Packit f0b94e
    }
Packit f0b94e
  }
Packit f0b94e
  if (mPort->DeviceState() == MIDIPortDeviceState::Connected &&
Packit f0b94e
      mPort->ConnectionState() == MIDIPortConnectionState::Pending) {
Packit f0b94e
    mPort->SendOpen();
Packit f0b94e
  }
Packit f0b94e
  // Fire MIDIAccess events first so that the port is no longer in the port
Packit f0b94e
  // maps.
Packit f0b94e
  if (mMIDIAccessParent) {
Packit f0b94e
    mMIDIAccessParent->FireConnectionEvent(this);
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  MIDIConnectionEventInit init;
Packit f0b94e
  init.mPort = this;
Packit f0b94e
  RefPtr<MIDIConnectionEvent> event(MIDIConnectionEvent::Constructor(
Packit f0b94e
      this, NS_LITERAL_STRING("statechange"), init));
Packit f0b94e
  DispatchTrustedEvent(event);
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
void MIDIPort::Receive(const nsTArray<MIDIMessage>& aMsg) {
Packit f0b94e
  MOZ_CRASH("We should never get here!");
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
}  // namespace dom
Packit f0b94e
}  // namespace mozilla