src/third_party/WebKit/Source/modules/speech/SpeechRecognitionResult.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 SpeechRecognitionResult_h
  27 #define SpeechRecognitionResult_h
  28
  29 #include "bindings/v8/ScriptWrappable.h"
  30 #include "heap/Handle.h"
  31 #include "modules/speech/SpeechRecognitionAlternative.h"
  32 #include "wtf/RefCounted.h"
  33 #include "wtf/Vector.h"
  34
  35 namespace WebCore {
  36
  37 // FIXME: oilpan: the platform outer layer (WebSpeechRecognitionResult) depends on
  38 // holding a WebPrivatePtr (a RefPtr) to this result object. When/if such pointers
  39 // can be to GCed objects, we can drop the extra reference counting layer.
  40 class SpeechRecognitionResult : public RefCountedWillBeRefCountedGarbageCollected<SpeechRecognitionResult>, public ScriptWrappable {
  41     DECLARE_GC_INFO;
  42 public:
  43     ~SpeechRecognitionResult();
  44     static PassRefPtr<SpeechRecognitionResult> create(const WillBeHeapVector<RefPtrWillBeMember<SpeechRecognitionAlternative> >&, bool final);
  45
  46     unsigned long length() { return m_alternatives.size(); }
  47     SpeechRecognitionAlternative* item(unsigned long index);
  48     bool isFinal() { return m_final; }
  49
  50     void trace(Visitor*);
  51
  52 private:
  53     SpeechRecognitionResult(const WillBeHeapVector<RefPtrWillBeMember<SpeechRecognitionAlternative> >&, bool final);
  54
  55     bool m_final;
  56     WillBeHeapVector<RefPtrWillBeMember<SpeechRecognitionAlternative> > m_alternatives;
  57 };
  58
  59 } // namespace WebCore
  60
  61 #endif // SpeechRecognitionResult_h