1/*
2 * Copyright (C) 2012 Google Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *  * Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 *  * Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef SpeechRecognitionEvent_h
27#define SpeechRecognitionEvent_h
28
29#include "modules/EventModules.h"
30#include "modules/speech/SpeechRecognitionResult.h"
31#include "modules/speech/SpeechRecognitionResultList.h"
32#include "platform/heap/Handle.h"
33
34namespace blink {
35
36class Document;
37
38class SpeechRecognitionEventInit : public EventInit {
39public:
40    SpeechRecognitionEventInit();
41
42    unsigned long resultIndex;
43    Member<SpeechRecognitionResultList> results;
44};
45
46class SpeechRecognitionEvent FINAL : public Event {
47    DEFINE_WRAPPERTYPEINFO();
48public:
49    static PassRefPtrWillBeRawPtr<SpeechRecognitionEvent> create();
50    static PassRefPtrWillBeRawPtr<SpeechRecognitionEvent> create(const AtomicString&, const SpeechRecognitionEventInit&);
51    virtual ~SpeechRecognitionEvent();
52
53    static PassRefPtrWillBeRawPtr<SpeechRecognitionEvent> createResult(unsigned long resultIndex, const HeapVector<Member<SpeechRecognitionResult> >& results);
54    static PassRefPtrWillBeRawPtr<SpeechRecognitionEvent> createNoMatch(SpeechRecognitionResult*);
55
56    unsigned long resultIndex() const { return m_resultIndex; }
57    SpeechRecognitionResultList* results() const { return m_results.get(); }
58
59    // These two methods are here to satisfy the specification which requires these attrubutes to exist.
60    Document* interpretation() { return 0; }
61    Document* emma() { return 0; }
62
63    // Event
64    virtual const AtomicString& interfaceName() const OVERRIDE;
65
66    virtual void trace(Visitor*) OVERRIDE;
67
68private:
69    SpeechRecognitionEvent();
70    SpeechRecognitionEvent(const AtomicString&, const SpeechRecognitionEventInit&);
71    SpeechRecognitionEvent(const AtomicString& eventName, unsigned long resultIndex, SpeechRecognitionResultList* results);
72
73    unsigned long m_resultIndex;
74    PersistentWillBeMember<SpeechRecognitionResultList> m_results;
75};
76
77} // namespace blink
78
79#endif // SpeechRecognitionEvent_h
80