Initial implementation of continuous read for ChromeVox Next.

chrome/browser/resources/chromeos/chromevox/cvox2/background/output.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.
 
 /**
  * @fileoverview Provides output services for ChromeVox.
  */
 
 goog.provide('Output');
 goog.provide('Output.EventType');
@@ skipping 22 matching lines @@
  *     an AutomationNode. Specialized values include role and state. Attributes
  *     available for substitution are AutomationNode.prototype.attributes and
  *     AutomationNode.prototype.state.
  *     For example, $value $role $enabled
  * @ prefix: used to substitute a message. Note the ability to specify params to
  *     the message.  For example, '@tag_html' '@selected_index($text_sel_start,
  *     $text_sel_end').
  * = suffix: used to specify substitution only if not previously appended.
  *     For example, $name= would insert the name attribute only if no name
  * attribute had been inserted previously.
- * @param {!cursors.Range} range
- * @param {cursors.Range} prevRange
- * @param {chrome.automation.EventType|Output.EventType} type
- * @param {{braille: (boolean|undefined), speech: (boolean|undefined)}=}
- *     opt_options
  * @constructor
  */
-Output = function(range, prevRange, type, opt_options) {
-  opt_options = opt_options || {braille: true, speech: true};
+Output = function() {
   // TODO(dtseng): Include braille specific rules.
   /** @type {!cvox.Spannable} */
   this.buffer_ = new cvox.Spannable();
   /** @type {!cvox.Spannable} */
   this.brailleBuffer_ = new cvox.Spannable();
   /** @type {!Array.<Object>} */
   this.locations_ = [];
+  /** @type {function()} */
+  this.speechStartCallback_ = function() {};
+  /** @type {function()} */
+  this.speechEndCallback_ = function() {};
+  /** @type {function()} */
+  this.speechInterruptedCallback_ = function() {};
 
   /**
    * Current global options.
    * @type {{speech: boolean, braille: boolean, location: boolean}}
    */
   this.formatOptions_ = {speech: true, braille: false, location: true};
-
-  this.render_(range, prevRange, type);
-  if (opt_options.speech)
-    this.handleSpeech();
-  if (opt_options.braille)
-    this.handleBraille();
-  this.handleDisplay();
 };
 
 /**
  * Delimiter to use between output values.
  * @type {string}
  */
 Output.SPACE = ' ';
 
 /**
  * Rules specifying format of AutomationNodes for output.
@@ skipping 151 matching lines @@
 Output.prototype = {
   /**
    * Gets the output buffer for speech.
    * @return {!cvox.Spannable}
    */
   getBuffer: function() {
     return this.buffer_;
   },
 
   /**
-   * Handle output to speech.
+   * Specify ranges for speech.
+   * @param {!cursors.Range} range
+   * @param {cursors.Range} prevRange
+   * @param {chrome.automation.EventType|Output.EventType} type
+   * @return {!Output}
    */
-  handleSpeech: function() {
+  withSpeech: function(range, prevRange, type) {
+    this.formatOptions_ = {speech: true, braille: false, location: true};
+    this.render_(range, prevRange, type, this.buffer_);
+    return this;
+  },
+
+  /**
+   * Specify ranges for braille.
+   * @param {!cursors.Range} range
+   * @param {cursors.Range} prevRange
+   * @param {chrome.automation.EventType|Output.EventType} type
+   * @return {!Output}
+   */
+  withBraille: function(range, prevRange, type) {
+    this.formatOptions_ = {speech: false, braille: true, location: false};
+    this.render_(range, prevRange, type, this.brailleBuffer_);
+    return this;
+  },
+
+  /**
+   * Specify the same ranges for speech and braille.
+   * @param {!cursors.Range} range
+   * @param {cursors.Range} prevRange
+   * @param {chrome.automation.EventType|Output.EventType} type
+   * @return {!Output}
+   */
+  withSpeechAndBraille: function(range, prevRange, type) {
+    this.withSpeech(range, prevRange, type);
+    this.withBraille(range, prevRange, type);
+    return this;
+  },
+
+  /**
+   * Triggers callback for a speech event.
+   * @param {function()} callback
+   */
+  onSpeechStart: function(callback) {
+    this.speechStartCallback_ = callback;
+    return this;
+  },
+
+  /**
+   * Triggers callback for a speech event.
+   * @param {function()} callback
+   */
+  onSpeechEnd: function(callback) {
+    this.speechEndCallback_ = callback;
+    return this;
+  },
+
+  /**
+   * Triggers callback for a speech event.
+   * @param {function()} callback
+   */
+  onSpeechInterrupted: function(callback) {
+    this.speechInterruptedCallback_ = callback;
+    return this;
+  },
+
+  /**
+   * Executes all specified output.
+   */
+  go: function() {
+    // Speech.
     var buff = this.buffer_;
-    if (!buff.toString())
-      return;
 
-    cvox.ChromeVox.tts.speak(buff.toString(), cvox.QueueMode.FLUSH);
+    var onEvent = function(evt) {
+      switch (evt.type) {
+        case 'start': this.speechStartCallback_(); break;
+        case 'end': this.speechEndCallback_(); break;
+        case 'interrupted': this.speechInterruptedCallback_(); break;
+      }
+    }.bind(this);
+
+    if (buff.toString()) {
+      cvox.ChromeVox.tts.speak(
+          buff.toString(), cvox.QueueMode.FLUSH, {onEvent: onEvent});
+    }
+
     var actions = buff.getSpansInstanceOf(Output.Action);
     if (actions) {
       actions.forEach(function(a) {
         a.run();
       });
     }
-  },
 
-  /**
-   * Handles output to braille.
-   */
-  handleBraille: function() {
+    // Braille.
     var selSpan =
         this.brailleBuffer_.getSpanInstanceOf(Output.SelectionSpan);
     var startIndex = -1, endIndex = -1;
     if (selSpan) {
       var valueStart = this.brailleBuffer_.getSpanStart(selSpan);
       var valueEnd = this.brailleBuffer_.getSpanEnd(selSpan);
       if (valueStart === undefined || valueEnd === undefined) {
         valueStart = -1;
         valueEnd = -1;
       } else {
         startIndex = valueStart + selSpan.startIndex;
         endIndex = valueStart + selSpan.endIndex;
         this.brailleBuffer_.setSpan(new cvox.BrailleUtil.ValueSpan(valueStart),
                                     valueStart, valueEnd);
         this.brailleBuffer_.setSpan(new cvox.BrailleUtil.ValueSelectionSpan(),
                                     startIndex, endIndex);
       }
     }
 
     var output = new cvox.NavBraille({
       text: this.brailleBuffer_,
       startIndex: startIndex,
       endIndex: endIndex
     });
 
-    cvox.ChromeVox.braille.write(output);
-  },
+    if (this.brailleBuffer_)
+      cvox.ChromeVox.braille.write(output);
 
-  /**
-   * Handles output to visual display.
-   */
-  handleDisplay: function() {
+    // Display.
     chrome.accessibilityPrivate.setFocusRing(this.locations_);
   },
 
   /**
    * Renders the given range using optional context previous range and event
    * type.
    * @param {!cursors.Range} range
    * @param {cursors.Range} prevRange
    * @param {chrome.automation.EventType|string} type
+   * @param {!cvox.Spannable} buff Buffer to receive rendered output.
    * @private
    */
-  render_: function(range, prevRange, type) {
-    var buff = new cvox.Spannable();
-    var brailleBuff = new cvox.Spannable();
+  render_: function(range, prevRange, type, buff) {
     if (range.isSubNode())
       this.subNode_(range, prevRange, type, buff);
     else
       this.range_(range, prevRange, type, buff);
-
-    this.formatOptions_.braille = true;
-    this.formatOptions_.location = false;
-        if (range.isSubNode())
-      this.subNode_(range, prevRange, type, brailleBuff);
-    else
-      this.range_(range, prevRange, type, brailleBuff);
-
-    this.buffer_ = buff;
-    this.brailleBuffer_ = brailleBuff;
   },
 
   /**
    * Format the node given the format specifier.
    * @param {!chrome.automation.AutomationNode} node
    * @param {string|!Object} format The output format either specified as an
    * output template string or a parsed output format tree.
    * @param {!Object=} opt_exclude A set of attributes to exclude.
    * @private
    */
@@ skipping 321 matching lines @@
     }
 
     if (currentNode != root)
       throw 'Unbalanced parenthesis.';
 
     return root;
   }
 };
 
 });  // goog.scope