Rename fastGetAttribute to attributeWithoutSynchronization
[WebKit-https.git] / Source / WebCore / html / HTMLOptionElement.cpp
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  *           (C) 2006 Alexey Proskuryakov (ap@nypop.com)
6  * Copyright (C) 2004, 2005, 2006, 2010, 2016 Apple Inc. All rights reserved.
7  * Copyright (C) 2010 Google Inc. All rights reserved.
8  * Copyright (C) 2011 Motorola Mobility, Inc.  All rights reserved.
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Library General Public
12  * License as published by the Free Software Foundation; either
13  * version 2 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Library General Public License for more details.
19  *
20  * You should have received a copy of the GNU Library General Public License
21  * along with this library; see the file COPYING.LIB.  If not, write to
22  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23  * Boston, MA 02110-1301, USA.
24  *
25  */
26
27 #include "config.h"
28 #include "HTMLOptionElement.h"
29
30 #include "Document.h"
31 #include "ExceptionCode.h"
32 #include "HTMLDataListElement.h"
33 #include "HTMLNames.h"
34 #include "HTMLOptGroupElement.h"
35 #include "HTMLParserIdioms.h"
36 #include "HTMLSelectElement.h"
37 #include "NodeRenderStyle.h"
38 #include "NodeTraversal.h"
39 #include "RenderMenuList.h"
40 #include "RenderTheme.h"
41 #include "ScriptElement.h"
42 #include "StyleResolver.h"
43 #include "Text.h"
44 #include <wtf/Ref.h>
45
46 namespace WebCore {
47
48 using namespace HTMLNames;
49
50 HTMLOptionElement::HTMLOptionElement(const QualifiedName& tagName, Document& document)
51     : HTMLElement(tagName, document)
52     , m_disabled(false)
53     , m_isSelected(false)
54 {
55     ASSERT(hasTagName(optionTag));
56     setHasCustomStyleResolveCallbacks();
57 }
58
59 Ref<HTMLOptionElement> HTMLOptionElement::create(Document& document)
60 {
61     return adoptRef(*new HTMLOptionElement(optionTag, document));
62 }
63
64 Ref<HTMLOptionElement> HTMLOptionElement::create(const QualifiedName& tagName, Document& document)
65 {
66     return adoptRef(*new HTMLOptionElement(tagName, document));
67 }
68
69 RefPtr<HTMLOptionElement> HTMLOptionElement::createForJSConstructor(Document& document, const String& data, const String& value,
70         bool defaultSelected, bool selected, ExceptionCode& ec)
71 {
72     Ref<HTMLOptionElement> element = adoptRef(*new HTMLOptionElement(optionTag, document));
73
74     auto text = Text::create(document, data.isNull() ? emptyString() : data);
75
76     ec = 0;
77     element->appendChild(text, ec);
78     if (ec)
79         return nullptr;
80
81     if (!value.isNull())
82         element->setValue(value);
83     if (defaultSelected)
84         element->setAttributeWithoutSynchronization(selectedAttr, emptyAtom);
85     element->setSelected(selected);
86
87     return WTFMove(element);
88 }
89
90 bool HTMLOptionElement::isFocusable() const
91 {
92     if (!supportsFocus())
93         return false;
94     // Option elements do not have a renderer.
95     auto* style = const_cast<HTMLOptionElement&>(*this).computedStyle();
96     return style && style->display() != NONE;
97 }
98
99 bool HTMLOptionElement::matchesDefaultPseudoClass() const
100 {
101     return fastHasAttribute(selectedAttr);
102 }
103
104 String HTMLOptionElement::text() const
105 {
106     String text = collectOptionInnerText();
107
108     // FIXME: Is displayStringModifiedByEncoding helpful here?
109     // If it's correct here, then isn't it needed in the value and label functions too?
110     return document().displayStringModifiedByEncoding(text).stripWhiteSpace(isHTMLSpace).simplifyWhiteSpace(isHTMLSpace);
111 }
112
113 void HTMLOptionElement::setText(const String &text, ExceptionCode& ec)
114 {
115     Ref<HTMLOptionElement> protectedThis(*this);
116
117     // Changing the text causes a recalc of a select's items, which will reset the selected
118     // index to the first item if the select is single selection with a menu list. We attempt to
119     // preserve the selected item.
120     RefPtr<HTMLSelectElement> select = ownerSelectElement();
121     bool selectIsMenuList = select && select->usesMenuList();
122     int oldSelectedIndex = selectIsMenuList ? select->selectedIndex() : -1;
123
124     // Handle the common special case where there's exactly 1 child node, and it's a text node.
125     Node* child = firstChild();
126     if (is<Text>(child) && !child->nextSibling())
127         downcast<Text>(*child).setData(text);
128     else {
129         removeChildren();
130         appendChild(Text::create(document(), text), ec);
131     }
132     
133     if (selectIsMenuList && select->selectedIndex() != oldSelectedIndex)
134         select->setSelectedIndex(oldSelectedIndex);
135 }
136
137 void HTMLOptionElement::accessKeyAction(bool)
138 {
139     HTMLSelectElement* select = ownerSelectElement();
140     if (select)
141         select->accessKeySetSelectedIndex(index());
142 }
143
144 int HTMLOptionElement::index() const
145 {
146     // It would be faster to cache the index, but harder to get it right in all cases.
147
148     HTMLSelectElement* selectElement = ownerSelectElement();
149     if (!selectElement)
150         return 0;
151
152     int optionIndex = 0;
153
154     for (auto& item : selectElement->listItems()) {
155         if (!is<HTMLOptionElement>(*item))
156             continue;
157         if (item == this)
158             return optionIndex;
159         ++optionIndex;
160     }
161
162     return 0;
163 }
164
165 void HTMLOptionElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
166 {
167 #if ENABLE(DATALIST_ELEMENT)
168     if (name == valueAttr) {
169         if (HTMLDataListElement* dataList = ownerDataListElement())
170             dataList->optionElementChildrenChanged();
171     } else
172 #endif
173     if (name == disabledAttr) {
174         bool oldDisabled = m_disabled;
175         m_disabled = !value.isNull();
176         if (oldDisabled != m_disabled) {
177             setNeedsStyleRecalc();
178             if (renderer() && renderer()->style().hasAppearance())
179                 renderer()->theme().stateChanged(*renderer(), ControlStates::EnabledState);
180         }
181     } else if (name == selectedAttr) {
182         setNeedsStyleRecalc();
183
184         // FIXME: This doesn't match what the HTML specification says.
185         // The specification implies that removing the selected attribute or
186         // changing the value of a selected attribute that is already present
187         // has no effect on whether the element is selected. Further, it seems
188         // that we need to do more than just set m_isSelected to select in that
189         // case; we'd need to do the other work from the setSelected function.
190         m_isSelected = !value.isNull();
191     } else
192         HTMLElement::parseAttribute(name, value);
193 }
194
195 String HTMLOptionElement::value() const
196 {
197     const AtomicString& value = attributeWithoutSynchronization(valueAttr);
198     if (!value.isNull())
199         return value;
200     return collectOptionInnerText().stripWhiteSpace(isHTMLSpace).simplifyWhiteSpace(isHTMLSpace);
201 }
202
203 void HTMLOptionElement::setValue(const String& value)
204 {
205     setAttributeWithoutSynchronization(valueAttr, value);
206 }
207
208 bool HTMLOptionElement::selected()
209 {
210     if (HTMLSelectElement* select = ownerSelectElement())
211         select->updateListItemSelectedStates();
212     return m_isSelected;
213 }
214
215 void HTMLOptionElement::setSelected(bool selected)
216 {
217     if (m_isSelected == selected)
218         return;
219
220     setSelectedState(selected);
221
222     if (HTMLSelectElement* select = ownerSelectElement())
223         select->optionSelectionStateChanged(*this, selected);
224 }
225
226 void HTMLOptionElement::setSelectedState(bool selected)
227 {
228     if (m_isSelected == selected)
229         return;
230
231     m_isSelected = selected;
232     setNeedsStyleRecalc();
233
234     if (HTMLSelectElement* select = ownerSelectElement())
235         select->invalidateSelectedItems();
236 }
237
238 void HTMLOptionElement::childrenChanged(const ChildChange& change)
239 {
240 #if ENABLE(DATALIST_ELEMENT)
241     if (HTMLDataListElement* dataList = ownerDataListElement())
242         dataList->optionElementChildrenChanged();
243     else
244 #endif
245     if (HTMLSelectElement* select = ownerSelectElement())
246         select->optionElementChildrenChanged();
247     HTMLElement::childrenChanged(change);
248 }
249
250 #if ENABLE(DATALIST_ELEMENT)
251 HTMLDataListElement* HTMLOptionElement::ownerDataListElement() const
252 {
253     for (ContainerNode* parent = parentNode(); parent ; parent = parent->parentNode()) {
254         if (is<HTMLDataListElement>(*parent))
255             return downcast<HTMLDataListElement>(parent);
256     }
257     return nullptr;
258 }
259 #endif
260
261 HTMLSelectElement* HTMLOptionElement::ownerSelectElement() const
262 {
263     ContainerNode* select = parentNode();
264     while (select && !is<HTMLSelectElement>(*select))
265         select = select->parentNode();
266
267     if (!select)
268         return nullptr;
269
270     return downcast<HTMLSelectElement>(select);
271 }
272
273 String HTMLOptionElement::label() const
274 {
275     String label = attributeWithoutSynchronization(labelAttr);
276     if (!label.isNull())
277         return label.stripWhiteSpace(isHTMLSpace);
278     return collectOptionInnerText().stripWhiteSpace(isHTMLSpace).simplifyWhiteSpace(isHTMLSpace);
279 }
280
281 void HTMLOptionElement::setLabel(const String& label)
282 {
283     setAttributeWithoutSynchronization(labelAttr, label);
284 }
285
286 void HTMLOptionElement::willResetComputedStyle()
287 {
288     // FIXME: This is nasty, we ask our owner select to repaint even if the new
289     // style is exactly the same.
290     if (auto select = ownerSelectElement()) {
291         if (auto renderer = select->renderer())
292             renderer->repaint();
293     }
294 }
295
296 String HTMLOptionElement::textIndentedToRespectGroupLabel() const
297 {
298     ContainerNode* parent = parentNode();
299     if (is<HTMLOptGroupElement>(parent))
300         return "    " + label();
301     return label();
302 }
303
304 bool HTMLOptionElement::isDisabledFormControl() const
305 {
306     if (ownElementDisabled())
307         return true;
308
309     if (!is<HTMLOptGroupElement>(parentNode()))
310         return false;
311
312     return downcast<HTMLOptGroupElement>(*parentNode()).isDisabledFormControl();
313 }
314
315 Node::InsertionNotificationRequest HTMLOptionElement::insertedInto(ContainerNode& insertionPoint)
316 {
317     if (HTMLSelectElement* select = ownerSelectElement()) {
318         select->setRecalcListItems();
319         // Do not call selected() since calling updateListItemSelectedStates()
320         // at this time won't do the right thing. (Why, exactly?)
321         // FIXME: Might be better to call this unconditionally, always passing m_isSelected,
322         // rather than only calling it if we are selected.
323         if (m_isSelected)
324             select->optionSelectionStateChanged(*this, true);
325         select->scrollToSelection();
326     }
327
328     return HTMLElement::insertedInto(insertionPoint);
329 }
330
331 String HTMLOptionElement::collectOptionInnerText() const
332 {
333     StringBuilder text;
334     for (Node* node = firstChild(); node; ) {
335         if (is<Text>(*node))
336             text.append(node->nodeValue());
337         // Text nodes inside script elements are not part of the option text.
338         if (is<Element>(*node) && toScriptElementIfPossible(downcast<Element>(node)))
339             node = NodeTraversal::nextSkippingChildren(*node, this);
340         else
341             node = NodeTraversal::next(*node, this);
342     }
343     return text.toString();
344 }
345
346 } // namespace