Bug 1467382 - Support aria-keyshortcuts. r=Jamie

Differential Revision: https://phabricator.services.mozilla.com/D246695

accessible/basetypes/Accessible.h

@@ -404,6 +404,9 @@ class Accessible {
 
   virtual Maybe<int32_t> GetIntARIAAttr(nsAtom* aAttrName) const = 0;
 
+  virtual bool GetStringARIAAttr(nsAtom* aAttrName,
+                                 nsAString& aAttrValue) const = 0;
+
   /**
    * Get the relation of the given type.
    */

accessible/generic/LocalAccessible.cpp

@@ -4490,3 +4490,11 @@ Maybe<int32_t> LocalAccessible::GetIntARIAAttr(nsAtom* aAttrName) const {
   }
   return Nothing();
 }
+
+bool LocalAccessible::GetStringARIAAttr(nsAtom* aAttrName,
+                                        nsAString& aAttrValue) const {
+  if (dom::Element* elm = Elm()) {
+    return nsAccUtils::GetARIAAttr(elm, aAttrName, aAttrValue);
+  }
+  return false;
+}

accessible/generic/LocalAccessible.h

@@ -435,6 +435,9 @@ class LocalAccessible : public nsISupports, public Accessible {
 
   virtual Maybe<int32_t> GetIntARIAAttr(nsAtom* aAttrName) const override;
 
+  virtual bool GetStringARIAAttr(nsAtom* aAttrName,
+                                 nsAString& aAttrValue) const override;
+
   //////////////////////////////////////////////////////////////////////////////
   // Downcasting and types
 

accessible/ipc/RemoteAccessible.cpp

@@ -2337,6 +2337,18 @@ Maybe<int32_t> RemoteAccessible::GetIntARIAAttr(nsAtom* aAttrName) const {
   return Nothing();
 }
 
+bool RemoteAccessible::GetStringARIAAttr(nsAtom* aAttrName,
+                                         nsAString& aAttrValue) const {
+  if (RequestDomainsIfInactive(CacheDomain::ARIA)) {
+    return false;
+  }
+  if (auto attrs = GetCachedARIAAttributes()) {
+    return attrs->GetAttribute(aAttrName, aAttrValue);
+  }
+
+  return false;
+}
+
 void RemoteAccessible::Language(nsAString& aLocale) {
   if (RequestDomainsIfInactive(CacheDomain::Text)) {
     return;

accessible/ipc/RemoteAccessible.h

@@ -230,6 +230,9 @@ class RemoteAccessible : public Accessible, public HyperTextAccessibleBase {
 
   virtual Maybe<int32_t> GetIntARIAAttr(nsAtom* aAttrName) const override;
 
+  virtual bool GetStringARIAAttr(nsAtom* aAttrName,
+                                 nsAString& aAttrValue) const override;
+
   virtual void Language(nsAString& aLocale) override;
 
   //////////////////////////////////////////////////////////////////////////////

accessible/mac/MOXAccessibleProtocol.h

@@ -341,6 +341,9 @@
 // AXLanguage
 - (NSString* _Nullable)moxLanguage;
 
+// AXKeyShortcutsValue
+- (NSString* _Nullable)moxKeyShortcutsValue;
+
 // AXMozDebugDescription
 - (NSString* _Nullable)moxMozDebugDescription;
 

accessible/mac/mozAccessible.h

@@ -248,6 +248,9 @@ enum CheckedState {
 // override
 - (NSString*)moxLanguage;
 
+// override
+- (NSString*)moxKeyShortcutsValue;
+
 #ifndef RELEASE_OR_BETA
 // override
 - (NSString*)moxMozDebugDescription;

accessible/mac/mozAccessible.mm

@@ -769,6 +769,19 @@ struct RoleDescrComparator {
   return nsCocoaUtils::ToNSString(lang);
 }
 
+- (NSString*)moxKeyShortcutsValue {
+  MOZ_ASSERT(mGeckoAccessible);
+
+  nsAutoString shortcut;
+
+  if (!mGeckoAccessible->GetStringARIAAttr(nsGkAtoms::aria_keyshortcuts,
+                                           shortcut)) {
+    return nil;
+  }
+
+  return nsCocoaUtils::ToNSString(shortcut);
+}
+
 #ifndef RELEASE_OR_BETA
 - (NSString*)moxMozDebugDescription {
   NS_OBJC_BEGIN_TRY_BLOCK_RETURN;

accessible/tests/browser/mac/browser.toml

@@ -29,6 +29,8 @@ skip-if = ["os == 'mac' && os_version == '15.30' && arch == 'aarch64' && opt"] #
 
 ["browser_aria_haspopup.js"]
 
+["browser_aria_keyshortcuts.js"]
+
 ["browser_aria_placeholder.js"]
 
 ["browser_aria_setsize.js"]

accessible/tests/browser/mac/browser_aria_keyshortcuts.js

@@ -0,0 +1,22 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+"use strict";
+
+/**
+ * Test aria-keyshortcuts
+ */
+addAccessibleTask(
+  `
+  <div id="btn" role="button" aria-keyshortcuts="Alt+Shift+f">bar</div>
+  `,
+  (browser, accDoc) => {
+    let btn = getNativeInterface(accDoc, "btn");
+    is(
+      btn.getAttributeValue("AXKeyShortcutsValue"),
+      "Alt+Shift+f",
+      "aria-keyshortcuts value is correct"
+    );
+  }
+);

accessible/tests/browser/windows/ia2/browser.toml

@@ -15,6 +15,8 @@ prefs = [
 
 ["browser_groupPosition.js"]
 
+["browser_keyboard_shortcut.js"]
+
 ["browser_osPicker.js"]
 
 ["browser_role.js"]

accessible/tests/browser/windows/ia2/browser_keyboard_shortcut.js

@@ -0,0 +1,35 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+"use strict";
+
+addAccessibleTask(
+  `
+<button id="btn1" accesskey="s">foo</button>
+<div id="btn2" role="button" aria-keyshortcuts="Alt+Shift+f">bar</div>
+
+  `,
+  async function () {
+    is(
+      await runPython(`
+      global doc
+      doc = getDocIa2()
+      btn = findIa2ByDomId(doc, "btn1")
+      return btn.accKeyboardShortcut(CHILDID_SELF)
+    `),
+      "Alt+Shift+s",
+      "btn1 has correct keyboard shortcut"
+    );
+
+    is(
+      await runPython(`
+      btn = findIa2ByDomId(doc, "btn2")
+      return btn.accKeyboardShortcut(CHILDID_SELF)
+    `),
+      "Alt+Shift+f",
+      "btn2 has correct keyboard shortcut"
+    );
+  },
+  { chrome: true, topLevel: true }
+);

accessible/tests/browser/windows/uia/browser_generalProps.js

@@ -453,3 +453,21 @@ addUiaTask(
     );
   }
 );
+
+/**
+ * Test the AcceleratorKey property.
+ */
+addUiaTask(
+  `
+  <div id="button" role="button" aria-keyshortcuts="Alt+Shift+f">foo</div>
+  `,
+  async function testAcceleratorKey() {
+    await definePyVar("doc", `getDocUia()`);
+    is(
+      await runPython(`findUiaByDomId(doc, "button").CurrentAcceleratorKey`),
+      "Alt+Shift+f",
+      "button has correct AcceleratorKey"
+    );
+  },
+  { uiaEnabled: true, uiaDisabled: false }
+);

accessible/windows/msaa/MsaaAccessible.cpp

@@ -865,6 +865,9 @@ MsaaAccessible::get_accKeyboardShortcut(
                                                pszKeyboardShortcut);
   }
 
+  nsAutoString shortcut;
+
+  if (!mAcc->GetStringARIAAttr(nsGkAtoms::aria_keyshortcuts, shortcut)) {
     KeyBinding keyBinding = mAcc->AccessKey();
     if (keyBinding.IsEmpty()) {
       if (LocalAccessible* localAcc = mAcc->AsLocal()) {
@@ -872,8 +875,8 @@ MsaaAccessible::get_accKeyboardShortcut(
       }
     }
 
-  nsAutoString shortcut;
     keyBinding.ToString(shortcut);
+  }
 
   *pszKeyboardShortcut = ::SysAllocStringLen(shortcut.get(), shortcut.Length());
   return *pszKeyboardShortcut ? S_OK : E_OUTOFMEMORY;

accessible/windows/uia/uiaRawElmProvider.cpp

@@ -514,13 +514,14 @@ uiaRawElmProvider::GetPropertyValue(PROPERTYID aPropertyId,
   switch (aPropertyId) {
     // Accelerator Key / shortcut.
     case UIA_AcceleratorKeyPropertyId: {
-      if (!localAcc) {
-        // KeyboardShortcut is only currently relevant for LocalAccessible.
-        break;
-      }
       nsAutoString keyString;
 
+      if (!acc->GetStringARIAAttr(nsGkAtoms::aria_keyshortcuts, keyString)) {
+        if (localAcc) {
+          // KeyboardShortcut is only currently relevant for LocalAccessible.
           localAcc->KeyboardShortcut().ToString(keyString);
+        }
+      }
 
       if (!keyString.IsEmpty()) {
         aPropertyValue->vt = VT_BSTR;