src/third_party/WebKit/Source/modules/speech/SpeechRecognitionError.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 SpeechRecognitionError_h
  27 #define SpeechRecognitionError_h
  28
  29 #include "modules/EventModules.h"
  30 #include "wtf/text/WTFString.h"
  31
  32 namespace blink {
  33
  34 struct SpeechRecognitionErrorInit : public EventInit {
  35     SpeechRecognitionErrorInit();
  36
  37     String error;
  38     String message;
  39 };
  40
  41 class SpeechRecognitionError FINAL : public Event {
  42 public:
  43     enum ErrorCode {
  44         // FIXME: This is an unspecified error and Chromium should stop using it.
  45         ErrorCodeOther = 0,
  46
  47         ErrorCodeNoSpeech = 1,
  48         ErrorCodeAborted = 2,
  49         ErrorCodeAudioCapture = 3,
  50         ErrorCodeNetwork = 4,
  51         ErrorCodeNotAllowed = 5,
  52         ErrorCodeServiceNotAllowed = 6,
  53         ErrorCodeBadGrammar = 7,
  54         ErrorCodeLanguageNotSupported = 8
  55     };
  56
  57     static PassRefPtrWillBeRawPtr<SpeechRecognitionError> create(ErrorCode, const String&);
  58     static PassRefPtrWillBeRawPtr<SpeechRecognitionError> create();
  59     static PassRefPtrWillBeRawPtr<SpeechRecognitionError> create(const AtomicString&, const SpeechRecognitionErrorInit&);
  60
  61     const String& error() { return m_error; }
  62     const String& message() { return m_message; }
  63
  64     virtual const AtomicString& interfaceName() const OVERRIDE;
  65
  66     virtual void trace(Visitor* visitor) OVERRIDE
  67     {
  68         Event::trace(visitor);
  69     }
  70
  71 private:
  72     SpeechRecognitionError(const String&, const String&);
  73     SpeechRecognitionError(const AtomicString&, const SpeechRecognitionErrorInit&);
  74
  75     String m_error;
  76     String m_message;
  77 };
  78
  79 } // namespace blink
  80
  81 #endif // SpeechRecognitionError_h