summaryrefslogtreecommitdiffstats
path: root/dom/media/webspeech/recognition/SpeechGrammarList.h
blob: 7f1e09cd9e0b7695365848563e5b92a76402e3d2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/* -*- 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_SpeechGrammarList_h
#define mozilla_dom_SpeechGrammarList_h

#include "mozilla/Attributes.h"
#include "nsCOMPtr.h"
#include "nsCycleCollectionParticipant.h"
#include "nsTArray.h"
#include "nsWrapperCache.h"

struct JSContext;

namespace mozilla {

class ErrorResult;

namespace dom {

class GlobalObject;
class SpeechGrammar;
template <typename>
class Optional;

class SpeechGrammarList final : public nsISupports, public nsWrapperCache {
 public:
  explicit SpeechGrammarList(nsISupports* aParent);

  NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(SpeechGrammarList)

  static already_AddRefed<SpeechGrammarList> Constructor(
      const GlobalObject& aGlobal);

  static already_AddRefed<SpeechGrammarList> WebkitSpeechGrammarList(
      const GlobalObject& aGlobal, ErrorResult& aRv) {
    return Constructor(aGlobal);
  }

  nsISupports* GetParentObject() const;

  JSObject* WrapObject(JSContext* aCx,
                       JS::Handle<JSObject*> aGivenProto) override;

  uint32_t Length() const;

  already_AddRefed<SpeechGrammar> Item(uint32_t aIndex, ErrorResult& aRv);

  void AddFromURI(const nsAString& aSrc, const Optional<float>& aWeight,
                  ErrorResult& aRv);

  void AddFromString(const nsAString& aString, const Optional<float>& aWeight,
                     ErrorResult& aRv);

  already_AddRefed<SpeechGrammar> IndexedGetter(uint32_t aIndex, bool& aPresent,
                                                ErrorResult& aRv);

 private:
  ~SpeechGrammarList();

  nsCOMPtr<nsISupports> mParent;

  nsTArray<RefPtr<SpeechGrammar>> mItems;
};

}  // namespace dom
}  // namespace mozilla

#endif