5c6534b4c6c2b293b6d430031ff02d3270489265
[WebKit-https.git] / Tools / DumpRenderTree / chromium / MockWebSpeechRecognizer.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  *
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 MockWebSpeechRecognizer_h
27 #define MockWebSpeechRecognizer_h
28
29 #if ENABLE(SCRIPTED_SPEECH)
30
31 #include "WebSpeechRecognizer.h"
32 #include "WebTask.h"
33 #include <wtf/Compiler.h>
34 #include <wtf/PassOwnPtr.h>
35 #include <wtf/Vector.h>
36
37 namespace WebKit {
38 class WebSpeechRecognitionHandle;
39 class WebSpeechRecognitionParams;
40 class WebSpeechRecognizerClient;
41 }
42
43 class MockWebSpeechRecognizer : public WebKit::WebSpeechRecognizer {
44 public:
45     static PassOwnPtr<MockWebSpeechRecognizer> create();
46     ~MockWebSpeechRecognizer();
47
48     // WebSpeechRecognizer implementation:
49     virtual void start(const WebKit::WebSpeechRecognitionHandle&, const WebKit::WebSpeechRecognitionParams&, WebKit::WebSpeechRecognizerClient*) OVERRIDE;
50     virtual void stop(const WebKit::WebSpeechRecognitionHandle&, WebKit::WebSpeechRecognizerClient*) OVERRIDE;
51     virtual void abort(const WebKit::WebSpeechRecognitionHandle&, WebKit::WebSpeechRecognizerClient*) OVERRIDE;
52
53     // Methods accessed by layout tests:
54     void addMockResult(const WebKit::WebString& transcript, float confidence);
55     void setError(const WebKit::WebString& error, const WebKit::WebString& message);
56     bool wasAborted() const { return m_wasAborted; }
57
58     // Methods accessed from Task objects:
59     WebKit::WebSpeechRecognizerClient* client() { return m_client; }
60     WebKit::WebSpeechRecognitionHandle& handle() { return m_handle; }
61     WebTestRunner::WebTaskList* taskList() { return &m_taskList; }
62
63     class Task {
64     public:
65         Task(MockWebSpeechRecognizer* recognizer) : m_recognizer(recognizer) { }
66         virtual ~Task() { }
67         virtual void run() = 0;
68     protected:
69         MockWebSpeechRecognizer* m_recognizer;
70     };
71
72 private:
73     MockWebSpeechRecognizer();
74     void startTaskQueue();
75     void clearTaskQueue();
76
77     WebTestRunner::WebTaskList m_taskList;
78     WebKit::WebSpeechRecognitionHandle m_handle;
79     WebKit::WebSpeechRecognizerClient* m_client;
80     Vector<WebKit::WebString> m_mockTranscripts;
81     Vector<float> m_mockConfidences;
82     bool m_wasAborted;
83
84     // Queue of tasks to be run.
85     Vector<OwnPtr<Task> > m_taskQueue;
86     bool m_taskQueueRunning;
87
88     // Task for stepping the queue.
89     class StepTask : public WebTestRunner::WebMethodTask<MockWebSpeechRecognizer> {
90     public:
91         StepTask(MockWebSpeechRecognizer* object) : WebTestRunner::WebMethodTask<MockWebSpeechRecognizer>(object) { }
92         virtual void runIfValid() OVERRIDE;
93     };
94 };
95
96 #endif // ENABLE(SCRIPTED_SPEECH)
97
98 #endif // MockWebSpeechRecognizer_h