accessible/android/AccessibleWrap.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "AccessibleWrap.h"
   7
   8 #include "JavaBuiltins.h"
   9 #include "LocalAccessible-inl.h"
  10 #include "HyperTextAccessible-inl.h"
  11 #include "AccAttributes.h"
  12 #include "AccEvent.h"
  13 #include "AndroidInputType.h"
  14 #include "DocAccessibleWrap.h"
  15 #include "IDSet.h"
  16 #include "SessionAccessibility.h"
  17 #include "TextLeafAccessible.h"
  18 #include "TraversalRule.h"
  19 #include "Pivot.h"
  20 #include "Platform.h"
  21 #include "nsAccessibilityService.h"
  22 #include "nsEventShell.h"
  23 #include "nsIAccessibleAnnouncementEvent.h"
  24 #include "nsAccUtils.h"
  25 #include "nsTextEquivUtils.h"
  26 #include "nsWhitespaceTokenizer.h"
  27 #include "RootAccessible.h"
  28
  29 #include "mozilla/a11y/PDocAccessibleChild.h"
  30 #include "mozilla/jni/GeckoBundleUtils.h"
  31
  32 // icu TRUE conflicting with java::sdk::Boolean::TRUE()
  33 // https://searchfox.org/mozilla-central/rev/ce02064d8afc8673cef83c92896ee873bd35e7ae/intl/icu/source/common/unicode/umachine.h#265
  34 // https://searchfox.org/mozilla-central/source/__GENERATED__/widget/android/bindings/JavaBuiltins.h#78
  35 #ifdef TRUE
  36 #  undef TRUE
  37 #endif
  38
  39 using namespace mozilla::a11y;
  40
  41 // IDs should be a positive 32bit integer.
  42 IDSet sIDSet(31UL);
  43
  44 //-----------------------------------------------------
  45 // construction
  46 //-----------------------------------------------------
  47 AccessibleWrap::AccessibleWrap(nsIContent* aContent, DocAccessible* aDoc)
  48     : LocalAccessible(aContent, aDoc) {
  49   if (aDoc) {
  50     mID = AcquireID();
  51     DocAccessibleWrap* doc = static_cast<DocAccessibleWrap*>(aDoc);
  52     doc->AddID(mID, this);
  53   }
  54 }
  55
  56 //-----------------------------------------------------
  57 // destruction
  58 //-----------------------------------------------------
  59 AccessibleWrap::~AccessibleWrap() {}
  60
  61 nsresult AccessibleWrap::HandleAccEvent(AccEvent* aEvent) {
  62   auto accessible = static_cast<AccessibleWrap*>(aEvent->GetAccessible());
  63   NS_ENSURE_TRUE(accessible, NS_ERROR_FAILURE);
  64   DocAccessibleWrap* doc =
  65       static_cast<DocAccessibleWrap*>(accessible->Document());
  66   if (doc) {
  67     switch (aEvent->GetEventType()) {
  68       case nsIAccessibleEvent::EVENT_FOCUS: {
  69         if (DocAccessibleWrap* topContentDoc =
  70                 doc->GetTopLevelContentDoc(accessible)) {
  71           topContentDoc->CacheFocusPath(accessible);
  72         }
  73         break;
  74       }
  75       case nsIAccessibleEvent::EVENT_VIRTUALCURSOR_CHANGED: {
  76         AccVCChangeEvent* vcEvent = downcast_accEvent(aEvent);
  77         auto newPosition =
  78             static_cast<AccessibleWrap*>(vcEvent->NewAccessible());
  79         if (newPosition) {
  80           if (DocAccessibleWrap* topContentDoc =
  81                   doc->GetTopLevelContentDoc(accessible)) {
  82             topContentDoc->CacheFocusPath(newPosition);
  83           }
  84         }
  85         break;
  86       }
  87       case nsIAccessibleEvent::EVENT_REORDER: {
  88         if (DocAccessibleWrap* topContentDoc =
  89                 doc->GetTopLevelContentDoc(accessible)) {
  90           topContentDoc->CacheViewport(true);
  91         }
  92         break;
  93       }
  94       case nsIAccessibleEvent::EVENT_TEXT_CARET_MOVED: {
  95         if (accessible != aEvent->Document() && !aEvent->IsFromUserInput()) {
  96           AccCaretMoveEvent* caretEvent = downcast_accEvent(aEvent);
  97           HyperTextAccessible* ht = AsHyperText();
  98           // Pivot to the caret's position if it has an expanded selection.
  99           // This is used mostly for find in page.
 100           if ((ht && ht->SelectionCount())) {
 101             DOMPoint point =
 102                 AsHyperText()->OffsetToDOMPoint(caretEvent->GetCaretOffset());
 103             if (LocalAccessible* newPos =
 104                     doc->GetAccessibleOrContainer(point.node)) {
 105               static_cast<AccessibleWrap*>(newPos)->PivotTo(
 106                   java::SessionAccessibility::HTML_GRANULARITY_DEFAULT, true,
 107                   true);
 108             }
 109           }
 110         }
 111         break;
 112       }
 113       case nsIAccessibleEvent::EVENT_SCROLLING_START: {
 114         accessible->PivotTo(
 115             java::SessionAccessibility::HTML_GRANULARITY_DEFAULT, true, true);
 116         break;
 117       }
 118       default:
 119         break;
 120     }
 121   }
 122
 123   nsresult rv = LocalAccessible::HandleAccEvent(aEvent);
 124   NS_ENSURE_SUCCESS(rv, rv);
 125
 126   accessible->HandleLiveRegionEvent(aEvent);
 127
 128   if (IPCAccessibilityActive()) {
 129     return NS_OK;
 130   }
 131
 132   // The accessible can become defunct if we have an xpcom event listener
 133   // which decides it would be fun to change the DOM and flush layout.
 134   if (accessible->IsDefunct() || !accessible->IsBoundToParent()) {
 135     return NS_OK;
 136   }
 137
 138   if (doc) {
 139     if (!doc->DocumentNode()->IsContentDocument()) {
 140       return NS_OK;
 141     }
 142   }
 143
 144   RefPtr<SessionAccessibility> sessionAcc =
 145       SessionAccessibility::GetInstanceFor(accessible);
 146   if (!sessionAcc) {
 147     return NS_OK;
 148   }
 149
 150   switch (aEvent->GetEventType()) {
 151     case nsIAccessibleEvent::EVENT_FOCUS:
 152       sessionAcc->SendFocusEvent(accessible);
 153       break;
 154     case nsIAccessibleEvent::EVENT_VIRTUALCURSOR_CHANGED: {
 155       AccVCChangeEvent* vcEvent = downcast_accEvent(aEvent);
 156       if (!vcEvent->IsFromUserInput()) {
 157         break;
 158       }
 159
 160       RefPtr<AccessibleWrap> newPosition =
 161           static_cast<AccessibleWrap*>(vcEvent->NewAccessible());
 162       if (sessionAcc && newPosition) {
 163         if (vcEvent->Reason() == nsIAccessiblePivot::REASON_POINT) {
 164           sessionAcc->SendHoverEnterEvent(newPosition);
 165         } else if (vcEvent->BoundaryType() == nsIAccessiblePivot::NO_BOUNDARY) {
 166           sessionAcc->SendAccessibilityFocusedEvent(newPosition);
 167         }
 168
 169         if (vcEvent->BoundaryType() != nsIAccessiblePivot::NO_BOUNDARY) {
 170           sessionAcc->SendTextTraversedEvent(
 171               newPosition, vcEvent->NewStartOffset(), vcEvent->NewEndOffset());
 172         }
 173       }
 174       break;
 175     }
 176     case nsIAccessibleEvent::EVENT_TEXT_CARET_MOVED: {
 177       AccCaretMoveEvent* event = downcast_accEvent(aEvent);
 178       sessionAcc->SendTextSelectionChangedEvent(accessible,
 179                                                 event->GetCaretOffset());
 180       break;
 181     }
 182     case nsIAccessibleEvent::EVENT_TEXT_INSERTED:
 183     case nsIAccessibleEvent::EVENT_TEXT_REMOVED: {
 184       AccTextChangeEvent* event = downcast_accEvent(aEvent);
 185       sessionAcc->SendTextChangedEvent(
 186           accessible, event->ModifiedText(), event->GetStartOffset(),
 187           event->GetLength(), event->IsTextInserted(),
 188           event->IsFromUserInput());
 189       break;
 190     }
 191     case nsIAccessibleEvent::EVENT_STATE_CHANGE: {
 192       AccStateChangeEvent* event = downcast_accEvent(aEvent);
 193       auto state = event->GetState();
 194       if (state & states::CHECKED) {
 195         sessionAcc->SendClickedEvent(
 196             accessible, java::SessionAccessibility::FLAG_CHECKABLE |
 197                             (event->IsStateEnabled()
 198                                  ? java::SessionAccessibility::FLAG_CHECKED
 199                                  : 0));
 200       }
 201
 202       if (state & states::EXPANDED) {
 203         sessionAcc->SendClickedEvent(
 204             accessible, java::SessionAccessibility::FLAG_EXPANDABLE |
 205                             (event->IsStateEnabled()
 206                                  ? java::SessionAccessibility::FLAG_EXPANDED
 207                                  : 0));
 208       }
 209
 210       if (state & states::SELECTED) {
 211         sessionAcc->SendSelectedEvent(accessible, event->IsStateEnabled());
 212       }
 213
 214       if (state & states::BUSY) {
 215         sessionAcc->SendWindowStateChangedEvent(accessible);
 216       }
 217       break;
 218     }
 219     case nsIAccessibleEvent::EVENT_SCROLLING: {
 220       AccScrollingEvent* event = downcast_accEvent(aEvent);
 221       sessionAcc->SendScrollingEvent(accessible, event->ScrollX(),
 222                                      event->ScrollY(), event->MaxScrollX(),
 223                                      event->MaxScrollY());
 224       break;
 225     }
 226     case nsIAccessibleEvent::EVENT_ANNOUNCEMENT: {
 227       AccAnnouncementEvent* event = downcast_accEvent(aEvent);
 228       sessionAcc->SendAnnouncementEvent(accessible, event->Announcement(),
 229                                         event->Priority());
 230       break;
 231     }
 232     default:
 233       break;
 234   }
 235
 236   return NS_OK;
 237 }
 238
 239 void AccessibleWrap::Shutdown() {
 240   if (mDoc) {
 241     if (mID > 0) {
 242       if (auto doc = static_cast<DocAccessibleWrap*>(mDoc.get())) {
 243         doc->RemoveID(mID);
 244       }
 245       ReleaseID(mID);
 246       mID = 0;
 247     }
 248   }
 249
 250   LocalAccessible::Shutdown();
 251 }
 252
 253 bool AccessibleWrap::DoAction(uint8_t aIndex) const {
 254   if (ActionCount()) {
 255     return LocalAccessible::DoAction(aIndex);
 256   }
 257
 258   if (mContent) {
 259     // We still simulate a click on an accessible even if there is no
 260     // known actions. For the sake of bad markup.
 261     DoCommand();
 262     return true;
 263   }
 264
 265   return false;
 266 }
 267
 268 int32_t AccessibleWrap::AcquireID() { return sIDSet.GetID(); }
 269
 270 void AccessibleWrap::ReleaseID(int32_t aID) { sIDSet.ReleaseID(aID); }
 271
 272 void AccessibleWrap::SetTextContents(const nsAString& aText) {
 273   if (IsHyperText()) {
 274     AsHyperText()->ReplaceText(aText);
 275   }
 276 }
 277
 278 void AccessibleWrap::GetTextContents(nsAString& aText) {
 279   // For now it is a simple wrapper for getting entire range of TextSubstring.
 280   // In the future this may be smarter and retrieve a flattened string.
 281   if (IsHyperText()) {
 282     AsHyperText()->TextSubstring(0, -1, aText);
 283   } else if (IsTextLeaf()) {
 284     aText = AsTextLeaf()->Text();
 285   }
 286 }
 287
 288 bool AccessibleWrap::GetSelectionBounds(int32_t* aStartOffset,
 289                                         int32_t* aEndOffset) {
 290   if (IsHyperText()) {
 291     return AsHyperText()->SelectionBoundsAt(0, aStartOffset, aEndOffset);
 292   }
 293
 294   return false;
 295 }
 296
 297 void AccessibleWrap::PivotTo(int32_t aGranularity, bool aForward,
 298                              bool aInclusive) {
 299   a11y::Pivot pivot(RootAccessible());
 300   TraversalRule rule(aGranularity);
 301   Accessible* maybeResult = aForward ? pivot.Next(this, rule, aInclusive)
 302                                      : pivot.Prev(this, rule, aInclusive);
 303   LocalAccessible* result = maybeResult ? maybeResult->AsLocal() : nullptr;
 304   if (result && (result != this || aInclusive)) {
 305     PivotMoveReason reason = aForward ? nsIAccessiblePivot::REASON_NEXT
 306                                       : nsIAccessiblePivot::REASON_PREV;
 307     RefPtr<AccEvent> event = new AccVCChangeEvent(
 308         result->Document(), this, -1, -1, result, -1, -1, reason,
 309         nsIAccessiblePivot::NO_BOUNDARY, eFromUserInput);
 310     nsEventShell::FireEvent(event);
 311   }
 312 }
 313
 314 void AccessibleWrap::ExploreByTouch(float aX, float aY) {
 315   a11y::Pivot pivot(RootAccessible());
 316   TraversalRule rule;
 317
 318   Accessible* maybeResult = pivot.AtPoint(aX, aY, rule);
 319   LocalAccessible* result = maybeResult ? maybeResult->AsLocal() : nullptr;
 320
 321   if (result && result != this) {
 322     RefPtr<AccEvent> event =
 323         new AccVCChangeEvent(result->Document(), this, -1, -1, result, -1, -1,
 324                              nsIAccessiblePivot::REASON_POINT,
 325                              nsIAccessiblePivot::NO_BOUNDARY, eFromUserInput);
 326     nsEventShell::FireEvent(event);
 327   }
 328 }
 329
 330 void AccessibleWrap::NavigateText(int32_t aGranularity, int32_t aStartOffset,
 331                                   int32_t aEndOffset, bool aForward,
 332                                   bool aSelect) {
 333   a11y::Pivot pivot(RootAccessible());
 334
 335   HyperTextAccessible* editable =
 336       (State() & states::EDITABLE) != 0 ? AsHyperText() : nullptr;
 337
 338   int32_t start = aStartOffset, end = aEndOffset;
 339   // If the accessible is an editable, set the virtual cursor position
 340   // to its caret offset. Otherwise use the document's virtual cursor
 341   // position as a starting offset.
 342   if (editable) {
 343     start = end = editable->CaretOffset();
 344   }
 345
 346   uint16_t pivotGranularity = nsIAccessiblePivot::LINE_BOUNDARY;
 347   switch (aGranularity) {
 348     case 1:  // MOVEMENT_GRANULARITY_CHARACTER
 349       pivotGranularity = nsIAccessiblePivot::CHAR_BOUNDARY;
 350       break;
 351     case 2:  // MOVEMENT_GRANULARITY_WORD
 352       pivotGranularity = nsIAccessiblePivot::WORD_BOUNDARY;
 353       break;
 354     default:
 355       break;
 356   }
 357
 358   int32_t newOffset;
 359   LocalAccessible* newAnchor = nullptr;
 360   if (aForward) {
 361     newAnchor = pivot.NextText(this, &start, &end, pivotGranularity);
 362     newOffset = end;
 363   } else {
 364     newAnchor = pivot.PrevText(this, &start, &end, pivotGranularity);
 365     newOffset = start;
 366   }
 367
 368   if (newAnchor && (start != aStartOffset || end != aEndOffset)) {
 369     if (IsTextLeaf() && newAnchor == LocalParent()) {
 370       // For paragraphs, divs, spans, etc., we put a11y focus on the text leaf
 371       // node instead of the HyperTextAccessible. However, Pivot will always
 372       // return a HyperTextAccessible. Android doesn't support text navigation
 373       // landing on an accessible which is different to the originating
 374       // accessible. Therefore, if we're still within the same text leaf,
 375       // translate the offsets to the text leaf.
 376       int32_t thisChild = IndexInParent();
 377       HyperTextAccessible* newHyper = newAnchor->AsHyperText();
 378       MOZ_ASSERT(newHyper);
 379       int32_t startChild = newHyper->GetChildIndexAtOffset(start);
 380       // We use end - 1 because the end offset is exclusive, so end itself
 381       // might be associated with the next child.
 382       int32_t endChild = newHyper->GetChildIndexAtOffset(end - 1);
 383       if (startChild == thisChild && endChild == thisChild) {
 384         // We've landed within the same text leaf.
 385         newAnchor = this;
 386         int32_t thisOffset = newHyper->GetChildOffset(thisChild);
 387         start -= thisOffset;
 388         end -= thisOffset;
 389       }
 390     }
 391     RefPtr<AccEvent> event = new AccVCChangeEvent(
 392         newAnchor->Document(), this, aStartOffset, aEndOffset, newAnchor, start,
 393         end, nsIAccessiblePivot::REASON_NONE, pivotGranularity, eFromUserInput);
 394     nsEventShell::FireEvent(event);
 395   }
 396
 397   // If we are in an editable, move the caret to the new virtual cursor
 398   // offset.
 399   if (editable) {
 400     if (aSelect) {
 401       int32_t anchor = editable->CaretOffset();
 402       if (editable->SelectionCount()) {
 403         int32_t startSel, endSel;
 404         GetSelectionOrCaret(&startSel, &endSel);
 405         anchor = startSel == anchor ? endSel : startSel;
 406       }
 407       editable->SetSelectionBoundsAt(0, anchor, newOffset);
 408     } else {
 409       editable->SetCaretOffset(newOffset);
 410     }
 411   }
 412 }
 413
 414 void AccessibleWrap::SetSelection(int32_t aStart, int32_t aEnd) {
 415   if (HyperTextAccessible* textAcc = AsHyperText()) {
 416     if (aStart == aEnd) {
 417       textAcc->SetCaretOffset(aStart);
 418     } else {
 419       textAcc->SetSelectionBoundsAt(0, aStart, aEnd);
 420     }
 421   }
 422 }
 423
 424 void AccessibleWrap::Cut() {
 425   if ((State() & states::EDITABLE) == 0) {
 426     return;
 427   }
 428
 429   if (HyperTextAccessible* textAcc = AsHyperText()) {
 430     int32_t startSel, endSel;
 431     GetSelectionOrCaret(&startSel, &endSel);
 432     textAcc->CutText(startSel, endSel);
 433   }
 434 }
 435
 436 void AccessibleWrap::Copy() {
 437   if (HyperTextAccessible* textAcc = AsHyperText()) {
 438     int32_t startSel, endSel;
 439     GetSelectionOrCaret(&startSel, &endSel);
 440     textAcc->CopyText(startSel, endSel);
 441   }
 442 }
 443
 444 void AccessibleWrap::Paste() {
 445   if ((State() & states::EDITABLE) == 0) {
 446     return;
 447   }
 448
 449   if (IsHyperText()) {
 450     RefPtr<HyperTextAccessible> textAcc = AsHyperText();
 451     int32_t startSel, endSel;
 452     GetSelectionOrCaret(&startSel, &endSel);
 453     if (startSel != endSel) {
 454       textAcc->DeleteText(startSel, endSel);
 455     }
 456     textAcc->PasteText(startSel);
 457   }
 458 }
 459
 460 void AccessibleWrap::GetSelectionOrCaret(int32_t* aStartOffset,
 461                                          int32_t* aEndOffset) {
 462   *aStartOffset = *aEndOffset = -1;
 463   if (HyperTextAccessible* textAcc = AsHyperText()) {
 464     if (!textAcc->SelectionBoundsAt(0, aStartOffset, aEndOffset)) {
 465       *aStartOffset = *aEndOffset = textAcc->CaretOffset();
 466     }
 467   }
 468 }
 469
 470 uint32_t AccessibleWrap::GetFlags(role aRole, uint64_t aState,
 471                                   uint8_t aActionCount) {
 472   uint32_t flags = 0;
 473   if (aState & states::CHECKABLE) {
 474     flags |= java::SessionAccessibility::FLAG_CHECKABLE;
 475   }
 476
 477   if (aState & states::CHECKED) {
 478     flags |= java::SessionAccessibility::FLAG_CHECKED;
 479   }
 480
 481   if (aState & states::INVALID) {
 482     flags |= java::SessionAccessibility::FLAG_CONTENT_INVALID;
 483   }
 484
 485   if (aState & states::EDITABLE) {
 486     flags |= java::SessionAccessibility::FLAG_EDITABLE;
 487   }
 488
 489   if (aActionCount && aRole != roles::TEXT_LEAF) {
 490     flags |= java::SessionAccessibility::FLAG_CLICKABLE;
 491   }
 492
 493   if (aState & states::ENABLED) {
 494     flags |= java::SessionAccessibility::FLAG_ENABLED;
 495   }
 496
 497   if (aState & states::FOCUSABLE) {
 498     flags |= java::SessionAccessibility::FLAG_FOCUSABLE;
 499   }
 500
 501   if (aState & states::FOCUSED) {
 502     flags |= java::SessionAccessibility::FLAG_FOCUSED;
 503   }
 504
 505   if (aState & states::MULTI_LINE) {
 506     flags |= java::SessionAccessibility::FLAG_MULTI_LINE;
 507   }
 508
 509   if (aState & states::SELECTABLE) {
 510     flags |= java::SessionAccessibility::FLAG_SELECTABLE;
 511   }
 512
 513   if (aState & states::SELECTED) {
 514     flags |= java::SessionAccessibility::FLAG_SELECTED;
 515   }
 516
 517   if (aState & states::EXPANDABLE) {
 518     flags |= java::SessionAccessibility::FLAG_EXPANDABLE;
 519   }
 520
 521   if (aState & states::EXPANDED) {
 522     flags |= java::SessionAccessibility::FLAG_EXPANDED;
 523   }
 524
 525   if ((aState & (states::INVISIBLE | states::OFFSCREEN)) == 0) {
 526     flags |= java::SessionAccessibility::FLAG_VISIBLE_TO_USER;
 527   }
 528
 529   if (aRole == roles::PASSWORD_TEXT) {
 530     flags |= java::SessionAccessibility::FLAG_PASSWORD;
 531   }
 532
 533   return flags;
 534 }
 535
 536 void AccessibleWrap::GetRoleDescription(role aRole, AccAttributes* aAttributes,
 537                                         nsAString& aGeckoRole,
 538                                         nsAString& aRoleDescription) {
 539   if (aRole == roles::HEADING && aAttributes) {
 540     // The heading level is an attribute, so we need that.
 541     AutoTArray<nsString, 1> formatString;
 542     if (aAttributes->GetAttribute(nsGkAtoms::level,
 543                                   *formatString.AppendElement()) &&
 544         LocalizeString("headingLevel", aRoleDescription, formatString)) {
 545       return;
 546     }
 547   }
 548
 549   if ((aRole == roles::LANDMARK || aRole == roles::REGION) && aAttributes) {
 550     nsAutoString xmlRoles;
 551     if (aAttributes->GetAttribute(nsGkAtoms::xmlroles, xmlRoles)) {
 552       nsWhitespaceTokenizer tokenizer(xmlRoles);
 553       while (tokenizer.hasMoreTokens()) {
 554         if (LocalizeString(NS_ConvertUTF16toUTF8(tokenizer.nextToken()).get(),
 555                            aRoleDescription)) {
 556           return;
 557         }
 558       }
 559     }
 560   }
 561
 562   GetAccService()->GetStringRole(aRole, aGeckoRole);
 563   LocalizeString(NS_ConvertUTF16toUTF8(aGeckoRole).get(), aRoleDescription);
 564 }
 565
 566 int32_t AccessibleWrap::GetAndroidClass(role aRole) {
 567 #define ROLE(geckoRole, stringRole, atkRole, macRole, macSubrole, msaaRole, \
 568              ia2Role, androidClass, nameRule)                               \
 569   case roles::geckoRole:                                                    \
 570     return androidClass;
 571
 572   switch (aRole) {
 573 #include "RoleMap.h"
 574     default:
 575       return java::SessionAccessibility::CLASSNAME_VIEW;
 576   }
 577
 578 #undef ROLE
 579 }
 580
 581 int32_t AccessibleWrap::GetInputType(const nsString& aInputTypeAttr) {
 582   if (aInputTypeAttr.EqualsIgnoreCase("email")) {
 583     return java::sdk::InputType::TYPE_CLASS_TEXT |
 584            java::sdk::InputType::TYPE_TEXT_VARIATION_WEB_EMAIL_ADDRESS;
 585   }
 586
 587   if (aInputTypeAttr.EqualsIgnoreCase("number")) {
 588     return java::sdk::InputType::TYPE_CLASS_NUMBER;
 589   }
 590
 591   if (aInputTypeAttr.EqualsIgnoreCase("password")) {
 592     return java::sdk::InputType::TYPE_CLASS_TEXT |
 593            java::sdk::InputType::TYPE_TEXT_VARIATION_WEB_PASSWORD;
 594   }
 595
 596   if (aInputTypeAttr.EqualsIgnoreCase("tel")) {
 597     return java::sdk::InputType::TYPE_CLASS_PHONE;
 598   }
 599
 600   if (aInputTypeAttr.EqualsIgnoreCase("text")) {
 601     return java::sdk::InputType::TYPE_CLASS_TEXT |
 602            java::sdk::InputType::TYPE_TEXT_VARIATION_WEB_EDIT_TEXT;
 603   }
 604
 605   if (aInputTypeAttr.EqualsIgnoreCase("url")) {
 606     return java::sdk::InputType::TYPE_CLASS_TEXT |
 607            java::sdk::InputType::TYPE_TEXT_VARIATION_URI;
 608   }
 609
 610   return 0;
 611 }
 612
 613 void AccessibleWrap::WrapperDOMNodeID(nsString& aDOMNodeID) {
 614   if (mContent) {
 615     nsAtom* id = mContent->GetID();
 616     if (id) {
 617       id->ToString(aDOMNodeID);
 618     }
 619   }
 620 }
 621
 622 bool AccessibleWrap::WrapperRangeInfo(double* aCurVal, double* aMinVal,
 623                                       double* aMaxVal, double* aStep) {
 624   if (HasNumericValue()) {
 625     *aCurVal = CurValue();
 626     *aMinVal = MinValue();
 627     *aMaxVal = MaxValue();
 628     *aStep = Step();
 629     return true;
 630   }
 631
 632   return false;
 633 }
 634
 635 mozilla::java::GeckoBundle::LocalRef AccessibleWrap::ToBundle(bool aSmall) {
 636   nsAutoString name;
 637   Name(name);
 638   nsAutoString textValue;
 639   Value(textValue);
 640   nsAutoString nodeID;
 641   WrapperDOMNodeID(nodeID);
 642   nsAutoString description;
 643   Description(description);
 644
 645   if (aSmall) {
 646     return ToBundle(State(), Bounds(), ActionCount(), name, textValue, nodeID,
 647                     description);
 648   }
 649
 650   double curValue = UnspecifiedNaN<double>();
 651   double minValue = UnspecifiedNaN<double>();
 652   double maxValue = UnspecifiedNaN<double>();
 653   double step = UnspecifiedNaN<double>();
 654   WrapperRangeInfo(&curValue, &minValue, &maxValue, &step);
 655
 656   RefPtr<AccAttributes> attributes = Attributes();
 657
 658   return ToBundle(State(), Bounds(), ActionCount(), name, textValue, nodeID,
 659                   description, curValue, minValue, maxValue, step, attributes);
 660 }
 661
 662 mozilla::java::GeckoBundle::LocalRef AccessibleWrap::ToBundle(
 663     const uint64_t aState, const nsIntRect& aBounds, const uint8_t aActionCount,
 664     const nsString& aName, const nsString& aTextValue,
 665     const nsString& aDOMNodeID, const nsString& aDescription,
 666     const double& aCurVal, const double& aMinVal, const double& aMaxVal,
 667     const double& aStep, AccAttributes* aAttributes) {
 668   if (!IsProxy() && IsDefunct()) {
 669     return nullptr;
 670   }
 671
 672   GECKOBUNDLE_START(nodeInfo);
 673   GECKOBUNDLE_PUT(nodeInfo, "id", java::sdk::Integer::ValueOf(VirtualViewID()));
 674
 675   AccessibleWrap* parent = WrapperParent();
 676   GECKOBUNDLE_PUT(
 677       nodeInfo, "parentId",
 678       java::sdk::Integer::ValueOf(parent ? parent->VirtualViewID() : 0));
 679
 680   role role = WrapperRole();
 681   if (role == roles::LINK && !(aState & states::LINKED)) {
 682     // A link without the linked state (<a> with no href) shouldn't be presented
 683     // as a link.
 684     role = roles::TEXT;
 685   }
 686
 687   uint32_t flags = GetFlags(role, aState, aActionCount);
 688   GECKOBUNDLE_PUT(nodeInfo, "flags", java::sdk::Integer::ValueOf(flags));
 689   GECKOBUNDLE_PUT(nodeInfo, "className",
 690                   java::sdk::Integer::ValueOf(AndroidClass()));
 691
 692   nsAutoString hint;
 693   if (aState & states::EDITABLE) {
 694     // An editable field's name is populated in the hint.
 695     hint.Assign(aName);
 696     GECKOBUNDLE_PUT(nodeInfo, "text", jni::StringParam(aTextValue));
 697   } else {
 698     if (role == roles::LINK || role == roles::HEADING) {
 699       GECKOBUNDLE_PUT(nodeInfo, "description", jni::StringParam(aName));
 700     } else {
 701       GECKOBUNDLE_PUT(nodeInfo, "text", jni::StringParam(aName));
 702     }
 703   }
 704
 705   if (!aDescription.IsEmpty()) {
 706     if (!hint.IsEmpty()) {
 707       // If this is an editable, the description is concatenated with a
 708       // whitespace directly after the name.
 709       hint.AppendLiteral(" ");
 710     }
 711     hint.Append(aDescription);
 712   }
 713
 714   if ((aState & states::REQUIRED) != 0) {
 715     nsAutoString requiredString;
 716     if (LocalizeString("stateRequired", requiredString)) {
 717       if (!hint.IsEmpty()) {
 718         // If the hint is non-empty, concatenate with a comma for a brief pause.
 719         hint.AppendLiteral(", ");
 720       }
 721       hint.Append(requiredString);
 722     }
 723   }
 724
 725   if (!hint.IsEmpty()) {
 726     GECKOBUNDLE_PUT(nodeInfo, "hint", jni::StringParam(hint));
 727   }
 728
 729   nsAutoString geckoRole;
 730   nsAutoString roleDescription;
 731   if (VirtualViewID() != kNoID) {
 732     GetRoleDescription(role, aAttributes, geckoRole, roleDescription);
 733   }
 734
 735   GECKOBUNDLE_PUT(nodeInfo, "roleDescription",
 736                   jni::StringParam(roleDescription));
 737   GECKOBUNDLE_PUT(nodeInfo, "geckoRole", jni::StringParam(geckoRole));
 738
 739   if (!aDOMNodeID.IsEmpty()) {
 740     GECKOBUNDLE_PUT(nodeInfo, "viewIdResourceName",
 741                     jni::StringParam(aDOMNodeID));
 742   }
 743
 744   const int32_t data[4] = {aBounds.x, aBounds.y, aBounds.x + aBounds.width,
 745                            aBounds.y + aBounds.height};
 746   GECKOBUNDLE_PUT(nodeInfo, "bounds", jni::IntArray::New(data, 4));
 747
 748   if (HasNumericValue()) {
 749     GECKOBUNDLE_START(rangeInfo);
 750     if (aMaxVal == 1 && aMinVal == 0) {
 751       GECKOBUNDLE_PUT(rangeInfo, "type",
 752                       java::sdk::Integer::ValueOf(2));  // percent
 753     } else if (std::round(aStep) != aStep) {
 754       GECKOBUNDLE_PUT(rangeInfo, "type",
 755                       java::sdk::Integer::ValueOf(1));  // float
 756     } else {
 757       GECKOBUNDLE_PUT(rangeInfo, "type",
 758                       java::sdk::Integer::ValueOf(0));  // integer
 759     }
 760
 761     if (!IsNaN(aCurVal)) {
 762       GECKOBUNDLE_PUT(rangeInfo, "current", java::sdk::Double::New(aCurVal));
 763     }
 764     if (!IsNaN(aMinVal)) {
 765       GECKOBUNDLE_PUT(rangeInfo, "min", java::sdk::Double::New(aMinVal));
 766     }
 767     if (!IsNaN(aMaxVal)) {
 768       GECKOBUNDLE_PUT(rangeInfo, "max", java::sdk::Double::New(aMaxVal));
 769     }
 770
 771     GECKOBUNDLE_FINISH(rangeInfo);
 772     GECKOBUNDLE_PUT(nodeInfo, "rangeInfo", rangeInfo);
 773   }
 774
 775   if (aAttributes) {
 776     nsString inputTypeAttr;
 777     aAttributes->GetAttribute(nsGkAtoms::textInputType, inputTypeAttr);
 778     int32_t inputType = GetInputType(inputTypeAttr);
 779     if (inputType) {
 780       GECKOBUNDLE_PUT(nodeInfo, "inputType",
 781                       java::sdk::Integer::ValueOf(inputType));
 782     }
 783
 784     Maybe<int32_t> rowIndex =
 785         aAttributes->GetAttribute<int32_t>(nsGkAtoms::posinset);
 786     if (rowIndex) {
 787       GECKOBUNDLE_START(collectionItemInfo);
 788       GECKOBUNDLE_PUT(collectionItemInfo, "rowIndex",
 789                       java::sdk::Integer::ValueOf(*rowIndex));
 790       GECKOBUNDLE_PUT(collectionItemInfo, "columnIndex",
 791                       java::sdk::Integer::ValueOf(0));
 792       GECKOBUNDLE_PUT(collectionItemInfo, "rowSpan",
 793                       java::sdk::Integer::ValueOf(1));
 794       GECKOBUNDLE_PUT(collectionItemInfo, "columnSpan",
 795                       java::sdk::Integer::ValueOf(1));
 796       GECKOBUNDLE_FINISH(collectionItemInfo);
 797
 798       GECKOBUNDLE_PUT(nodeInfo, "collectionItemInfo", collectionItemInfo);
 799     }
 800
 801     Maybe<int32_t> rowCount =
 802         aAttributes->GetAttribute<int32_t>(nsGkAtoms::child_item_count);
 803     if (rowCount) {
 804       GECKOBUNDLE_START(collectionInfo);
 805       GECKOBUNDLE_PUT(collectionInfo, "rowCount",
 806                       java::sdk::Integer::ValueOf(*rowCount));
 807       GECKOBUNDLE_PUT(collectionInfo, "columnCount",
 808                       java::sdk::Integer::ValueOf(1));
 809
 810       if (aAttributes->HasAttribute(nsGkAtoms::tree)) {
 811         GECKOBUNDLE_PUT(collectionInfo, "isHierarchical",
 812                         java::sdk::Boolean::TRUE());
 813       }
 814
 815       if (IsSelect()) {
 816         int32_t selectionMode = (aState & states::MULTISELECTABLE) ? 2 : 1;
 817         GECKOBUNDLE_PUT(collectionInfo, "selectionMode",
 818                         java::sdk::Integer::ValueOf(selectionMode));
 819       }
 820
 821       GECKOBUNDLE_FINISH(collectionInfo);
 822       GECKOBUNDLE_PUT(nodeInfo, "collectionInfo", collectionInfo);
 823     }
 824   }
 825
 826   bool mustPrune =
 827       IsProxy() ? nsAccUtils::MustPrune(Proxy()) : nsAccUtils::MustPrune(this);
 828   if (!mustPrune) {
 829     auto childCount = ChildCount();
 830     nsTArray<int32_t> children(childCount);
 831     for (uint32_t i = 0; i < childCount; i++) {
 832       auto child = static_cast<AccessibleWrap*>(LocalChildAt(i));
 833       children.AppendElement(child->VirtualViewID());
 834     }
 835
 836     GECKOBUNDLE_PUT(nodeInfo, "children",
 837                     jni::IntArray::New(children.Elements(), children.Length()));
 838   }
 839
 840   GECKOBUNDLE_FINISH(nodeInfo);
 841
 842   return nodeInfo;
 843 }
 844
 845 void AccessibleWrap::GetTextEquiv(nsString& aText) {
 846   if (nsTextEquivUtils::HasNameRule(this, eNameFromSubtreeIfReqRule)) {
 847     // This is an accessible that normally doesn't get its name from its
 848     // subtree, so we collect the text equivalent explicitly.
 849     nsTextEquivUtils::GetTextEquivFromSubtree(this, aText);
 850   } else {
 851     Name(aText);
 852   }
 853 }
 854
 855 bool AccessibleWrap::HandleLiveRegionEvent(AccEvent* aEvent) {
 856   auto eventType = aEvent->GetEventType();
 857   if (eventType != nsIAccessibleEvent::EVENT_TEXT_INSERTED &&
 858       eventType != nsIAccessibleEvent::EVENT_NAME_CHANGE) {
 859     // XXX: Right now only announce text inserted events. aria-relevant=removals
 860     // is potentially on the chopping block[1]. We also don't support editable
 861     // text because we currently can't descern the source of the change[2].
 862     // 1. https://github.com/w3c/aria/issues/712
 863     // 2. https://bugzilla.mozilla.org/show_bug.cgi?id=1531189
 864     return false;
 865   }
 866
 867   if (aEvent->IsFromUserInput()) {
 868     return false;
 869   }
 870
 871   RefPtr<AccAttributes> attributes = Attributes();
 872   nsString live;
 873   if (!attributes->GetAttribute(nsGkAtoms::containerLive, live)) {
 874     return false;
 875   }
 876
 877   uint16_t priority = live.EqualsIgnoreCase("assertive")
 878                           ? nsIAccessibleAnnouncementEvent::ASSERTIVE
 879                           : nsIAccessibleAnnouncementEvent::POLITE;
 880
 881   Maybe<bool> atomic =
 882       attributes->GetAttribute<bool>(nsGkAtoms::containerAtomic);
 883   LocalAccessible* announcementTarget = this;
 884   nsAutoString announcement;
 885   if (atomic && *atomic) {
 886     LocalAccessible* atomicAncestor = nullptr;
 887     for (LocalAccessible* parent = announcementTarget; parent;
 888          parent = parent->LocalParent()) {
 889       dom::Element* element = parent->Elm();
 890       if (element &&
 891           element->AttrValueIs(kNameSpaceID_None, nsGkAtoms::aria_atomic,
 892                                nsGkAtoms::_true, eCaseMatters)) {
 893         atomicAncestor = parent;
 894         break;
 895       }
 896     }
 897
 898     if (atomicAncestor) {
 899       announcementTarget = atomicAncestor;
 900       static_cast<AccessibleWrap*>(atomicAncestor)->GetTextEquiv(announcement);
 901     }
 902   } else {
 903     GetTextEquiv(announcement);
 904   }
 905
 906   announcement.CompressWhitespace();
 907   if (announcement.IsEmpty()) {
 908     return false;
 909   }
 910
 911   announcementTarget->Announce(announcement, priority);
 912   return true;
 913 }