SpeechSynthesis.h - mozsearch

Enable keyboard shortcuts

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

#define mozilla_dom_SpeechSynthesis_h

#include "nsCOMPtr.h"

#include "nsIObserver.h"

#include "nsRefPtrHashtable.h"

#include "nsString.h"

#include "nsWeakReference.h"

#include "nsWrapperCache.h"

#include "js/TypeDecls.h"

#include "SpeechSynthesisUtterance.h"

#include "SpeechSynthesisVoice.h"

class nsIDOMWindow;

namespace mozilla::dom {

class nsSpeechTask;

class SpeechSynthesis final : public DOMEventTargetHelper,

                              public nsIObserver,

                              public nsSupportsWeakReference {

 public:

  explicit SpeechSynthesis(nsPIDOMWindowInner* aParent);

  NS_DECL_ISUPPORTS_INHERITED

  NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(SpeechSynthesis,

                                           DOMEventTargetHelper)

  NS_DECL_NSIOBSERVER

  JSObject* WrapObject(JSContext* aCx,

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

  bool Pending() const;

  bool Speaking() const;

  bool Paused() const;

  bool HasEmptyQueue() const;

  void Speak(SpeechSynthesisUtterance& aUtterance);

  void Cancel();

  void Pause();

  void Resume();

  void OnEnd(const nsSpeechTask* aTask);

  void GetVoices(nsTArray<RefPtr<SpeechSynthesisVoice> >& aResult);

  void ForceEnd();

  IMPL_EVENT_HANDLER(voiceschanged)

 private:

  virtual ~SpeechSynthesis();

  void AdvanceQueue();

  bool HasVoices() const;

  bool HasSpeakingTask() const {

    return mCurrentTask && mCurrentTask->IsSpeaking();

  nsTArray<RefPtr<SpeechSynthesisUtterance> > mSpeechQueue;

  RefPtr<nsSpeechTask> mCurrentTask;

  nsRefPtrHashtable<nsStringHashKey, SpeechSynthesisVoice> mVoiceCache;

  bool mHoldQueue;

  uint64_t mInnerID;

};

}  // namespace mozilla::dom

#endif