src/third_party/WebKit/Source/modules/speech/SpeechRecognitionEvent.h

   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 "core/events/Event.h"
  30 #include "heap/Handle.h"
  31 #include "heap/Heap.h"
  32 #include "modules/speech/SpeechRecognitionResult.h"
  33 #include "modules/speech/SpeechRecognitionResultList.h"
  34 #include "wtf/RefPtr.h"
  35
  36 namespace WebCore {
  37
  38 class Document;
  39
  40 class SpeechRecognitionEventInit : public EventInit {
  41 public:
  42     SpeechRecognitionEventInit();
  43
  44     unsigned long resultIndex;
  45     RefPtrWillBeMember<SpeechRecognitionResultList> results;
  46 };
  47
  48 class SpeechRecognitionEvent FINAL : public Event {
  49 public:
  50     static PassRefPtrWillBeRawPtr<SpeechRecognitionEvent> create();
  51     static PassRefPtrWillBeRawPtr<SpeechRecognitionEvent> create(const AtomicString&, const SpeechRecognitionEventInit&);
  52     virtual ~SpeechRecognitionEvent();
  53
  54     static PassRefPtrWillBeRawPtr<SpeechRecognitionEvent> createResult(unsigned long resultIndex, const WillBeHeapVector<RefPtrWillBeMember<SpeechRecognitionResult> >& results);
  55     static PassRefPtrWillBeRawPtr<SpeechRecognitionEvent> createNoMatch(PassRefPtrWillBeRawPtr<SpeechRecognitionResult>);
  56
  57     unsigned long resultIndex() const { return m_resultIndex; }
  58     SpeechRecognitionResultList* results() const { return m_results.get(); }
  59
  60     // These two methods are here to satisfy the specification which requires these attrubutes to exist.
  61     Document* interpretation() { return 0; }
  62     Document* emma() { return 0; }
  63
  64     // Event
  65     virtual const AtomicString& interfaceName() const OVERRIDE;
  66
  67     virtual void trace(Visitor*) OVERRIDE;
  68
  69 private:
  70     SpeechRecognitionEvent();
  71     SpeechRecognitionEvent(const AtomicString&, const SpeechRecognitionEventInit&);
  72     SpeechRecognitionEvent(const AtomicString& eventName, unsigned long resultIndex, PassRefPtrWillBeRawPtr<SpeechRecognitionResultList> results);
  73
  74     unsigned long m_resultIndex;
  75     RefPtrWillBeMember<SpeechRecognitionResultList> m_results;
  76 };
  77
  78 } // namespace WebCore
  79
  80 #endif // SpeechRecognitionEvent_h