Add custom action support

chrome/common/extensions/api/automation.idl

 // 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.
 
 // The <code>chrome.automation</code> API allows developers to access the
 // automation (accessibility) tree for the browser. The tree resembles the DOM
 // tree, but only exposes the <em>semantic</em> structure of a page. It can be
 // used to programmatically interact with a page by examining names, roles, and
 // states, listening for events, and performing actions on nodes.
 [nocompile] namespace automation {
@@ skipping 348 matching lines @@
   enum TreeChangeObserverFilter {
     noTreeChanges,
     liveRegionTreeChanges,
     textMarkerChanges,
     allTreeChanges
   };
 
   // A listener for changes on the <code>AutomationNode</code> tree.
   callback TreeChangeObserver = void(TreeChange treeChange);
 
+  dictionary CustomAction {
+    long id;
+    DOMString description;
+  };
+
   // A single node in an Automation tree.
   [nocompile, noinline_doc] dictionary AutomationNode {
     // The root node of the tree containing this AutomationNode.
     AutomationNode? root;
 
     // Whether this AutomationNode is a root node.
     boolean isRootNode;
 
     // The role of this node.
     RoleType? role;
@@ skipping 63 matching lines @@
     // name, via the $(ref:automation.AutomationNode.name) attribute.
     AutomationNode[]? labelledBy;
 
     // The node referred to by <code>aria-activedescendant</code>, where
     // applicable
     AutomationNode? activeDescendant;
 
     // The target of an in-page link.
     AutomationNode? inPageLinkTarget;
 
+    // An array of custom actions.
+    CustomAction[]? customActions;
+
     //
     // Link attributes.
     //
 
     // The URL that this link will navigate to.
     DOMString? url;
 
     //
     // Document attributes.
     //
@@ skipping 241 matching lines @@
     // original size.
     static void getImageData(long maxWidth, long maxHeight);
 
     // Does a hit test of the given global screen coordinates, and fires
     // eventToFire on the resulting object.
     static void hitTest(long x, long y, EventType eventToFire);
 
     // Scrolls this node to make it visible.
     static void makeVisible();
 
+    // Performs custom action.
+    static void performCustomAction(CustomAction customAction);

[David Tseng, 2017/06/08 17:21:59]

Wait, this is the _public_ api. It doesn't make sense for a caller to provide
both id and description, right?

[yawano, 2017/06/09 01:05:14]

Yes, this is public API. The intention is that it might be cleaner if user only
need to pass CustomAction object which is got by getCustomActions rather than
extracting an id from there. However, if I look other methods in automation.idl,
few method takes object as an argument. Let's make this back to pass custom
action id for now.

It might make sense to pass an object as an argument if we become to support
standard actions in the same way, i.e. if we implement performAction which is
capable of performing custom actions as well.

[David Tseng, 2017/06/09 18:09:53]

If we chose to, I think we should separate the concept of an ActionDescription
vs an ActionResolver.

The former would in my mind describe an action e.g. id, description, is_custom,
etc.

The latter would be used to find an action e.g. by id, by description, by is
custom, etc. Since we're not doing this currently, and unsure if we need to do
this, I think doing it by id is clearer.

Also, note that publically, each standard action gets its own binding (e.g.
node.focus()).

[yawano, 2017/06/13 06:58:46]

Changed performCustomAction to take customActionId.

+
     // Sets selection within a text field.
     static void setSelection(long startIndex, long endIndex);
 
     // Clears focus and sets this node as the starting point for the next
     // time the user presses Tab or Shift+Tab.
     static void setSequentialFocusNavigationStartingPoint();
 
     // Show the context menu for this element, as if the user right-clicked.
     static void showContextMenu();
 
@@ skipping 84 matching lines @@
     // Everything in the tree between the two node/offset pairs gets included
     // in the selection. The anchor is where the user started the selection,
     // while the focus is the point at which the selection gets extended
     // e.g. when dragging with a mouse or using the keyboard. For nodes with
     // the role staticText, the offset gives the character offset within
     // the value where the selection starts or ends, respectively.
     [nocompile] static void setDocumentSelection(
         SetDocumentSelectionParams params);
   };
 };