third_party/WebKit/public/web/WebSpeechRecognitionHandle.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 WebSpeechRecognitionHandle_h
  27 #define WebSpeechRecognitionHandle_h
  28
  29 #include "../platform/WebCommon.h"
  30 #include "../platform/WebPrivatePtr.h"
  31
  32 namespace blink {
  33
  34 class SpeechRecognition;
  35
  36 // WebSpeechRecognitionHandle is used by WebSpeechRecognizer to identify a
  37 // recognition session, and by WebSpeechRecognizerClient to route
  38 // recognition events.
  39 class WebSpeechRecognitionHandle {
  40 public:
  41     ~WebSpeechRecognitionHandle() { reset(); }
  42     WebSpeechRecognitionHandle() { }
  43
  44     WebSpeechRecognitionHandle(const WebSpeechRecognitionHandle& other) { assign(other); }
  45     WebSpeechRecognitionHandle& operator=(const WebSpeechRecognitionHandle& other)
  46     {
  47         assign(other);
  48         return *this;
  49     }
  50
  51     BLINK_EXPORT void reset();
  52     BLINK_EXPORT void assign(const WebSpeechRecognitionHandle&);
  53
  54     // Comparison functions are provided so that WebSpeechRecognitionHandle objects
  55     // can be stored in a hash map.
  56     BLINK_EXPORT bool equals(const WebSpeechRecognitionHandle&) const;
  57     BLINK_EXPORT bool lessThan(const WebSpeechRecognitionHandle&) const;
  58
  59 #if BLINK_IMPLEMENTATION
  60     WebSpeechRecognitionHandle(SpeechRecognition*);
  61     operator SpeechRecognition*() const;
  62 #endif
  63
  64 private:
  65     WebPrivatePtr<SpeechRecognition> m_private;
  66 };
  67
  68 inline bool operator==(const WebSpeechRecognitionHandle& a, const WebSpeechRecognitionHandle& b)
  69 {
  70     return a.equals(b);
  71 }
  72
  73 inline bool operator!=(const WebSpeechRecognitionHandle& a, const WebSpeechRecognitionHandle& b)
  74 {
  75     return !(a == b);
  76 }
  77
  78 inline bool operator<(const WebSpeechRecognitionHandle& a, const WebSpeechRecognitionHandle& b)
  79 {
  80     return a.lessThan(b);
  81 }
  82
  83 } // namespace blink
  84
  85 #endif // WebSpeechRecognitionHandle_h