DOM event handling should pass Event around by reference.
[WebKit-https.git] / Source / WebCore / html / HTMLAreaElement.cpp
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  * Copyright (C) 2004, 2005, 2006, 2009, 2011 Apple Inc. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #include "config.h"
23 #include "HTMLAreaElement.h"
24
25 #include "AffineTransform.h"
26 #include "Frame.h"
27 #include "HTMLImageElement.h"
28 #include "HTMLMapElement.h"
29 #include "HTMLParserIdioms.h"
30 #include "HitTestResult.h"
31 #include "Path.h"
32 #include "RenderImage.h"
33 #include "RenderView.h"
34
35 namespace WebCore {
36
37 using namespace HTMLNames;
38
39 inline HTMLAreaElement::HTMLAreaElement(const QualifiedName& tagName, Document& document)
40     : HTMLAnchorElement(tagName, document)
41     , m_lastSize(-1, -1)
42     , m_shape(Unknown)
43 {
44     ASSERT(hasTagName(areaTag));
45 }
46
47 Ref<HTMLAreaElement> HTMLAreaElement::create(const QualifiedName& tagName, Document& document)
48 {
49     return adoptRef(*new HTMLAreaElement(tagName, document));
50 }
51
52 void HTMLAreaElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
53 {
54     if (name == shapeAttr) {
55         if (equalLettersIgnoringASCIICase(value, "default"))
56             m_shape = Default;
57         else if (equalLettersIgnoringASCIICase(value, "circle"))
58             m_shape = Circle;
59         else if (equalLettersIgnoringASCIICase(value, "poly"))
60             m_shape = Poly;
61         else if (equalLettersIgnoringASCIICase(value, "rect"))
62             m_shape = Rect;
63         invalidateCachedRegion();
64     } else if (name == coordsAttr) {
65         m_coords = parseHTMLListOfOfFloatingPointNumberValues(value.string());
66         invalidateCachedRegion();
67     } else if (name == altAttr || name == accesskeyAttr) {
68         // Do nothing.
69     } else
70         HTMLAnchorElement::parseAttribute(name, value);
71 }
72
73 void HTMLAreaElement::invalidateCachedRegion()
74 {
75     m_lastSize = LayoutSize(-1, -1);
76 }
77
78 bool HTMLAreaElement::mapMouseEvent(LayoutPoint location, const LayoutSize& size, HitTestResult& result)
79 {
80     if (m_lastSize != size) {
81         m_region = std::make_unique<Path>(getRegion(size));
82         m_lastSize = size;
83     }
84
85     if (!m_region->contains(location))
86         return false;
87     
88     result.setInnerNode(this);
89     result.setURLElement(this);
90     return true;
91 }
92
93 // FIXME: We should use RenderElement* instead of RenderObject* once we upstream iOS's DOMUIKitExtensions.{h, mm}.
94 Path HTMLAreaElement::computePath(RenderObject* obj) const
95 {
96     if (!obj)
97         return Path();
98     
99     // FIXME: This doesn't work correctly with transforms.
100     FloatPoint absPos = obj->localToAbsolute();
101
102     // Default should default to the size of the containing object.
103     LayoutSize size = m_lastSize;
104     if (m_shape == Default)
105         size = obj->absoluteOutlineBounds().size();
106     
107     Path p = getRegion(size);
108     float zoomFactor = obj->style().effectiveZoom();
109     if (zoomFactor != 1.0f) {
110         AffineTransform zoomTransform;
111         zoomTransform.scale(zoomFactor);
112         p.transform(zoomTransform);
113     }
114
115     p.translate(toFloatSize(absPos));
116     return p;
117 }
118
119 Path HTMLAreaElement::computePathForFocusRing(const LayoutSize& elementSize) const
120 {
121     return getRegion(m_shape == Default ? elementSize : m_lastSize);
122 }
123
124 // FIXME: Use RenderElement* instead of RenderObject* once we upstream iOS's DOMUIKitExtensions.{h, mm}.
125 LayoutRect HTMLAreaElement::computeRect(RenderObject* obj) const
126 {
127     return enclosingLayoutRect(computePath(obj).fastBoundingRect());
128 }
129
130 Path HTMLAreaElement::getRegion(const LayoutSize& size) const
131 {
132     if (m_coords.isEmpty() && m_shape != Default)
133         return Path();
134
135     LayoutUnit width = size.width();
136     LayoutUnit height = size.height();
137
138     // If element omits the shape attribute, select shape based on number of coordinates.
139     Shape shape = m_shape;
140     if (shape == Unknown) {
141         if (m_coords.size() == 3)
142             shape = Circle;
143         else if (m_coords.size() == 4)
144             shape = Rect;
145         else if (m_coords.size() >= 6)
146             shape = Poly;
147     }
148
149     Path path;
150     switch (shape) {
151         case Poly:
152             if (m_coords.size() >= 6) {
153                 int numPoints = m_coords.size() / 2;
154                 path.moveTo(FloatPoint(m_coords[0], m_coords[1]));
155                 for (int i = 1; i < numPoints; ++i)
156                     path.addLineTo(FloatPoint(m_coords[i * 2], m_coords[i * 2 + 1]));
157                 path.closeSubpath();
158             }
159             break;
160         case Circle:
161             if (m_coords.size() >= 3) {
162                 double r = m_coords[2];
163                 path.addEllipse(FloatRect(m_coords[0] - r, m_coords[1] - r, 2 * r, 2 * r));
164             }
165             break;
166         case Rect:
167             if (m_coords.size() >= 4) {
168                 double x0 = m_coords[0];
169                 double y0 = m_coords[1];
170                 double x1 = m_coords[2];
171                 double y1 = m_coords[3];
172                 path.addRect(FloatRect(x0, y0, x1 - x0, y1 - y0));
173             }
174             break;
175         case Default:
176             path.addRect(FloatRect(0, 0, width, height));
177             break;
178         case Unknown:
179             break;
180     }
181
182     return path;
183 }
184
185 HTMLImageElement* HTMLAreaElement::imageElement() const
186 {
187     Node* mapElement = parentNode();
188     if (!is<HTMLMapElement>(mapElement))
189         return nullptr;
190     
191     return downcast<HTMLMapElement>(*mapElement).imageElement();
192 }
193
194 bool HTMLAreaElement::isKeyboardFocusable(KeyboardEvent&) const
195 {
196     return isFocusable();
197 }
198     
199 bool HTMLAreaElement::isMouseFocusable() const
200 {
201     return isFocusable();
202 }
203
204 bool HTMLAreaElement::isFocusable() const
205 {
206     HTMLImageElement* image = imageElement();
207     if (!image || !image->renderer() || image->renderer()->style().visibility() != VISIBLE)
208         return false;
209
210     return supportsFocus() && Element::tabIndex() >= 0;
211 }
212     
213 void HTMLAreaElement::setFocus(bool shouldBeFocused)
214 {
215     if (focused() == shouldBeFocused)
216         return;
217
218     HTMLAnchorElement::setFocus(shouldBeFocused);
219
220     HTMLImageElement* imageElement = this->imageElement();
221     if (!imageElement)
222         return;
223
224     auto* renderer = imageElement->renderer();
225     if (!is<RenderImage>(renderer))
226         return;
227
228     downcast<RenderImage>(*renderer).areaElementFocusChanged(this);
229 }
230     
231 void HTMLAreaElement::updateFocusAppearance(SelectionRestorationMode restorationMode, SelectionRevealMode revealMode)
232 {
233     if (!isFocusable())
234         return;
235
236     HTMLImageElement* imageElement = this->imageElement();
237     if (!imageElement)
238         return;
239
240     imageElement->updateFocusAppearance(restorationMode, revealMode);
241 }
242     
243 bool HTMLAreaElement::supportsFocus() const
244 {
245     // If the AREA element was a link, it should support focus.
246     // The inherited method is not used because it assumes that a render object must exist 
247     // for the element to support focus. AREA elements do not have render objects.
248     return isLink();
249 }
250
251 String HTMLAreaElement::target() const
252 {
253     return attributeWithoutSynchronization(targetAttr);
254 }
255
256 }