8f993d1e82a1e75a7b256f8e7e1105dfc8108613
[WebKit-https.git] / Source / WebCore / accessibility / atk / WebKitAccessibleUtil.cpp
1 /*
2  * Copyright (C) 2008 Nuanti Ltd.
3  * Copyright (C) 2009 Jan Alonzo
4  * Copyright (C) 2009, 2010, 2012 Igalia S.L.
5  *
6  * Portions from Mozilla a11y, copyright as follows:
7  *
8  * The Original Code is mozilla.org code.
9  *
10  * The Initial Developer of the Original Code is
11  * Sun Microsystems, Inc.
12  * Portions created by the Initial Developer are Copyright (C) 2002
13  * the Initial Developer. All Rights Reserved.
14  *
15  * This library is free software; you can redistribute it and/or
16  * modify it under the terms of the GNU Library General Public
17  * License as published by the Free Software Foundation; either
18  * version 2 of the License, or (at your option) any later version.
19  *
20  * This library is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
23  * Library General Public License for more details.
24  *
25  * You should have received a copy of the GNU Library General Public License
26  * along with this library; see the file COPYING.LIB.  If not, write to
27  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
28  * Boston, MA 02110-1301, USA.
29  */
30
31 #include "config.h"
32 #include "WebKitAccessibleUtil.h"
33
34 #if HAVE(ACCESSIBILITY)
35
36 #include "AccessibilityObject.h"
37 #include "FrameView.h"
38 #include "IntRect.h"
39 #include "Node.h"
40 #include "Range.h"
41 #include "VisibleSelection.h"
42
43 #include <wtf/text/AtomicString.h>
44 #include <wtf/text/CString.h>
45
46 using namespace WebCore;
47
48 AtkAttributeSet* addToAtkAttributeSet(AtkAttributeSet* attributeSet, const char* name, const char* value)
49 {
50     AtkAttribute* attribute = static_cast<AtkAttribute*>(g_malloc(sizeof(AtkAttribute)));
51     attribute->name = g_strdup(name);
52     attribute->value = g_strdup(value);
53     attributeSet = g_slist_prepend(attributeSet, attribute);
54     return attributeSet;
55 }
56
57 void contentsRelativeToAtkCoordinateType(AccessibilityObject* coreObject, AtkCoordType coordType, IntRect rect, gint* x, gint* y, gint* width, gint* height)
58 {
59     FrameView* frameView = coreObject->documentFrameView();
60
61     if (frameView) {
62         switch (coordType) {
63         case ATK_XY_WINDOW:
64             rect = frameView->contentsToWindow(rect);
65             break;
66         case ATK_XY_SCREEN:
67             rect = frameView->contentsToScreen(rect);
68             break;
69         }
70     }
71
72     if (x)
73         *x = rect.x();
74     if (y)
75         *y = rect.y();
76     if (width)
77         *width = rect.width();
78     if (height)
79         *height = rect.height();
80 }
81
82 // FIXME: Different kinds of elements are putting the title tag to use
83 // in different AX fields. This might not be 100% correct but we will
84 // keep it now in order to achieve consistency with previous behavior.
85 static bool titleTagShouldBeUsedInDescriptionField(AccessibilityObject* coreObject)
86 {
87     return (coreObject->isLink() && !coreObject->isImageMapLink()) || coreObject->isImage();
88 }
89
90 // This should be the "visible" text that's actually on the screen if possible.
91 // If there's alternative text, that can override the title.
92 String accessibilityTitle(AccessibilityObject* coreObject)
93 {
94     Vector<AccessibilityText> textOrder;
95     coreObject->accessibilityText(textOrder);
96
97     for (const AccessibilityText& text : textOrder) {
98         // Once we encounter visible text, or the text from our children that should be used foremost.
99         if (text.textSource == AccessibilityTextSource::Visible || text.textSource == AccessibilityTextSource::Children)
100             return text.text;
101
102         // If there's an element that labels this object and it's not exposed, then we should use
103         // that text as our title.
104         if (text.textSource == AccessibilityTextSource::LabelByElement && !coreObject->exposesTitleUIElement())
105             return text.text;
106
107         // Elements of role AccessibilityRole::Toolbar will return its title as AccessibilityTextSource::Alternative.
108         if (coreObject->roleValue() == AccessibilityRole::Toolbar && text.textSource == AccessibilityTextSource::Alternative)
109             return text.text;
110
111         // FIXME: The title tag is used in certain cases for the title. This usage should
112         // probably be in the description field since it's not "visible".
113         if (text.textSource == AccessibilityTextSource::TitleTag && !titleTagShouldBeUsedInDescriptionField(coreObject))
114             return text.text;
115     }
116
117     return String();
118 }
119
120 String accessibilityDescription(AccessibilityObject* coreObject)
121 {
122     Vector<AccessibilityText> textOrder;
123     coreObject->accessibilityText(textOrder);
124
125     bool visibleTextAvailable = false;
126     for (const AccessibilityText& text : textOrder) {
127         if (text.textSource == AccessibilityTextSource::Alternative)
128             return text.text;
129
130         switch (text.textSource) {
131         case AccessibilityTextSource::Visible:
132         case AccessibilityTextSource::Children:
133         case AccessibilityTextSource::LabelByElement:
134             visibleTextAvailable = true;
135         default:
136             break;
137         }
138
139         if (text.textSource == AccessibilityTextSource::TitleTag && !visibleTextAvailable)
140             return text.text;
141     }
142
143     return String();
144 }
145
146 bool selectionBelongsToObject(AccessibilityObject* coreObject, VisibleSelection& selection)
147 {
148     if (!coreObject || !coreObject->isAccessibilityRenderObject())
149         return false;
150
151     if (selection.isNone())
152         return false;
153
154     RefPtr<Range> range = selection.toNormalizedRange();
155     if (!range)
156         return false;
157
158     // We want to check that both the selection intersects the node
159     // AND that the selection is not just "touching" one of the
160     // boundaries for the selected node. We want to check whether the
161     // node is actually inside the region, at least partially.
162     auto& node = *coreObject->node();
163     auto* lastDescendant = node.lastDescendant();
164     unsigned lastOffset = lastOffsetInNode(lastDescendant);
165     auto intersectsResult = range->intersectsNode(node);
166     return !intersectsResult.hasException()
167         && intersectsResult.releaseReturnValue()
168         && (&range->endContainer() != &node || range->endOffset())
169         && (&range->startContainer() != lastDescendant || range->startOffset() != lastOffset);
170 }
171
172 #endif