HTMLOptionElement.text should never return the value of label
[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 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     RefPtr<HTMLOptionElement> element = adoptRef(new HTMLOptionElement(optionTag, document));
73
74     Ref<Text> text = Text::create(document, data.isNull() ? "" : data);
75
76     ec = 0;
77     element->appendChild(WTF::move(text), ec);
78     if (ec)
79         return nullptr;
80
81     if (!value.isNull())
82         element->setValue(value);
83     if (defaultSelected)
84         element->setAttribute(selectedAttr, emptyAtom);
85     element->setSelected(selected);
86
87     return 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 String HTMLOptionElement::text() const
100 {
101     String text = collectOptionInnerText();
102
103     // FIXME: Is displayStringModifiedByEncoding helpful here?
104     // If it's correct here, then isn't it needed in the value and label functions too?
105     return document().displayStringModifiedByEncoding(text).stripWhiteSpace(isHTMLSpace).simplifyWhiteSpace(isHTMLSpace);
106 }
107
108 void HTMLOptionElement::setText(const String &text, ExceptionCode& ec)
109 {
110     Ref<HTMLOptionElement> protectFromMutationEvents(*this);
111
112     // Changing the text causes a recalc of a select's items, which will reset the selected
113     // index to the first item if the select is single selection with a menu list. We attempt to
114     // preserve the selected item.
115     RefPtr<HTMLSelectElement> select = ownerSelectElement();
116     bool selectIsMenuList = select && select->usesMenuList();
117     int oldSelectedIndex = selectIsMenuList ? select->selectedIndex() : -1;
118
119     // Handle the common special case where there's exactly 1 child node, and it's a text node.
120     Node* child = firstChild();
121     if (is<Text>(child) && !child->nextSibling())
122         downcast<Text>(*child).setData(text, ec);
123     else {
124         removeChildren();
125         appendChild(Text::create(document(), text), ec);
126     }
127     
128     if (selectIsMenuList && select->selectedIndex() != oldSelectedIndex)
129         select->setSelectedIndex(oldSelectedIndex);
130 }
131
132 void HTMLOptionElement::accessKeyAction(bool)
133 {
134     HTMLSelectElement* select = ownerSelectElement();
135     if (select)
136         select->accessKeySetSelectedIndex(index());
137 }
138
139 int HTMLOptionElement::index() const
140 {
141     // It would be faster to cache the index, but harder to get it right in all cases.
142
143     HTMLSelectElement* selectElement = ownerSelectElement();
144     if (!selectElement)
145         return 0;
146
147     int optionIndex = 0;
148
149     for (auto& item : selectElement->listItems()) {
150         if (!is<HTMLOptionElement>(*item))
151             continue;
152         if (item == this)
153             return optionIndex;
154         ++optionIndex;
155     }
156
157     return 0;
158 }
159
160 void HTMLOptionElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
161 {
162 #if ENABLE(DATALIST_ELEMENT)
163     if (name == valueAttr) {
164         if (HTMLDataListElement* dataList = ownerDataListElement())
165             dataList->optionElementChildrenChanged();
166     } else
167 #endif
168     if (name == disabledAttr) {
169         bool oldDisabled = m_disabled;
170         m_disabled = !value.isNull();
171         if (oldDisabled != m_disabled) {
172             setNeedsStyleRecalc();
173             if (renderer() && renderer()->style().hasAppearance())
174                 renderer()->theme().stateChanged(*renderer(), ControlStates::EnabledState);
175         }
176     } else if (name == selectedAttr) {
177         // FIXME: This doesn't match what the HTML specification says.
178         // The specification implies that removing the selected attribute or
179         // changing the value of a selected attribute that is already present
180         // has no effect on whether the element is selected. Further, it seems
181         // that we need to do more than just set m_isSelected to select in that
182         // case; we'd need to do the other work from the setSelected function.
183         m_isSelected = !value.isNull();
184     } else
185         HTMLElement::parseAttribute(name, value);
186 }
187
188 String HTMLOptionElement::value() const
189 {
190     const AtomicString& value = fastGetAttribute(valueAttr);
191     if (!value.isNull())
192         return value;
193     return collectOptionInnerText().stripWhiteSpace(isHTMLSpace).simplifyWhiteSpace(isHTMLSpace);
194 }
195
196 void HTMLOptionElement::setValue(const String& value)
197 {
198     setAttribute(valueAttr, value);
199 }
200
201 bool HTMLOptionElement::selected()
202 {
203     if (HTMLSelectElement* select = ownerSelectElement())
204         select->updateListItemSelectedStates();
205     return m_isSelected;
206 }
207
208 void HTMLOptionElement::setSelected(bool selected)
209 {
210     if (m_isSelected == selected)
211         return;
212
213     setSelectedState(selected);
214
215     if (HTMLSelectElement* select = ownerSelectElement())
216         select->optionSelectionStateChanged(this, selected);
217 }
218
219 void HTMLOptionElement::setSelectedState(bool selected)
220 {
221     if (m_isSelected == selected)
222         return;
223
224     m_isSelected = selected;
225     setNeedsStyleRecalc();
226
227     if (HTMLSelectElement* select = ownerSelectElement())
228         select->invalidateSelectedItems();
229 }
230
231 void HTMLOptionElement::childrenChanged(const ChildChange& change)
232 {
233 #if ENABLE(DATALIST_ELEMENT)
234     if (HTMLDataListElement* dataList = ownerDataListElement())
235         dataList->optionElementChildrenChanged();
236     else
237 #endif
238     if (HTMLSelectElement* select = ownerSelectElement())
239         select->optionElementChildrenChanged();
240     HTMLElement::childrenChanged(change);
241 }
242
243 #if ENABLE(DATALIST_ELEMENT)
244 HTMLDataListElement* HTMLOptionElement::ownerDataListElement() const
245 {
246     for (ContainerNode* parent = parentNode(); parent ; parent = parent->parentNode()) {
247         if (is<HTMLDataListElement>(*parent))
248             return downcast<HTMLDataListElement>(parent);
249     }
250     return nullptr;
251 }
252 #endif
253
254 HTMLSelectElement* HTMLOptionElement::ownerSelectElement() const
255 {
256     ContainerNode* select = parentNode();
257     while (select && !is<HTMLSelectElement>(*select))
258         select = select->parentNode();
259
260     if (!select)
261         return nullptr;
262
263     return downcast<HTMLSelectElement>(select);
264 }
265
266 String HTMLOptionElement::label() const
267 {
268     const AtomicString& label = fastGetAttribute(labelAttr);
269     if (!label.isNull())
270         return label; 
271     return collectOptionInnerText().stripWhiteSpace(isHTMLSpace).simplifyWhiteSpace(isHTMLSpace);
272 }
273
274 void HTMLOptionElement::setLabel(const String& label)
275 {
276     setAttribute(labelAttr, label);
277 }
278
279 void HTMLOptionElement::willResetComputedStyle()
280 {
281     // FIXME: This is nasty, we ask our owner select to repaint even if the new
282     // style is exactly the same.
283     if (auto select = ownerSelectElement()) {
284         if (auto renderer = select->renderer())
285             renderer->repaint();
286     }
287 }
288
289 String HTMLOptionElement::textIndentedToRespectGroupLabel() const
290 {
291     ContainerNode* parent = parentNode();
292     if (is<HTMLOptGroupElement>(parent))
293         return "    " + label();
294     return label();
295 }
296
297 bool HTMLOptionElement::isDisabledFormControl() const
298 {
299     if (ownElementDisabled())
300         return true;
301
302     if (!is<HTMLOptGroupElement>(parentNode()))
303         return false;
304
305     return downcast<HTMLOptGroupElement>(*parentNode()).isDisabledFormControl();
306 }
307
308 Node::InsertionNotificationRequest HTMLOptionElement::insertedInto(ContainerNode& insertionPoint)
309 {
310     if (HTMLSelectElement* select = ownerSelectElement()) {
311         select->setRecalcListItems();
312         // Do not call selected() since calling updateListItemSelectedStates()
313         // at this time won't do the right thing. (Why, exactly?)
314         // FIXME: Might be better to call this unconditionally, always passing m_isSelected,
315         // rather than only calling it if we are selected.
316         if (m_isSelected)
317             select->optionSelectionStateChanged(this, true);
318         select->scrollToSelection();
319     }
320
321     return HTMLElement::insertedInto(insertionPoint);
322 }
323
324 String HTMLOptionElement::collectOptionInnerText() const
325 {
326     StringBuilder text;
327     for (Node* node = firstChild(); node; ) {
328         if (is<Text>(*node))
329             text.append(node->nodeValue());
330         // Text nodes inside script elements are not part of the option text.
331         if (is<Element>(*node) && toScriptElementIfPossible(downcast<Element>(node)))
332             node = NodeTraversal::nextSkippingChildren(*node, this);
333         else
334             node = NodeTraversal::next(*node, this);
335     }
336     return text.toString();
337 }
338
339 } // namespace