chrome/browser/resources/chromeos/chromevox/testing/mock_tts.js

// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

/**
 * Mock tts class.
 * @constructor
 * @extends {cvox.TtsInterface}
 */
var MockTts = function() {
  /**
   * The event handler for the most recent call to |speak|.
   * @private
   */
  this.onEvent_;
};

MockTts.prototype = {
  /**
   * A list of predicate, start, and end callbacks for a pending expectation.
   * @type {!Array<{{predicate: function(string) : boolean,
   *     startCallback: function() : void,
   *     endCallback: function() : void}>}
   * @private
   */
  expectations_: [],

  /**
   * A list of strings stored whenever there are no expectations.
   * @type {!Array<string}
   * @private
   */
  idleUtterances_: [],

  /** @override */
  speak: function(textString, queueMode, properties) {
    if (properties)
      this.onEvent_ = properties['onEvent'];

    this.process_(textString);
  },

  /**
   * Adds an expectation for the given string to be spoken. If satisfied,
   * |opt_callback| is called.
   * @param {string} expectedText
   * @param {function() : void=} opt_callback
   * @param {boolean=} opt_exact Expect an exact match; defaults to false.
   */
  expectSpeech: function(expectedText, opt_callback, opt_exact) {
    var expectation = {};
    expectation.endCallback = opt_callback;
    this.addExpectation_(expectedText, expectation, opt_exact);
  },

  /**
   * Adds an expectation for the given string to be spoken after |opt_callback|
   * executes.
   * @param {string} expectedText
   * @param {function() : void=} opt_callback
   * @param {boolean=} opt_exact Expect an exact match; defaults to false.
   */
  expectSpeechAfter: function(expectedText, opt_callback, opt_exact) {
    var expectation = {};
    if (this.expectations_.length == 0 && opt_callback)
      opt_callback();
    else
      expectation.startCallback = opt_callback;
    this.addExpectation_(expectedText, expectation, opt_exact);
  },

  /**
   * Finishes expectations and calls testDone.
   */
  finishExpectations: function() {
    this.expectSpeechAfter('', testDone);
  },

  /**
   * Fakes an event to |onEvent|.
   */
  sendStartEvent: function() {
    if (this.onEvent_)
      this.onEvent_({type: 'start'});
  },

  /**
   * Fakes an event to |onEvent|.
   */
  sendEndEvent: function() {
    if (this.onEvent_)
      this.onEvent_({type: 'end'});
  },

  /**
   * @private
   * @param {string} expectedText Text expected spoken.
   * @param {{startCallback: function() : void,
   *     endCallback: function() : void}=} opt_expectation
   * @param {boolean=} opt_exact Expects an exact match.
   */
  addExpectation_: function(expectedText, opt_expectation, opt_exact) {
    var expectation = opt_expectation ? opt_expectation : {};

    expectation.predicate = function(actualText) {
      if (opt_exact)
        return actualText === expectedText;
      return actualText.indexOf(expectedText) != -1;
    };

    this.expectations_.push(expectation);

    // Process any idleUtterances.
    this.idleUtterances_.forEach(function(utterance) {
      this.process_(utterance, true);
    });
  },

  /**
   * @param {string} textString Utterance to match against callbacks.
   * @param {boolean=} opt_manual True if called outside of tts.speak.
   * @private
   */
  process_: function(textString, opt_manual) {
    if (this.expectations_.length == 0) {
      if (!opt_manual)
        this.idleUtterances_.push(textString);
      return;
    }

    var allUtterances = this.idleUtterances_.concat([textString]);
    var targetExpectation = this.expectations_.shift();
    if (allUtterances.some(targetExpectation.predicate)) {
      this.idleUtterances_.length = 0;
      if (targetExpectation.endCallback)
        targetExpectation.endCallback();
      var nextExpectation = this.expectations_[0];
      if (nextExpectation && nextExpectation.startCallback)
        nextExpectation.startCallback();
    } else {
      this.expectations_.unshift(targetExpectation);
    }
  },
};