dom/midi/MIDIAccessManager.h
author Mike Hommey <mh+mozilla@glandium.org>
Fri, 11 Jan 2019 16:01:15 +0000
changeset 453570 daf50f25895db073e44d50fecf2e4f6fe873865d
parent 448947 6f3709b3878117466168c40affa7bca0b60cf75b
permissions -rw-r--r--
Bug 1519307 - Add a new project to build useful parts of breakpad independently. r=froydnj With `ac_add_options --enable-project=tools/crashreporter` in a mozconfig, `./mach build` builds minidump_stackwalk, dump_syms and fileid. One caveat is that due to limitation in how the build system works currently, it's cumbersome to keep dump_syms as a host program for Gecko, and to make it a target program for this project. For now, keep it as a host program. We're not going to use it on automation, but it's still convenient to have for quick local builds (I've had to resort to awful hacks downstream). Differential Revision: https://phabricator.services.mozilla.com/D16299

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et cindent: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_dom_MIDIAccessManager_h
#define mozilla_dom_MIDIAccessManager_h

#include "nsPIDOMWindow.h"
#include "nsIObserver.h"
#include "mozilla/dom/MIDITypes.h"
#include "mozilla/Observer.h"

namespace mozilla {
namespace dom {

class MIDIAccess;
class MIDIManagerChild;
struct MIDIOptions;
class MIDIPortChangeEvent;
class MIDIPortInfo;
class Promise;

/**
 * MIDIAccessManager manages creation and lifetime of MIDIAccess objects for the
 * process it lives in. It is in charge of dealing with permission requests,
 * creating new MIDIAccess objects, and updating live MIDIAccess objects with
 * new device listings.
 *
 * While a process/window can have many MIDIAccess objects, there is only one
 * MIDIAccessManager for any one process.
 */
class MIDIAccessManager final {
 public:
  NS_INLINE_DECL_REFCOUNTING(MIDIAccessManager);
  // Handles requests from Navigator for MIDI permissions and MIDIAccess
  // creation.
  already_AddRefed<Promise> RequestMIDIAccess(nsPIDOMWindowInner* aWindow,
                                              const MIDIOptions& aOptions,
                                              ErrorResult& aRv);
  // Creates a new MIDIAccess object
  void CreateMIDIAccess(nsPIDOMWindowInner* aWindow, bool aNeedsSysex,
                        Promise* aPromise);
  // Getter for manager singleton
  static MIDIAccessManager* Get();
  // True if manager singleton has been created
  static bool IsRunning();
  // Send device connection updates to all known MIDIAccess objects.
  void Update(const MIDIPortList& aEvent);
  // Adds a device update observer (usually a MIDIAccess object)
  bool AddObserver(Observer<MIDIPortList>* aObserver);
  // Removes a device update observer (usually a MIDIAccess object)
  void RemoveObserver(Observer<MIDIPortList>* aObserver);

 private:
  MIDIAccessManager();
  ~MIDIAccessManager();
  // True if object has received a device list from the MIDI platform service.
  bool mHasPortList;
  // List of known ports for the system.
  MIDIPortList mPortList;
  // Holds MIDIAccess objects until we've received the first list of devices
  // from the MIDI Service.
  nsTArray<RefPtr<MIDIAccess>> mAccessHolder;
  // Device state update observers (usually MIDIAccess objects)
  ObserverList<MIDIPortList> mChangeObservers;
  // IPC Object for MIDIManager. Created on first MIDIAccess object creation,
  // destroyed on last MIDIAccess object destruction.
  RefPtr<MIDIManagerChild> mChild;
};

}  // namespace dom
}  // namespace mozilla

#endif  // mozilla_dom_MIDIAccessManager_h