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