Serial.h - mozsearch

Enable keyboard shortcuts

/* 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_Serial_h

#define mozilla_dom_Serial_h

#include "mozilla/DOMEventTargetHelper.h"

#include "mozilla/WeakPtr.h"

#include "mozilla/dom/PSerialPortChild.h"

#include "mozilla/dom/SerialPortInfo.h"

#include "mozilla/ipc/Endpoint.h"

#include "nsCOMPtr.h"

#include "nsTArray.h"

namespace mozilla::dom {

// Canonical UUID for the Bluetooth Serial Port Profile, used as the default

// bluetoothServiceClassId for Bluetooth serial ports when a more specific

// service class ID is not available from the platform.

inline constexpr char16_t kBluetoothSerialPortProfileUUID[] =

    u"00001101-0000-1000-8000-00805f9b34fb";

class Promise;

class SerialManagerChild;

class SerialPort;

struct SerialPortRequestOptions;

class Serial final : public DOMEventTargetHelper, public SupportsWeakPtr {

 public:

  NS_DECL_ISUPPORTS_INHERITED

  NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(Serial, DOMEventTargetHelper)

  explicit Serial(nsPIDOMWindowInner* aWindow);

  explicit Serial(nsIGlobalObject* aGlobal);

  JSObject* WrapObject(JSContext* aCx,

                       JS::Handle<JSObject*> aGivenProto) override;

  already_AddRefed<Promise> RequestPort(

      const SerialPortRequestOptions& aOptions, ErrorResult& aRv);

  already_AddRefed<Promise> GetPorts(ErrorResult& aRv);

  IMPL_EVENT_HANDLER(connect)

  IMPL_EVENT_HANDLER(disconnect)

  void Shutdown();

  SerialManagerChild* GetOrCreateManagerChild();

  void DisconnectFromOwner() override;

  MOZ_CAN_RUN_SCRIPT void ForgetAllPorts();

  already_AddRefed<Promise> SimulateDeviceConnection(

      const nsAString& aDeviceId, const nsAString& aDevicePath,

      uint16_t aVendorId, uint16_t aProductId,

      const nsAString& aBluetoothServiceClassId, ErrorResult& aRv);

  already_AddRefed<Promise> SimulateDeviceDisconnection(

      const nsAString& aDeviceId, ErrorResult& aRv);

  already_AddRefed<Promise> RemoveAllMockDevices(ErrorResult& aRv);

  already_AddRefed<Promise> ResetToDefaultMockDevices(ErrorResult& aRv);

  // Find or create a SerialPort for the given info. If an existing port

  // for aInfo.id() is already tracked, aEndpoint is dropped; the

  // caller is expected to reuse the existing port. Otherwise binds

  // aEndpoint to a new SerialPortChild.

  RefPtr<SerialPort> GetOrCreatePort(

      const IPCSerialPortInfo& aInfo,

      mozilla::ipc::Endpoint<PSerialPortChild>&& aEndpoint);

  // Remove the port from the granted list and mark it forgotten.

  MOZ_CAN_RUN_SCRIPT_BOUNDARY void ForgetPort(const nsAString& aPortId);

  bool GetAutoselectPorts(ErrorResult& aRv) const;

  void SetAutoselectPorts(bool aAutoselect, ErrorResult& aRv);

  static bool IsValidBluetoothUUID(const nsAString& aString);

  // Returns whether the filter validated successfully. If this function

  // returns false, aFailureReason will contain a string that can be used to

  // reject a Promise.

  static bool ValidatePortFilter(bool aHasUsbVendorId, bool aHasUsbProductId,

                                 bool aHasBluetoothServiceClassId,

                                 nsACString& aFailureReason);

 private:

  ~Serial() override;

  // The single list of granted SerialPort objects for this context.

  nsTArray<RefPtr<SerialPort>> mPorts;

  RefPtr<SerialManagerChild> mManagerChild;

  // True if shutdown has started

  bool mHasShutdown = false;

  // Auto-select port in testing mode (defaults to true since most tests want

  // this)

  bool mAutoselectPorts = true;

};

}  // namespace mozilla::dom

#endif  // mozilla_dom_Serial_h