AX: Adding children incorrectly when there are nested inline continuations
[WebKit-https.git] / Source / WebCore / accessibility / AccessibilityRenderObject.cpp
1 /*
2 * Copyright (C) 2008 Apple Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * 1.  Redistributions of source code must retain the above copyright
9 *     notice, this list of conditions and the following disclaimer.
10 * 2.  Redistributions in binary form must reproduce the above copyright
11 *     notice, this list of conditions and the following disclaimer in the
12 *     documentation and/or other materials provided with the distribution.
13 * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14 *     its contributors may be used to endorse or promote products derived
15 *     from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 #include "config.h"
30 #include "AccessibilityRenderObject.h"
31
32 #include "AXObjectCache.h"
33 #include "AccessibilityImageMapLink.h"
34 #include "AccessibilityListBox.h"
35 #include "AccessibilitySVGRoot.h"
36 #include "AccessibilitySpinButton.h"
37 #include "AccessibilityTable.h"
38 #include "CachedImage.h"
39 #include "Chrome.h"
40 #include "ElementIterator.h"
41 #include "EventNames.h"
42 #include "FloatRect.h"
43 #include "Frame.h"
44 #include "FrameLoader.h"
45 #include "FrameSelection.h"
46 #include "HTMLAreaElement.h"
47 #include "HTMLAudioElement.h"
48 #include "HTMLFormElement.h"
49 #include "HTMLFrameElementBase.h"
50 #include "HTMLImageElement.h"
51 #include "HTMLInputElement.h"
52 #include "HTMLLabelElement.h"
53 #include "HTMLMapElement.h"
54 #include "HTMLNames.h"
55 #include "HTMLOptGroupElement.h"
56 #include "HTMLOptionElement.h"
57 #include "HTMLOptionsCollection.h"
58 #include "HTMLSelectElement.h"
59 #include "HTMLTableElement.h"
60 #include "HTMLTextAreaElement.h"
61 #include "HTMLVideoElement.h"
62 #include "HitTestRequest.h"
63 #include "HitTestResult.h"
64 #include "Image.h"
65 #include "LocalizedStrings.h"
66 #include "MathMLNames.h"
67 #include "NodeList.h"
68 #include "Page.h"
69 #include "ProgressTracker.h"
70 #include "RenderButton.h"
71 #include "RenderFieldset.h"
72 #include "RenderFileUploadControl.h"
73 #include "RenderHTMLCanvas.h"
74 #include "RenderImage.h"
75 #include "RenderInline.h"
76 #include "RenderIterator.h"
77 #include "RenderLayer.h"
78 #include "RenderLineBreak.h"
79 #include "RenderListBox.h"
80 #include "RenderListItem.h"
81 #include "RenderListMarker.h"
82 #include "RenderMathMLBlock.h"
83 #include "RenderMathMLFraction.h"
84 #include "RenderMathMLOperator.h"
85 #include "RenderMathMLRoot.h"
86 #include "RenderMenuList.h"
87 #include "RenderSVGRoot.h"
88 #include "RenderSVGShape.h"
89 #include "RenderTableCell.h"
90 #include "RenderText.h"
91 #include "RenderTextControl.h"
92 #include "RenderTextControlSingleLine.h"
93 #include "RenderTextFragment.h"
94 #include "RenderTheme.h"
95 #include "RenderView.h"
96 #include "RenderWidget.h"
97 #include "RenderedPosition.h"
98 #include "SVGDocument.h"
99 #include "SVGImage.h"
100 #include "SVGNames.h"
101 #include "SVGSVGElement.h"
102 #include "Text.h"
103 #include "TextControlInnerElements.h"
104 #include "TextIterator.h"
105 #include "VisibleUnits.h"
106 #include "htmlediting.h"
107 #include <wtf/NeverDestroyed.h>
108 #include <wtf/StdLibExtras.h>
109 #include <wtf/text/StringBuilder.h>
110 #include <wtf/unicode/CharacterNames.h>
111
112 namespace WebCore {
113
114 using namespace HTMLNames;
115
116 AccessibilityRenderObject::AccessibilityRenderObject(RenderObject* renderer)
117     : AccessibilityNodeObject(renderer->node())
118     , m_renderer(renderer)
119 {
120 #ifndef NDEBUG
121     m_renderer->setHasAXObject(true);
122 #endif
123 }
124
125 AccessibilityRenderObject::~AccessibilityRenderObject()
126 {
127     ASSERT(isDetached());
128 }
129
130 void AccessibilityRenderObject::init()
131 {
132     AccessibilityNodeObject::init();
133 }
134
135 Ref<AccessibilityRenderObject> AccessibilityRenderObject::create(RenderObject* renderer)
136 {
137     return adoptRef(*new AccessibilityRenderObject(renderer));
138 }
139
140 void AccessibilityRenderObject::detach(AccessibilityDetachmentType detachmentType, AXObjectCache* cache)
141 {
142     AccessibilityNodeObject::detach(detachmentType, cache);
143     
144     detachRemoteSVGRoot();
145     
146 #ifndef NDEBUG
147     if (m_renderer)
148         m_renderer->setHasAXObject(false);
149 #endif
150     m_renderer = nullptr;
151 }
152
153 RenderBoxModelObject* AccessibilityRenderObject::renderBoxModelObject() const
154 {
155     if (!is<RenderBoxModelObject>(m_renderer))
156         return nullptr;
157     return downcast<RenderBoxModelObject>(m_renderer);
158 }
159
160 void AccessibilityRenderObject::setRenderer(RenderObject* renderer)
161 {
162     m_renderer = renderer;
163     setNode(renderer->node());
164 }
165
166 static inline bool isInlineWithContinuation(RenderObject& object)
167 {
168     return is<RenderInline>(object) && downcast<RenderInline>(object).continuation();
169 }
170
171 static inline RenderObject* firstChildInContinuation(RenderInline& renderer)
172 {
173     auto continuation = renderer.continuation();
174
175     while (continuation) {
176         if (is<RenderBlock>(*continuation))
177             return continuation;
178         if (RenderObject* child = continuation->firstChild())
179             return child;
180         continuation = downcast<RenderInline>(*continuation).continuation();
181     }
182
183     return nullptr;
184 }
185
186 static inline RenderObject* firstChildConsideringContinuation(RenderObject& renderer)
187 {
188     RenderObject* firstChild = renderer.firstChildSlow();
189
190     if (!firstChild && isInlineWithContinuation(renderer))
191         firstChild = firstChildInContinuation(downcast<RenderInline>(renderer));
192
193     return firstChild;
194 }
195
196
197 static inline RenderObject* lastChildConsideringContinuation(RenderObject& renderer)
198 {
199     if (!is<RenderInline>(renderer) && !is<RenderBlock>(renderer))
200         return &renderer;
201
202     RenderObject* lastChild = downcast<RenderBoxModelObject>(renderer).lastChild();
203     RenderBoxModelObject* previous;
204     for (auto* current = &downcast<RenderBoxModelObject>(renderer); current; ) {
205         previous = current;
206
207         if (RenderObject* newLastChild = current->lastChild())
208             lastChild = newLastChild;
209
210         if (is<RenderInline>(*current)) {
211             current = downcast<RenderInline>(*current).inlineElementContinuation();
212             ASSERT_UNUSED(previous, current || !downcast<RenderInline>(*previous).continuation());
213         } else
214             current = downcast<RenderBlock>(*current).inlineElementContinuation();
215     }
216
217     return lastChild;
218 }
219
220 AccessibilityObject* AccessibilityRenderObject::firstChild() const
221 {
222     if (!m_renderer)
223         return nullptr;
224     
225     RenderObject* firstChild = firstChildConsideringContinuation(*m_renderer);
226
227     // If an object can't have children, then it is using this method to help
228     // calculate some internal property (like its description).
229     // In this case, it should check the Node level for children in case they're
230     // not rendered (like a <meter> element).
231     if (!firstChild && !canHaveChildren())
232         return AccessibilityNodeObject::firstChild();
233
234     return axObjectCache()->getOrCreate(firstChild);
235 }
236
237 AccessibilityObject* AccessibilityRenderObject::lastChild() const
238 {
239     if (!m_renderer)
240         return nullptr;
241
242     RenderObject* lastChild = lastChildConsideringContinuation(*m_renderer);
243
244     if (!lastChild && !canHaveChildren())
245         return AccessibilityNodeObject::lastChild();
246
247     return axObjectCache()->getOrCreate(lastChild);
248 }
249
250 static inline RenderInline* startOfContinuations(RenderObject& renderer)
251 {
252     if (renderer.isInlineElementContinuation() && is<RenderInline>(renderer.node()->renderer()))
253         return downcast<RenderInline>(renderer.node()->renderer());
254
255     // Blocks with a previous continuation always have a next continuation
256     if (is<RenderBlock>(renderer) && downcast<RenderBlock>(renderer).inlineElementContinuation())
257         return downcast<RenderInline>(downcast<RenderBlock>(renderer).inlineElementContinuation()->element()->renderer());
258
259     return nullptr;
260 }
261
262 static inline RenderObject* endOfContinuations(RenderObject& renderer)
263 {
264     if (!is<RenderInline>(renderer) && !is<RenderBlock>(renderer))
265         return &renderer;
266
267     auto* previous = &downcast<RenderBoxModelObject>(renderer);
268     for (auto* current = previous; current; ) {
269         previous = current;
270         if (is<RenderInline>(*current)) {
271             current = downcast<RenderInline>(*current).inlineElementContinuation();
272             ASSERT(current || !downcast<RenderInline>(*previous).continuation());
273         } else 
274             current = downcast<RenderBlock>(*current).inlineElementContinuation();
275     }
276
277     return previous;
278 }
279
280
281 static inline RenderObject* childBeforeConsideringContinuations(RenderInline* renderer, RenderObject* child)
282 {
283     RenderObject* previous = nullptr;
284     for (RenderBoxModelObject* currentContainer = renderer; currentContainer; ) {
285         if (is<RenderInline>(*currentContainer)) {
286             auto* current = currentContainer->firstChild();
287             while (current) {
288                 if (current == child)
289                     return previous;
290                 previous = current;
291                 current = current->nextSibling();
292             }
293
294             currentContainer = downcast<RenderInline>(*currentContainer).continuation();
295         } else if (is<RenderBlock>(*currentContainer)) {
296             if (currentContainer == child)
297                 return previous;
298
299             previous = currentContainer;
300             currentContainer = downcast<RenderBlock>(*currentContainer).inlineElementContinuation();
301         }
302     }
303
304     ASSERT_NOT_REACHED();
305     return nullptr;
306 }
307
308 static inline bool firstChildIsInlineContinuation(RenderElement& renderer)
309 {
310     RenderObject* child = renderer.firstChild();
311     return child && child->isInlineElementContinuation();
312 }
313
314 AccessibilityObject* AccessibilityRenderObject::previousSibling() const
315 {
316     if (!m_renderer)
317         return nullptr;
318
319     RenderObject* previousSibling = nullptr;
320
321     // Case 1: The node is a block and is an inline's continuation. In that case, the inline's
322     // last child is our previous sibling (or further back in the continuation chain)
323     RenderInline* startOfConts;
324     if (is<RenderBox>(*m_renderer) && (startOfConts = startOfContinuations(*m_renderer)))
325         previousSibling = childBeforeConsideringContinuations(startOfConts, m_renderer);
326
327     // Case 2: Anonymous block parent of the end of a continuation - skip all the way to before
328     // the parent of the start, since everything in between will be linked up via the continuation.
329     else if (m_renderer->isAnonymousBlock() && firstChildIsInlineContinuation(downcast<RenderBlock>(*m_renderer))) {
330         RenderBlock& renderBlock = downcast<RenderBlock>(*m_renderer);
331         auto* firstParent = startOfContinuations(*renderBlock.firstChild())->parent();
332         ASSERT(firstParent);
333         while (firstChildIsInlineContinuation(*firstParent))
334             firstParent = startOfContinuations(*firstParent->firstChild())->parent();
335         previousSibling = firstParent->previousSibling();
336     }
337
338     // Case 3: The node has an actual previous sibling
339     else if (RenderObject* ps = m_renderer->previousSibling())
340         previousSibling = ps;
341
342     // Case 4: This node has no previous siblings, but its parent is an inline,
343     // and is another node's inline continutation. Follow the continuation chain.
344     else if (is<RenderInline>(*m_renderer->parent()) && (startOfConts = startOfContinuations(*m_renderer->parent())))
345         previousSibling = childBeforeConsideringContinuations(startOfConts, m_renderer->parent()->firstChild());
346
347     if (!previousSibling)
348         return nullptr;
349     
350     return axObjectCache()->getOrCreate(previousSibling);
351 }
352
353 static inline bool lastChildHasContinuation(RenderElement& renderer)
354 {
355     RenderObject* child = renderer.lastChild();
356     return child && isInlineWithContinuation(*child);
357 }
358
359 AccessibilityObject* AccessibilityRenderObject::nextSibling() const
360 {
361     if (!m_renderer)
362         return nullptr;
363
364     RenderObject* nextSibling = nullptr;
365
366     // Case 1: node is a block and has an inline continuation. Next sibling is the inline continuation's
367     // first child.
368     RenderInline* inlineContinuation;
369     if (is<RenderBlock>(*m_renderer) && (inlineContinuation = downcast<RenderBlock>(*m_renderer).inlineElementContinuation()))
370         nextSibling = firstChildConsideringContinuation(*inlineContinuation);
371
372     // Case 2: Anonymous block parent of the start of a continuation - skip all the way to
373     // after the parent of the end, since everything in between will be linked up via the continuation.
374     else if (m_renderer->isAnonymousBlock() && lastChildHasContinuation(downcast<RenderBlock>(*m_renderer))) {
375         RenderElement* lastParent = endOfContinuations(*downcast<RenderBlock>(*m_renderer).lastChild())->parent();
376         ASSERT(lastParent);
377         while (lastChildHasContinuation(*lastParent))
378             lastParent = endOfContinuations(*lastParent->lastChild())->parent();
379         nextSibling = lastParent->nextSibling();
380     }
381
382     // Case 3: node has an actual next sibling
383     else if (RenderObject* ns = m_renderer->nextSibling())
384         nextSibling = ns;
385
386     // Case 4: node is an inline with a continuation. Next sibling is the next sibling of the end 
387     // of the continuation chain.
388     else if (isInlineWithContinuation(*m_renderer))
389         nextSibling = endOfContinuations(*m_renderer)->nextSibling();
390
391     // Case 5: node has no next sibling, and its parent is an inline with a continuation.
392     // Case 5.1: After case 4, (the element was inline w/ continuation but had no sibling), then check it's parent.
393     if (!nextSibling && isInlineWithContinuation(*m_renderer->parent())) {
394         auto& continuation = *downcast<RenderInline>(*m_renderer->parent()).continuation();
395         
396         // Case 5a: continuation is a block - in this case the block itself is the next sibling.
397         if (is<RenderBlock>(continuation))
398             nextSibling = &continuation;
399         // Case 5b: continuation is an inline - in this case the inline's first child is the next sibling
400         else
401             nextSibling = firstChildConsideringContinuation(continuation);
402         
403         // After case 4, there are chances that nextSibling has the same node as the current renderer,
404         // which might lead to adding the same child repeatedly.
405         if (nextSibling && nextSibling->node() == m_renderer->node()) {
406             if (AccessibilityObject* nextObj = axObjectCache()->getOrCreate(nextSibling))
407                 return nextObj->nextSibling();
408         }
409     }
410
411     if (!nextSibling)
412         return nullptr;
413     
414     return axObjectCache()->getOrCreate(nextSibling);
415 }
416
417 static RenderBoxModelObject* nextContinuation(RenderObject& renderer)
418 {
419     if (is<RenderInline>(renderer) && !renderer.isReplaced())
420         return downcast<RenderInline>(renderer).continuation();
421     if (is<RenderBlock>(renderer))
422         return downcast<RenderBlock>(renderer).inlineElementContinuation();
423     return nullptr;
424 }
425     
426 RenderObject* AccessibilityRenderObject::renderParentObject() const
427 {
428     if (!m_renderer)
429         return nullptr;
430
431     RenderElement* parent = m_renderer->parent();
432
433     // Case 1: node is a block and is an inline's continuation. Parent
434     // is the start of the continuation chain.
435     RenderInline* startOfConts = nullptr;
436     RenderObject* firstChild = nullptr;
437     if (is<RenderBlock>(*m_renderer) && (startOfConts = startOfContinuations(*m_renderer)))
438         parent = startOfConts;
439
440     // Case 2: node's parent is an inline which is some node's continuation; parent is 
441     // the earliest node in the continuation chain.
442     else if (is<RenderInline>(parent) && (startOfConts = startOfContinuations(*parent)))
443         parent = startOfConts;
444     
445     // Case 3: The first sibling is the beginning of a continuation chain. Find the origin of that continuation.
446     else if (parent && (firstChild = parent->firstChild()) && firstChild->node()) {
447         // Get the node's renderer and follow that continuation chain until the first child is found
448         RenderObject* nodeRenderFirstChild = firstChild->node()->renderer();
449         while (nodeRenderFirstChild != firstChild) {
450             for (RenderObject* contsTest = nodeRenderFirstChild; contsTest; contsTest = nextContinuation(*contsTest)) {
451                 if (contsTest == firstChild) {
452                     parent = nodeRenderFirstChild->parent();
453                     break;
454                 }
455             }
456             RenderObject* parentFirstChild = parent->firstChild();
457             if (firstChild == parentFirstChild)
458                 break;
459             firstChild = parentFirstChild;
460             if (!firstChild->node())
461                 break;
462             nodeRenderFirstChild = firstChild->node()->renderer();
463         }
464     }
465         
466     return parent;
467 }
468     
469 AccessibilityObject* AccessibilityRenderObject::parentObjectIfExists() const
470 {
471     AXObjectCache* cache = axObjectCache();
472     if (!cache)
473         return nullptr;
474     
475     // WebArea's parent should be the scroll view containing it.
476     if (isWebArea())
477         return cache->get(&m_renderer->view().frameView());
478
479     return cache->get(renderParentObject());
480 }
481     
482 AccessibilityObject* AccessibilityRenderObject::parentObject() const
483 {
484     if (!m_renderer)
485         return nullptr;
486     
487     if (ariaRoleAttribute() == MenuBarRole)
488         return axObjectCache()->getOrCreate(m_renderer->parent());
489
490     // menuButton and its corresponding menu are DOM siblings, but Accessibility needs them to be parent/child
491     if (ariaRoleAttribute() == MenuRole) {
492         AccessibilityObject* parent = menuButtonForMenu();
493         if (parent)
494             return parent;
495     }
496     
497     AXObjectCache* cache = axObjectCache();
498     if (!cache)
499         return nullptr;
500     
501     RenderObject* parentObj = renderParentObject();
502     if (parentObj)
503         return cache->getOrCreate(parentObj);
504     
505     // WebArea's parent should be the scroll view containing it.
506     if (isWebArea())
507         return cache->getOrCreate(&m_renderer->view().frameView());
508     
509     return nullptr;
510 }
511     
512 bool AccessibilityRenderObject::isAttachment() const
513 {
514     RenderBoxModelObject* renderer = renderBoxModelObject();
515     if (!renderer)
516         return false;
517     // Widgets are the replaced elements that we represent to AX as attachments
518     bool isWidget = renderer->isWidget();
519
520     return isWidget && ariaRoleAttribute() == UnknownRole;
521 }
522
523 bool AccessibilityRenderObject::isFileUploadButton() const
524 {
525     if (m_renderer && is<HTMLInputElement>(m_renderer->node())) {
526         HTMLInputElement& input = downcast<HTMLInputElement>(*m_renderer->node());
527         return input.isFileUpload();
528     }
529     
530     return false;
531 }
532
533 bool AccessibilityRenderObject::isOffScreen() const
534 {
535     ASSERT(m_renderer);
536     IntRect contentRect = snappedIntRect(m_renderer->absoluteClippedOverflowRect());
537     // FIXME: unclear if we need LegacyIOSDocumentVisibleRect.
538     IntRect viewRect = m_renderer->view().frameView().visibleContentRect(ScrollableArea::LegacyIOSDocumentVisibleRect);
539     viewRect.intersect(contentRect);
540     return viewRect.isEmpty();
541 }
542
543 Element* AccessibilityRenderObject::anchorElement() const
544 {
545     if (!m_renderer)
546         return nullptr;
547     
548     AXObjectCache* cache = axObjectCache();
549     if (!cache)
550         return nullptr;
551     
552     RenderObject* currentRenderer;
553     
554     // Search up the render tree for a RenderObject with a DOM node.  Defer to an earlier continuation, though.
555     for (currentRenderer = m_renderer; currentRenderer && !currentRenderer->node(); currentRenderer = currentRenderer->parent()) {
556         if (currentRenderer->isAnonymousBlock()) {
557             if (RenderObject* continuation = downcast<RenderBlock>(*currentRenderer).continuation())
558                 return cache->getOrCreate(continuation)->anchorElement();
559         }
560     }
561     
562     // bail if none found
563     if (!currentRenderer)
564         return nullptr;
565     
566     // search up the DOM tree for an anchor element
567     // NOTE: this assumes that any non-image with an anchor is an HTMLAnchorElement
568     for (Node* node = currentRenderer->node(); node; node = node->parentNode()) {
569         if (is<HTMLAnchorElement>(*node) || (node->renderer() && cache->getOrCreate(node->renderer())->isLink()))
570             return downcast<Element>(node);
571     }
572     
573     return nullptr;
574 }
575
576 String AccessibilityRenderObject::helpText() const
577 {
578     if (!m_renderer)
579         return String();
580     
581     const AtomicString& ariaHelp = getAttribute(aria_helpAttr);
582     if (!ariaHelp.isEmpty())
583         return ariaHelp;
584     
585     String describedBy = ariaDescribedByAttribute();
586     if (!describedBy.isEmpty())
587         return describedBy;
588     
589     String description = accessibilityDescription();
590     for (RenderObject* ancestor = m_renderer; ancestor; ancestor = ancestor->parent()) {
591         if (is<HTMLElement>(ancestor->node())) {
592             HTMLElement& element = downcast<HTMLElement>(*ancestor->node());
593             const AtomicString& summary = element.getAttribute(summaryAttr);
594             if (!summary.isEmpty())
595                 return summary;
596             
597             // The title attribute should be used as help text unless it is already being used as descriptive text.
598             const AtomicString& title = element.getAttribute(titleAttr);
599             if (!title.isEmpty() && description != title)
600                 return title;
601         }
602         
603         // Only take help text from an ancestor element if its a group or an unknown role. If help was 
604         // added to those kinds of elements, it is likely it was meant for a child element.
605         AccessibilityObject* axObj = axObjectCache()->getOrCreate(ancestor);
606         if (axObj) {
607             AccessibilityRole role = axObj->roleValue();
608             if (role != GroupRole && role != UnknownRole)
609                 break;
610         }
611     }
612     
613     return String();
614 }
615
616 String AccessibilityRenderObject::textUnderElement(AccessibilityTextUnderElementMode mode) const
617 {
618     if (!m_renderer)
619         return String();
620
621     if (is<RenderFileUploadControl>(*m_renderer))
622         return downcast<RenderFileUploadControl>(*m_renderer).buttonValue();
623     
624     // Reflect when a content author has explicitly marked a line break.
625     if (m_renderer->isBR())
626         return ASCIILiteral("\n");
627
628     bool isRenderText = is<RenderText>(*m_renderer);
629
630 #if ENABLE(MATHML)
631     // Math operators create RenderText nodes on the fly that are not tied into the DOM in a reasonable way,
632     // so rangeOfContents does not work for them (nor does regular text selection).
633     if (isRenderText && m_renderer->isAnonymous() && ancestorsOfType<RenderMathMLOperator>(*m_renderer).first())
634         return downcast<RenderText>(*m_renderer).text();
635     if (is<RenderMathMLOperator>(*m_renderer) && !m_renderer->isAnonymous())
636         return downcast<RenderMathMLOperator>(*m_renderer).element().textContent();
637 #endif
638
639     if (shouldGetTextFromNode(mode))
640         return AccessibilityNodeObject::textUnderElement(mode);
641
642     // We use a text iterator for text objects AND for those cases where we are
643     // explicitly asking for the full text under a given element.
644     bool shouldIncludeAllChildren = mode.childrenInclusion == AccessibilityTextUnderElementMode::TextUnderElementModeIncludeAllChildren;
645     if (isRenderText || shouldIncludeAllChildren) {
646         // If possible, use a text iterator to get the text, so that whitespace
647         // is handled consistently.
648         Document* nodeDocument = nullptr;
649         RefPtr<Range> textRange;
650         if (Node* node = m_renderer->node()) {
651             nodeDocument = &node->document();
652             textRange = rangeOfContents(*node);
653         } else {
654             // For anonymous blocks, we work around not having a direct node to create a range from
655             // defining one based in the two external positions defining the boundaries of the subtree.
656             RenderObject* firstChildRenderer = m_renderer->firstChildSlow();
657             RenderObject* lastChildRenderer = m_renderer->lastChildSlow();
658             if (firstChildRenderer && lastChildRenderer) {
659                 ASSERT(firstChildRenderer->node());
660                 ASSERT(lastChildRenderer->node());
661
662                 // We define the start and end positions for the range as the ones right before and after
663                 // the first and the last nodes in the DOM tree that is wrapped inside the anonymous block.
664                 Node* firstNodeInBlock = firstChildRenderer->node();
665                 Position startPosition = positionInParentBeforeNode(firstNodeInBlock);
666                 Position endPosition = positionInParentAfterNode(lastChildRenderer->node());
667
668                 nodeDocument = &firstNodeInBlock->document();
669                 textRange = Range::create(*nodeDocument, startPosition, endPosition);
670             }
671         }
672
673         if (nodeDocument && textRange) {
674             if (Frame* frame = nodeDocument->frame()) {
675                 // catch stale WebCoreAXObject (see <rdar://problem/3960196>)
676                 if (frame->document() != nodeDocument)
677                     return String();
678
679                 // The tree should be stable before looking through the children of a non-Render Text object.
680                 // Otherwise, further uses of TextIterator will force a layout update, potentially altering
681                 // the accessibility tree and causing crashes in the loop that computes the result text.
682                 ASSERT((isRenderText || !shouldIncludeAllChildren) || (!nodeDocument->renderView()->layoutState() && !nodeDocument->childNeedsStyleRecalc()));
683
684                 return plainText(textRange.get(), textIteratorBehaviorForTextRange());
685             }
686         }
687     
688         // Sometimes text fragments don't have Nodes associated with them (like when
689         // CSS content is used to insert text or when a RenderCounter is used.)
690         if (is<RenderText>(*m_renderer)) {
691             RenderText& renderTextObject = downcast<RenderText>(*m_renderer);
692             if (is<RenderTextFragment>(renderTextObject)) {
693                 RenderTextFragment& renderTextFragment = downcast<RenderTextFragment>(renderTextObject);
694                 // The alt attribute may be set on a text fragment through CSS, which should be honored.
695                 const String& altText = renderTextFragment.altText();
696                 if (!altText.isEmpty())
697                     return altText;
698                 return renderTextFragment.contentString();
699             }
700
701             return renderTextObject.text();
702         }
703     }
704     
705     return AccessibilityNodeObject::textUnderElement(mode);
706 }
707
708 bool AccessibilityRenderObject::shouldGetTextFromNode(AccessibilityTextUnderElementMode mode) const
709 {
710     if (!m_renderer)
711         return false;
712
713     // AccessibilityRenderObject::textUnderElement() gets the text of anonymous blocks by using
714     // the child nodes to define positions. CSS tables and their anonymous descendants lack
715     // children with nodes.
716     if (m_renderer->isAnonymous() && m_renderer->isTablePart())
717         return mode.childrenInclusion == AccessibilityTextUnderElementMode::TextUnderElementModeIncludeAllChildren;
718
719     // AccessibilityRenderObject::textUnderElement() calls rangeOfContents() to create the text
720     // range. rangeOfContents() does not include CSS-generated content.
721     if (m_renderer->isBeforeOrAfterContent())
722         return true;
723     if (Node* node = m_renderer->node()) {
724         Node* firstChild = node->pseudoAwareFirstChild();
725         Node* lastChild = node->pseudoAwareLastChild();
726         if ((firstChild && firstChild->isPseudoElement()) || (lastChild && lastChild->isPseudoElement()))
727             return true;
728     }
729
730     return false;
731 }
732
733 Node* AccessibilityRenderObject::node() const
734 {
735     if (!m_renderer)
736         return nullptr;
737     if (m_renderer->isRenderView())
738         return &m_renderer->document();
739     return m_renderer->node();
740 }    
741
742 String AccessibilityRenderObject::stringValue() const
743 {
744     if (!m_renderer)
745         return String();
746
747     if (isPasswordField())
748         return passwordFieldValue();
749
750     RenderBoxModelObject* cssBox = renderBoxModelObject();
751
752     if (ariaRoleAttribute() == StaticTextRole) {
753         String staticText = text();
754         if (!staticText.length())
755             staticText = textUnderElement();
756         return staticText;
757     }
758         
759     if (is<RenderText>(*m_renderer))
760         return textUnderElement();
761     
762     if (is<RenderMenuList>(cssBox)) {
763         // RenderMenuList will go straight to the text() of its selected item.
764         // This has to be overridden in the case where the selected item has an ARIA label.
765         HTMLSelectElement& selectElement = downcast<HTMLSelectElement>(*m_renderer->node());
766         int selectedIndex = selectElement.selectedIndex();
767         const Vector<HTMLElement*>& listItems = selectElement.listItems();
768         if (selectedIndex >= 0 && static_cast<size_t>(selectedIndex) < listItems.size()) {
769             const AtomicString& overriddenDescription = listItems[selectedIndex]->fastGetAttribute(aria_labelAttr);
770             if (!overriddenDescription.isNull())
771                 return overriddenDescription;
772         }
773         return downcast<RenderMenuList>(*m_renderer).text();
774     }
775     
776     if (is<RenderListMarker>(*m_renderer))
777         return downcast<RenderListMarker>(*m_renderer).text();
778     
779     if (isWebArea())
780         return String();
781     
782     if (isTextControl())
783         return text();
784     
785     if (is<RenderFileUploadControl>(*m_renderer))
786         return downcast<RenderFileUploadControl>(*m_renderer).fileTextValue();
787     
788     // FIXME: We might need to implement a value here for more types
789     // FIXME: It would be better not to advertise a value at all for the types for which we don't implement one;
790     // this would require subclassing or making accessibilityAttributeNames do something other than return a
791     // single static array.
792     return String();
793 }
794
795 HTMLLabelElement* AccessibilityRenderObject::labelElementContainer() const
796 {
797     if (!m_renderer)
798         return nullptr;
799
800     // the control element should not be considered part of the label
801     if (isControl())
802         return nullptr;
803     
804     // find if this has a parent that is a label
805     for (Node* parentNode = m_renderer->node(); parentNode; parentNode = parentNode->parentNode()) {
806         if (is<HTMLLabelElement>(*parentNode))
807             return downcast<HTMLLabelElement>(parentNode);
808     }
809     
810     return nullptr;
811 }
812
813 // The boundingBox for elements within the remote SVG element needs to be offset by its position
814 // within the parent page, otherwise they are in relative coordinates only.
815 void AccessibilityRenderObject::offsetBoundingBoxForRemoteSVGElement(LayoutRect& rect) const
816 {
817     for (AccessibilityObject* parent = parentObject(); parent; parent = parent->parentObject()) {
818         if (parent->isAccessibilitySVGRoot()) {
819             rect.moveBy(parent->parentObject()->boundingBoxRect().location());
820             break;
821         }
822     }
823 }
824     
825 LayoutRect AccessibilityRenderObject::boundingBoxRect() const
826 {
827     RenderObject* obj = m_renderer;
828     
829     if (!obj)
830         return LayoutRect();
831     
832     if (obj->node()) // If we are a continuation, we want to make sure to use the primary renderer.
833         obj = obj->node()->renderer();
834     
835     // absoluteFocusRingQuads will query the hierarchy below this element, which for large webpages can be very slow.
836     // For a web area, which will have the most elements of any element, absoluteQuads should be used.
837     // We should also use absoluteQuads for SVG elements, otherwise transforms won't be applied.
838     Vector<FloatQuad> quads;
839     bool isSVGRoot = false;
840
841     if (obj->isSVGRoot())
842         isSVGRoot = true;
843
844     if (is<RenderText>(*obj))
845         quads = downcast<RenderText>(*obj).absoluteQuadsClippedToEllipsis();
846     else if (isWebArea() || isSVGRoot)
847         obj->absoluteQuads(quads);
848     else
849         obj->absoluteFocusRingQuads(quads);
850     
851     LayoutRect result = boundingBoxForQuads(obj, quads);
852
853     Document* document = this->document();
854     if (document && document->isSVGDocument())
855         offsetBoundingBoxForRemoteSVGElement(result);
856     
857     // The size of the web area should be the content size, not the clipped size.
858     if (isWebArea())
859         result.setSize(obj->view().frameView().contentsSize());
860     
861     return result;
862 }
863     
864 LayoutRect AccessibilityRenderObject::checkboxOrRadioRect() const
865 {
866     if (!m_renderer)
867         return LayoutRect();
868     
869     HTMLLabelElement* label = labelForElement(downcast<Element>(m_renderer->node()));
870     if (!label || !label->renderer())
871         return boundingBoxRect();
872     
873     LayoutRect labelRect = axObjectCache()->getOrCreate(label)->elementRect();
874     labelRect.unite(boundingBoxRect());
875     return labelRect;
876 }
877
878 LayoutRect AccessibilityRenderObject::elementRect() const
879 {
880     // a checkbox or radio button should encompass its label
881     if (isCheckboxOrRadio())
882         return checkboxOrRadioRect();
883     
884     return boundingBoxRect();
885 }
886     
887 bool AccessibilityRenderObject::supportsPath() const
888 {
889     return is<RenderSVGShape>(m_renderer);
890 }
891
892 Path AccessibilityRenderObject::elementPath() const
893 {
894     if (is<RenderSVGShape>(m_renderer) && downcast<RenderSVGShape>(*m_renderer).hasPath()) {
895         Path path = downcast<RenderSVGShape>(*m_renderer).path();
896         
897         // The SVG path is in terms of the parent's bounding box. The path needs to be offset to frame coordinates.
898         if (auto svgRoot = ancestorsOfType<RenderSVGRoot>(*m_renderer).first()) {
899             LayoutPoint parentOffset = axObjectCache()->getOrCreate(&*svgRoot)->elementRect().location();
900             path.transform(AffineTransform().translate(parentOffset.x(), parentOffset.y()));
901         }
902         
903         return path;
904     }
905     
906     return Path();
907 }
908
909 IntPoint AccessibilityRenderObject::clickPoint()
910 {
911     // Headings are usually much wider than their textual content. If the mid point is used, often it can be wrong.
912     if (isHeading() && children().size() == 1)
913         return children()[0]->clickPoint();
914
915     // use the default position unless this is an editable web area, in which case we use the selection bounds.
916     if (!isWebArea() || !canSetValueAttribute())
917         return AccessibilityObject::clickPoint();
918     
919     VisibleSelection visSelection = selection();
920     VisiblePositionRange range = VisiblePositionRange(visSelection.visibleStart(), visSelection.visibleEnd());
921     IntRect bounds = boundsForVisiblePositionRange(range);
922 #if PLATFORM(COCOA)
923     bounds.setLocation(m_renderer->view().frameView().screenToContents(bounds.location()));
924 #endif        
925     return IntPoint(bounds.x() + (bounds.width() / 2), bounds.y() - (bounds.height() / 2));
926 }
927     
928 AccessibilityObject* AccessibilityRenderObject::internalLinkElement() const
929 {
930     Element* element = anchorElement();
931     // Right now, we do not support ARIA links as internal link elements
932     if (!is<HTMLAnchorElement>(element))
933         return nullptr;
934     HTMLAnchorElement& anchor = downcast<HTMLAnchorElement>(*element);
935     
936     URL linkURL = anchor.href();
937     String fragmentIdentifier = linkURL.fragmentIdentifier();
938     if (fragmentIdentifier.isEmpty())
939         return nullptr;
940     
941     // check if URL is the same as current URL
942     URL documentURL = m_renderer->document().url();
943     if (!equalIgnoringFragmentIdentifier(documentURL, linkURL))
944         return nullptr;
945     
946     Node* linkedNode = m_renderer->document().findAnchor(fragmentIdentifier);
947     if (!linkedNode)
948         return nullptr;
949     
950     // The element we find may not be accessible, so find the first accessible object.
951     return firstAccessibleObjectFromNode(linkedNode);
952 }
953
954 ESpeak AccessibilityRenderObject::speakProperty() const
955 {
956     if (!m_renderer)
957         return AccessibilityObject::speakProperty();
958     
959     return m_renderer->style().speak();
960 }
961     
962 void AccessibilityRenderObject::addRadioButtonGroupChildren(AccessibilityObject* parent, AccessibilityChildrenVector& linkedUIElements) const
963 {
964     for (const auto& child : parent->children()) {
965         if (child->roleValue() == RadioButtonRole)
966             linkedUIElements.append(child);
967         else
968             addRadioButtonGroupChildren(child.get(), linkedUIElements);
969     }
970 }
971     
972 void AccessibilityRenderObject::addRadioButtonGroupMembers(AccessibilityChildrenVector& linkedUIElements) const
973 {
974     if (roleValue() != RadioButtonRole)
975         return;
976     
977     Node* node = this->node();
978     if (is<HTMLInputElement>(node)) {
979         HTMLInputElement& input = downcast<HTMLInputElement>(*node);
980         for (auto& radioSibling : input.radioButtonGroup()) {
981             if (AccessibilityObject* object = axObjectCache()->getOrCreate(radioSibling))
982                 linkedUIElements.append(object);
983         }
984     } else {
985         // If we didn't find any radio button siblings with the traditional naming, lets search for a radio group role and find its children.
986         for (AccessibilityObject* parent = parentObject(); parent; parent = parent->parentObject()) {
987             if (parent->roleValue() == RadioGroupRole)
988                 addRadioButtonGroupChildren(parent, linkedUIElements);
989         }
990     }
991 }
992     
993 // linked ui elements could be all the related radio buttons in a group
994 // or an internal anchor connection
995 void AccessibilityRenderObject::linkedUIElements(AccessibilityChildrenVector& linkedUIElements) const
996 {
997     ariaFlowToElements(linkedUIElements);
998
999     if (isLink()) {
1000         AccessibilityObject* linkedAXElement = internalLinkElement();
1001         if (linkedAXElement)
1002             linkedUIElements.append(linkedAXElement);
1003     }
1004
1005     if (roleValue() == RadioButtonRole)
1006         addRadioButtonGroupMembers(linkedUIElements);
1007 }
1008
1009 bool AccessibilityRenderObject::hasTextAlternative() const
1010 {
1011     // ARIA: section 2A, bullet #3 says if aria-labeledby or aria-label appears, it should
1012     // override the "label" element association.
1013     return ariaAccessibilityDescription().length();
1014 }
1015     
1016 bool AccessibilityRenderObject::ariaHasPopup() const
1017 {
1018     return elementAttributeValue(aria_haspopupAttr);
1019 }
1020
1021 bool AccessibilityRenderObject::supportsARIADropping() const 
1022 {
1023     const AtomicString& dropEffect = getAttribute(aria_dropeffectAttr);
1024     return !dropEffect.isEmpty();
1025 }
1026
1027 bool AccessibilityRenderObject::supportsARIADragging() const
1028 {
1029     const AtomicString& grabbed = getAttribute(aria_grabbedAttr);
1030     return equalLettersIgnoringASCIICase(grabbed, "true") || equalLettersIgnoringASCIICase(grabbed, "false");
1031 }
1032
1033 bool AccessibilityRenderObject::isARIAGrabbed()
1034 {
1035     return elementAttributeValue(aria_grabbedAttr);
1036 }
1037
1038 void AccessibilityRenderObject::determineARIADropEffects(Vector<String>& effects)
1039 {
1040     const AtomicString& dropEffects = getAttribute(aria_dropeffectAttr);
1041     if (dropEffects.isEmpty()) {
1042         effects.clear();
1043         return;
1044     }
1045     
1046     String dropEffectsString = dropEffects.string();
1047     dropEffectsString.replace('\n', ' ');
1048     dropEffectsString.split(' ', effects);
1049 }
1050     
1051 bool AccessibilityRenderObject::exposesTitleUIElement() const
1052 {
1053     if (!isControl())
1054         return false;
1055
1056     // If this control is ignored (because it's invisible), 
1057     // then the label needs to be exposed so it can be visible to accessibility.
1058     if (accessibilityIsIgnored())
1059         return true;
1060     
1061     // When controls have their own descriptions, the title element should be ignored.
1062     if (hasTextAlternative())
1063         return false;
1064     
1065     // When <label> element has aria-label on it, we shouldn't expose it as the titleUIElement,
1066     // otherwise its inner text will be announced by a screenreader.
1067     if (is<HTMLInputElement>(*this->node()) || AccessibilityObject::isARIAInput(ariaRoleAttribute())) {
1068         if (HTMLLabelElement* label = labelForElement(downcast<Element>(node()))) {
1069             if (!label->fastGetAttribute(aria_labelAttr).isEmpty())
1070                 return false;
1071         }
1072     }
1073     
1074     return true;
1075 }
1076     
1077 AccessibilityObject* AccessibilityRenderObject::titleUIElement() const
1078 {
1079     if (!m_renderer)
1080         return nullptr;
1081     
1082     // if isFieldset is true, the renderer is guaranteed to be a RenderFieldset
1083     if (isFieldset())
1084         return axObjectCache()->getOrCreate(downcast<RenderFieldset>(*m_renderer).findLegend(RenderFieldset::IncludeFloatingOrOutOfFlow));
1085     
1086     Node* node = m_renderer->node();
1087     if (!is<Element>(node))
1088         return nullptr;
1089     HTMLLabelElement* label = labelForElement(downcast<Element>(node));
1090     if (label && label->renderer())
1091         return axObjectCache()->getOrCreate(label);
1092
1093     return nullptr;
1094 }
1095     
1096 bool AccessibilityRenderObject::isAllowedChildOfTree() const
1097 {
1098     // Determine if this is in a tree. If so, we apply special behavior to make it work like an AXOutline.
1099     AccessibilityObject* axObj = parentObject();
1100     bool isInTree = false;
1101     bool isTreeItemDescendant = false;
1102     while (axObj) {
1103         if (axObj->roleValue() == TreeItemRole)
1104             isTreeItemDescendant = true;
1105         if (axObj->isTree()) {
1106             isInTree = true;
1107             break;
1108         }
1109         axObj = axObj->parentObject();
1110     }
1111     
1112     // If the object is in a tree, only tree items should be exposed (and the children of tree items).
1113     if (isInTree) {
1114         AccessibilityRole role = roleValue();
1115         if (role != TreeItemRole && role != StaticTextRole && !isTreeItemDescendant)
1116             return false;
1117     }
1118     return true;
1119 }
1120     
1121 static AccessibilityObjectInclusion objectInclusionFromAltText(const String& altText)
1122 {
1123     // Don't ignore an image that has an alt tag.
1124     if (!altText.containsOnlyWhitespace())
1125         return IncludeObject;
1126     
1127     // The informal standard is to ignore images with zero-length alt strings.
1128     if (!altText.isNull())
1129         return IgnoreObject;
1130     
1131     return DefaultBehavior;
1132 }
1133
1134 AccessibilityObjectInclusion AccessibilityRenderObject::defaultObjectInclusion() const
1135 {
1136     // The following cases can apply to any element that's a subclass of AccessibilityRenderObject.
1137     
1138     if (!m_renderer)
1139         return IgnoreObject;
1140
1141     if (m_renderer->style().visibility() != VISIBLE) {
1142         // aria-hidden is meant to override visibility as the determinant in AX hierarchy inclusion.
1143         if (equalLettersIgnoringASCIICase(getAttribute(aria_hiddenAttr), "false"))
1144             return DefaultBehavior;
1145         
1146         return IgnoreObject;
1147     }
1148
1149     return AccessibilityObject::defaultObjectInclusion();
1150 }
1151
1152 bool AccessibilityRenderObject::computeAccessibilityIsIgnored() const
1153 {
1154 #ifndef NDEBUG
1155     ASSERT(m_initialized);
1156 #endif
1157
1158     if (!m_renderer)
1159         return true;
1160     
1161     // Check first if any of the common reasons cause this element to be ignored.
1162     // Then process other use cases that need to be applied to all the various roles
1163     // that AccessibilityRenderObjects take on.
1164     AccessibilityObjectInclusion decision = defaultObjectInclusion();
1165     if (decision == IncludeObject)
1166         return false;
1167     if (decision == IgnoreObject)
1168         return true;
1169     
1170     // If this element is within a parent that cannot have children, it should not be exposed.
1171     if (isDescendantOfBarrenParent())
1172         return true;    
1173     
1174     if (roleValue() == IgnoredRole)
1175         return true;
1176     
1177     if (roleValue() == PresentationalRole || inheritsPresentationalRole())
1178         return true;
1179     
1180     // An ARIA tree can only have tree items and static text as children.
1181     if (!isAllowedChildOfTree())
1182         return true;
1183
1184     // Allow the platform to decide if the attachment is ignored or not.
1185     if (isAttachment())
1186         return accessibilityIgnoreAttachment();
1187     
1188     // ignore popup menu items because AppKit does
1189     if (m_renderer && ancestorsOfType<RenderMenuList>(*m_renderer).first())
1190         return true;
1191
1192     // find out if this element is inside of a label element.
1193     // if so, it may be ignored because it's the label for a checkbox or radio button
1194     AccessibilityObject* controlObject = correspondingControlForLabelElement();
1195     if (controlObject && !controlObject->exposesTitleUIElement() && controlObject->isCheckboxOrRadio())
1196         return true;
1197
1198     if (m_renderer->isBR())
1199         return true;
1200
1201     if (is<RenderText>(*m_renderer)) {
1202         // static text beneath MenuItems and MenuButtons are just reported along with the menu item, so it's ignored on an individual level
1203         AccessibilityObject* parent = parentObjectUnignored();
1204         if (parent && (parent->isMenuItem() || parent->ariaRoleAttribute() == MenuButtonRole))
1205             return true;
1206         auto& renderText = downcast<RenderText>(*m_renderer);
1207         if (!renderText.hasRenderedText())
1208             return true;
1209
1210         // static text beneath TextControls is reported along with the text control text so it's ignored.
1211         for (AccessibilityObject* parent = parentObject(); parent; parent = parent->parentObject()) { 
1212             if (parent->roleValue() == TextFieldRole)
1213                 return true;
1214         }
1215         
1216         // The alt attribute may be set on a text fragment through CSS, which should be honored.
1217         if (is<RenderTextFragment>(renderText)) {
1218             AccessibilityObjectInclusion altTextInclusion = objectInclusionFromAltText(downcast<RenderTextFragment>(renderText).altText());
1219             if (altTextInclusion == IgnoreObject)
1220                 return true;
1221             if (altTextInclusion == IncludeObject)
1222                 return false;
1223         }
1224
1225         // text elements that are just empty whitespace should not be returned
1226         return renderText.text()->containsOnlyWhitespace();
1227     }
1228     
1229     if (isHeading())
1230         return false;
1231     
1232     if (isLink())
1233         return false;
1234     
1235     if (isLandmark())
1236         return false;
1237
1238     // all controls are accessible
1239     if (isControl())
1240         return false;
1241
1242     switch (roleValue()) {
1243     case AudioRole:
1244     case DescriptionListTermRole:
1245     case DescriptionListDetailRole:
1246     case DetailsRole:
1247     case DocumentArticleRole:
1248     case LandmarkRegionRole:
1249     case ListItemRole:
1250     case VideoRole:
1251         return false;
1252     default:
1253         break;
1254     }
1255     
1256     if (ariaRoleAttribute() != UnknownRole)
1257         return false;
1258     
1259     if (roleValue() == HorizontalRuleRole)
1260         return false;
1261     
1262     // don't ignore labels, because they serve as TitleUIElements
1263     Node* node = m_renderer->node();
1264     if (is<HTMLLabelElement>(node))
1265         return false;
1266     
1267     // Anything that is content editable should not be ignored.
1268     // However, one cannot just call node->hasEditableStyle() since that will ask if its parents
1269     // are also editable. Only the top level content editable region should be exposed.
1270     if (hasContentEditableAttributeSet())
1271         return false;
1272     
1273     
1274     // if this element has aria attributes on it, it should not be ignored.
1275     if (supportsARIAAttributes())
1276         return false;
1277
1278 #if ENABLE(MATHML)
1279     // First check if this is a special case within the math tree that needs to be ignored.
1280     if (isIgnoredElementWithinMathTree())
1281         return true;
1282     // Otherwise all other math elements are in the tree.
1283     if (isMathElement())
1284         return false;
1285 #endif
1286     
1287     if (is<RenderBlockFlow>(*m_renderer) && m_renderer->childrenInline() && !canSetFocusAttribute())
1288         return !downcast<RenderBlockFlow>(*m_renderer).hasLines() && !mouseButtonListener();
1289     
1290     // ignore images seemingly used as spacers
1291     if (isImage()) {
1292         
1293         // If the image can take focus, it should not be ignored, lest the user not be able to interact with something important.
1294         if (canSetFocusAttribute())
1295             return false;
1296         
1297         // First check the RenderImage's altText (which can be set through a style sheet, or come from the Element).
1298         // However, if this is not a native image, fallback to the attribute on the Element.
1299         AccessibilityObjectInclusion altTextInclusion = DefaultBehavior;
1300         bool isRenderImage = is<RenderImage>(m_renderer);
1301         if (isRenderImage)
1302             altTextInclusion = objectInclusionFromAltText(downcast<RenderImage>(*m_renderer).altText());
1303         else
1304             altTextInclusion = objectInclusionFromAltText(getAttribute(altAttr).string());
1305
1306         if (altTextInclusion == IgnoreObject)
1307             return true;
1308         if (altTextInclusion == IncludeObject)
1309             return false;
1310         
1311         // If an image has a title attribute on it, accessibility should be lenient and allow it to appear in the hierarchy (according to WAI-ARIA).
1312         if (!getAttribute(titleAttr).isEmpty())
1313             return false;
1314     
1315         if (isRenderImage) {
1316             // check for one-dimensional image
1317             RenderImage& image = downcast<RenderImage>(*m_renderer);
1318             if (image.height() <= 1 || image.width() <= 1)
1319                 return true;
1320             
1321             // check whether rendered image was stretched from one-dimensional file image
1322             if (image.cachedImage()) {
1323                 LayoutSize imageSize = image.cachedImage()->imageSizeForRenderer(&image, image.view().zoomFactor());
1324                 return imageSize.height() <= 1 || imageSize.width() <= 1;
1325             }
1326         }
1327         return false;
1328     }
1329
1330     if (isCanvas()) {
1331         if (canvasHasFallbackContent())
1332             return false;
1333
1334         if (is<RenderBox>(*m_renderer)) {
1335             auto& canvasBox = downcast<RenderBox>(*m_renderer);
1336             if (canvasBox.height() <= 1 || canvasBox.width() <= 1)
1337                 return true;
1338         }
1339         // Otherwise fall through; use presence of help text, title, or description to decide.
1340     }
1341
1342     if (m_renderer->isListMarker()) {
1343         AccessibilityObject* parent = parentObjectUnignored();
1344         return parent && !parent->isListItem();
1345     }
1346
1347     if (isWebArea())
1348         return false;
1349     
1350     // Using the presence of an accessible name to decide an element's visibility is not
1351     // as definitive as previous checks, so this should remain as one of the last.
1352     if (hasAttributesRequiredForInclusion())
1353         return false;
1354
1355     // Don't ignore generic focusable elements like <div tabindex=0>
1356     // unless they're completely empty, with no children.
1357     if (isGenericFocusableElement() && node->firstChild())
1358         return false;
1359
1360     // <span> tags are inline tags and not meant to convey information if they have no other aria
1361     // information on them. If we don't ignore them, they may emit signals expected to come from
1362     // their parent. In addition, because included spans are GroupRole objects, and GroupRole
1363     // objects are often containers with meaningful information, the inclusion of a span can have
1364     // the side effect of causing the immediate parent accessible to be ignored. This is especially
1365     // problematic for platforms which have distinct roles for textual block elements.
1366     if (node && node->hasTagName(spanTag))
1367         return true;
1368
1369     // Other non-ignored host language elements
1370     if (node && node->hasTagName(dfnTag))
1371         return false;
1372     
1373     if (isStyleFormatGroup())
1374         return false;
1375     
1376     // Make sure that ruby containers are not ignored.
1377     if (m_renderer->isRubyRun() || m_renderer->isRubyBlock() || m_renderer->isRubyInline())
1378         return false;
1379
1380     // By default, objects should be ignored so that the AX hierarchy is not
1381     // filled with unnecessary items.
1382     return true;
1383 }
1384
1385 bool AccessibilityRenderObject::isLoaded() const
1386 {
1387     return !m_renderer->document().parser();
1388 }
1389
1390 double AccessibilityRenderObject::estimatedLoadingProgress() const
1391 {
1392     if (!m_renderer)
1393         return 0;
1394     
1395     if (isLoaded())
1396         return 1.0;
1397     
1398     Page* page = m_renderer->document().page();
1399     if (!page)
1400         return 0;
1401     
1402     return page->progress().estimatedProgress();
1403 }
1404     
1405 int AccessibilityRenderObject::layoutCount() const
1406 {
1407     if (!is<RenderView>(*m_renderer))
1408         return 0;
1409     return downcast<RenderView>(*m_renderer).frameView().layoutCount();
1410 }
1411
1412 String AccessibilityRenderObject::text() const
1413 {
1414     if (isPasswordField())
1415         return passwordFieldValue();
1416
1417     return AccessibilityNodeObject::text();
1418 }
1419     
1420 int AccessibilityRenderObject::textLength() const
1421 {
1422     ASSERT(isTextControl());
1423     
1424     if (isPasswordField())
1425         return passwordFieldValue().length();
1426
1427     return text().length();
1428 }
1429
1430 PlainTextRange AccessibilityRenderObject::documentBasedSelectedTextRange() const
1431 {
1432     Node* node = m_renderer->node();
1433     if (!node)
1434         return PlainTextRange();
1435     
1436     VisibleSelection visibleSelection = selection();
1437     RefPtr<Range> currentSelectionRange = visibleSelection.toNormalizedRange();
1438     if (!currentSelectionRange || !currentSelectionRange->intersectsNode(*node, IGNORE_EXCEPTION))
1439         return PlainTextRange();
1440     
1441     int start = indexForVisiblePosition(visibleSelection.start());
1442     int end = indexForVisiblePosition(visibleSelection.end());
1443     
1444     return PlainTextRange(start, end - start);
1445 }
1446
1447 String AccessibilityRenderObject::selectedText() const
1448 {
1449     ASSERT(isTextControl());
1450     
1451     if (isPasswordField())
1452         return String(); // need to return something distinct from empty string
1453     
1454     if (isNativeTextControl()) {
1455         HTMLTextFormControlElement& textControl = downcast<RenderTextControl>(*m_renderer).textFormControlElement();
1456         return textControl.selectedText();
1457     }
1458     
1459     return doAXStringForRange(documentBasedSelectedTextRange());
1460 }
1461
1462 const AtomicString& AccessibilityRenderObject::accessKey() const
1463 {
1464     Node* node = m_renderer->node();
1465     if (!is<Element>(node))
1466         return nullAtom;
1467     return downcast<Element>(*node).getAttribute(accesskeyAttr);
1468 }
1469
1470 VisibleSelection AccessibilityRenderObject::selection() const
1471 {
1472     return m_renderer->frame().selection().selection();
1473 }
1474
1475 PlainTextRange AccessibilityRenderObject::selectedTextRange() const
1476 {
1477     ASSERT(isTextControl());
1478     
1479     if (isPasswordField())
1480         return PlainTextRange();
1481     
1482     AccessibilityRole ariaRole = ariaRoleAttribute();
1483     // Use the text control native range if it's a native object and it has no ARIA role (or has a text based ARIA role).
1484     if (isNativeTextControl() && (ariaRole == UnknownRole || isARIATextControl())) {
1485         HTMLTextFormControlElement& textControl = downcast<RenderTextControl>(*m_renderer).textFormControlElement();
1486         return PlainTextRange(textControl.selectionStart(), textControl.selectionEnd() - textControl.selectionStart());
1487     }
1488     
1489     return documentBasedSelectedTextRange();
1490 }
1491
1492 static void setTextSelectionIntent(AXObjectCache* cache, AXTextStateChangeType type)
1493 {
1494     if (!cache)
1495         return;
1496     AXTextStateChangeIntent intent(type, AXTextSelection { AXTextSelectionDirectionDiscontiguous, AXTextSelectionGranularityUnknown, false });
1497     cache->setTextSelectionIntent(intent);
1498     cache->setIsSynchronizingSelection(true);
1499 }
1500
1501 static void clearTextSelectionIntent(AXObjectCache* cache)
1502 {
1503     if (!cache)
1504         return;
1505     cache->setTextSelectionIntent(AXTextStateChangeIntent());
1506     cache->setIsSynchronizingSelection(false);
1507 }
1508
1509 void AccessibilityRenderObject::setSelectedTextRange(const PlainTextRange& range)
1510 {
1511     setTextSelectionIntent(axObjectCache(), range.length ? AXTextStateChangeTypeSelectionExtend : AXTextStateChangeTypeSelectionMove);
1512
1513     if (isNativeTextControl()) {
1514         HTMLTextFormControlElement& textControl = downcast<RenderTextControl>(*m_renderer).textFormControlElement();
1515         textControl.setSelectionRange(range.start, range.start + range.length);
1516     } else {
1517         ASSERT(node());
1518         VisiblePosition start = visiblePositionForIndexUsingCharacterIterator(*node(), range.start);
1519         VisiblePosition end = visiblePositionForIndexUsingCharacterIterator(*node(), range.start + range.length);
1520         m_renderer->frame().selection().setSelection(VisibleSelection(start, end), FrameSelection::defaultSetSelectionOptions(UserTriggered));
1521     }
1522     
1523     clearTextSelectionIntent(axObjectCache());
1524 }
1525
1526 URL AccessibilityRenderObject::url() const
1527 {
1528     if (isLink() && is<HTMLAnchorElement>(*m_renderer->node())) {
1529         if (HTMLAnchorElement* anchor = downcast<HTMLAnchorElement>(anchorElement()))
1530             return anchor->href();
1531     }
1532     
1533     if (isWebArea())
1534         return m_renderer->document().url();
1535     
1536     if (isImage() && is<HTMLImageElement>(m_renderer->node()))
1537         return downcast<HTMLImageElement>(*m_renderer->node()).src();
1538     
1539     if (isInputImage())
1540         return downcast<HTMLInputElement>(*m_renderer->node()).src();
1541     
1542     return URL();
1543 }
1544
1545 bool AccessibilityRenderObject::isUnvisited() const
1546 {
1547     // FIXME: Is it a privacy violation to expose unvisited information to accessibility APIs?
1548     return m_renderer->style().isLink() && m_renderer->style().insideLink() == InsideUnvisitedLink;
1549 }
1550
1551 bool AccessibilityRenderObject::isVisited() const
1552 {
1553     // FIXME: Is it a privacy violation to expose visited information to accessibility APIs?
1554     return m_renderer->style().isLink() && m_renderer->style().insideLink() == InsideVisitedLink;
1555 }
1556
1557 void AccessibilityRenderObject::setElementAttributeValue(const QualifiedName& attributeName, bool value)
1558 {
1559     if (!m_renderer)
1560         return;
1561     
1562     Node* node = m_renderer->node();
1563     if (!is<Element>(node))
1564         return;
1565     
1566     downcast<Element>(*node).setAttribute(attributeName, (value) ? "true" : "false");
1567 }
1568     
1569 bool AccessibilityRenderObject::elementAttributeValue(const QualifiedName& attributeName) const
1570 {
1571     if (!m_renderer)
1572         return false;
1573     
1574     return equalLettersIgnoringASCIICase(getAttribute(attributeName), "true");
1575 }
1576     
1577 bool AccessibilityRenderObject::isSelected() const
1578 {
1579     if (!m_renderer)
1580         return false;
1581     
1582     if (!m_renderer->node())
1583         return false;
1584     
1585     if (equalLettersIgnoringASCIICase(getAttribute(aria_selectedAttr), "true"))
1586         return true;    
1587     
1588     if (isTabItem() && isTabItemSelected())
1589         return true;
1590
1591     return false;
1592 }
1593
1594 bool AccessibilityRenderObject::isTabItemSelected() const
1595 {
1596     if (!isTabItem() || !m_renderer)
1597         return false;
1598     
1599     Node* node = m_renderer->node();
1600     if (!node || !node->isElementNode())
1601         return false;
1602     
1603     // The ARIA spec says a tab item can also be selected if it is aria-labeled by a tabpanel
1604     // that has keyboard focus inside of it, or if a tabpanel in its aria-controls list has KB
1605     // focus inside of it.
1606     AccessibilityObject* focusedElement = focusedUIElement();
1607     if (!focusedElement)
1608         return false;
1609     
1610     Vector<Element*> elements;
1611     elementsFromAttribute(elements, aria_controlsAttr);
1612     
1613     AXObjectCache* cache = axObjectCache();
1614     if (!cache)
1615         return false;
1616     
1617     for (const auto& element : elements) {
1618         AccessibilityObject* tabPanel = cache->getOrCreate(element);
1619
1620         // A tab item should only control tab panels.
1621         if (!tabPanel || tabPanel->roleValue() != TabPanelRole)
1622             continue;
1623         
1624         AccessibilityObject* checkFocusElement = focusedElement;
1625         // Check if the focused element is a descendant of the element controlled by the tab item.
1626         while (checkFocusElement) {
1627             if (tabPanel == checkFocusElement)
1628                 return true;
1629             checkFocusElement = checkFocusElement->parentObject();
1630         }
1631     }
1632     
1633     return false;
1634 }
1635     
1636 bool AccessibilityRenderObject::isFocused() const
1637 {
1638     if (!m_renderer)
1639         return false;
1640     
1641     Document& document = m_renderer->document();
1642
1643     Element* focusedElement = document.focusedElement();
1644     if (!focusedElement)
1645         return false;
1646     
1647     // A web area is represented by the Document node in the DOM tree, which isn't focusable.
1648     // Check instead if the frame's selection controller is focused
1649     if (focusedElement == m_renderer->node()
1650         || (roleValue() == WebAreaRole && document.frame()->selection().isFocusedAndActive()))
1651         return true;
1652     
1653     return false;
1654 }
1655
1656 void AccessibilityRenderObject::setFocused(bool on)
1657 {
1658     if (!canSetFocusAttribute())
1659         return;
1660     
1661     Document* document = this->document();
1662     Node* node = this->node();
1663
1664     if (!on || !is<Element>(node)) {
1665         document->setFocusedElement(nullptr);
1666         return;
1667     }
1668
1669     // When a node is told to set focus, that can cause it to be deallocated, which means that doing
1670     // anything else inside this object will crash. To fix this, we added a RefPtr to protect this object
1671     // long enough for duration.
1672     RefPtr<AccessibilityObject> protectedThis(this);
1673     
1674     // If this node is already the currently focused node, then calling focus() won't do anything.
1675     // That is a problem when focus is removed from the webpage to chrome, and then returns.
1676     // In these cases, we need to do what keyboard and mouse focus do, which is reset focus first.
1677     if (document->focusedElement() == node)
1678         document->setFocusedElement(nullptr);
1679
1680     // If we return from setFocusedElement and our element has been removed from a tree, axObjectCache() may be null.
1681     if (AXObjectCache* cache = axObjectCache()) {
1682         cache->setIsSynchronizingSelection(true);
1683         downcast<Element>(*node).focus();
1684         cache->setIsSynchronizingSelection(false);
1685     }
1686 }
1687
1688 void AccessibilityRenderObject::setSelectedRows(AccessibilityChildrenVector& selectedRows)
1689 {
1690     // Setting selected only makes sense in trees and tables (and tree-tables).
1691     AccessibilityRole role = roleValue();
1692     if (role != TreeRole && role != TreeGridRole && role != TableRole && role != GridRole)
1693         return;
1694     
1695     bool isMulti = isMultiSelectable();
1696     unsigned count = selectedRows.size();
1697     if (count > 1 && !isMulti)
1698         count = 1;
1699     
1700     for (const auto& selectedRow : selectedRows)
1701         selectedRow->setSelected(true);
1702 }
1703     
1704 void AccessibilityRenderObject::setValue(const String& string)
1705 {
1706     if (!m_renderer || !is<Element>(m_renderer->node()))
1707         return;
1708     Element& element = downcast<Element>(*m_renderer->node());
1709
1710     if (!is<RenderBoxModelObject>(*m_renderer))
1711         return;
1712     RenderBoxModelObject& renderer = downcast<RenderBoxModelObject>(*m_renderer);
1713
1714     // FIXME: Do we want to do anything here for ARIA textboxes?
1715     if (renderer.isTextField() && is<HTMLInputElement>(element))
1716         downcast<HTMLInputElement>(element).setValue(string);
1717     else if (renderer.isTextArea() && is<HTMLTextAreaElement>(element))
1718         downcast<HTMLTextAreaElement>(element).setValue(string);
1719 }
1720
1721 bool AccessibilityRenderObject::supportsARIAOwns() const
1722 {
1723     if (!m_renderer)
1724         return false;
1725     const AtomicString& ariaOwns = getAttribute(aria_ownsAttr);
1726
1727     return !ariaOwns.isEmpty();
1728 }
1729     
1730 RenderView* AccessibilityRenderObject::topRenderer() const
1731 {
1732     Document* topDoc = topDocument();
1733     if (!topDoc)
1734         return nullptr;
1735     
1736     return topDoc->renderView();
1737 }
1738
1739 Document* AccessibilityRenderObject::document() const
1740 {
1741     if (!m_renderer)
1742         return nullptr;
1743     return &m_renderer->document();
1744 }
1745
1746 Widget* AccessibilityRenderObject::widget() const
1747 {
1748     if (!is<RenderWidget>(*m_renderer))
1749         return nullptr;
1750     return downcast<RenderWidget>(*m_renderer).widget();
1751 }
1752
1753 AccessibilityObject* AccessibilityRenderObject::accessibilityParentForImageMap(HTMLMapElement* map) const
1754 {
1755     // find an image that is using this map
1756     if (!map)
1757         return nullptr;
1758
1759     HTMLImageElement* imageElement = map->imageElement();
1760     if (!imageElement)
1761         return nullptr;
1762     
1763     if (AXObjectCache* cache = axObjectCache())
1764         return cache->getOrCreate(imageElement);
1765     
1766     return nullptr;
1767 }
1768     
1769 void AccessibilityRenderObject::getDocumentLinks(AccessibilityChildrenVector& result)
1770 {
1771     Document& document = m_renderer->document();
1772     Ref<HTMLCollection> links = document.links();
1773     for (unsigned i = 0; auto* current = links->item(i); ++i) {
1774         if (auto* renderer = current->renderer()) {
1775             RefPtr<AccessibilityObject> axObject = document.axObjectCache()->getOrCreate(renderer);
1776             ASSERT(axObject);
1777             if (!axObject->accessibilityIsIgnored() && axObject->isLink())
1778                 result.append(axObject);
1779         } else {
1780             auto* parent = current->parentNode();
1781             if (is<HTMLAreaElement>(*current) && is<HTMLMapElement>(parent)) {
1782                 auto& areaObject = downcast<AccessibilityImageMapLink>(*axObjectCache()->getOrCreate(ImageMapLinkRole));
1783                 HTMLMapElement& map = downcast<HTMLMapElement>(*parent);
1784                 areaObject.setHTMLAreaElement(downcast<HTMLAreaElement>(current));
1785                 areaObject.setHTMLMapElement(&map);
1786                 areaObject.setParent(accessibilityParentForImageMap(&map));
1787
1788                 result.append(&areaObject);
1789             }
1790         }
1791     }
1792 }
1793
1794 FrameView* AccessibilityRenderObject::documentFrameView() const 
1795
1796     if (!m_renderer)
1797         return nullptr;
1798
1799     // this is the RenderObject's Document's Frame's FrameView 
1800     return &m_renderer->view().frameView();
1801 }
1802
1803 Widget* AccessibilityRenderObject::widgetForAttachmentView() const
1804 {
1805     if (!isAttachment())
1806         return nullptr;
1807     return downcast<RenderWidget>(*m_renderer).widget();
1808 }
1809
1810 // This function is like a cross-platform version of - (WebCoreTextMarkerRange*)textMarkerRange. It returns
1811 // a Range that we can convert to a WebCoreTextMarkerRange in the Obj-C file
1812 VisiblePositionRange AccessibilityRenderObject::visiblePositionRange() const
1813 {
1814     if (!m_renderer)
1815         return VisiblePositionRange();
1816     
1817     // construct VisiblePositions for start and end
1818     Node* node = m_renderer->node();
1819     if (!node)
1820         return VisiblePositionRange();
1821
1822     VisiblePosition startPos = firstPositionInOrBeforeNode(node);
1823     VisiblePosition endPos = lastPositionInOrAfterNode(node);
1824
1825     // the VisiblePositions are equal for nodes like buttons, so adjust for that
1826     // FIXME: Really?  [button, 0] and [button, 1] are distinct (before and after the button)
1827     // I expect this code is only hit for things like empty divs?  In which case I don't think
1828     // the behavior is correct here -- eseidel
1829     if (startPos == endPos) {
1830         endPos = endPos.next();
1831         if (endPos.isNull())
1832             endPos = startPos;
1833     }
1834
1835     return VisiblePositionRange(startPos, endPos);
1836 }
1837
1838 VisiblePositionRange AccessibilityRenderObject::visiblePositionRangeForLine(unsigned lineCount) const
1839 {
1840     if (!lineCount || !m_renderer)
1841         return VisiblePositionRange();
1842     
1843     // iterate over the lines
1844     // FIXME: this is wrong when lineNumber is lineCount+1,  because nextLinePosition takes you to the
1845     // last offset of the last line
1846     VisiblePosition visiblePos = m_renderer->view().positionForPoint(IntPoint(), nullptr);
1847     VisiblePosition savedVisiblePos;
1848     while (--lineCount) {
1849         savedVisiblePos = visiblePos;
1850         visiblePos = nextLinePosition(visiblePos, 0);
1851         if (visiblePos.isNull() || visiblePos == savedVisiblePos)
1852             return VisiblePositionRange();
1853     }
1854     
1855     // make a caret selection for the marker position, then extend it to the line
1856     // NOTE: ignores results of sel.modify because it returns false when
1857     // starting at an empty line.  The resulting selection in that case
1858     // will be a caret at visiblePos.
1859     FrameSelection selection;
1860     selection.setSelection(VisibleSelection(visiblePos));
1861     selection.modify(FrameSelection::AlterationExtend, DirectionRight, LineBoundary);
1862     
1863     return VisiblePositionRange(selection.selection().visibleStart(), selection.selection().visibleEnd());
1864 }
1865     
1866 VisiblePosition AccessibilityRenderObject::visiblePositionForIndex(int index) const
1867 {
1868     if (!m_renderer)
1869         return VisiblePosition();
1870
1871     if (isNativeTextControl())
1872         return downcast<RenderTextControl>(*m_renderer).textFormControlElement().visiblePositionForIndex(index);
1873
1874     if (!allowsTextRanges() && !is<RenderText>(*m_renderer))
1875         return VisiblePosition();
1876     
1877     Node* node = m_renderer->node();
1878     if (!node)
1879         return VisiblePosition();
1880
1881     return visiblePositionForIndexUsingCharacterIterator(*node, index);
1882 }
1883     
1884 int AccessibilityRenderObject::indexForVisiblePosition(const VisiblePosition& position) const
1885 {
1886     if (isNativeTextControl())
1887         return downcast<RenderTextControl>(*m_renderer).textFormControlElement().indexForVisiblePosition(position);
1888
1889     if (!isTextControl())
1890         return 0;
1891     
1892     Node* node = m_renderer->node();
1893     if (!node)
1894         return 0;
1895
1896     Position indexPosition = position.deepEquivalent();
1897     if (indexPosition.isNull() || highestEditableRoot(indexPosition, HasEditableAXRole) != node)
1898         return 0;
1899
1900 #if PLATFORM(GTK)
1901     // We need to consider replaced elements for GTK, as they will be
1902     // presented with the 'object replacement character' (0xFFFC).
1903     bool forSelectionPreservation = true;
1904 #else
1905     bool forSelectionPreservation = false;
1906 #endif
1907
1908     return WebCore::indexForVisiblePosition(*node, position, forSelectionPreservation);
1909 }
1910
1911 Element* AccessibilityRenderObject::rootEditableElementForPosition(const Position& position) const
1912 {
1913     // Find the root editable or pseudo-editable (i.e. having an editable ARIA role) element.
1914     Element* result = nullptr;
1915     
1916     Element* rootEditableElement = position.rootEditableElement();
1917
1918     for (Element* e = position.element(); e && e != rootEditableElement; e = e->parentElement()) {
1919         if (nodeIsTextControl(e))
1920             result = e;
1921         if (e->hasTagName(bodyTag))
1922             break;
1923     }
1924
1925     if (result)
1926         return result;
1927
1928     return rootEditableElement;
1929 }
1930
1931 bool AccessibilityRenderObject::nodeIsTextControl(const Node* node) const
1932 {
1933     if (!node)
1934         return false;
1935
1936     if (AXObjectCache* cache = axObjectCache()) {
1937         if (AccessibilityObject* axObjectForNode = cache->getOrCreate(const_cast<Node*>(node)))
1938             return axObjectForNode->isTextControl();
1939     }
1940
1941     return false;
1942 }
1943
1944 IntRect AccessibilityRenderObject::boundsForRects(LayoutRect& rect1, LayoutRect& rect2, RefPtr<Range> dataRange) const
1945 {
1946     LayoutRect ourRect = rect1;
1947     ourRect.unite(rect2);
1948     
1949     // if the rectangle spans lines and contains multiple text chars, use the range's bounding box intead
1950     if (rect1.maxY() != rect2.maxY()) {
1951         LayoutRect boundingBox = dataRange->absoluteBoundingBox();
1952         String rangeString = plainText(dataRange.get());
1953         if (rangeString.length() > 1 && !boundingBox.isEmpty())
1954             ourRect = boundingBox;
1955     }
1956     
1957 #if PLATFORM(MAC)
1958     return m_renderer->view().frameView().contentsToScreen(snappedIntRect(ourRect));
1959 #else
1960     return snappedIntRect(ourRect);
1961 #endif
1962 }
1963
1964 IntRect AccessibilityRenderObject::boundsForVisiblePositionRange(const VisiblePositionRange& visiblePositionRange) const
1965 {
1966     if (visiblePositionRange.isNull())
1967         return IntRect();
1968     
1969     // Create a mutable VisiblePositionRange.
1970     VisiblePositionRange range(visiblePositionRange);
1971     LayoutRect rect1 = range.start.absoluteCaretBounds();
1972     LayoutRect rect2 = range.end.absoluteCaretBounds();
1973     
1974     // readjust for position at the edge of a line.  This is to exclude line rect that doesn't need to be accounted in the range bounds
1975     if (rect2.y() != rect1.y()) {
1976         VisiblePosition endOfFirstLine = endOfLine(range.start);
1977         if (range.start == endOfFirstLine) {
1978             range.start.setAffinity(DOWNSTREAM);
1979             rect1 = range.start.absoluteCaretBounds();
1980         }
1981         if (range.end == endOfFirstLine) {
1982             range.end.setAffinity(UPSTREAM);
1983             rect2 = range.end.absoluteCaretBounds();
1984         }
1985     }
1986     
1987     RefPtr<Range> dataRange = makeRange(range.start, range.end);
1988     return boundsForRects(rect1, rect2, dataRange);
1989 }
1990
1991 IntRect AccessibilityRenderObject::boundsForRange(const RefPtr<Range> range) const
1992 {
1993     if (!range)
1994         return IntRect();
1995     
1996     AXObjectCache* cache = this->axObjectCache();
1997     if (!cache)
1998         return IntRect();
1999     
2000     CharacterOffset start = cache->startOrEndCharacterOffsetForRange(range, true);
2001     CharacterOffset end = cache->startOrEndCharacterOffsetForRange(range, false);
2002     
2003     LayoutRect rect1 = cache->absoluteCaretBoundsForCharacterOffset(start);
2004     LayoutRect rect2 = cache->absoluteCaretBoundsForCharacterOffset(end);
2005     
2006     // readjust for position at the edge of a line. This is to exclude line rect that doesn't need to be accounted in the range bounds.
2007     if (rect2.y() != rect1.y()) {
2008         CharacterOffset endOfFirstLine = cache->endCharacterOffsetOfLine(start);
2009         if (start.isEqual(endOfFirstLine)) {
2010             start = cache->nextCharacterOffset(start, false);
2011             rect1 = cache->absoluteCaretBoundsForCharacterOffset(start);
2012         }
2013         if (end.isEqual(endOfFirstLine)) {
2014             end = cache->previousCharacterOffset(end, false);
2015             rect2 = cache->absoluteCaretBoundsForCharacterOffset(end);
2016         }
2017     }
2018     
2019     return boundsForRects(rect1, rect2, range);
2020 }
2021     
2022 void AccessibilityRenderObject::setSelectedVisiblePositionRange(const VisiblePositionRange& range) const
2023 {
2024     if (range.start.isNull() || range.end.isNull())
2025         return;
2026
2027     // make selection and tell the document to use it. if it's zero length, then move to that position
2028     if (range.start == range.end) {
2029         setTextSelectionIntent(axObjectCache(), AXTextStateChangeTypeSelectionMove);
2030         m_renderer->frame().selection().moveTo(range.start, UserTriggered);
2031         clearTextSelectionIntent(axObjectCache());
2032     }
2033     else {
2034         setTextSelectionIntent(axObjectCache(), AXTextStateChangeTypeSelectionExtend);
2035         VisibleSelection newSelection = VisibleSelection(range.start, range.end);
2036         m_renderer->frame().selection().setSelection(newSelection, FrameSelection::defaultSetSelectionOptions());
2037         clearTextSelectionIntent(axObjectCache());
2038     }
2039 }
2040
2041 VisiblePosition AccessibilityRenderObject::visiblePositionForPoint(const IntPoint& point) const
2042 {
2043     if (!m_renderer)
2044         return VisiblePosition();
2045
2046     // convert absolute point to view coordinates
2047     RenderView* renderView = topRenderer();
2048     if (!renderView)
2049         return VisiblePosition();
2050
2051 #if PLATFORM(COCOA)
2052     FrameView* frameView = &renderView->frameView();
2053 #endif
2054
2055     Node* innerNode = nullptr;
2056     
2057     // locate the node containing the point
2058     LayoutPoint pointResult;
2059     while (1) {
2060         LayoutPoint ourpoint;
2061 #if PLATFORM(MAC)
2062         ourpoint = frameView->screenToContents(point);
2063 #else
2064         ourpoint = point;
2065 #endif
2066         HitTestRequest request(HitTestRequest::ReadOnly |
2067                                HitTestRequest::Active);
2068         HitTestResult result(ourpoint);
2069         renderView->hitTest(request, result);
2070         innerNode = result.innerNode();
2071         if (!innerNode)
2072             return VisiblePosition();
2073         
2074         RenderObject* renderer = innerNode->renderer();
2075         if (!renderer)
2076             return VisiblePosition();
2077         
2078         pointResult = result.localPoint();
2079
2080         // done if hit something other than a widget
2081         if (!is<RenderWidget>(*renderer))
2082             break;
2083
2084         // descend into widget (FRAME, IFRAME, OBJECT...)
2085         Widget* widget = downcast<RenderWidget>(*renderer).widget();
2086         if (!is<FrameView>(widget))
2087             break;
2088         Frame& frame = downcast<FrameView>(*widget).frame();
2089         renderView = frame.document()->renderView();
2090 #if PLATFORM(COCOA)
2091         frameView = downcast<FrameView>(widget);
2092 #endif
2093     }
2094     
2095     return innerNode->renderer()->positionForPoint(pointResult, nullptr);
2096 }
2097
2098 // NOTE: Consider providing this utility method as AX API
2099 VisiblePosition AccessibilityRenderObject::visiblePositionForIndex(unsigned indexValue, bool lastIndexOK) const
2100 {
2101     if (!isTextControl())
2102         return VisiblePosition();
2103     
2104     // lastIndexOK specifies whether the position after the last character is acceptable
2105     if (indexValue >= text().length()) {
2106         if (!lastIndexOK || indexValue > text().length())
2107             return VisiblePosition();
2108     }
2109     VisiblePosition position = visiblePositionForIndex(indexValue);
2110     position.setAffinity(DOWNSTREAM);
2111     return position;
2112 }
2113
2114 // NOTE: Consider providing this utility method as AX API
2115 int AccessibilityRenderObject::index(const VisiblePosition& position) const
2116 {
2117     if (position.isNull() || !isTextControl())
2118         return -1;
2119
2120     if (renderObjectContainsPosition(m_renderer, position.deepEquivalent()))
2121         return indexForVisiblePosition(position);
2122     
2123     return -1;
2124 }
2125
2126 void AccessibilityRenderObject::lineBreaks(Vector<int>& lineBreaks) const
2127 {
2128     if (!isTextControl())
2129         return;
2130
2131     VisiblePosition visiblePos = visiblePositionForIndex(0);
2132     VisiblePosition savedVisiblePos = visiblePos;
2133     visiblePos = nextLinePosition(visiblePos, 0);
2134     while (!visiblePos.isNull() && visiblePos != savedVisiblePos) {
2135         lineBreaks.append(indexForVisiblePosition(visiblePos));
2136         savedVisiblePos = visiblePos;
2137         visiblePos = nextLinePosition(visiblePos, 0);
2138     }
2139 }
2140
2141 // Given a line number, the range of characters of the text associated with this accessibility
2142 // object that contains the line number.
2143 PlainTextRange AccessibilityRenderObject::doAXRangeForLine(unsigned lineNumber) const
2144 {
2145     if (!isTextControl())
2146         return PlainTextRange();
2147     
2148     // iterate to the specified line
2149     VisiblePosition visiblePos = visiblePositionForIndex(0);
2150     VisiblePosition savedVisiblePos;
2151     for (unsigned lineCount = lineNumber; lineCount; lineCount -= 1) {
2152         savedVisiblePos = visiblePos;
2153         visiblePos = nextLinePosition(visiblePos, 0);
2154         if (visiblePos.isNull() || visiblePos == savedVisiblePos)
2155             return PlainTextRange();
2156     }
2157
2158     // Get the end of the line based on the starting position.
2159     VisiblePosition endPosition = endOfLine(visiblePos);
2160
2161     int index1 = indexForVisiblePosition(visiblePos);
2162     int index2 = indexForVisiblePosition(endPosition);
2163     
2164     // add one to the end index for a line break not caused by soft line wrap (to match AppKit)
2165     if (endPosition.affinity() == DOWNSTREAM && endPosition.next().isNotNull())
2166         index2 += 1;
2167     
2168     // return nil rather than an zero-length range (to match AppKit)
2169     if (index1 == index2)
2170         return PlainTextRange();
2171     
2172     return PlainTextRange(index1, index2 - index1);
2173 }
2174
2175 // The composed character range in the text associated with this accessibility object that
2176 // is specified by the given index value. This parameterized attribute returns the complete
2177 // range of characters (including surrogate pairs of multi-byte glyphs) at the given index.
2178 PlainTextRange AccessibilityRenderObject::doAXRangeForIndex(unsigned index) const
2179 {
2180     if (!isTextControl())
2181         return PlainTextRange();
2182     
2183     String elementText = text();
2184     if (!elementText.length() || index > elementText.length() - 1)
2185         return PlainTextRange();
2186     
2187     return PlainTextRange(index, 1);
2188 }
2189
2190 // A substring of the text associated with this accessibility object that is
2191 // specified by the given character range.
2192 String AccessibilityRenderObject::doAXStringForRange(const PlainTextRange& range) const
2193 {
2194     if (!range.length)
2195         return String();
2196     
2197     if (!isTextControl())
2198         return String();
2199     
2200     String elementText = isPasswordField() ? passwordFieldValue() : text();
2201     return elementText.substring(range.start, range.length);
2202 }
2203
2204 // The bounding rectangle of the text associated with this accessibility object that is
2205 // specified by the given range. This is the bounding rectangle a sighted user would see
2206 // on the display screen, in pixels.
2207 IntRect AccessibilityRenderObject::doAXBoundsForRange(const PlainTextRange& range) const
2208 {
2209     if (allowsTextRanges())
2210         return boundsForVisiblePositionRange(visiblePositionRangeForRange(range));
2211     return IntRect();
2212 }
2213
2214 IntRect AccessibilityRenderObject::doAXBoundsForRangeUsingCharacterOffset(const PlainTextRange& range) const
2215 {
2216     if (allowsTextRanges())
2217         return boundsForRange(rangeForPlainTextRange(range));
2218     return IntRect();
2219 }
2220
2221 AccessibilityObject* AccessibilityRenderObject::accessibilityImageMapHitTest(HTMLAreaElement* area, const IntPoint& point) const
2222 {
2223     if (!area)
2224         return nullptr;
2225
2226     AccessibilityObject* parent = nullptr;
2227     for (Element* mapParent = area->parentElement(); mapParent; mapParent = mapParent->parentElement()) {
2228         if (is<HTMLMapElement>(*mapParent)) {
2229             parent = accessibilityParentForImageMap(downcast<HTMLMapElement>(mapParent));
2230             break;
2231         }
2232     }
2233     if (!parent)
2234         return nullptr;
2235     
2236     for (const auto& child : parent->children()) {
2237         if (child->elementRect().contains(point))
2238             return child.get();
2239     }
2240     
2241     return nullptr;
2242 }
2243
2244 AccessibilityObject* AccessibilityRenderObject::remoteSVGElementHitTest(const IntPoint& point) const
2245 {
2246     AccessibilityObject* remote = remoteSVGRootElement();
2247     if (!remote)
2248         return nullptr;
2249     
2250     IntSize offset = point - roundedIntPoint(boundingBoxRect().location());
2251     return remote->accessibilityHitTest(IntPoint(offset));
2252 }
2253
2254 AccessibilityObject* AccessibilityRenderObject::elementAccessibilityHitTest(const IntPoint& point) const
2255 {
2256     if (isSVGImage())
2257         return remoteSVGElementHitTest(point);
2258     
2259     return AccessibilityObject::elementAccessibilityHitTest(point);
2260 }
2261     
2262 static bool shouldUseShadowHostForHitTesting(Node* shadowHost)
2263 {
2264     // We need to allow automation of mouse events on video tags.
2265     return shadowHost && !shadowHost->hasTagName(videoTag);
2266 }
2267
2268 AccessibilityObject* AccessibilityRenderObject::accessibilityHitTest(const IntPoint& point) const
2269 {
2270     if (!m_renderer || !m_renderer->hasLayer())
2271         return nullptr;
2272     
2273     m_renderer->document().updateLayout();
2274
2275     RenderLayer* layer = downcast<RenderBox>(*m_renderer).layer();
2276      
2277     HitTestRequest request(HitTestRequest::ReadOnly | HitTestRequest::Active | HitTestRequest::AccessibilityHitTest);
2278     HitTestResult hitTestResult = HitTestResult(point);
2279     layer->hitTest(request, hitTestResult);
2280     Node* node = hitTestResult.innerNode();
2281     if (!node)
2282         return nullptr;
2283     Node* shadowAncestorNode = node->shadowHost();
2284     if (shouldUseShadowHostForHitTesting(shadowAncestorNode))
2285         node = shadowAncestorNode;
2286     ASSERT(node);
2287
2288     if (is<HTMLAreaElement>(*node))
2289         return accessibilityImageMapHitTest(downcast<HTMLAreaElement>(node), point);
2290     
2291     if (is<HTMLOptionElement>(*node))
2292         node = downcast<HTMLOptionElement>(*node).ownerSelectElement();
2293     
2294     RenderObject* obj = node->renderer();
2295     if (!obj)
2296         return nullptr;
2297     
2298     AccessibilityObject* result = obj->document().axObjectCache()->getOrCreate(obj);
2299     result->updateChildrenIfNecessary();
2300
2301     // Allow the element to perform any hit-testing it might need to do to reach non-render children.
2302     result = result->elementAccessibilityHitTest(point);
2303     
2304     if (result && result->accessibilityIsIgnored()) {
2305         // If this element is the label of a control, a hit test should return the control.
2306         AccessibilityObject* controlObject = result->correspondingControlForLabelElement();
2307         if (controlObject && !controlObject->exposesTitleUIElement())
2308             return controlObject;
2309
2310         result = result->parentObjectUnignored();
2311     }
2312
2313     return result;
2314 }
2315
2316 bool AccessibilityRenderObject::shouldNotifyActiveDescendant() const
2317 {
2318     // We want to notify that the combo box has changed its active descendant,
2319     // but we do not want to change the focus, because focus should remain with the combo box.
2320     if (isComboBox())
2321         return true;
2322     
2323     return shouldFocusActiveDescendant();
2324 }
2325
2326 bool AccessibilityRenderObject::shouldFocusActiveDescendant() const
2327 {
2328     switch (ariaRoleAttribute()) {
2329     case GroupRole:
2330     case ListBoxRole:
2331     case MenuRole:
2332     case MenuBarRole:
2333     case RadioGroupRole:
2334     case RowRole:
2335     case PopUpButtonRole:
2336     case ProgressIndicatorRole:
2337     case ToolbarRole:
2338     case OutlineRole:
2339     case TreeRole:
2340     case GridRole:
2341     /* FIXME: replace these with actual roles when they are added to AccessibilityRole
2342     composite
2343     alert
2344     alertdialog
2345     status
2346     timer
2347     */
2348         return true;
2349     default:
2350         return false;
2351     }
2352 }
2353
2354 AccessibilityObject* AccessibilityRenderObject::activeDescendant() const
2355 {
2356     if (!m_renderer)
2357         return nullptr;
2358     
2359     const AtomicString& activeDescendantAttrStr = getAttribute(aria_activedescendantAttr);
2360     if (activeDescendantAttrStr.isNull() || activeDescendantAttrStr.isEmpty())
2361         return nullptr;
2362     
2363     Element* element = this->element();
2364     if (!element)
2365         return nullptr;
2366     
2367     Element* target = element->treeScope().getElementById(activeDescendantAttrStr);
2368     if (!target)
2369         return nullptr;
2370     
2371     if (AXObjectCache* cache = axObjectCache()) {
2372         AccessibilityObject* obj = cache->getOrCreate(target);
2373         if (obj && obj->isAccessibilityRenderObject())
2374             // an activedescendant is only useful if it has a renderer, because that's what's needed to post the notification
2375             return obj;
2376     }
2377     
2378     return nullptr;
2379 }
2380
2381 void AccessibilityRenderObject::handleAriaExpandedChanged()
2382 {
2383     // Find if a parent of this object should handle aria-expanded changes.
2384     AccessibilityObject* containerParent = this->parentObject();
2385     while (containerParent) {
2386         bool foundParent = false;
2387         
2388         switch (containerParent->roleValue()) {
2389         case TreeRole:
2390         case TreeGridRole:
2391         case GridRole:
2392         case TableRole:
2393         case BrowserRole:
2394             foundParent = true;
2395             break;
2396         default:
2397             break;
2398         }
2399         
2400         if (foundParent)
2401             break;
2402         
2403         containerParent = containerParent->parentObject();
2404     }
2405     
2406     // Post that the row count changed.
2407     AXObjectCache* cache = axObjectCache();
2408     if (!cache)
2409         return;
2410     
2411     if (containerParent)
2412         cache->postNotification(containerParent, document(), AXObjectCache::AXRowCountChanged);
2413
2414     // Post that the specific row either collapsed or expanded.
2415     if (roleValue() == RowRole || roleValue() == TreeItemRole)
2416         cache->postNotification(this, document(), isExpanded() ? AXObjectCache::AXRowExpanded : AXObjectCache::AXRowCollapsed);
2417     else
2418         cache->postNotification(this, document(), AXObjectCache::AXExpandedChanged);
2419 }
2420
2421 void AccessibilityRenderObject::handleActiveDescendantChanged()
2422 {
2423     Element* element = downcast<Element>(renderer()->node());
2424     if (!element)
2425         return;
2426     if (!renderer()->frame().selection().isFocusedAndActive() || renderer()->document().focusedElement() != element)
2427         return;
2428
2429     if (activeDescendant() && shouldNotifyActiveDescendant())
2430         renderer()->document().axObjectCache()->postNotification(m_renderer, AXObjectCache::AXActiveDescendantChanged);
2431 }
2432
2433 AccessibilityObject* AccessibilityRenderObject::correspondingControlForLabelElement() const
2434 {
2435     HTMLLabelElement* labelElement = labelElementContainer();
2436     if (!labelElement)
2437         return nullptr;
2438     
2439     HTMLElement* correspondingControl = labelElement->control();
2440     if (!correspondingControl)
2441         return nullptr;
2442
2443     // Make sure the corresponding control isn't a descendant of this label that's in the middle of being destroyed.
2444     if (correspondingControl->renderer() && !correspondingControl->renderer()->parent())
2445         return nullptr;
2446     
2447     return axObjectCache()->getOrCreate(correspondingControl);     
2448 }
2449
2450 AccessibilityObject* AccessibilityRenderObject::correspondingLabelForControlElement() const
2451 {
2452     if (!m_renderer)
2453         return nullptr;
2454
2455     // ARIA: section 2A, bullet #3 says if aria-labeledby or aria-label appears, it should
2456     // override the "label" element association.
2457     if (hasTextAlternative())
2458         return nullptr;
2459
2460     Node* node = m_renderer->node();
2461     if (is<HTMLElement>(node)) {
2462         if (HTMLLabelElement* label = labelForElement(downcast<HTMLElement>(node)))
2463             return axObjectCache()->getOrCreate(label);
2464     }
2465
2466     return nullptr;
2467 }
2468
2469 bool AccessibilityRenderObject::renderObjectIsObservable(RenderObject& renderer) const
2470 {
2471     // AX clients will listen for AXValueChange on a text control.
2472     if (is<RenderTextControl>(renderer))
2473         return true;
2474     
2475     // AX clients will listen for AXSelectedChildrenChanged on listboxes.
2476     Node* node = renderer.node();
2477     if (!node)
2478         return false;
2479     
2480     if (nodeHasRole(node, "listbox") || (is<RenderBoxModelObject>(renderer) && downcast<RenderBoxModelObject>(renderer).isListBox()))
2481         return true;
2482
2483     // Textboxes should send out notifications.
2484     if (nodeHasRole(node, "textbox") || (is<Element>(*node) && contentEditableAttributeIsEnabled(downcast<Element>(node))))
2485         return true;
2486     
2487     return false;
2488 }
2489     
2490 AccessibilityObject* AccessibilityRenderObject::observableObject() const
2491 {
2492     // Find the object going up the parent chain that is used in accessibility to monitor certain notifications.
2493     for (RenderObject* renderer = m_renderer; renderer && renderer->node(); renderer = renderer->parent()) {
2494         if (renderObjectIsObservable(*renderer)) {
2495             if (AXObjectCache* cache = axObjectCache())
2496                 return cache->getOrCreate(renderer);
2497         }
2498     }
2499     
2500     return nullptr;
2501 }
2502
2503 bool AccessibilityRenderObject::isDescendantOfElementType(const QualifiedName& tagName) const
2504 {
2505     for (auto& ancestor : ancestorsOfType<RenderElement>(*m_renderer)) {
2506         if (ancestor.element() && ancestor.element()->hasTagName(tagName))
2507             return true;
2508     }
2509     return false;
2510 }
2511     
2512 String AccessibilityRenderObject::expandedTextValue() const
2513 {
2514     if (AccessibilityObject* parent = parentObject()) {
2515         if (parent->hasTagName(abbrTag) || parent->hasTagName(acronymTag))
2516             return parent->getAttribute(titleAttr);
2517     }
2518     
2519     return String();
2520 }
2521
2522 bool AccessibilityRenderObject::supportsExpandedTextValue() const
2523 {
2524     if (roleValue() == StaticTextRole) {
2525         if (AccessibilityObject* parent = parentObject())
2526             return parent->hasTagName(abbrTag) || parent->hasTagName(acronymTag);
2527     }
2528     
2529     return false;
2530 }
2531
2532 AccessibilityRole AccessibilityRenderObject::determineAccessibilityRole()
2533 {
2534     if (!m_renderer)
2535         return UnknownRole;
2536
2537     // Sometimes we need to ignore the attribute role. Like if a tree is malformed,
2538     // we want to ignore the treeitem's attribute role.
2539     if ((m_ariaRole = determineAriaRoleAttribute()) != UnknownRole && !shouldIgnoreAttributeRole())
2540         return m_ariaRole;
2541     
2542     Node* node = m_renderer->node();
2543     RenderBoxModelObject* cssBox = renderBoxModelObject();
2544
2545     if (node && node->isLink())
2546         return WebCoreLinkRole;
2547     if (node && is<HTMLImageElement>(*node) && downcast<HTMLImageElement>(*node).fastHasAttribute(usemapAttr))
2548         return ImageMapRole;
2549     if ((cssBox && cssBox->isListItem()) || (node && node->hasTagName(liTag)))
2550         return ListItemRole;
2551     if (m_renderer->isListMarker())
2552         return ListMarkerRole;
2553     if (node && node->hasTagName(buttonTag))
2554         return buttonRoleType();
2555     if (node && node->hasTagName(legendTag))
2556         return LegendRole;
2557     if (m_renderer->isText())
2558         return StaticTextRole;
2559     if (cssBox && cssBox->isImage()) {
2560         if (is<HTMLInputElement>(node))
2561             return ariaHasPopup() ? PopUpButtonRole : ButtonRole;
2562         if (isSVGImage())
2563             return SVGRootRole;
2564         return ImageRole;
2565     }
2566     
2567     if (node && node->hasTagName(canvasTag))
2568         return CanvasRole;
2569
2570     if (cssBox && cssBox->isRenderView())
2571         return WebAreaRole;
2572     
2573     if (cssBox && cssBox->isTextField()) {
2574         if (is<HTMLInputElement>(node))
2575             return downcast<HTMLInputElement>(*node).isSearchField() ? SearchFieldRole : TextFieldRole;
2576     }
2577     
2578     if (cssBox && cssBox->isTextArea())
2579         return TextAreaRole;
2580
2581     if (is<HTMLInputElement>(node)) {
2582         HTMLInputElement& input = downcast<HTMLInputElement>(*node);
2583         if (input.isCheckbox())
2584             return CheckBoxRole;
2585         if (input.isRadioButton())
2586             return RadioButtonRole;
2587         if (input.isTextButton())
2588             return buttonRoleType();
2589         // On iOS, the date field and time field are popup buttons. On other platforms they are text fields.
2590 #if PLATFORM(IOS)
2591         if (input.isDateField() || input.isTimeField())
2592             return PopUpButtonRole;
2593 #endif
2594 #if ENABLE(INPUT_TYPE_COLOR)
2595         if (input.isColorControl())
2596             return ColorWellRole;
2597 #endif
2598     }
2599     
2600     if (hasContentEditableAttributeSet())
2601         return TextAreaRole;
2602     
2603     if (isFileUploadButton())
2604         return ButtonRole;
2605     
2606     if (cssBox && cssBox->isMenuList())
2607         return PopUpButtonRole;
2608     
2609     if (headingLevel())
2610         return HeadingRole;
2611     
2612     if (m_renderer->isSVGRoot())
2613         return SVGRootRole;
2614     
2615     if (isStyleFormatGroup())
2616         return is<RenderInline>(*m_renderer) ? InlineRole : GroupRole;
2617     
2618 #if ENABLE(MATHML)
2619     if (node && node->hasTagName(MathMLNames::mathTag))
2620         return DocumentMathRole;
2621 #endif
2622     // It's not clear which role a platform should choose for a math element.
2623     // Declaring a math element role should give flexibility to platforms to choose.
2624     if (isMathElement())
2625         return MathElementRole;
2626     
2627     if (node && node->hasTagName(ddTag))
2628         return DescriptionListDetailRole;
2629     
2630     if (node && node->hasTagName(dtTag))
2631         return DescriptionListTermRole;
2632
2633     if (node && node->hasTagName(dlTag))
2634         return DescriptionListRole;
2635
2636     // Check for Ruby elements
2637     if (m_renderer->isRubyText())
2638         return RubyTextRole;
2639     if (m_renderer->isRubyBase())
2640         return RubyBaseRole;
2641     if (m_renderer->isRubyRun())
2642         return RubyRunRole;
2643     if (m_renderer->isRubyBlock())
2644         return RubyBlockRole;
2645     if (m_renderer->isRubyInline())
2646         return RubyInlineRole;
2647     
2648     // This return value is what will be used if AccessibilityTableCell determines
2649     // the cell should not be treated as a cell (e.g. because it is a layout table.
2650     // In ATK, there is a distinction between generic text block elements and other
2651     // generic containers; AX API does not make this distinction.
2652     if (is<RenderTableCell>(m_renderer))
2653 #if PLATFORM(GTK) || PLATFORM(EFL)
2654         return DivRole;
2655 #else
2656         return GroupRole;
2657 #endif
2658
2659     // Table sections should be ignored.
2660     if (m_renderer->isTableSection())
2661         return IgnoredRole;
2662
2663     if (m_renderer->isHR())
2664         return HorizontalRuleRole;
2665
2666     if (node && node->hasTagName(pTag))
2667         return ParagraphRole;
2668
2669     if (is<HTMLLabelElement>(node))
2670         return LabelRole;
2671
2672     if (node && node->hasTagName(dfnTag))
2673         return DefinitionRole;
2674
2675     if (node && node->hasTagName(divTag))
2676         return DivRole;
2677
2678     if (is<HTMLFormElement>(node))
2679         return FormRole;
2680
2681     if (node && node->hasTagName(articleTag))
2682         return DocumentArticleRole;
2683
2684     if (node && node->hasTagName(mainTag))
2685         return LandmarkMainRole;
2686
2687     if (node && node->hasTagName(navTag))
2688         return LandmarkNavigationRole;
2689
2690     if (node && node->hasTagName(asideTag))
2691         return LandmarkComplementaryRole;
2692
2693     // The default role attribute value for the section element, region, became a landmark in ARIA 1.1.
2694     // The HTML AAM spec says it is "strongly recommended" that ATs only convey and provide navigation
2695     // for section elements which have names.
2696     if (node && node->hasTagName(sectionTag))
2697         return hasAttribute(aria_labelAttr) || hasAttribute(aria_labelledbyAttr) ? LandmarkRegionRole : GroupRole;
2698
2699     if (node && node->hasTagName(addressTag))
2700         return LandmarkContentInfoRole;
2701
2702     if (node && node->hasTagName(blockquoteTag))
2703         return BlockquoteRole;
2704
2705     if (node && node->hasTagName(captionTag))
2706         return CaptionRole;
2707
2708     if (node && node->hasTagName(preTag))
2709         return PreRole;
2710
2711     if (is<HTMLDetailsElement>(node))
2712         return DetailsRole;
2713     if (is<HTMLSummaryElement>(node))
2714         return SummaryRole;
2715
2716 #if ENABLE(VIDEO)
2717     if (is<HTMLVideoElement>(node))
2718         return VideoRole;
2719     if (is<HTMLAudioElement>(node))
2720         return AudioRole;
2721 #endif
2722     
2723     // The HTML element should not be exposed as an element. That's what the RenderView element does.
2724     if (node && node->hasTagName(htmlTag))
2725         return IgnoredRole;
2726
2727     // There should only be one banner/contentInfo per page. If header/footer are being used within an article or section
2728     // then it should not be exposed as whole page's banner/contentInfo
2729     if (node && node->hasTagName(headerTag) && !isDescendantOfElementType(articleTag) && !isDescendantOfElementType(sectionTag))
2730         return LandmarkBannerRole;
2731     if (node && node->hasTagName(footerTag) && !isDescendantOfElementType(articleTag) && !isDescendantOfElementType(sectionTag))
2732         return FooterRole;
2733     
2734     // If the element does not have role, but it has ARIA attributes, or accepts tab focus, accessibility should fallback to exposing it as a group.
2735     if (supportsARIAAttributes() || canSetFocusAttribute())
2736         return GroupRole;
2737
2738     if (m_renderer->isRenderBlockFlow()) {
2739 #if PLATFORM(GTK) || PLATFORM(EFL)
2740         // For ATK, GroupRole maps to ATK_ROLE_PANEL. Panels are most commonly found (and hence
2741         // expected) in UI elements; not text blocks.
2742         return m_renderer->isAnonymousBlock() ? DivRole : GroupRole;
2743 #else
2744         return GroupRole;
2745 #endif
2746     }
2747     
2748     // InlineRole is the final fallback before assigning UnknownRole to an object. It makes it
2749     // possible to distinguish truly unknown objects from non-focusable inline text elements
2750     // which have an event handler or attribute suggesting possible inclusion by the platform.
2751     if (is<RenderInline>(*m_renderer)
2752         && (hasAttributesRequiredForInclusion()
2753             || (node && node->hasEventListeners())
2754             || (supportsDatetimeAttribute() && !getAttribute(datetimeAttr).isEmpty())))
2755         return InlineRole;
2756
2757     return UnknownRole;
2758 }
2759
2760 AccessibilityOrientation AccessibilityRenderObject::orientation() const
2761 {
2762     const AtomicString& ariaOrientation = getAttribute(aria_orientationAttr);
2763     if (equalLettersIgnoringASCIICase(ariaOrientation, "horizontal"))
2764         return AccessibilityOrientationHorizontal;
2765     if (equalLettersIgnoringASCIICase(ariaOrientation, "vertical"))
2766         return AccessibilityOrientationVertical;
2767     if (equalLettersIgnoringASCIICase(ariaOrientation, "undefined"))
2768         return AccessibilityOrientationUndefined;
2769
2770     // ARIA 1.1 Implicit defaults are defined on some roles.
2771     // http://www.w3.org/TR/wai-aria-1.1/#aria-orientation
2772     if (isScrollbar() || isComboBox() || isListBox() || isMenu() || isTree())
2773         return AccessibilityOrientationVertical;
2774     
2775     if (isMenuBar() || isSplitter() || isTabList() || isToolbar())
2776         return AccessibilityOrientationHorizontal;
2777     
2778     return AccessibilityObject::orientation();
2779 }
2780     
2781 bool AccessibilityRenderObject::inheritsPresentationalRole() const
2782 {
2783     // ARIA states if an item can get focus, it should not be presentational.
2784     if (canSetFocusAttribute())
2785         return false;
2786     
2787     // ARIA spec says that when a parent object is presentational, and it has required child elements,
2788     // those child elements are also presentational. For example, <li> becomes presentational from <ul>.
2789     // http://www.w3.org/WAI/PF/aria/complete#presentation
2790     static NeverDestroyed<HashSet<QualifiedName>> listItemParents;
2791     static NeverDestroyed<HashSet<QualifiedName>> tableCellParents;
2792
2793     HashSet<QualifiedName>* possibleParentTagNames = nullptr;
2794     switch (roleValue()) {
2795     case ListItemRole:
2796     case ListMarkerRole:
2797         if (listItemParents.get().isEmpty()) {
2798             listItemParents.get().add(ulTag);
2799             listItemParents.get().add(olTag);
2800             listItemParents.get().add(dlTag);
2801         }
2802         possibleParentTagNames = &listItemParents.get();
2803         break;
2804     case GridCellRole:
2805     case CellRole:
2806         if (tableCellParents.get().isEmpty())
2807             tableCellParents.get().add(tableTag);
2808         possibleParentTagNames = &tableCellParents.get();
2809         break;
2810     default:
2811         break;
2812     }
2813     
2814     // Not all elements need to check for this, only ones that are required children.
2815     if (!possibleParentTagNames)
2816         return false;
2817     
2818     for (AccessibilityObject* parent = parentObject(); parent; parent = parent->parentObject()) { 
2819         if (!is<AccessibilityRenderObject>(*parent))
2820             continue;
2821         
2822         Node* node = downcast<AccessibilityRenderObject>(*parent).node();
2823         if (!is<Element>(node))
2824             continue;
2825         
2826         // If native tag of the parent element matches an acceptable name, then return
2827         // based on its presentational status.
2828         if (possibleParentTagNames->contains(downcast<Element>(node)->tagQName()))
2829             return parent->roleValue() == PresentationalRole;
2830     }
2831     
2832     return false;
2833 }
2834     
2835 bool AccessibilityRenderObject::isPresentationalChildOfAriaRole() const
2836 {
2837     // Walk the parent chain looking for a parent that has presentational children
2838     AccessibilityObject* parent;
2839     for (parent = parentObject(); parent && !parent->ariaRoleHasPresentationalChildren(); parent = parent->parentObject())
2840     { }
2841     
2842     return parent;
2843 }
2844     
2845 bool AccessibilityRenderObject::ariaRoleHasPresentationalChildren() const
2846 {
2847     switch (m_ariaRole) {
2848     case ButtonRole:
2849     case SliderRole:
2850     case ImageRole:
2851     case ProgressIndicatorRole:
2852     case SpinButtonRole:
2853     // case SeparatorRole:
2854         return true;
2855     default:
2856         return false;
2857     }
2858 }
2859
2860 bool AccessibilityRenderObject::canSetExpandedAttribute() const
2861 {
2862     if (roleValue() == DetailsRole)
2863         return true;
2864     
2865     // An object can be expanded if it aria-expanded is true or false.
2866     const AtomicString& ariaExpanded = getAttribute(aria_expandedAttr);
2867     return equalLettersIgnoringASCIICase(ariaExpanded, "true") || equalLettersIgnoringASCIICase(ariaExpanded, "false");
2868 }
2869
2870 bool AccessibilityRenderObject::canSetTextRangeAttributes() const
2871 {
2872     return isTextControl();
2873 }
2874
2875 void AccessibilityRenderObject::textChanged()
2876 {
2877     // If this element supports ARIA live regions, or is part of a region with an ARIA editable role,
2878     // then notify the AT of changes.
2879     AXObjectCache* cache = axObjectCache();
2880     if (!cache)
2881         return;
2882     
2883     for (RenderObject* renderParent = m_renderer; renderParent; renderParent = renderParent->parent()) {
2884         AccessibilityObject* parent = cache->get(renderParent);
2885         if (!parent)
2886             continue;
2887         
2888         if (parent->supportsARIALiveRegion())
2889             cache->postNotification(renderParent, AXObjectCache::AXLiveRegionChanged);
2890
2891         if (parent->isNonNativeTextControl())
2892             cache->postNotification(renderParent, AXObjectCache::AXValueChanged);
2893     }
2894 }
2895
2896 void AccessibilityRenderObject::clearChildren()
2897 {
2898     AccessibilityObject::clearChildren();
2899     m_childrenDirty = false;
2900 }
2901
2902 void AccessibilityRenderObject::addImageMapChildren()
2903 {
2904     RenderBoxModelObject* cssBox = renderBoxModelObject();
2905     if (!is<RenderImage>(cssBox))
2906         return;
2907     
2908     HTMLMapElement* map = downcast<RenderImage>(*cssBox).imageMap();
2909     if (!map)
2910         return;
2911
2912     for (auto& area : descendantsOfType<HTMLAreaElement>(*map)) {
2913         // add an <area> element for this child if it has a link
2914         if (!area.isLink())
2915             continue;
2916         auto& areaObject = downcast<AccessibilityImageMapLink>(*axObjectCache()->getOrCreate(ImageMapLinkRole));
2917         areaObject.setHTMLAreaElement(&area);
2918         areaObject.setHTMLMapElement(map);
2919         areaObject.setParent(this);
2920         if (!areaObject.accessibilityIsIgnored())
2921             m_children.append(&areaObject);
2922         else
2923             axObjectCache()->remove(areaObject.axObjectID());
2924     }
2925 }
2926
2927 void AccessibilityRenderObject::updateChildrenIfNecessary()
2928 {
2929     if (needsToUpdateChildren())
2930         clearChildren();        
2931     
2932     AccessibilityObject::updateChildrenIfNecessary();
2933 }
2934     
2935 void AccessibilityRenderObject::addTextFieldChildren()
2936 {
2937     Node* node = this->node();
2938     if (!is<HTMLInputElement>(node))
2939         return;
2940     
2941     HTMLInputElement& input = downcast<HTMLInputElement>(*node);
2942     if (HTMLElement* autoFillElement = input.autoFillButtonElement()) {
2943         if (AccessibilityObject* axAutoFill = axObjectCache()->getOrCreate(autoFillElement))
2944             m_children.append(axAutoFill);
2945     }
2946     
2947     HTMLElement* spinButtonElement = input.innerSpinButtonElement();
2948     if (!is<SpinButtonElement>(spinButtonElement))
2949         return;
2950
2951     auto& axSpinButton = downcast<AccessibilitySpinButton>(*axObjectCache()->getOrCreate(SpinButtonRole));
2952     axSpinButton.setSpinButtonElement(downcast<SpinButtonElement>(spinButtonElement));
2953     axSpinButton.setParent(this);
2954     m_children.append(&axSpinButton);
2955 }
2956     
2957 bool AccessibilityRenderObject::isSVGImage() const
2958 {
2959     return remoteSVGRootElement();
2960 }
2961     
2962 void AccessibilityRenderObject::detachRemoteSVGRoot()
2963 {
2964     if (AccessibilitySVGRoot* root = remoteSVGRootElement())
2965         root->setParent(nullptr);
2966 }
2967
2968 AccessibilitySVGRoot* AccessibilityRenderObject::remoteSVGRootElement() const
2969 {
2970     if (!is<RenderImage>(m_renderer))
2971         return nullptr;
2972     
2973     CachedImage* cachedImage = downcast<RenderImage>(*m_renderer).cachedImage();
2974     if (!cachedImage)
2975         return nullptr;
2976     
2977     Image* image = cachedImage->image();
2978     if (!is<SVGImage>(image))
2979         return nullptr;
2980     
2981     FrameView* frameView = downcast<SVGImage>(*image).frameView();
2982     if (!frameView)
2983         return nullptr;
2984     Frame& frame = frameView->frame();
2985     
2986     Document* document = frame.document();
2987     if (!is<SVGDocument>(document))
2988         return nullptr;
2989     
2990     SVGSVGElement* rootElement = downcast<SVGDocument>(*document).rootElement();
2991     if (!rootElement)
2992         return nullptr;
2993     RenderObject* rendererRoot = rootElement->renderer();
2994     if (!rendererRoot)
2995         return nullptr;
2996     
2997     AXObjectCache* cache = frame.document()->axObjectCache();
2998     if (!cache)
2999         return nullptr;
3000     AccessibilityObject* rootSVGObject = cache->getOrCreate(rendererRoot);
3001
3002     // In order to connect the AX hierarchy from the SVG root element from the loaded resource
3003     // the parent must be set, because there's no other way to get back to who created the image.
3004     ASSERT(rootSVGObject);
3005     if (!is<AccessibilitySVGRoot>(*rootSVGObject))
3006         return nullptr;
3007     
3008     return downcast<AccessibilitySVGRoot>(rootSVGObject);
3009 }
3010     
3011 void AccessibilityRenderObject::addRemoteSVGChildren()
3012 {
3013     AccessibilitySVGRoot* root = remoteSVGRootElement();
3014     if (!root)
3015         return;
3016     
3017     root->setParent(this);
3018     
3019     if (root->accessibilityIsIgnored()) {
3020         for (const auto& child : root->children())
3021             m_children.append(child);
3022     } else
3023         m_children.append(root);
3024 }
3025
3026 void AccessibilityRenderObject::addCanvasChildren()
3027 {
3028     // Add the unrendered canvas children as AX nodes, unless we're not using a canvas renderer
3029     // because JS is disabled for example.
3030     if (!node() || !node()->hasTagName(canvasTag) || (renderer() && !renderer()->isCanvas()))
3031         return;
3032
3033     // If it's a canvas, it won't have rendered children, but it might have accessible fallback content.
3034     // Clear m_haveChildren because AccessibilityNodeObject::addChildren will expect it to be false.
3035     ASSERT(!m_children.size());
3036     m_haveChildren = false;
3037     AccessibilityNodeObject::addChildren();
3038 }
3039
3040 void AccessibilityRenderObject::addAttachmentChildren()
3041 {
3042     if (!isAttachment())
3043         return;
3044
3045     // FrameView's need to be inserted into the AX hierarchy when encountered.
3046     Widget* widget = widgetForAttachmentView();
3047     if (!widget || !widget->isFrameView())
3048         return;
3049     
3050     AccessibilityObject* axWidget = axObjectCache()->getOrCreate(widget);
3051     if (!axWidget->accessibilityIsIgnored())
3052         m_children.append(axWidget);
3053 }
3054
3055 #if PLATFORM(COCOA)
3056 void AccessibilityRenderObject::updateAttachmentViewParents()
3057 {
3058     // Only the unignored parent should set the attachment parent, because that's what is reflected in the AX 
3059     // hierarchy to the client.
3060     if (accessibilityIsIgnored())
3061         return;
3062     
3063     for (const auto& child : m_children) {
3064         if (child->isAttachment())
3065             child->overrideAttachmentParent(this);
3066     }
3067 }
3068 #endif
3069
3070 // Hidden children are those that are not rendered or visible, but are specifically marked as aria-hidden=false,
3071 // meaning that they should be exposed to the AX hierarchy.
3072 void AccessibilityRenderObject::addHiddenChildren()
3073 {
3074     Node* node = this->node();
3075     if (!node)
3076         return;
3077     
3078     // First do a quick run through to determine if we have any hidden nodes (most often we will not).
3079     // If we do have hidden nodes, we need to determine where to insert them so they match DOM order as close as possible.
3080     bool shouldInsertHiddenNodes = false;
3081     for (Node* child = node->firstChild(); child; child = child->nextSibling()) {
3082         if (!child->renderer() && isNodeAriaVisible(child)) {
3083             shouldInsertHiddenNodes = true;
3084             break;
3085         }
3086     }
3087     
3088     if (!shouldInsertHiddenNodes)
3089         return;
3090     
3091     // Iterate through all of the children, including those that may have already been added, and
3092     // try to insert hidden nodes in the correct place in the DOM order.
3093     unsigned insertionIndex = 0;
3094     for (Node* child = node->firstChild(); child; child = child->nextSibling()) {
3095         if (child->renderer()) {
3096             // Find out where the last render sibling is located within m_children.
3097             AccessibilityObject* childObject = axObjectCache()->get(child->renderer());
3098             if (childObject && childObject->accessibilityIsIgnored()) {
3099                 auto& children = childObject->children();
3100                 if (children.size())
3101                     childObject = children.last().get();
3102                 else
3103                     childObject = nullptr;
3104             }
3105
3106             if (childObject)
3107                 insertionIndex = m_children.find(childObject) + 1;
3108             continue;
3109         }
3110
3111         if (!isNodeAriaVisible(child))
3112             continue;
3113         
3114         unsigned previousSize = m_children.size();
3115         if (insertionIndex > previousSize)
3116             insertionIndex = previousSize;
3117         
3118         insertChild(axObjectCache()->getOrCreate(child), insertionIndex);
3119         insertionIndex += (m_children.size() - previousSize);
3120     }
3121 }
3122     
3123 void AccessibilityRenderObject::updateRoleAfterChildrenCreation()
3124 {
3125     // If a menu does not have valid menuitem children, it should not be exposed as a menu.
3126     if (roleValue() == MenuRole) {
3127         // Elements marked as menus must have at least one menu item child.
3128         size_t menuItemCount = 0;
3129         for (const auto& child : children()) {
3130             if (child->isMenuItem()) {
3131                 menuItemCount++;
3132                 break;
3133             }
3134         }
3135
3136         if (!menuItemCount)
3137             m_role = GroupRole;
3138     }
3139 }
3140     
3141 void AccessibilityRenderObject::addChildren()
3142 {
3143     // If the need to add more children in addition to existing children arises, 
3144     // childrenChanged should have been called, leaving the object with no children.
3145     ASSERT(!m_haveChildren); 
3146
3147     m_haveChildren = true;
3148     
3149     if (!canHaveChildren())
3150         return;
3151     
3152     for (RefPtr<AccessibilityObject> obj = firstChild(); obj; obj = obj->nextSibling())
3153         addChild(obj.get());
3154     
3155     addHiddenChildren();
3156     addAttachmentChildren();
3157     addImageMapChildren();
3158     addTextFieldChildren();
3159     addCanvasChildren();
3160     addRemoteSVGChildren();
3161     
3162 #if PLATFORM(COCOA)
3163     updateAttachmentViewParents();
3164 #endif
3165     
3166     updateRoleAfterChildrenCreation();
3167 }
3168
3169 bool AccessibilityRenderObject::canHaveChildren() const
3170 {
3171     if (!m_renderer)
3172         return false;
3173
3174     return AccessibilityNodeObject::canHaveChildren();
3175 }
3176
3177 const String AccessibilityRenderObject::ariaLiveRegionStatus() const
3178 {
3179     const AtomicString& liveRegionStatus = getAttribute(aria_liveAttr);
3180     // These roles have implicit live region status.
3181     if (liveRegionStatus.isEmpty())
3182         return defaultLiveRegionStatusForRole(roleValue());
3183
3184     return liveRegionStatus;
3185 }
3186
3187 const AtomicString& AccessibilityRenderObject::ariaLiveRegionRelevant() const
3188 {
3189     static NeverDestroyed<const AtomicString> defaultLiveRegionRelevant("additions text", AtomicString::ConstructFromLiteral);
3190     const AtomicString& relevant = getAttribute(aria_relevantAttr);
3191
3192     // Default aria-relevant = "additions text".
3193     if (relevant.isEmpty())
3194         return defaultLiveRegionRelevant;
3195     
3196     return relevant;
3197 }
3198
3199 bool AccessibilityRenderObject::ariaLiveRegionAtomic() const
3200 {
3201     const AtomicString& atomic = getAttribute(aria_atomicAttr);
3202     if (equalLettersIgnoringASCIICase(atomic, "true"))
3203         return true;
3204     if (equalLettersIgnoringASCIICase(atomic, "false"))
3205         return false;
3206
3207     // WAI-ARIA "alert" and "status" roles have an implicit aria-atomic value of true.
3208     switch (roleValue()) {
3209     case ApplicationAlertRole:
3210     case ApplicationStatusRole:
3211         return true;
3212     default:
3213         return false;
3214     }
3215 }
3216
3217 bool AccessibilityRenderObject::ariaLiveRegionBusy() const
3218 {
3219     return elementAttributeValue(aria_busyAttr);    
3220 }
3221     
3222 void AccessibilityRenderObject::ariaSelectedRows(AccessibilityChildrenVector& result)
3223 {
3224     // Determine which rows are selected.
3225     bool isMulti = isMultiSelectable();
3226
3227     // Prefer active descendant over aria-selected.
3228     AccessibilityObject* activeDesc = activeDescendant();
3229     if (activeDesc && (activeDesc->isTreeItem() || activeDesc->isTableRow())) {
3230         result.append(activeDesc);    
3231         if (!isMulti)
3232             return;
3233     }
3234
3235     // Get all the rows.
3236     auto rowsIteration = [&](const AccessibilityChildrenVector& rows) {
3237         for (auto& row : rows) {
3238             if (row->isSelected()) {
3239                 result.append(row);
3240                 if (!isMulti)
3241                     break;
3242             }
3243         }
3244     };
3245     if (isTree()) {
3246         AccessibilityChildrenVector allRows;
3247         ariaTreeRows(allRows);
3248         rowsIteration(allRows);
3249     } else if (is<AccessibilityTable>(*this)) {
3250         auto& thisTable = downcast<AccessibilityTable>(*this);
3251         if (thisTable.isExposableThroughAccessibility() && thisTable.supportsSelectedRows())
3252             rowsIteration(thisTable.rows());
3253     }
3254 }
3255     
3256 void AccessibilityRenderObject::ariaListboxSelectedChildren(AccessibilityChildrenVector& result)
3257 {
3258     bool isMulti = isMultiSelectable();
3259
3260     for (const auto& child : children()) {
3261         // Every child should have aria-role option, and if so, check for selected attribute/state.
3262         if (child->isSelected() && child->ariaRoleAttribute() == ListBoxOptionRole) {
3263             result.append(child);
3264             if (!isMulti)
3265                 return;
3266         }
3267     }
3268 }
3269
3270 void AccessibilityRenderObject::selectedChildren(AccessibilityChildrenVector& result)
3271 {
3272     ASSERT(result.isEmpty());
3273
3274     // only listboxes should be asked for their selected children. 
3275     AccessibilityRole role = roleValue();
3276     if (role == ListBoxRole) // native list boxes would be AccessibilityListBoxes, so only check for aria list boxes
3277         ariaListboxSelectedChildren(result);
3278     else if (role == TreeRole || role == TreeGridRole || role == TableRole || role == GridRole)
3279         ariaSelectedRows(result);
3280 }
3281
3282 void AccessibilityRenderObject::ariaListboxVisibleChildren(AccessibilityChildrenVector& result)      
3283 {
3284     if (!hasChildren())
3285         addChildren();
3286     
3287     for (const auto& child : children()) {
3288         if (child->isOffScreen())
3289             result.append(child);
3290     }
3291 }
3292
3293 void AccessibilityRenderObject::visibleChildren(AccessibilityChildrenVector& result)
3294 {
3295     ASSERT(result.isEmpty());
3296         
3297     // only listboxes are asked for their visible children. 
3298     if (ariaRoleAttribute() != ListBoxRole) { // native list boxes would be AccessibilityListBoxes, so only check for aria list boxes
3299         ASSERT_NOT_REACHED();
3300         return;
3301     }
3302     return ariaListboxVisibleChildren(result);
3303 }
3304  
3305 void AccessibilityRenderObject::tabChildren(AccessibilityChildrenVector& result)
3306 {
3307     ASSERT(roleValue() == TabListRole);
3308     
3309     for (const auto& child : children()) {
3310         if (child->isTabItem())
3311             result.append(child);
3312     }
3313 }
3314     
3315 const String& AccessibilityRenderObject::actionVerb() const
3316 {
3317 #if !PLATFORM(IOS)
3318     // FIXME: Need to add verbs for select elements.
3319     static NeverDestroyed<const String> buttonAction(AXButtonActionVerb());
3320     static NeverDestroyed<const String> textFieldAction(AXTextFieldActionVerb());
3321     static NeverDestroyed<const String> radioButtonAction(AXRadioButtonActionVerb());
3322     static NeverDestroyed<const String> checkedCheckBoxAction(AXUncheckedCheckBoxActionVerb());
3323     static NeverDestroyed<const String> uncheckedCheckBoxAction(AXUncheckedCheckBoxActionVerb());
3324     static NeverDestroyed<const String> linkAction(AXLinkActionVerb());
3325
3326     switch (roleValue()) {
3327     case ButtonRole:
3328     case ToggleButtonRole:
3329         return buttonAction;
3330     case TextFieldRole:
3331     case TextAreaRole:
3332         return textFieldAction;
3333     case RadioButtonRole:
3334         return radioButtonAction;
3335     case CheckBoxRole:
3336         return isChecked() ? checkedCheckBoxAction : uncheckedCheckBoxAction;
3337     case LinkRole:
3338     case WebCoreLinkRole:
3339         return linkAction;
3340     default:
3341         return nullAtom;
3342     }
3343 #else
3344     return nullAtom;
3345 #endif
3346 }
3347     
3348 void AccessibilityRenderObject::setAccessibleName(const AtomicString& name)
3349 {
3350     // Setting the accessible name can store the value in the DOM
3351     if (!m_renderer)
3352         return;
3353
3354     Node* node = nullptr;
3355     // For web areas, set the aria-label on the HTML element.
3356     if (isWebArea())
3357         node = m_renderer->document().documentElement();
3358     else
3359         node = m_renderer->node();
3360
3361     if (is<Element>(node))
3362         downcast<Element>(*node).setAttribute(aria_labelAttr, name);
3363 }
3364     
3365 static bool isLinkable(const AccessibilityRenderObject& object)
3366 {
3367     if (!object.renderer())
3368         return false;
3369
3370     // See https://wiki.mozilla.org/Accessibility/AT-Windows-API for the elements
3371     // Mozilla considers linkable.
3372     return object.isLink() || object.isImage() || object.renderer()->isText();
3373 }
3374
3375 String AccessibilityRenderObject::stringValueForMSAA() const
3376 {
3377     if (isLinkable(*this)) {
3378         Element* anchor = anchorElement();
3379         if (is<HTMLAnchorElement>(anchor))
3380             return downcast<HTMLAnchorElement>(*anchor).href();
3381     }
3382
3383     return stringValue();
3384 }
3385
3386 bool AccessibilityRenderObject::isLinked() const
3387 {
3388     if (!isLinkable(*this))
3389         return false;
3390
3391     Element* anchor = anchorElement();
3392     if (!is<HTMLAnchorElement>(anchor))
3393         return false;
3394
3395     return !downcast<HTMLAnchorElement>(*anchor).href().isEmpty();
3396 }
3397
3398 bool AccessibilityRenderObject::hasBoldFont() const
3399 {
3400     if (!m_renderer)
3401         return false;
3402     
3403     return m_renderer->style().fontDescription().weight() >= FontWeightBold;
3404 }
3405
3406 bool AccessibilityRenderObject::hasItalicFont() const
3407 {
3408     if (!m_renderer)
3409         return false;
3410     
3411     return m_renderer->style().fontDescription().italic() == FontItalicOn;
3412 }
3413
3414 bool AccessibilityRenderObject::hasPlainText() const
3415 {
3416     if (!m_renderer)
3417         return false;
3418     
3419     const RenderStyle& style = m_renderer->style();
3420     
3421     return style.fontDescription().weight() == FontWeightNormal
3422         && style.fontDescription().italic() == FontItalicOff
3423         && style.textDecorationsInEffect() == TextDecorationNone;
3424 }
3425
3426 bool AccessibilityRenderObject::hasSameFont(RenderObject* renderer) const
3427 {
3428     if (!m_renderer || !renderer)
3429         return false;
3430     
3431     return m_renderer->style().fontDescription().families() == renderer->style().fontDescription().families();
3432 }
3433
3434 bool AccessibilityRenderObject::hasSameFontColor(RenderObject* renderer) const
3435 {
3436     if (!m_renderer || !renderer)
3437         return false;
3438     
3439     return m_renderer->style().visitedDependentColor(CSSPropertyColor) == renderer->style().visitedDependentColor(CSSPropertyColor);
3440 }
3441
3442 bool AccessibilityRenderObject::hasSameStyle(RenderObject* renderer) const
3443 {
3444     if (!m_renderer || !renderer)
3445         return false;
3446     
3447     return m_renderer->style() == renderer->style();
3448 }
3449
3450 bool AccessibilityRenderObject::hasUnderline() const
3451 {
3452     if (!m_renderer)
3453         return false;
3454     
3455     return m_renderer->style().textDecorationsInEffect() & TextDecorationUnderline;
3456 }
3457
3458 String AccessibilityRenderObject::nameForMSAA() const
3459 {
3460     if (m_renderer && m_renderer->isText())
3461         return textUnderElement();
3462
3463     return title();
3464 }
3465
3466 static bool shouldReturnTagNameAsRoleForMSAA(const Element& element)
3467 {
3468     // See "document structure",
3469     // https://wiki.mozilla.org/Accessibility/AT-Windows-API
3470     // FIXME: Add the other tag names that should be returned as the role.
3471     return element.hasTagName(h1Tag) || element.hasTagName(h2Tag) 
3472         || element.hasTagName(h3Tag) || element.hasTagName(h4Tag)
3473         || element.hasTagName(h5Tag) || element.hasTagName(h6Tag);
3474 }
3475
3476 String AccessibilityRenderObject::stringRoleForMSAA() const
3477 {
3478     if (!m_renderer)
3479         return String();
3480
3481     Node* node = m_renderer->node();
3482     if (!is<Element>(node))
3483         return String();
3484
3485     Element& element = downcast<Element>(*node);
3486     if (!shouldReturnTagNameAsRoleForMSAA(element))
3487         return String();
3488
3489     return element.tagName();
3490 }
3491
3492 String AccessibilityRenderObject::positionalDescriptionForMSAA() const
3493 {
3494     // See "positional descriptions",
3495     // https://wiki.mozilla.org/Accessibility/AT-Windows-API
3496     if (isHeading())
3497         return "L" + String::number(headingLevel());
3498
3499     // FIXME: Add positional descriptions for other elements.
3500     return String();
3501 }
3502
3503 String AccessibilityRenderObject::descriptionForMSAA() const
3504 {
3505     String description = positionalDescriptionForMSAA();
3506     if (!description.isEmpty())
3507         return description;
3508
3509     description = accessibilityDescription();
3510     if (!description.isEmpty()) {
3511         // From the Mozilla MSAA implementation:
3512         // "Signal to screen readers that this description is speakable and is not
3513         // a formatted positional information description. Don't localize the
3514         // 'Description: ' part of this string, it will be parsed out by assistive
3515         // technologies."
3516         return "Description: " + description;
3517     }
3518
3519     return String();
3520 }
3521
3522 static AccessibilityRole msaaRoleForRenderer(const RenderObject* renderer)
3523 {
3524     if (!renderer)
3525         return UnknownRole;
3526
3527     if (is<RenderText>(*renderer))
3528         return EditableTextRole;
3529
3530     if (is<RenderListItem>(*renderer))
3531         return ListItemRole;
3532
3533     return UnknownRole;
3534 }
3535
3536 AccessibilityRole AccessibilityRenderObject::roleValueForMSAA() const
3537 {
3538     if (m_roleForMSAA != UnknownRole)
3539         return m_roleForMSAA;
3540
3541     m_roleForMSAA = msaaRoleForRenderer(m_renderer);
3542
3543     if (m_roleForMSAA == UnknownRole)
3544         m_roleForMSAA = roleValue();
3545
3546     return m_roleForMSAA;
3547 }
3548
3549 String AccessibilityRenderObject::passwordFieldValue() const
3550 {
3551     ASSERT(isPasswordField());
3552
3553     // Look for the RenderText object in the RenderObject tree for this input field.
3554     RenderObject* renderer = node()->renderer();
3555     while (renderer && !is<RenderText>(renderer))
3556         renderer = downcast<RenderElement>(*renderer).firstChild();
3557
3558     if (!is<RenderText>(renderer))
3559         return String();
3560
3561     // Return the text that is actually being rendered in the input field.
3562     return downcast<RenderText>(*renderer).textWithoutConvertingBackslashToYenSymbol();
3563 }
3564
3565 ScrollableArea* AccessibilityRenderObject::getScrollableAreaIfScrollable() const
3566 {
3567     // If the parent is a scroll view, then this object isn't really scrollable, the parent ScrollView should handle the scrolling.
3568     if (parentObject() && parentObject()->isAccessibilityScrollView())
3569         return nullptr;
3570
3571     if (!is<RenderBox>(m_renderer))
3572         return nullptr;
3573
3574     auto& box = downcast<RenderBox>(*m_renderer);
3575     if (!box.canBeScrolledAndHasScrollableArea())
3576         return nullptr;
3577
3578     return box.layer();
3579 }
3580
3581 void AccessibilityRenderObject::scrollTo(const IntPoint& point) const
3582 {
3583     if (!is<RenderBox>(m_renderer))
3584         return;
3585
3586     auto& box = downcast<RenderBox>(*m_renderer);
3587     if (!box.canBeScrolledAndHasScrollableArea())
3588         return;
3589
3590     // FIXME: is point a ScrollOffset or ScrollPosition? Test in RTL overflow.
3591     box.layer()->scrollToOffset(point, RenderLayer::ScrollOffsetClamped);
3592 }
3593
3594 #if ENABLE(MATHML)
3595 bool AccessibilityRenderObject::isMathElement() const
3596 {
3597     if (!m_renderer)
3598         return false;
3599     
3600     return is<MathMLElement>(node());
3601 }
3602
3603 bool AccessibilityRenderObject::isMathFraction() const
3604 {
3605     return m_renderer && m_renderer->isRenderMathMLFraction();
3606 }
3607
3608 bool AccessibilityRenderObject::isMathFenced() const
3609 {
3610     return m_renderer && m_renderer->isRenderMathMLFenced();
3611 }
3612
3613 bool AccessibilityRenderObject::isMathSubscriptSuperscript() const
3614 {
3615     return m_renderer && m_renderer->isRenderMathMLScripts() && !isMathMultiscript();
3616 }
3617
3618 bool AccessibilityRenderObject::isMathRow() const
3619 {
3620     return m_renderer && m_renderer->isRenderMathMLRow();
3621 }
3622
3623 bool AccessibilityRenderObject::isMathUnderOver() const
3624 {
3625     return m_renderer && m_renderer->isRenderMathMLUnderOver();
3626 }
3627
3628 bool AccessibilityRenderObject::isMathSquareRoot() const
3629 {
3630     return m_renderer && m_renderer->isRenderMathMLSquareRoot();
3631 }
3632     
3633 bool AccessibilityRenderObject::isMathToken() const
3634 {
3635     return m_renderer && m_renderer->isRenderMathMLToken();
3636 }
3637
3638 bool AccessibilityRenderObject::isMathRoot() const
3639 {
3640     return m_renderer && m_renderer->isRenderMathMLRoot();
3641 }
3642
3643 bool AccessibilityRenderObject::isMathOperator() const
3644 {
3645     if (!m_renderer || !m_renderer->isRenderMathMLOperator())
3646         return false;
3647
3648     return true;
3649 }
3650
3651 bool AccessibilityRenderObject::isMathFenceOperator() const
3652 {
3653     if (!is<RenderMathMLOperator>(m_renderer))
3654         return false;
3655
3656     return downcast<RenderMathMLOperator>(*m_renderer).hasOperatorFlag(MathMLOperatorDictionary::Fence);
3657 }
3658
3659 bool AccessibilityRenderObject::isMathSeparatorOperator() const
3660 {
3661     if (!is<RenderMathMLOperator>(m_renderer))
3662         return false;
3663
3664     return downcast<RenderMathMLOperator>(*m_renderer).hasOperatorFlag(MathMLOperatorDictionary::Separator);
3665 }
3666     
3667 bool AccessibilityRenderObject::isMathText() const
3668 {
3669     return node() && (node()->hasTagName(MathMLNames::mtextTag) || hasTagName(MathMLNames::msTag));
3670 }
3671
3672 bool AccessibilityRenderObject::isMathNumber() const
3673 {
3674     return node() && node()->hasTagName(MathMLNames::mnTag);
3675 }
3676
3677 bool AccessibilityRenderObject::isMathIdentifier() const
3678 {
3679     return node() && node()->hasTagName(MathMLNames::miTag);
3680 }
3681
3682 bool AccessibilityRenderObject::isMathMultiscript() const
3683 {
3684     return node() && node()->hasTagName(MathMLNames::mmultiscriptsTag);
3685 }
3686     
3687 bool AccessibilityRenderObject::isMathTable() const
3688 {
3689     return node() && node()->hasTagName(MathMLNames::mtableTag);
3690 }
3691
3692 bool AccessibilityRenderObject::isMathTableRow() const
3693 {
3694     return node() && (node()->hasTagName(MathMLNames::mtrTag) || hasTagName(MathMLNames::mlabeledtrTag));
3695 }
3696
3697 bool AccessibilityRenderObject::isMathTableCell() const
3698 {
3699     return node() && node()->hasTagName(MathMLNames::mtdTag);
3700 }
3701
3702 bool AccessibilityRenderObject::isMathScriptObject(AccessibilityMathScriptObjectType type) const
3703 {
3704     AccessibilityObject* parent = parentObjectUnignored();
3705     if (!parent)
3706         return false;
3707
3708     return type == Subscript ? this == parent->mathSubscriptObject() : this == parent->mathSuperscriptObject();
3709 }
3710
3711 bool AccessibilityRenderObject::isMathMultiscriptObject(AccessibilityMathMultiscriptObjectType type) const
3712 {
3713     AccessibilityObject* parent = parentObjectUnignored();
3714     if (!parent || !parent->isMathMultiscript())
3715         return false;
3716
3717     // The scripts in a MathML <mmultiscripts> element consist of one or more
3718     // subscript, superscript pairs. In order to determine if this object is
3719     // a scripted token, we need to examine each set of pairs to see if the
3720     // this token is present and in the position corresponding with the type.
3721
3722     AccessibilityMathMultiscriptPairs pairs;
3723     if (type == PreSubscript || type == PreSuperscript)
3724         parent->mathPrescripts(pairs);
3725     else
3726         parent->mathPostscripts(pairs);
3727
3728     for (const auto& pair : pairs) {
3729         if (this == pair.first)
3730             return (type == PreSubscript || type == PostSubscript);
3731         if (this == pair.second)
3732             return (type == PreSuperscript || type == PostSuperscript);
3733     }
3734
3735     return false;
3736 }
3737     
3738 bool AccessibilityRenderObject::isIgnoredElementWithinMathTree() const
3739 {
3740     if (!m_renderer)
3741         return true;
3742     
3743     // We ignore anonymous renderers inside math blocks.
3744     // However, we do not exclude anonymous RenderMathMLOperator nodes created by the mfenced element nor RenderText nodes created by math operators so that the text can be exposed by AccessibilityRenderObject::textUnderElement.
3745     if (m_renderer->isAnonymous()) {
3746         if (m_renderer->isRenderMathMLOperator())
3747             return false;
3748         for (AccessibilityObject* parent = parentObject(); parent; parent = parent->parentObject()) {
3749             if (parent->isMathElement())
3750                 return !(m_renderer->isText() && ancestorsOfType<RenderMathMLOperator>(*m_renderer).first());
3751         }
3752     }
3753
3754     // Only math elements that we explicitly recognize should be included
3755     // We don't want things like <mstyle> to appear in the tree.
3756     if (isMathElement()) {
3757         if (isMathFraction() || isMathFenced() || isMathSubscriptSuperscript() || isMathRow()
3758             || isMathUnderOver() || isMathRoot() || isMathText() || isMathNumber()
3759             || isMathOperator() || isMathFenceOperator() || isMathSeparatorOperator()
3760             || isMathIdentifier() || isMathTable() || isMathTableRow() || isMathTableCell() || isMathMultiscript())
3761             return false;
3762         return true;
3763     }
3764
3765     return false;
3766 }
3767
3768 AccessibilityObject* AccessibilityRenderObject::mathRadicandObject()
3769 {
3770     if (!isMathRoot())
3771         return nullptr;
3772     RenderMathMLRoot* root = &downcast<RenderMathMLRoot>(*m_renderer);
3773     AccessibilityObject* rootRadicandWrapper = axObjectCache()->getOrCreate(root->baseWrapper());
3774     if (!rootRadicandWrapper)
3775         return nullptr;
3776     AccessibilityObject* rootRadicand = rootRadicandWrapper->children().first().get();
3777     ASSERT(rootRadicand && children().contains(rootRadicand));
3778     return rootRadicand;
3779 }
3780
3781 AccessibilityObject* AccessibilityRenderObject::mathRootIndexObject()
3782 {
3783     if (!isMathRoot())
3784         return nullptr;
3785     RenderMathMLRoot* root = &downcast<RenderMathMLRoot>(*m_renderer);
3786     AccessibilityObject* rootIndexWrapper = axObjectCache()->getOrCreate(root->indexWrapper());
3787     if (!rootIndexWrapper)
3788         return nullptr;
3789     AccessibilityObject* rootIndex = rootIndexWrapper->children().first().get();
3790     ASSERT(rootIndex && children().contains(rootIndex));
3791     return rootIndex;
3792 }
3793
3794 AccessibilityObject* AccessibilityRenderObject::mathNumeratorObject()
3795 {