Extend PlatformSpeechSynthesizerMock with an utterance queue.

Source/modules/speech/testing/PlatformSpeechSynthesizerMock.cpp

 /*
  * Copyright (C) 2013 Apple Computer, Inc.  All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
@@ skipping 23 matching lines @@
 PlatformSpeechSynthesizerMock* PlatformSpeechSynthesizerMock::create(PlatformSpeechSynthesizerClient* client)
 {
     PlatformSpeechSynthesizerMock* synthesizer = new PlatformSpeechSynthesizerMock(client);
     synthesizer->initializeVoiceList();
     client->voicesDidChange();
     return synthesizer;
 }
 
 PlatformSpeechSynthesizerMock::PlatformSpeechSynthesizerMock(PlatformSpeechSynthesizerClient* client)
     : PlatformSpeechSynthesizer(client)
+    , m_speakingErrorOccurredTimer(this, &PlatformSpeechSynthesizerMock::speakingErrorOccurred)
     , m_speakingFinishedTimer(this, &PlatformSpeechSynthesizerMock::speakingFinished)
-    , m_speakingErrorOccurredTimer(this, &PlatformSpeechSynthesizerMock::speakingErrorOccurred)
+    , m_speakingNextTimer(this, &PlatformSpeechSynthesizerMock::speakingNext)

[haraken, 2015/01/31 01:38:03]

Why do we need to speakNow here? In the previous code, we didn't schedule
speaking in PlatformSpeechSynthesizerMock's constructor.

[sof, 2015/01/31 06:06:19]

I don't understand, the ctor just initializes the timers.

 {
 }
 
 PlatformSpeechSynthesizerMock::~PlatformSpeechSynthesizerMock()
 {
-    m_speakingFinishedTimer.stop();
-    m_speakingErrorOccurredTimer.stop();
+}
+
+void PlatformSpeechSynthesizerMock::speakingErrorOccurred(Timer<PlatformSpeechSynthesizerMock>*)
+{
+    ASSERT(m_currentUtterance);
+    // Per spec, removes all utterances from the queue.
+    m_queuedUtterances.clear();
+
+    client()->speakingErrorOccurred(m_currentUtterance);
+    speakNext();
 }
 
 void PlatformSpeechSynthesizerMock::speakingFinished(Timer<PlatformSpeechSynthesizerMock>*)
 {
-    ASSERT(m_utterance.get());
-    client()->didFinishSpeaking(m_utterance);
-    m_utterance = nullptr;
+    ASSERT(m_currentUtterance);
+    client()->didFinishSpeaking(m_currentUtterance);
+    speakNext();
 }
 
-void PlatformSpeechSynthesizerMock::speakingErrorOccurred(Timer<PlatformSpeechSynthesizerMock>*)
+void PlatformSpeechSynthesizerMock::speakingNext(Timer<PlatformSpeechSynthesizerMock>*)
 {
-    ASSERT(m_utterance.get());
-    client()->speakingErrorOccurred(m_utterance);
-    m_utterance = nullptr;
+    ASSERT(m_currentUtterance);
+    speakNow();
+}
+
+void PlatformSpeechSynthesizerMock::speakNext()
+{
+    if (m_speakingErrorOccurredTimer.isActive())
+        return;
+
+    if (m_queuedUtterances.isEmpty()) {
+        m_currentUtterance = nullptr;
+        return;
+    }
+    m_currentUtterance = m_queuedUtterances.takeFirst();
+    // Give others a look in before starting with next.
+    m_speakingNextTimer.startOneShot(.2, FROM_HERE);

[haraken, 2015/01/31 01:38:03]

I don't know if .2 is good or not though :)

[dmazzoni, 2015/01/31 06:51:11]

Do we need a delay between the end of one utterance and the beginning of the
next? In the real impl we'd start the next one immediately.

[sof, 2015/01/31 07:24:24]

ok, will align with that.

[sof, 2015/01/31 07:36:19]

Done, removing the "next" timer that was previously added.

 }
 
 void PlatformSpeechSynthesizerMock::initializeVoiceList()
 {
     m_voiceList.clear();
     m_voiceList.append(PlatformSpeechSynthesisVoice::create(String("mock.voice.bruce"), String("bruce"), String("en-US"), true, true));
     m_voiceList.append(PlatformSpeechSynthesisVoice::create(String("mock.voice.clark"), String("clark"), String("en-US"), true, false));
     m_voiceList.append(PlatformSpeechSynthesisVoice::create(String("mock.voice.logan"), String("logan"), String("fr-CA"), true, true));
 }
 
 void PlatformSpeechSynthesizerMock::speak(PlatformSpeechSynthesisUtterance* utterance)
 {
-    ASSERT(!m_utterance);
-    m_utterance = utterance;
-    client()->didStartSpeaking(m_utterance);
+    if (!m_currentUtterance) {
+        m_currentUtterance = utterance;
+        speakNow();
+        return;
+    }
+    m_queuedUtterances.append(utterance);
+}
+
+void PlatformSpeechSynthesizerMock::speakNow()
+{
+    ASSERT(m_currentUtterance);
+    client()->didStartSpeaking(m_currentUtterance);
 
     // Fire a fake word and then sentence boundary event.
-    client()->boundaryEventOccurred(m_utterance, SpeechWordBoundary, 0);
-    client()->boundaryEventOccurred(m_utterance, SpeechSentenceBoundary, m_utterance->text().length());
+    client()->boundaryEventOccurred(m_currentUtterance, SpeechWordBoundary, 0);
+    client()->boundaryEventOccurred(m_currentUtterance, SpeechSentenceBoundary, m_currentUtterance->text().length());
 
     // Give the fake speech job some time so that pause and other functions have time to be called.
     m_speakingFinishedTimer.startOneShot(.1, FROM_HERE);
 }
 
 void PlatformSpeechSynthesizerMock::cancel()

[dmazzoni, 2015/01/31 06:51:11]

This should remove all utterances from the queue, too.

[sof, 2015/01/31 07:24:24]

It should, but doesn't it suffice to do it in speakingErrorOccurred() (as it now
does) ? That would then also include whatever gets added before we dispatch the
'onerror' event when that error timer fires.

[dmazzoni, 2015/01/31 07:43:30]

I don't think that's right. If I call cancel() and then immediately call speak()
on a new utterance, it should speak the new utterance - even if it takes time
for the cancel() to succeed, when it does, it should move onto whatever was
enqueued after the cancel.

Perhaps we should have a separate function to force an error, rather than
abusing cancel() for that.

[sof, 2015/01/31 07:56:50]

That makes good sense - switched to that behavior + adjusted the test to verify
that this happens.
ok, but will not do that here.

 {
-    if (!m_utterance)
+    if (!m_currentUtterance)
         return;
 
     m_speakingFinishedTimer.stop();
+    m_speakingNextTimer.stop();
     m_speakingErrorOccurredTimer.startOneShot(.1, FROM_HERE);
 }
 
 void PlatformSpeechSynthesizerMock::pause()
 {
-    client()->didPauseSpeaking(m_utterance);
+    client()->didPauseSpeaking(m_currentUtterance);
 }
 
 void PlatformSpeechSynthesizerMock::resume()
 {
-    client()->didResumeSpeaking(m_utterance);
+    client()->didResumeSpeaking(m_currentUtterance);
 }
 
 void PlatformSpeechSynthesizerMock::trace(Visitor* visitor)
 {
-    visitor->trace(m_utterance);
+    visitor->trace(m_currentUtterance);
+    visitor->trace(m_queuedUtterances);
     PlatformSpeechSynthesizer::trace(visitor);
 }
 
 } // namespace blink