1/*
2 * Copyright (C) 2010 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 *
8 * 1.  Redistributions of source code must retain the above copyright
9 *     notice, this list of conditions and the following disclaimer.
10 * 2.  Redistributions in binary form must reproduce the above copyright
11 *     notice, this list of conditions and the following disclaimer in the
12 *     documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef WebSpeechInputResult_h
27#define WebSpeechInputResult_h
28
29#include "WebCommon.h"
30#include "WebPrivatePtr.h"
31#include "WebString.h"
32#include "WebVector.h"
33
34namespace WebCore {
35class SpeechInputResult;
36}
37
38namespace WebKit {
39
40// This class holds one speech recognition result including the text and other related
41// fields, as received from the embedder.
42class WebSpeechInputResult {
43public:
44    WebSpeechInputResult() { }
45    ~WebSpeechInputResult() { reset(); }
46
47    WEBKIT_API void set(const WebString& utterance, double confidence);
48    WEBKIT_API void reset();
49
50#if WEBKIT_IMPLEMENTATION
51    WebSpeechInputResult(const WTF::PassRefPtr<WebCore::SpeechInputResult>&);
52    operator WTF::PassRefPtr<WebCore::SpeechInputResult>() const;
53#endif
54
55private:
56    WebPrivatePtr<WebCore::SpeechInputResult> m_private;
57};
58
59typedef WebVector<WebSpeechInputResult> WebSpeechInputResultArray;
60
61} // namespace WebKit
62
63#endif // WebSpeechInputResult_h
64