Use downcast<SVG*Element>() instead of toSVG*Element()
[WebKit-https.git] / Source / WebCore / accessibility / AccessibilityNodeObject.cpp
1 /*
2 * Copyright (C) 2012, Google 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 "AccessibilityNodeObject.h"
31
32 #include "AXObjectCache.h"
33 #include "AccessibilityImageMapLink.h"
34 #include "AccessibilityListBox.h"
35 #include "AccessibilitySpinButton.h"
36 #include "AccessibilityTable.h"
37 #include "ElementIterator.h"
38 #include "EventNames.h"
39 #include "FloatRect.h"
40 #include "Frame.h"
41 #include "FrameLoader.h"
42 #include "FrameSelection.h"
43 #include "FrameView.h"
44 #include "HTMLAreaElement.h"
45 #include "HTMLFieldSetElement.h"
46 #include "HTMLFormElement.h"
47 #include "HTMLFrameElementBase.h"
48 #include "HTMLImageElement.h"
49 #include "HTMLInputElement.h"
50 #include "HTMLLabelElement.h"
51 #include "HTMLLegendElement.h"
52 #include "HTMLMapElement.h"
53 #include "HTMLNames.h"
54 #include "HTMLOptGroupElement.h"
55 #include "HTMLOptionElement.h"
56 #include "HTMLOptionsCollection.h"
57 #include "HTMLParserIdioms.h"
58 #include "HTMLPlugInImageElement.h"
59 #include "HTMLSelectElement.h"
60 #include "HTMLTextAreaElement.h"
61 #include "HTMLTextFormControlElement.h"
62 #include "HitTestRequest.h"
63 #include "HitTestResult.h"
64 #include "LabelableElement.h"
65 #include "LocalizedStrings.h"
66 #include "MathMLNames.h"
67 #include "NodeList.h"
68 #include "NodeTraversal.h"
69 #include "Page.h"
70 #include "ProgressTracker.h"
71 #include "RenderImage.h"
72 #include "RenderView.h"
73 #include "SVGElement.h"
74 #include "SVGNames.h"
75 #include "Text.h"
76 #include "TextControlInnerElements.h"
77 #include "UserGestureIndicator.h"
78 #include "VisibleUnits.h"
79 #include "Widget.h"
80 #include "htmlediting.h"
81 #include <wtf/StdLibExtras.h>
82 #include <wtf/text/StringBuilder.h>
83 #include <wtf/unicode/CharacterNames.h>
84
85 namespace WebCore {
86
87 using namespace HTMLNames;
88
89 static String accessibleNameForNode(Node*);
90
91 AccessibilityNodeObject::AccessibilityNodeObject(Node* node)
92     : AccessibilityObject()
93     , m_ariaRole(UnknownRole)
94     , m_childrenDirty(false)
95     , m_roleForMSAA(UnknownRole)
96 #ifndef NDEBUG
97     , m_initialized(false)
98 #endif
99     , m_node(node)
100 {
101 }
102
103 AccessibilityNodeObject::~AccessibilityNodeObject()
104 {
105     ASSERT(isDetached());
106 }
107
108 void AccessibilityNodeObject::init()
109 {
110 #ifndef NDEBUG
111     ASSERT(!m_initialized);
112     m_initialized = true;
113 #endif
114     m_role = determineAccessibilityRole();
115 }
116
117 PassRefPtr<AccessibilityNodeObject> AccessibilityNodeObject::create(Node* node)
118 {
119     return adoptRef(new AccessibilityNodeObject(node));
120 }
121
122 void AccessibilityNodeObject::detach(AccessibilityDetachmentType detachmentType, AXObjectCache* cache)
123 {
124     // AccessibilityObject calls clearChildren.
125     AccessibilityObject::detach(detachmentType, cache);
126     m_node = nullptr;
127 }
128
129 void AccessibilityNodeObject::childrenChanged()
130 {
131     // This method is meant as a quick way of marking a portion of the accessibility tree dirty.
132     if (!node() && !renderer())
133         return;
134
135     AXObjectCache* cache = axObjectCache();
136     if (!cache)
137         return;
138     cache->postNotification(this, document(), AXObjectCache::AXChildrenChanged);
139
140     // Go up the accessibility parent chain, but only if the element already exists. This method is
141     // called during render layouts, minimal work should be done. 
142     // If AX elements are created now, they could interrogate the render tree while it's in a funky state.
143     // At the same time, process ARIA live region changes.
144     for (AccessibilityObject* parent = this; parent; parent = parent->parentObjectIfExists()) {
145         parent->setNeedsToUpdateChildren();
146
147         // These notifications always need to be sent because screenreaders are reliant on them to perform. 
148         // In other words, they need to be sent even when the screen reader has not accessed this live region since the last update.
149
150         // If this element supports ARIA live regions, then notify the AT of changes.
151         if (parent->supportsARIALiveRegion())
152             cache->postNotification(parent, parent->document(), AXObjectCache::AXLiveRegionChanged);
153         
154         // If this element is an ARIA text control, notify the AT of changes.
155         if ((parent->isARIATextControl() || parent->hasContentEditableAttributeSet()) && !parent->isNativeTextControl())
156             cache->postNotification(parent, parent->document(), AXObjectCache::AXValueChanged);
157     }
158 }
159
160 void AccessibilityNodeObject::updateAccessibilityRole()
161 {
162     bool ignoredStatus = accessibilityIsIgnored();
163     m_role = determineAccessibilityRole();
164     
165     // The AX hierarchy only needs to be updated if the ignored status of an element has changed.
166     if (ignoredStatus != accessibilityIsIgnored())
167         childrenChanged();
168 }
169     
170 AccessibilityObject* AccessibilityNodeObject::firstChild() const
171 {
172     if (!node())
173         return nullptr;
174     
175     Node* firstChild = node()->firstChild();
176
177     if (!firstChild)
178         return nullptr;
179     
180     return axObjectCache()->getOrCreate(firstChild);
181 }
182
183 AccessibilityObject* AccessibilityNodeObject::lastChild() const
184 {
185     if (!node())
186         return nullptr;
187     
188     Node* lastChild = node()->lastChild();
189     if (!lastChild)
190         return nullptr;
191     
192     return axObjectCache()->getOrCreate(lastChild);
193 }
194
195 AccessibilityObject* AccessibilityNodeObject::previousSibling() const
196 {
197     if (!node())
198         return nullptr;
199
200     Node* previousSibling = node()->previousSibling();
201     if (!previousSibling)
202         return nullptr;
203
204     return axObjectCache()->getOrCreate(previousSibling);
205 }
206
207 AccessibilityObject* AccessibilityNodeObject::nextSibling() const
208 {
209     if (!node())
210         return nullptr;
211
212     Node* nextSibling = node()->nextSibling();
213     if (!nextSibling)
214         return nullptr;
215
216     return axObjectCache()->getOrCreate(nextSibling);
217 }
218     
219 AccessibilityObject* AccessibilityNodeObject::parentObjectIfExists() const
220 {
221     return parentObject();
222 }
223     
224 AccessibilityObject* AccessibilityNodeObject::parentObject() const
225 {
226     if (!node())
227         return nullptr;
228
229     Node* parentObj = node()->parentNode();
230     if (!parentObj)
231         return nullptr;
232     
233     if (AXObjectCache* cache = axObjectCache())
234         return cache->getOrCreate(parentObj);
235     
236     return nullptr;
237 }
238
239 LayoutRect AccessibilityNodeObject::elementRect() const
240 {
241     return boundingBoxRect();
242 }
243     
244 LayoutRect AccessibilityNodeObject::boundingBoxRect() const
245 {
246     // AccessibilityNodeObjects have no mechanism yet to return a size or position.
247     // For now, let's return the position of the ancestor that does have a position,
248     // and make it the width of that parent, and about the height of a line of text, so that it's clear the object is a child of the parent.
249     
250     LayoutRect boundingBox;
251     
252     for (AccessibilityObject* positionProvider = parentObject(); positionProvider; positionProvider = positionProvider->parentObject()) {
253         if (positionProvider->isAccessibilityRenderObject()) {
254             LayoutRect parentRect = positionProvider->elementRect();
255             boundingBox.setSize(LayoutSize(parentRect.width(), LayoutUnit(std::min(10.0f, parentRect.height().toFloat()))));
256             boundingBox.setLocation(parentRect.location());
257             break;
258         }
259     }
260     
261     return boundingBox;
262 }
263
264 void AccessibilityNodeObject::setNode(Node* node)
265 {
266     m_node = node;
267 }
268
269 Document* AccessibilityNodeObject::document() const
270 {
271     if (!node())
272         return nullptr;
273     return &node()->document();
274 }
275
276 AccessibilityRole AccessibilityNodeObject::determineAccessibilityRole()
277 {
278     if (!node())
279         return UnknownRole;
280
281     m_ariaRole = determineAriaRoleAttribute();
282     
283     AccessibilityRole ariaRole = ariaRoleAttribute();
284     if (ariaRole != UnknownRole)
285         return ariaRole;
286
287     if (node()->isLink())
288         return WebCoreLinkRole;
289     if (node()->isTextNode())
290         return StaticTextRole;
291     if (node()->hasTagName(buttonTag))
292         return buttonRoleType();
293     if (isHTMLInputElement(node())) {
294         HTMLInputElement* input = toHTMLInputElement(node());
295         if (input->isCheckbox())
296             return CheckBoxRole;
297         if (input->isRadioButton())
298             return RadioButtonRole;
299         if (input->isTextButton())
300             return buttonRoleType();
301         if (input->isRangeControl())
302             return SliderRole;
303
304 #if ENABLE(INPUT_TYPE_COLOR)
305         const AtomicString& type = input->getAttribute(typeAttr);
306         if (equalIgnoringCase(type, "color"))
307             return ColorWellRole;
308 #endif
309
310         return TextFieldRole;
311     }
312     if (node()->hasTagName(selectTag)) {
313         HTMLSelectElement* selectElement = toHTMLSelectElement(node());
314         return selectElement->multiple() ? ListBoxRole : PopUpButtonRole;
315     }
316     if (isHTMLTextAreaElement(node()))
317         return TextAreaRole;
318     if (headingLevel())
319         return HeadingRole;
320     if (node()->hasTagName(divTag))
321         return DivRole;
322     if (node()->hasTagName(pTag))
323         return ParagraphRole;
324     if (isHTMLLabelElement(node()))
325         return LabelRole;
326     if (node()->isElementNode() && toElement(node())->isFocusable())
327         return GroupRole;
328     
329     return UnknownRole;
330 }
331
332 void AccessibilityNodeObject::insertChild(AccessibilityObject* child, unsigned index)
333 {
334     if (!child)
335         return;
336     
337     // If the parent is asking for this child's children, then either it's the first time (and clearing is a no-op),
338     // or its visibility has changed. In the latter case, this child may have a stale child cached.
339     // This can prevent aria-hidden changes from working correctly. Hence, whenever a parent is getting children, ensure data is not stale.
340     child->clearChildren();
341     
342     if (child->accessibilityIsIgnored()) {
343         const auto& children = child->children();
344         size_t length = children.size();
345         for (size_t i = 0; i < length; ++i)
346             m_children.insert(index + i, children[i]);
347     } else {
348         ASSERT(child->parentObject() == this);
349         m_children.insert(index, child);
350     }
351 }
352
353 void AccessibilityNodeObject::addChild(AccessibilityObject* child)
354 {
355     insertChild(child, m_children.size());
356 }
357
358 void AccessibilityNodeObject::addChildren()
359 {
360     // If the need to add more children in addition to existing children arises, 
361     // childrenChanged should have been called, leaving the object with no children.
362     ASSERT(!m_haveChildren); 
363     
364     if (!m_node)
365         return;
366
367     m_haveChildren = true;
368
369     // The only time we add children from the DOM tree to a node with a renderer is when it's a canvas.
370     if (renderer() && !m_node->hasTagName(canvasTag))
371         return;
372     
373     for (Node* child = m_node->firstChild(); child; child = child->nextSibling())
374         addChild(axObjectCache()->getOrCreate(child));
375 }
376
377 bool AccessibilityNodeObject::canHaveChildren() const
378 {
379     // If this is an AccessibilityRenderObject, then it's okay if this object
380     // doesn't have a node - there are some renderers that don't have associated
381     // nodes, like scroll areas and css-generated text.
382     if (!node() && !isAccessibilityRenderObject())
383         return false;
384
385     // When <noscript> is not being used (its renderer() == 0), ignore its children.
386     if (node() && !renderer() && node()->hasTagName(noscriptTag))
387         return false;
388     
389     // Elements that should not have children
390     switch (roleValue()) {
391     case ImageRole:
392     case ButtonRole:
393     case PopUpButtonRole:
394     case CheckBoxRole:
395     case RadioButtonRole:
396     case TabRole:
397     case ToggleButtonRole:
398     case StaticTextRole:
399     case ListBoxOptionRole:
400     case ScrollBarRole:
401     case ProgressIndicatorRole:
402         return false;
403     default:
404         return true;
405     }
406 }
407
408 bool AccessibilityNodeObject::computeAccessibilityIsIgnored() const
409 {
410 #ifndef NDEBUG
411     // Double-check that an AccessibilityObject is never accessed before
412     // it's been initialized.
413     ASSERT(m_initialized);
414 #endif
415
416     // Handle non-rendered text that is exposed through aria-hidden=false.
417     if (m_node && m_node->isTextNode() && !renderer()) {
418         // Fallback content in iframe nodes should be ignored.
419         if (m_node->parentNode() && m_node->parentNode()->hasTagName(iframeTag) && m_node->parentNode()->renderer())
420             return true;
421
422         // Whitespace only text elements should be ignored when they have no renderer.
423         String string = stringValue().stripWhiteSpace().simplifyWhiteSpace();
424         if (!string.length())
425             return true;
426     }
427
428     AccessibilityObjectInclusion decision = defaultObjectInclusion();
429     if (decision == IncludeObject)
430         return false;
431     if (decision == IgnoreObject)
432         return true;
433     // If this element is within a parent that cannot have children, it should not be exposed.
434     if (isDescendantOfBarrenParent())
435         return true;
436
437     return m_role == UnknownRole;
438 }
439
440 bool AccessibilityNodeObject::canvasHasFallbackContent() const
441 {
442     Node* node = this->node();
443     if (!node || !node->hasTagName(canvasTag))
444         return false;
445     Element& canvasElement = toElement(*node);
446     // If it has any children that are elements, we'll assume it might be fallback
447     // content. If it has no children or its only children are not elements
448     // (e.g. just text nodes), it doesn't have fallback content.
449     return childrenOfType<Element>(canvasElement).first();
450 }
451
452 bool AccessibilityNodeObject::isImageButton() const
453 {
454     return isNativeImage() && isButton();
455 }
456
457 bool AccessibilityNodeObject::isAnchor() const
458 {
459     return !isNativeImage() && isLink();
460 }
461
462 bool AccessibilityNodeObject::isNativeTextControl() const
463 {
464     Node* node = this->node();
465     if (!node)
466         return false;
467
468     if (isHTMLTextAreaElement(node))
469         return true;
470
471     if (isHTMLInputElement(node)) {
472         HTMLInputElement* input = toHTMLInputElement(node);
473         return input->isText() || input->isNumberField();
474     }
475
476     return false;
477 }
478
479 bool AccessibilityNodeObject::isSearchField() const
480 {
481     Node* node = this->node();
482     if (!node)
483         return false;
484
485     HTMLInputElement* inputElement = node->toInputElement();
486     if (!inputElement)
487         return false;
488
489     if (inputElement->isSearchField())
490         return true;
491
492     // Some websites don't label their search fields as such. However, they will
493     // use the word "search" in either the form or input type. This won't catch every case,
494     // but it will catch google.com for example.
495
496     // Check the node name of the input type, sometimes it's "search".
497     const AtomicString& nameAttribute = getAttribute(nameAttr);
498     if (nameAttribute.contains("search", false))
499         return true;
500
501     // Check the form action and the name, which will sometimes be "search".
502     HTMLFormElement* form = inputElement->form();
503     if (form && (form->name().contains("search", false) || form->action().contains("search", false)))
504         return true;
505
506     return false;
507 }
508
509 bool AccessibilityNodeObject::isNativeImage() const
510 {
511     Node* node = this->node();
512     if (!node)
513         return false;
514
515     if (isHTMLImageElement(node))
516         return true;
517
518     if (node->hasTagName(appletTag) || node->hasTagName(embedTag) || node->hasTagName(objectTag))
519         return true;
520
521     if (isHTMLInputElement(node)) {
522         HTMLInputElement* input = toHTMLInputElement(node);
523         return input->isImageButton();
524     }
525
526     return false;
527 }
528
529 bool AccessibilityNodeObject::isImage() const
530 {
531     return roleValue() == ImageRole;
532 }
533
534 bool AccessibilityNodeObject::isPasswordField() const
535 {
536     Node* node = this->node();
537     if (!node || !node->isHTMLElement())
538         return false;
539
540     if (ariaRoleAttribute() != UnknownRole)
541         return false;
542
543     HTMLInputElement* inputElement = node->toInputElement();
544     if (!inputElement)
545         return false;
546
547     return inputElement->isPasswordField();
548 }
549
550 bool AccessibilityNodeObject::isInputImage() const
551 {
552     Node* node = this->node();
553     if (!node)
554         return false;
555  
556     if (roleValue() == ButtonRole && isHTMLInputElement(node)) {
557         HTMLInputElement* input = toHTMLInputElement(node);
558         return input->isImageButton();
559     }
560
561     return false;
562 }
563
564 bool AccessibilityNodeObject::isProgressIndicator() const
565 {
566     return roleValue() == ProgressIndicatorRole;
567 }
568
569 bool AccessibilityNodeObject::isSlider() const
570 {
571     return roleValue() == SliderRole;
572 }
573
574 bool AccessibilityNodeObject::isMenuRelated() const
575 {
576     switch (roleValue()) {
577     case MenuRole:
578     case MenuBarRole:
579     case MenuButtonRole:
580     case MenuItemRole:
581     case MenuItemCheckboxRole:
582     case MenuItemRadioRole:
583         return true;
584     default:
585         return false;
586     }
587 }
588
589 bool AccessibilityNodeObject::isMenu() const
590 {
591     return roleValue() == MenuRole;
592 }
593
594 bool AccessibilityNodeObject::isMenuBar() const
595 {
596     return roleValue() == MenuBarRole;
597 }
598
599 bool AccessibilityNodeObject::isMenuButton() const
600 {
601     return roleValue() == MenuButtonRole;
602 }
603
604 bool AccessibilityNodeObject::isMenuItem() const
605 {
606     switch (roleValue()) {
607     case MenuItemRole:
608     case MenuItemRadioRole:
609     case MenuItemCheckboxRole:
610         return true;
611     default:
612         return false;
613     }
614 }
615
616 bool AccessibilityNodeObject::isNativeCheckboxOrRadio() const
617 {
618     Node* node = this->node();
619     if (!node)
620         return false;
621
622     HTMLInputElement* input = node->toInputElement();
623     if (input)
624         return input->isCheckbox() || input->isRadioButton();
625
626     return false;
627 }
628
629 bool AccessibilityNodeObject::isEnabled() const
630 {
631     // ARIA says that the disabled status applies to the current element and all descendant elements.
632     for (AccessibilityObject* object = const_cast<AccessibilityNodeObject*>(this); object; object = object->parentObject()) {
633         const AtomicString& disabledStatus = object->getAttribute(aria_disabledAttr);
634         if (equalIgnoringCase(disabledStatus, "true"))
635             return false;
636         if (equalIgnoringCase(disabledStatus, "false"))
637             break;
638     }
639     
640     if (roleValue() == HorizontalRuleRole)
641         return false;
642     
643     Node* node = this->node();
644     if (!node || !node->isElementNode())
645         return true;
646
647     return !toElement(node)->isDisabledFormControl();
648 }
649
650 bool AccessibilityNodeObject::isIndeterminate() const
651 {
652     Node* node = this->node();
653     if (!node)
654         return false;
655
656     HTMLInputElement* inputElement = node->toInputElement();
657     if (!inputElement)
658         return false;
659
660     return inputElement->shouldAppearIndeterminate();
661 }
662
663 bool AccessibilityNodeObject::isPressed() const
664 {
665     if (!isButton())
666         return false;
667
668     Node* node = this->node();
669     if (!node)
670         return false;
671
672     // If this is an ARIA button, check the aria-pressed attribute rather than node()->active()
673     if (ariaRoleAttribute() == ButtonRole) {
674         if (equalIgnoringCase(getAttribute(aria_pressedAttr), "true"))
675             return true;
676         return false;
677     }
678
679     if (!node->isElementNode())
680         return false;
681     return toElement(node)->active();
682 }
683
684 bool AccessibilityNodeObject::isChecked() const
685 {
686     Node* node = this->node();
687     if (!node)
688         return false;
689
690     // First test for native checkedness semantics
691     HTMLInputElement* inputElement = node->toInputElement();
692     if (inputElement)
693         return inputElement->shouldAppearChecked();
694
695     // Else, if this is an ARIA checkbox or radio, respect the aria-checked attribute
696     bool validRole = false;
697     switch (ariaRoleAttribute()) {
698     case RadioButtonRole:
699     case CheckBoxRole:
700     case MenuItemRole:
701     case MenuItemCheckboxRole:
702     case MenuItemRadioRole:
703         validRole = true;
704         break;
705     default:
706         break;
707     }
708     
709     if (validRole && equalIgnoringCase(getAttribute(aria_checkedAttr), "true"))
710         return true;
711
712     return false;
713 }
714
715 bool AccessibilityNodeObject::isHovered() const
716 {
717     Node* node = this->node();
718     if (!node)
719         return false;
720
721     return node->isElementNode() && toElement(node)->hovered();
722 }
723
724 bool AccessibilityNodeObject::isMultiSelectable() const
725 {
726     const AtomicString& ariaMultiSelectable = getAttribute(aria_multiselectableAttr);
727     if (equalIgnoringCase(ariaMultiSelectable, "true"))
728         return true;
729     if (equalIgnoringCase(ariaMultiSelectable, "false"))
730         return false;
731     
732     return node() && node()->hasTagName(selectTag) && toHTMLSelectElement(node())->multiple();
733 }
734
735 bool AccessibilityNodeObject::isReadOnly() const
736 {
737     Node* node = this->node();
738     if (!node)
739         return true;
740
741     if (isHTMLTextAreaElement(node))
742         return toHTMLFormControlElement(node)->isReadOnly();
743
744     if (isHTMLInputElement(node)) {
745         HTMLInputElement* input = toHTMLInputElement(node);
746         if (input->isTextField())
747             return input->isReadOnly();
748     }
749
750     return !node->hasEditableStyle();
751 }
752
753 bool AccessibilityNodeObject::isRequired() const
754 {
755     // Explicit aria-required values should trump native required attributes.
756     const AtomicString& requiredValue = getAttribute(aria_requiredAttr);
757     if (equalIgnoringCase(requiredValue, "true"))
758         return true;
759     if (equalIgnoringCase(requiredValue, "false"))
760         return false;
761
762     Node* n = this->node();
763     if (n && (n->isElementNode() && toElement(n)->isFormControlElement()))
764         return toHTMLFormControlElement(n)->isRequired();
765
766     return false;
767 }
768
769 bool AccessibilityNodeObject::supportsRequiredAttribute() const
770 {
771     switch (roleValue()) {
772     case ButtonRole:
773         return isFileUploadButton();
774     case CellRole:
775     case CheckBoxRole:
776     case ComboBoxRole:
777     case GridRole:
778     case IncrementorRole:
779     case ListBoxRole:
780     case PopUpButtonRole:
781     case RadioButtonRole:
782     case RadioGroupRole:
783     case RowHeaderRole:
784     case SliderRole:
785     case SpinButtonRole:
786     case TableHeaderContainerRole:
787     case TextAreaRole:
788     case TextFieldRole:
789     case ToggleButtonRole:
790         return true;
791     default:
792         return false;
793     }
794 }
795
796 int AccessibilityNodeObject::headingLevel() const
797 {
798     // headings can be in block flow and non-block flow
799     Node* node = this->node();
800     if (!node)
801         return false;
802
803     if (isHeading()) {
804         int ariaLevel = getAttribute(aria_levelAttr).toInt();
805         if (ariaLevel > 0)
806             return ariaLevel;
807     }
808
809     if (node->hasTagName(h1Tag))
810         return 1;
811
812     if (node->hasTagName(h2Tag))
813         return 2;
814
815     if (node->hasTagName(h3Tag))
816         return 3;
817
818     if (node->hasTagName(h4Tag))
819         return 4;
820
821     if (node->hasTagName(h5Tag))
822         return 5;
823
824     if (node->hasTagName(h6Tag))
825         return 6;
826
827     return 0;
828 }
829
830 String AccessibilityNodeObject::valueDescription() const
831 {
832     if (!isRangeControl())
833         return String();
834
835     return getAttribute(aria_valuetextAttr).string();
836 }
837
838 float AccessibilityNodeObject::valueForRange() const
839 {
840     if (node() && isHTMLInputElement(node())) {
841         HTMLInputElement* input = toHTMLInputElement(node());
842         if (input->isRangeControl())
843             return input->valueAsNumber();
844     }
845
846     if (!isRangeControl())
847         return 0.0f;
848
849     return getAttribute(aria_valuenowAttr).toFloat();
850 }
851
852 float AccessibilityNodeObject::maxValueForRange() const
853 {
854     if (node() && isHTMLInputElement(node())) {
855         HTMLInputElement* input = toHTMLInputElement(node());
856         if (input->isRangeControl())
857             return input->maximum();
858     }
859
860     if (!isRangeControl())
861         return 0.0f;
862
863     return getAttribute(aria_valuemaxAttr).toFloat();
864 }
865
866 float AccessibilityNodeObject::minValueForRange() const
867 {
868     if (node() && isHTMLInputElement(node())) {
869         HTMLInputElement* input = toHTMLInputElement(node());
870         if (input->isRangeControl())
871             return input->minimum();
872     }
873
874     if (!isRangeControl())
875         return 0.0f;
876
877     return getAttribute(aria_valueminAttr).toFloat();
878 }
879
880 float AccessibilityNodeObject::stepValueForRange() const
881 {
882     return getAttribute(stepAttr).toFloat();
883 }
884
885 bool AccessibilityNodeObject::isHeading() const
886 {
887     return roleValue() == HeadingRole;
888 }
889
890 bool AccessibilityNodeObject::isLink() const
891 {
892     return roleValue() == WebCoreLinkRole;
893 }
894
895 bool AccessibilityNodeObject::isControl() const
896 {
897     Node* node = this->node();
898     if (!node)
899         return false;
900
901     return ((node->isElementNode() && toElement(node)->isFormControlElement())
902         || AccessibilityObject::isARIAControl(ariaRoleAttribute()));
903 }
904
905 bool AccessibilityNodeObject::isFieldset() const
906 {
907     Node* node = this->node();
908     if (!node)
909         return false;
910
911     return node->hasTagName(fieldsetTag);
912 }
913
914 bool AccessibilityNodeObject::isGroup() const
915 {
916     return roleValue() == GroupRole;
917 }
918
919 AccessibilityObject* AccessibilityNodeObject::selectedRadioButton()
920 {
921     if (!isRadioGroup())
922         return nullptr;
923
924     // Find the child radio button that is selected (ie. the intValue == 1).
925     for (const auto& child : children()) {
926         if (child->roleValue() == RadioButtonRole && child->checkboxOrRadioValue() == ButtonStateOn)
927             return child.get();
928     }
929     return nullptr;
930 }
931
932 AccessibilityObject* AccessibilityNodeObject::selectedTabItem()
933 {
934     if (!isTabList())
935         return nullptr;
936
937     // Find the child tab item that is selected (ie. the intValue == 1).
938     AccessibilityObject::AccessibilityChildrenVector tabs;
939     tabChildren(tabs);
940
941     for (const auto& child : children()) {
942         if (child->isTabItem() && child->isChecked())
943             return child.get();
944     }
945     return nullptr;
946 }
947
948 AccessibilityButtonState AccessibilityNodeObject::checkboxOrRadioValue() const
949 {
950     if (isNativeCheckboxOrRadio())
951         return isChecked() ? ButtonStateOn : ButtonStateOff;
952
953     return AccessibilityObject::checkboxOrRadioValue();
954 }
955
956 Element* AccessibilityNodeObject::anchorElement() const
957 {
958     Node* node = this->node();
959     if (!node)
960         return nullptr;
961
962     AXObjectCache* cache = axObjectCache();
963
964     // search up the DOM tree for an anchor element
965     // NOTE: this assumes that any non-image with an anchor is an HTMLAnchorElement
966     for ( ; node; node = node->parentNode()) {
967         if (isHTMLAnchorElement(node) || (node->renderer() && cache->getOrCreate(node->renderer())->isAnchor()))
968             return toElement(node);
969     }
970
971     return nullptr;
972 }
973
974 static bool isNodeActionElement(Node* node)
975 {
976     if (isHTMLInputElement(node)) {
977         HTMLInputElement* input = toHTMLInputElement(node);
978         if (!input->isDisabledFormControl() && (input->isRadioButton() || input->isCheckbox() || input->isTextButton() || input->isFileUpload() || input->isImageButton()))
979             return true;
980     } else if (node->hasTagName(buttonTag) || node->hasTagName(selectTag))
981         return true;
982
983     return false;
984 }
985     
986 static Element* nativeActionElement(Node* start)
987 {
988     if (!start)
989         return nullptr;
990     
991     // Do a deep-dive to see if any nodes should be used as the action element.
992     // We have to look at Nodes, since this method should only be called on objects that do not have children (like buttons).
993     // It solves the problem when authors put role="button" on a group and leave the actual button inside the group.
994     
995     for (Node* child = start->firstChild(); child; child = child->nextSibling()) {
996         if (isNodeActionElement(child))
997             return toElement(child);
998
999         if (Element* subChild = nativeActionElement(child))
1000             return subChild;
1001     }
1002     return nullptr;
1003 }
1004     
1005 Element* AccessibilityNodeObject::actionElement() const
1006 {
1007     Node* node = this->node();
1008     if (!node)
1009         return nullptr;
1010
1011     if (isNodeActionElement(node))
1012         return toElement(node);
1013     
1014     if (AccessibilityObject::isARIAInput(ariaRoleAttribute()))
1015         return toElement(node);
1016
1017     switch (roleValue()) {
1018     case ButtonRole:
1019     case PopUpButtonRole:
1020     case ToggleButtonRole:
1021     case TabRole:
1022     case MenuItemRole:
1023     case MenuItemCheckboxRole:
1024     case MenuItemRadioRole:
1025     case ListItemRole:
1026         // Check if the author is hiding the real control element inside the ARIA element.
1027         if (Element* nativeElement = nativeActionElement(node))
1028             return nativeElement;
1029         return toElement(node);
1030     default:
1031         break;
1032     }
1033     
1034     Element* elt = anchorElement();
1035     if (!elt)
1036         elt = mouseButtonListener();
1037     return elt;
1038 }
1039
1040 Element* AccessibilityNodeObject::mouseButtonListener(MouseButtonListenerResultFilter filter) const
1041 {
1042     Node* node = this->node();
1043     if (!node)
1044         return nullptr;
1045
1046     // check if our parent is a mouse button listener
1047     // FIXME: Do the continuation search like anchorElement does
1048     for (auto& element : elementLineage(node->isElementNode() ? toElement(node) : node->parentElement())) {
1049         // If we've reached the body and this is not a control element, do not expose press action for this element unless filter is IncludeBodyElement.
1050         // It can cause false positives, where every piece of text is labeled as accepting press actions.
1051         if (element.hasTagName(bodyTag) && isStaticText() && filter == ExcludeBodyElement)
1052             break;
1053         
1054         if (element.hasEventListeners(eventNames().clickEvent) || element.hasEventListeners(eventNames().mousedownEvent) || element.hasEventListeners(eventNames().mouseupEvent))
1055             return &element;
1056     }
1057
1058     return nullptr;
1059 }
1060
1061 bool AccessibilityNodeObject::isDescendantOfBarrenParent() const
1062 {
1063     for (AccessibilityObject* object = parentObject(); object; object = object->parentObject()) {
1064         if (!object->canHaveChildren())
1065             return true;
1066     }
1067
1068     return false;
1069 }
1070
1071 void AccessibilityNodeObject::alterSliderValue(bool increase)
1072 {
1073     if (roleValue() != SliderRole)
1074         return;
1075
1076     if (!getAttribute(stepAttr).isEmpty())
1077         changeValueByStep(increase);
1078     else
1079         changeValueByPercent(increase ? 5 : -5);
1080 }
1081     
1082 void AccessibilityNodeObject::increment()
1083 {
1084     UserGestureIndicator gestureIndicator(DefinitelyProcessingUserGesture);
1085     alterSliderValue(true);
1086 }
1087
1088 void AccessibilityNodeObject::decrement()
1089 {
1090     UserGestureIndicator gestureIndicator(DefinitelyProcessingUserGesture);
1091     alterSliderValue(false);
1092 }
1093
1094 void AccessibilityNodeObject::changeValueByStep(bool increase)
1095 {
1096     float step = stepValueForRange();
1097     float value = valueForRange();
1098
1099     value += increase ? step : -step;
1100
1101     setValue(String::number(value));
1102
1103     axObjectCache()->postNotification(node(), AXObjectCache::AXValueChanged);
1104 }
1105
1106 void AccessibilityNodeObject::changeValueByPercent(float percentChange)
1107 {
1108     float range = maxValueForRange() - minValueForRange();
1109     float step = range * (percentChange / 100);
1110     float value = valueForRange();
1111
1112     // Make sure the specified percent will cause a change of one integer step or larger.
1113     if (fabs(step) < 1)
1114         step = fabs(percentChange) * (1 / percentChange);
1115
1116     value += step;
1117     setValue(String::number(value));
1118
1119     axObjectCache()->postNotification(node(), AXObjectCache::AXValueChanged);
1120 }
1121
1122 bool AccessibilityNodeObject::isGenericFocusableElement() const
1123 {
1124     if (!canSetFocusAttribute())
1125         return false;
1126
1127     // If it's a control, it's not generic.
1128     if (isControl())
1129         return false;
1130     
1131     AccessibilityRole role = roleValue();
1132     if (role == VideoRole || role == AudioRole)
1133         return false;
1134
1135     // If it has an aria role, it's not generic.
1136     if (m_ariaRole != UnknownRole)
1137         return false;
1138
1139     // If the content editable attribute is set on this element, that's the reason
1140     // it's focusable, and existing logic should handle this case already - so it's not a
1141     // generic focusable element.
1142
1143     if (hasContentEditableAttributeSet())
1144         return false;
1145
1146     // The web area and body element are both focusable, but existing logic handles these
1147     // cases already, so we don't need to include them here.
1148     if (role == WebAreaRole)
1149         return false;
1150     if (node() && node()->hasTagName(bodyTag))
1151         return false;
1152
1153     // An SVG root is focusable by default, but it's probably not interactive, so don't
1154     // include it. It can still be made accessible by giving it an ARIA role.
1155     if (role == SVGRootRole)
1156         return false;
1157
1158     return true;
1159 }
1160
1161 HTMLLabelElement* AccessibilityNodeObject::labelForElement(Element* element) const
1162 {
1163     if (!element->isHTMLElement() || !toHTMLElement(element)->isLabelable())
1164         return nullptr;
1165
1166     const AtomicString& id = element->getIdAttribute();
1167     if (!id.isEmpty()) {
1168         if (HTMLLabelElement* label = element->treeScope().labelElementForId(id))
1169             return label;
1170     }
1171
1172     return ancestorsOfType<HTMLLabelElement>(*element).first();
1173 }
1174
1175 String AccessibilityNodeObject::ariaAccessibilityDescription() const
1176 {
1177     String ariaLabeledBy = ariaLabeledByAttribute();
1178     if (!ariaLabeledBy.isEmpty())
1179         return ariaLabeledBy;
1180
1181     const AtomicString& ariaLabel = getAttribute(aria_labelAttr);
1182     if (!ariaLabel.isEmpty())
1183         return ariaLabel;
1184
1185     return String();
1186 }
1187
1188 static Element* siblingWithAriaRole(String role, Node* node)
1189 {
1190     ContainerNode* parent = node->parentNode();
1191     if (!parent)
1192         return nullptr;
1193
1194     for (auto& sibling : childrenOfType<Element>(*parent)) {
1195         const AtomicString& siblingAriaRole = sibling.fastGetAttribute(roleAttr);
1196         if (equalIgnoringCase(siblingAriaRole, role))
1197             return &sibling;
1198     }
1199
1200     return nullptr;
1201 }
1202
1203 Element* AccessibilityNodeObject::menuElementForMenuButton() const
1204 {
1205     if (ariaRoleAttribute() != MenuButtonRole)
1206         return nullptr;
1207
1208     return siblingWithAriaRole("menu", node());
1209 }
1210
1211 AccessibilityObject* AccessibilityNodeObject::menuForMenuButton() const
1212 {
1213     if (AXObjectCache* cache = axObjectCache())
1214         return cache->getOrCreate(menuElementForMenuButton());
1215     return nullptr;
1216 }
1217
1218 Element* AccessibilityNodeObject::menuItemElementForMenu() const
1219 {
1220     if (ariaRoleAttribute() != MenuRole)
1221         return nullptr;
1222     
1223     return siblingWithAriaRole("menuitem", node());    
1224 }
1225
1226 AccessibilityObject* AccessibilityNodeObject::menuButtonForMenu() const
1227 {
1228     AXObjectCache* cache = axObjectCache();
1229     if (!cache)
1230         return nullptr;
1231
1232     Element* menuItem = menuItemElementForMenu();
1233
1234     if (menuItem) {
1235         // ARIA just has generic menu items. AppKit needs to know if this is a top level items like MenuBarButton or MenuBarItem
1236         AccessibilityObject* menuItemAX = cache->getOrCreate(menuItem);
1237         if (menuItemAX && menuItemAX->isMenuButton())
1238             return menuItemAX;
1239     }
1240     return nullptr;
1241 }
1242
1243 bool AccessibilityNodeObject::usesAltTagForTextComputation() const
1244 {
1245     return isImage() || isInputImage() || isNativeImage() || isCanvas() || (node() && node()->hasTagName(imgTag));
1246 }
1247     
1248 void AccessibilityNodeObject::titleElementText(Vector<AccessibilityText>& textOrder) const
1249 {
1250     Node* node = this->node();
1251     if (!node)
1252         return;
1253     
1254     bool isInputTag = isHTMLInputElement(node);
1255     if (isInputTag || AccessibilityObject::isARIAInput(ariaRoleAttribute()) || isControl()) {
1256         HTMLLabelElement* label = labelForElement(toElement(node));
1257         if (label) {
1258             AccessibilityObject* labelObject = axObjectCache()->getOrCreate(label);
1259             String innerText = label->innerText();
1260             // Only use the <label> text if there's no ARIA override.
1261             if (!innerText.isEmpty() && !ariaAccessibilityDescription())
1262                 textOrder.append(AccessibilityText(innerText, LabelByElementText, labelObject));
1263             return;
1264         }
1265     }
1266     
1267     AccessibilityObject* titleUIElement = this->titleUIElement();
1268     if (titleUIElement)
1269         textOrder.append(AccessibilityText(String(), LabelByElementText, titleUIElement));
1270 }
1271
1272 void AccessibilityNodeObject::alternativeText(Vector<AccessibilityText>& textOrder) const
1273 {
1274     if (isWebArea()) {
1275         String webAreaText = alternativeTextForWebArea();
1276         if (!webAreaText.isEmpty())
1277             textOrder.append(AccessibilityText(webAreaText, AlternativeText));
1278         return;
1279     }
1280     
1281     ariaLabeledByText(textOrder);
1282     
1283     const AtomicString& ariaLabel = getAttribute(aria_labelAttr);
1284     if (!ariaLabel.isEmpty())
1285         textOrder.append(AccessibilityText(ariaLabel, AlternativeText));
1286     
1287     if (usesAltTagForTextComputation()) {
1288         if (renderer() && renderer()->isRenderImage()) {
1289             String renderAltText = toRenderImage(renderer())->altText();
1290
1291             // RenderImage will return title as a fallback from altText, but we don't want title here because we consider that in helpText.
1292             if (!renderAltText.isEmpty() && renderAltText != getAttribute(titleAttr)) {
1293                 textOrder.append(AccessibilityText(renderAltText, AlternativeText));
1294                 return;
1295             }
1296         }
1297         // Images should use alt as long as the attribute is present, even if empty.
1298         // Otherwise, it should fallback to other methods, like the title attribute.
1299         const AtomicString& alt = getAttribute(altAttr);
1300         if (!alt.isEmpty())
1301             textOrder.append(AccessibilityText(alt, AlternativeText));
1302     }
1303     
1304     Node* node = this->node();
1305     if (!node)
1306         return;
1307     
1308     // The fieldset element derives its alternative text from the first associated legend element if one is available.
1309     if (isHTMLFieldSetElement(node)) {
1310         AccessibilityObject* object = axObjectCache()->getOrCreate(toHTMLFieldSetElement(node)->legend());
1311         if (object && !object->isHidden())
1312             textOrder.append(AccessibilityText(accessibleNameForNode(object->node()), AlternativeText));
1313     }
1314     
1315     // SVG elements all can have a <svg:title> element inside which should act as the descriptive text.
1316     if (node->isSVGElement())
1317         textOrder.append(AccessibilityText(downcast<SVGElement>(*node).title(), AlternativeText));
1318     
1319 #if ENABLE(MATHML)
1320     if (node->isMathMLElement())
1321         textOrder.append(AccessibilityText(getAttribute(MathMLNames::alttextAttr), AlternativeText));
1322 #endif
1323 }
1324
1325 void AccessibilityNodeObject::visibleText(Vector<AccessibilityText>& textOrder) const
1326 {
1327     Node* node = this->node();
1328     if (!node)
1329         return;
1330     
1331     bool isInputTag = isHTMLInputElement(node);
1332     if (isInputTag) {
1333         HTMLInputElement* input = toHTMLInputElement(node);
1334         if (input->isTextButton()) {
1335             textOrder.append(AccessibilityText(input->valueWithDefault(), VisibleText));
1336             return;
1337         }
1338     }
1339     
1340     // If this node isn't rendered, there's no inner text we can extract from a select element.
1341     if (!isAccessibilityRenderObject() && node->hasTagName(selectTag))
1342         return;
1343     
1344     bool useTextUnderElement = false;
1345     
1346     switch (roleValue()) {
1347     case PopUpButtonRole:
1348         // Native popup buttons should not use their button children's text as a title. That value is retrieved through stringValue().
1349         if (node->hasTagName(selectTag))
1350             break;
1351         FALLTHROUGH;
1352     case ButtonRole:
1353     case ToggleButtonRole:
1354     case CheckBoxRole:
1355     case ListBoxOptionRole:
1356     // MacOS does not expect native <li> elements to expose label information, it only expects leaf node elements to do that.
1357 #if !PLATFORM(COCOA)
1358     case ListItemRole:
1359 #endif
1360     case MenuButtonRole:
1361     case MenuItemRole:
1362     case MenuItemCheckboxRole:
1363     case MenuItemRadioRole:
1364     case RadioButtonRole:
1365     case TabRole:
1366     case ProgressIndicatorRole:
1367         useTextUnderElement = true;
1368         break;
1369     default:
1370         break;
1371     }
1372     
1373     // If it's focusable but it's not content editable or a known control type, then it will appear to
1374     // the user as a single atomic object, so we should use its text as the default title.
1375     if (isHeading() || isLink())
1376         useTextUnderElement = true;
1377     
1378     if (useTextUnderElement) {
1379         AccessibilityTextUnderElementMode mode;
1380         
1381         // Headings often include links as direct children. Those links need to be included in text under element.
1382         if (isHeading())
1383             mode.includeFocusableContent = true;
1384
1385         String text = textUnderElement(mode);
1386         if (!text.isEmpty())
1387             textOrder.append(AccessibilityText(text, ChildrenText));
1388     }
1389 }
1390
1391 void AccessibilityNodeObject::helpText(Vector<AccessibilityText>& textOrder) const
1392 {
1393     const AtomicString& ariaHelp = getAttribute(aria_helpAttr);
1394     if (!ariaHelp.isEmpty())
1395         textOrder.append(AccessibilityText(ariaHelp, HelpText));
1396     
1397     String describedBy = ariaDescribedByAttribute();
1398     if (!describedBy.isEmpty())
1399         textOrder.append(AccessibilityText(describedBy, SummaryText));
1400
1401     // Summary attribute used as help text on tables.
1402     const AtomicString& summary = getAttribute(summaryAttr);
1403     if (!summary.isEmpty())
1404         textOrder.append(AccessibilityText(summary, SummaryText));
1405
1406     // The title attribute should be used as help text unless it is already being used as descriptive text.
1407     const AtomicString& title = getAttribute(titleAttr);
1408     if (!title.isEmpty())
1409         textOrder.append(AccessibilityText(title, TitleTagText));
1410 }
1411
1412 void AccessibilityNodeObject::accessibilityText(Vector<AccessibilityText>& textOrder)
1413 {
1414     titleElementText(textOrder);
1415     alternativeText(textOrder);
1416     visibleText(textOrder);
1417     helpText(textOrder);
1418     
1419     String placeholder = placeholderValue();
1420     if (!placeholder.isEmpty())
1421         textOrder.append(AccessibilityText(placeholder, PlaceholderText));
1422 }
1423     
1424 void AccessibilityNodeObject::ariaLabeledByText(Vector<AccessibilityText>& textOrder) const
1425 {
1426     String ariaLabeledBy = ariaLabeledByAttribute();
1427     if (!ariaLabeledBy.isEmpty()) {
1428         Vector<Element*> elements;
1429         ariaLabeledByElements(elements);
1430         
1431         Vector<RefPtr<AccessibilityObject>> axElements;
1432         for (const auto& element : elements) {
1433             RefPtr<AccessibilityObject> axElement = axObjectCache()->getOrCreate(element);
1434             axElements.append(axElement);
1435         }
1436         
1437         textOrder.append(AccessibilityText(ariaLabeledBy, AlternativeText, WTF::move(axElements)));
1438     }
1439 }
1440     
1441 String AccessibilityNodeObject::alternativeTextForWebArea() const
1442 {
1443     // The WebArea description should follow this order:
1444     //     aria-label on the <html>
1445     //     title on the <html>
1446     //     <title> inside the <head> (of it was set through JS)
1447     //     name on the <html>
1448     // For iframes:
1449     //     aria-label on the <iframe>
1450     //     title on the <iframe>
1451     //     name on the <iframe>
1452     
1453     Document* document = this->document();
1454     if (!document)
1455         return String();
1456     
1457     // Check if the HTML element has an aria-label for the webpage.
1458     if (Element* documentElement = document->documentElement()) {
1459         const AtomicString& ariaLabel = documentElement->fastGetAttribute(aria_labelAttr);
1460         if (!ariaLabel.isEmpty())
1461             return ariaLabel;
1462     }
1463     
1464     if (auto* owner = document->ownerElement()) {
1465         if (owner->hasTagName(frameTag) || owner->hasTagName(iframeTag)) {
1466             const AtomicString& title = owner->fastGetAttribute(titleAttr);
1467             if (!title.isEmpty())
1468                 return title;
1469         }
1470         return owner->getNameAttribute();
1471     }
1472     
1473     String documentTitle = document->title();
1474     if (!documentTitle.isEmpty())
1475         return documentTitle;
1476     
1477     if (auto* body = document->body())
1478         return body->getNameAttribute();
1479     
1480     return String();
1481 }
1482     
1483 String AccessibilityNodeObject::accessibilityDescription() const
1484 {
1485     // Static text should not have a description, it should only have a stringValue.
1486     if (roleValue() == StaticTextRole)
1487         return String();
1488
1489     String ariaDescription = ariaAccessibilityDescription();
1490     if (!ariaDescription.isEmpty())
1491         return ariaDescription;
1492
1493     if (usesAltTagForTextComputation()) {
1494         // Images should use alt as long as the attribute is present, even if empty.                    
1495         // Otherwise, it should fallback to other methods, like the title attribute.                    
1496         const AtomicString& alt = getAttribute(altAttr);
1497         if (!alt.isNull())
1498             return alt;
1499     }
1500
1501     // SVG elements all can have a <svg:title> element inside which should act as the descriptive text.
1502     if (m_node && m_node->isSVGElement())
1503         return downcast<SVGElement>(*m_node).title();
1504     
1505 #if ENABLE(MATHML)
1506     if (m_node && m_node->isMathMLElement())
1507         return getAttribute(MathMLNames::alttextAttr);
1508 #endif
1509
1510     // An element's descriptive text is comprised of title() (what's visible on the screen) and accessibilityDescription() (other descriptive text).
1511     // Both are used to generate what a screen reader speaks.                                                           
1512     // If this point is reached (i.e. there's no accessibilityDescription) and there's no title(), we should fallback to using the title attribute.
1513     // The title attribute is normally used as help text (because it is a tooltip), but if there is nothing else available, this should be used (according to ARIA).
1514     if (title().isEmpty())
1515         return getAttribute(titleAttr);
1516
1517     return String();
1518 }
1519
1520 String AccessibilityNodeObject::helpText() const
1521 {
1522     Node* node = this->node();
1523     if (!node)
1524         return String();
1525     
1526     const AtomicString& ariaHelp = getAttribute(aria_helpAttr);
1527     if (!ariaHelp.isEmpty())
1528         return ariaHelp;
1529     
1530     String describedBy = ariaDescribedByAttribute();
1531     if (!describedBy.isEmpty())
1532         return describedBy;
1533     
1534     String description = accessibilityDescription();
1535     for (Node* curr = node; curr; curr = curr->parentNode()) {
1536         if (curr->isHTMLElement()) {
1537             const AtomicString& summary = toElement(curr)->getAttribute(summaryAttr);
1538             if (!summary.isEmpty())
1539                 return summary;
1540             
1541             // The title attribute should be used as help text unless it is already being used as descriptive text.
1542             const AtomicString& title = toElement(curr)->getAttribute(titleAttr);
1543             if (!title.isEmpty() && description != title)
1544                 return title;
1545         }
1546         
1547         // Only take help text from an ancestor element if its a group or an unknown role. If help was 
1548         // added to those kinds of elements, it is likely it was meant for a child element.
1549         AccessibilityObject* axObj = axObjectCache()->getOrCreate(curr);
1550         if (axObj) {
1551             AccessibilityRole role = axObj->roleValue();
1552             if (role != GroupRole && role != UnknownRole)
1553                 break;
1554         }
1555     }
1556     
1557     return String();
1558 }
1559     
1560 unsigned AccessibilityNodeObject::hierarchicalLevel() const
1561 {
1562     Node* node = this->node();
1563     if (!node || !node->isElementNode())
1564         return 0;
1565     Element* element = toElement(node);
1566     const AtomicString& ariaLevel = element->fastGetAttribute(aria_levelAttr);
1567     if (!ariaLevel.isEmpty())
1568         return ariaLevel.toInt();
1569     
1570     // Only tree item will calculate its level through the DOM currently.
1571     if (roleValue() != TreeItemRole)
1572         return 0;
1573     
1574     // Hierarchy leveling starts at 1, to match the aria-level spec.
1575     // We measure tree hierarchy by the number of groups that the item is within.
1576     unsigned level = 1;
1577     for (AccessibilityObject* parent = parentObject(); parent; parent = parent->parentObject()) {
1578         AccessibilityRole parentRole = parent->roleValue();
1579         if (parentRole == GroupRole)
1580             level++;
1581         else if (parentRole == TreeRole)
1582             break;
1583     }
1584     
1585     return level;
1586 }
1587
1588 // When building the textUnderElement for an object, determine whether or not
1589 // we should include the inner text of this given descendant object or skip it.
1590 static bool shouldUseAccessiblityObjectInnerText(AccessibilityObject* obj, AccessibilityTextUnderElementMode mode)
1591 {
1592     // Do not use any heuristic if we are explicitly asking to include all the children.
1593     if (mode.childrenInclusion == AccessibilityTextUnderElementMode::TextUnderElementModeIncludeAllChildren)
1594         return true;
1595
1596     // Consider this hypothetical example:
1597     // <div tabindex=0>
1598     //   <h2>
1599     //     Table of contents
1600     //   </h2>
1601     //   <a href="#start">Jump to start of book</a>
1602     //   <ul>
1603     //     <li><a href="#1">Chapter 1</a></li>
1604     //     <li><a href="#1">Chapter 2</a></li>
1605     //   </ul>
1606     // </div>
1607     //
1608     // The goal is to return a reasonable title for the outer container div, because
1609     // it's focusable - but without making its title be the full inner text, which is
1610     // quite long. As a heuristic, skip links, controls, and elements that are usually
1611     // containers with lots of children.
1612
1613     if (equalIgnoringCase(obj->getAttribute(aria_hiddenAttr), "true"))
1614         return false;
1615     
1616     // If something doesn't expose any children, then we can always take the inner text content.
1617     // This is what we want when someone puts an <a> inside a <button> for example.
1618     if (obj->isDescendantOfBarrenParent())
1619         return true;
1620     
1621     // Skip focusable children, so we don't include the text of links and controls.
1622     if (obj->canSetFocusAttribute() && !mode.includeFocusableContent)
1623         return false;
1624
1625     // Skip big container elements like lists, tables, etc.
1626     if (obj->isList() || obj->isAccessibilityTable() || obj->isTree() || obj->isCanvas())
1627         return false;
1628
1629     return true;
1630 }
1631
1632 static bool shouldAddSpaceBeforeAppendingNextElement(StringBuilder& builder, String& childText)
1633 {
1634     if (!builder.length() || !childText.length())
1635         return false;
1636
1637     // We don't need to add an additional space before or after a line break.
1638     return !(isHTMLLineBreak(childText[0]) || isHTMLLineBreak(builder[builder.length() - 1]));
1639 }
1640
1641 String AccessibilityNodeObject::textUnderElement(AccessibilityTextUnderElementMode mode) const
1642 {
1643     Node* node = this->node();
1644     if (node && node->isTextNode())
1645         return toText(node)->wholeText();
1646
1647     // The render tree should be stable before going ahead. Otherwise, further uses of the
1648     // TextIterator will force a layout update, potentially altering the accessibility tree
1649     // and leading to crashes in the loop that computes the result text from the children.
1650     ASSERT(!document()->renderView()->layoutState());
1651     ASSERT(!document()->childNeedsStyleRecalc());
1652
1653     StringBuilder builder;
1654     for (AccessibilityObject* child = firstChild(); child; child = child->nextSibling()) {
1655         if (!shouldUseAccessiblityObjectInnerText(child, mode))
1656             continue;
1657
1658         if (child->isAccessibilityNodeObject()) {
1659             Vector<AccessibilityText> textOrder;
1660             toAccessibilityNodeObject(child)->alternativeText(textOrder);
1661             if (textOrder.size() > 0 && textOrder[0].text.length()) {
1662                 if (shouldAddSpaceBeforeAppendingNextElement(builder, textOrder[0].text))
1663                     builder.append(' ');
1664                 builder.append(textOrder[0].text);
1665                 continue;
1666             }
1667         }
1668
1669         String childText = child->textUnderElement(mode);
1670         if (childText.length()) {
1671             if (shouldAddSpaceBeforeAppendingNextElement(builder, childText))
1672                 builder.append(' ');
1673             builder.append(childText);
1674         }
1675     }
1676
1677     return builder.toString().stripWhiteSpace().simplifyWhiteSpace(isHTMLSpaceButNotLineBreak);
1678 }
1679
1680 String AccessibilityNodeObject::title() const
1681 {
1682     Node* node = this->node();
1683     if (!node)
1684         return String();
1685
1686     bool isInputTag = isHTMLInputElement(node);
1687     if (isInputTag) {
1688         HTMLInputElement* input = toHTMLInputElement(node);
1689         if (input->isTextButton())
1690             return input->valueWithDefault();
1691     }
1692
1693     if (isInputTag || AccessibilityObject::isARIAInput(ariaRoleAttribute()) || isControl()) {
1694         HTMLLabelElement* label = labelForElement(toElement(node));
1695         // Use the label text as the title if 1) the title element is NOT an exposed element and 2) there's no ARIA override.
1696         if (label && !exposesTitleUIElement() && !ariaAccessibilityDescription().length())
1697             return label->innerText();
1698     }
1699
1700     // If this node isn't rendered, there's no inner text we can extract from a select element.
1701     if (!isAccessibilityRenderObject() && node->hasTagName(selectTag))
1702         return String();
1703
1704     switch (roleValue()) {
1705     case PopUpButtonRole:
1706         // Native popup buttons should not use their button children's text as a title. That value is retrieved through stringValue().
1707         if (node->hasTagName(selectTag))
1708             return String();
1709         FALLTHROUGH;
1710     case ButtonRole:
1711     case ToggleButtonRole:
1712     case CheckBoxRole:
1713     case ListBoxOptionRole:
1714     case ListItemRole:
1715     case MenuButtonRole:
1716     case MenuItemRole:
1717     case MenuItemCheckboxRole:
1718     case MenuItemRadioRole:
1719     case RadioButtonRole:
1720     case TabRole:
1721         return textUnderElement();
1722     // SVGRoots should not use the text under itself as a title. That could include the text of objects like <text>.
1723     case SVGRootRole:
1724         return String();
1725     default:
1726         break;
1727     }
1728
1729     if (isLink())
1730         return textUnderElement();
1731     if (isHeading())
1732         return textUnderElement(AccessibilityTextUnderElementMode(AccessibilityTextUnderElementMode::TextUnderElementModeSkipIgnoredChildren, true));
1733
1734     return String();
1735 }
1736
1737 String AccessibilityNodeObject::text() const
1738 {
1739     // If this is a user defined static text, use the accessible name computation.                                      
1740     if (ariaRoleAttribute() == StaticTextRole) {
1741         Vector<AccessibilityText> textOrder;
1742         alternativeText(textOrder);
1743         if (textOrder.size() > 0 && textOrder[0].text.length())
1744             return textOrder[0].text;
1745     }
1746
1747     if (!isTextControl())
1748         return String();
1749
1750     Node* node = this->node();
1751     if (!node)
1752         return String();
1753
1754     if (isNativeTextControl() && (isHTMLTextAreaElement(node) || isHTMLInputElement(node)))
1755         return toHTMLTextFormControlElement(node)->value();
1756
1757     if (!node->isElementNode())
1758         return String();
1759
1760     return toElement(node)->innerText();
1761 }
1762
1763 String AccessibilityNodeObject::stringValue() const
1764 {
1765     Node* node = this->node();
1766     if (!node)
1767         return String();
1768
1769     if (ariaRoleAttribute() == StaticTextRole) {
1770         String staticText = text();
1771         if (!staticText.length())
1772             staticText = textUnderElement();
1773         return staticText;
1774     }
1775
1776     if (node->isTextNode())
1777         return textUnderElement();
1778
1779     if (node->hasTagName(selectTag)) {
1780         HTMLSelectElement* selectElement = toHTMLSelectElement(node);
1781         int selectedIndex = selectElement->selectedIndex();
1782         const Vector<HTMLElement*>& listItems = selectElement->listItems();
1783         if (selectedIndex >= 0 && static_cast<size_t>(selectedIndex) < listItems.size()) {
1784             const AtomicString& overriddenDescription = listItems[selectedIndex]->fastGetAttribute(aria_labelAttr);
1785             if (!overriddenDescription.isNull())
1786                 return overriddenDescription;
1787         }
1788         if (!selectElement->multiple())
1789             return selectElement->value();
1790         return String();
1791     }
1792
1793     if (isTextControl())
1794         return text();
1795
1796     // FIXME: We might need to implement a value here for more types
1797     // FIXME: It would be better not to advertise a value at all for the types for which we don't implement one;
1798     // this would require subclassing or making accessibilityAttributeNames do something other than return a
1799     // single static array.
1800     return String();
1801 }
1802
1803 void AccessibilityNodeObject::colorValue(int& r, int& g, int& b) const
1804 {
1805     r = 0;
1806     g = 0;
1807     b = 0;
1808
1809     if (!isColorWell())
1810         return;
1811
1812     if (!node() || !isHTMLInputElement(node()))
1813         return;
1814
1815     HTMLInputElement* input = toHTMLInputElement(node());
1816     const AtomicString& type = input->getAttribute(typeAttr);
1817     if (!equalIgnoringCase(type, "color"))
1818         return;
1819
1820     // HTMLInputElement::value always returns a string parseable by Color().
1821     Color color(input->value());
1822     r = color.red();
1823     g = color.green();
1824     b = color.blue();
1825 }
1826
1827 // This function implements the ARIA accessible name as described by the Mozilla                                        
1828 // ARIA Implementer's Guide.                                                                                            
1829 static String accessibleNameForNode(Node* node)
1830 {
1831     ASSERT(node);
1832     if (!node || !node->isElementNode())
1833         return String();
1834     
1835     Element* element = toElement(node);
1836     const AtomicString& ariaLabel = element->fastGetAttribute(aria_labelAttr);
1837     if (!ariaLabel.isEmpty())
1838         return ariaLabel;
1839     
1840     const AtomicString& alt = element->fastGetAttribute(altAttr);
1841     if (!alt.isEmpty())
1842         return alt;
1843     
1844     if (isHTMLInputElement(node))
1845         return toHTMLInputElement(node)->value();
1846     
1847     // If the node can be turned into an AX object, we can use standard name computation rules.
1848     // If however, the node cannot (because there's no renderer e.g.) fallback to using the basic text underneath.
1849     AccessibilityObject* axObject = node->document().axObjectCache()->getOrCreate(node);
1850     String text;
1851     if (axObject)
1852         text = axObject->textUnderElement(AccessibilityTextUnderElementMode(AccessibilityTextUnderElementMode::TextUnderElementModeSkipIgnoredChildren, true));
1853     else
1854         text = element->innerText();
1855     
1856     if (!text.isEmpty())
1857         return text;
1858     
1859     const AtomicString& title = element->fastGetAttribute(titleAttr);
1860     if (!title.isEmpty())
1861         return title;
1862     
1863     return String();
1864 }
1865
1866 String AccessibilityNodeObject::accessibilityDescriptionForElements(Vector<Element*> &elements) const
1867 {
1868     StringBuilder builder;
1869     unsigned size = elements.size();
1870     for (unsigned i = 0; i < size; ++i) {
1871         if (i)
1872             builder.append(' ');
1873         
1874         builder.append(accessibleNameForNode(elements[i]));
1875     }
1876     return builder.toString();
1877 }
1878
1879 String AccessibilityNodeObject::ariaDescribedByAttribute() const
1880 {
1881     Vector<Element*> elements;
1882     elementsFromAttribute(elements, aria_describedbyAttr);
1883     
1884     return accessibilityDescriptionForElements(elements);
1885 }
1886
1887 void AccessibilityNodeObject::ariaLabeledByElements(Vector<Element*>& elements) const
1888 {
1889     elementsFromAttribute(elements, aria_labelledbyAttr);
1890     if (!elements.size())
1891         elementsFromAttribute(elements, aria_labeledbyAttr);
1892 }
1893
1894
1895 String AccessibilityNodeObject::ariaLabeledByAttribute() const
1896 {
1897     Vector<Element*> elements;
1898     ariaLabeledByElements(elements);
1899
1900     return accessibilityDescriptionForElements(elements);
1901 }
1902
1903 bool AccessibilityNodeObject::hasAttributesRequiredForInclusion() const
1904 {
1905     if (AccessibilityObject::hasAttributesRequiredForInclusion())
1906         return true;
1907
1908     if (!ariaAccessibilityDescription().isEmpty())
1909         return true;
1910
1911     return false;
1912 }
1913
1914 bool AccessibilityNodeObject::canSetFocusAttribute() const
1915 {
1916     Node* node = this->node();
1917     if (!node)
1918         return false;
1919
1920     if (isWebArea())
1921         return true;
1922     
1923     // NOTE: It would be more accurate to ask the document whether setFocusedElement() would
1924     // do anything. For example, setFocusedElement() will do nothing if the current focused
1925     // node will not relinquish the focus.
1926     if (!node)
1927         return false;
1928
1929     if (!node->isElementNode())
1930         return false;
1931
1932     Element* element = toElement(node);
1933
1934     if (element->isDisabledFormControl())
1935         return false;
1936
1937     return element->supportsFocus();
1938 }
1939
1940 AccessibilityRole AccessibilityNodeObject::determineAriaRoleAttribute() const
1941 {
1942     const AtomicString& ariaRole = getAttribute(roleAttr);
1943     if (ariaRole.isNull() || ariaRole.isEmpty())
1944         return UnknownRole;
1945     
1946     AccessibilityRole role = ariaRoleToWebCoreRole(ariaRole);
1947
1948     // ARIA states if an item can get focus, it should not be presentational.
1949     if (role == PresentationalRole && canSetFocusAttribute())
1950         return UnknownRole;
1951
1952     if (role == ButtonRole)
1953         role = buttonRoleType();
1954
1955     if (role == TextAreaRole && !ariaIsMultiline())
1956         role = TextFieldRole;
1957
1958     role = remapAriaRoleDueToParent(role);
1959     
1960     // Presentational roles are invalidated by the presence of ARIA attributes.
1961     if (role == PresentationalRole && supportsARIAAttributes())
1962         role = UnknownRole;
1963     
1964     if (role)
1965         return role;
1966
1967     return UnknownRole;
1968 }
1969
1970 AccessibilityRole AccessibilityNodeObject::ariaRoleAttribute() const
1971 {
1972     return m_ariaRole;
1973 }
1974
1975 AccessibilityRole AccessibilityNodeObject::remapAriaRoleDueToParent(AccessibilityRole role) const
1976 {
1977     // Some objects change their role based on their parent.
1978     // However, asking for the unignoredParent calls accessibilityIsIgnored(), which can trigger a loop. 
1979     // While inside the call stack of creating an element, we need to avoid accessibilityIsIgnored().
1980     // https://bugs.webkit.org/show_bug.cgi?id=65174
1981
1982     if (role != ListBoxOptionRole && role != MenuItemRole)
1983         return role;
1984     
1985     for (AccessibilityObject* parent = parentObject(); parent && !parent->accessibilityIsIgnored(); parent = parent->parentObject()) {
1986         AccessibilityRole parentAriaRole = parent->ariaRoleAttribute();
1987
1988         // Selects and listboxes both have options as child roles, but they map to different roles within WebCore.
1989         if (role == ListBoxOptionRole && parentAriaRole == MenuRole)
1990             return MenuItemRole;
1991         // An aria "menuitem" may map to MenuButton or MenuItem depending on its parent.
1992         if (role == MenuItemRole && parentAriaRole == GroupRole)
1993             return MenuButtonRole;
1994         
1995         // If the parent had a different role, then we don't need to continue searching up the chain.
1996         if (parentAriaRole)
1997             break;
1998     }
1999     
2000     return role;
2001 }   
2002
2003 bool AccessibilityNodeObject::canSetSelectedAttribute() const
2004 {
2005     // Elements that can be selected
2006     switch (roleValue()) {
2007     case CellRole:
2008     case RadioButtonRole:
2009     case RowHeaderRole:
2010     case RowRole:
2011     case TabListRole:
2012     case TabRole:
2013     case TreeGridRole:
2014     case TreeItemRole:
2015     case TreeRole:
2016         return isEnabled();
2017     default:
2018         return false;
2019     }
2020 }
2021
2022 } // namespace WebCore