Add keyboard explorer improvements for braille

chrome/browser/resources/chromeos/chromevox/chromevox/background/kbexplorer.js

Index: chrome/browser/resources/chromeos/chromevox/chromevox/background/kbexplorer.js
diff --git a/chrome/browser/resources/chromeos/chromevox/chromevox/background/kbexplorer.js b/chrome/browser/resources/chromeos/chromevox/chromevox/background/kbexplorer.js
index 16a5427f5e2a0e46170608b40eb357e2c62e22b9..5e940aa3f55c09d62ba7aba30c00872f635e7f7a 100644
--- a/chrome/browser/resources/chromeos/chromevox/chromevox/background/kbexplorer.js
+++ b/chrome/browser/resources/chromeos/chromevox/chromevox/background/kbexplorer.js
@@ -9,12 +9,14 @@
 
 goog.provide('cvox.KbExplorer');
 
+goog.require('BrailleCommandHandler');
+goog.require('Spannable');
+goog.require('cvox.BrailleKeyCommand');
 goog.require('cvox.ChromeVoxKbHandler');
 goog.require('cvox.CommandStore');
 goog.require('cvox.KeyMap');
 goog.require('cvox.KeyUtil');
 
-
 /**
  * Class to manage the keyboard explorer.
  * @constructor
@@ -32,6 +34,10 @@ cvox.KbExplorer.init = function() {
   backgroundWindow.addEventListener('keyup', cvox.KbExplorer.onKeyUp, true);
   backgroundWindow.addEventListener(
       'keypress', cvox.KbExplorer.onKeyPress, true);
+  chrome.brailleDisplayPrivate.onKeyEvent.addListener(
+      cvox.KbExplorer.onBrailleKeyEvent);
+  chrome.accessibilityPrivate.onAccessibilityGesture.addListener(
+      cvox.KbExplorer.onAccessibilityGesture);
 
   window.onbeforeunload = function(evt) {
     backgroundWindow.removeEventListener(
@@ -40,6 +46,10 @@ cvox.KbExplorer.init = function() {
         'keyup', cvox.KbExplorer.onKeyUp, true);
     backgroundWindow.removeEventListener(
         'keypress', cvox.KbExplorer.onKeyPress, true);
+    chrome.brailleDisplayPrivate.onKeyEvent.removeListener(
+        cvox.KbExplorer.onBrailleKeyEvent);
+  chrome.accessibilityPrivate.onAccessibilityGesture.removeListener(

[dmazzoni, 2016/11/10 01:22:04]

nit: indent, this and next line

[David Tseng, 2016/11/10 04:56:58]

Done.

+      cvox.KbExplorer.onAccessibilityGesture);
   };
   if (localStorage['useNext'] == 'true') {
     cvox.ChromeVoxKbHandler.handlerKeyMap = cvox.KeyMap.fromNext();
@@ -49,6 +59,7 @@ cvox.KbExplorer.init = function() {
     cvox.ChromeVox.modKeyStr = 'Search+Shift';
   }
   cvox.ChromeVoxKbHandler.commandHandler = cvox.KbExplorer.onCommand;
+  $('instruction').focus();
 };
 
 
@@ -59,7 +70,7 @@ cvox.KbExplorer.init = function() {
  */
 cvox.KbExplorer.onKeyDown = function(evt) {
   chrome.extension.getBackgroundPage()['speak'](
-      cvox.KeyUtil.getReadableNameForKeyCode(evt.keyCode), false, {});
+      cvox.KeyUtil.getReadableNameForKeyCode(evt.keyCode), false, {pitch: 0});
 
   // Allow Ctrl+W to be handled.
   if (evt.keyCode == 87 && evt.ctrlKey) {
@@ -67,7 +78,7 @@ cvox.KbExplorer.onKeyDown = function(evt) {
   }
 
   cvox.ChromeVoxKbHandler.basicKeyDownActionsListener(evt);
-
+  cvox.KbExplorer.clearRange();
   evt.preventDefault();
   evt.stopPropagation();
   return false;
@@ -79,6 +90,7 @@ cvox.KbExplorer.onKeyDown = function(evt) {
  * @param {Event} evt key event.
  */
 cvox.KbExplorer.onKeyUp = function(evt) {
+  cvox.KbExplorer.clearRange();
   evt.preventDefault();
   evt.stopPropagation();
 };
@@ -89,11 +101,75 @@ cvox.KbExplorer.onKeyUp = function(evt) {
  * @param {Event} evt key event.
  */
 cvox.KbExplorer.onKeyPress = function(evt) {
+  cvox.KbExplorer.clearRange();
   evt.preventDefault();
   evt.stopPropagation();
 };
 
 /**
+ * @param {cvox.BrailleKeyEvent} evt The key event.
+ */
+cvox.KbExplorer.onBrailleKeyEvent = function(evt) {
+  var msgid;
+  var msgArgs = [];
+  var text;
+  switch (evt.command) {
+    case cvox.BrailleKeyCommand.PAN_LEFT:
+      msgid = 'braille_pan_left';

[dmazzoni, 2016/11/10 01:22:04]

I understand your reasons for not wanting to use the same key map that
we use for speech - but would it be possible to create a braille key map
and store the msgid for each one there, rather than having it split
across files like this?

[David Tseng, 2016/11/10 04:56:58]

Filed crbug.com/664010.

It's not quite that simple because we have lots of static data scattered
everywhere for key, braille, and gestures. I've proposed moving everything into
command store for the basic three types of mapping we're doing.

Of course, this still won't cover something dynamic like the thing below for
routing keys which isn't static data.

+      break;
+    case cvox.BrailleKeyCommand.PAN_RIGHT:
+      msgid = 'braille_pan_right';
+      break;
+    case cvox.BrailleKeyCommand.LINE_UP:
+      msgid = 'braille_line_up';
+      break;
+    case cvox.BrailleKeyCommand.LINE_DOWN:
+      msgid = 'braille_line_down';
+      break;
+    case cvox.BrailleKeyCommand.TOP:
+      msgid = 'braille_top';
+      break;
+    case cvox.BrailleKeyCommand.BOTTOM:
+      msgid = 'braille_bottom';
+      break;
+      break;
+    case cvox.BrailleKeyCommand.ROUTING:
+    case cvox.BrailleKeyCommand.SECONDARY_ROUTING:
+      msgid = 'braille_routing';
+      msgArgs.push(/** @type {number} */ (evt.displayPosition + 1));
+      break;
+    case cvox.BrailleKeyCommand.CHORD:
+      if (!evt.brailleDots)
+        return;
+      var command =
+          BrailleCommandHandler.getCommand(evt.brailleDots);
+      if (command && cvox.KbExplorer.onCommand(command))
+        return;
+      // Fall through.
+    case cvox.BrailleKeyCommand.DOTS:
+      if (!evt.brailleDots)
+        return;
+      text = BrailleCommandHandler.makeShortcutText(evt.brailleDots);
+      break;
+    case cvox.BrailleKeyCommand.STANDARD_KEY:
+      break;
+  }
+  if (msgid)
+  text = Msgs.getMsg(msgid, msgArgs);

[dmazzoni, 2016/11/10 01:22:04]

indent

[David Tseng, 2016/11/10 04:56:58]

Done.

+  cvox.KbExplorer.output(text || evt.command);
+  cvox.KbExplorer.clearRange();
+};
+
+/**
+ * Handles accessibility gestures from the touch screen.
+ * @param {string} gesture The gesture to handle, based on the AXGesture enum
+ *     defined in ui/accessibility/ax_enums.idl
+ */
+cvox.KbExplorer.onAccessibilityGesture = function(gesture) {
+  // TODO(dmazzoni): implement.
+};
+
+/**
  * Queues up command description.
  * @param {string} command
  * @return {boolean|undefined} True if command existed and was handled.
@@ -102,7 +178,24 @@ cvox.KbExplorer.onCommand = function(command) {
   var msg = cvox.CommandStore.messageForCommand(command);
   if (msg) {
     var commandText = Msgs.getMsg(msg);
-    chrome.extension.getBackgroundPage()['speak'](commandText);
+    cvox.KbExplorer.output(commandText);
+    cvox.KbExplorer.clearRange();
     return true;
   }
 };
+
+/**
+ * @param {string} text
+ * @param {string=} opt_braille If different from text.
+ */
+cvox.KbExplorer.output = function(text, opt_braille) {
+  chrome.extension.getBackgroundPage()['speak'](text);
+  chrome.extension.getBackgroundPage().cvox.ChromeVox.braille.write(
+      {text: new Spannable(opt_braille || text)});
+};
+
+/** Clears ChromeVox range. */
+cvox.KbExplorer.clearRange = function() {
+  chrome.extension.getBackgroundPage()[
+    'ChromeVoxState']['instance']['setCurrentRange'](null);
+};