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