Adopt is/toHTMLOptionElement for code cleanup
[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 "Attribute.h"
31 #include "Document.h"
32 #include "ExceptionCode.h"
33 #include "HTMLDataListElement.h"
34 #include "HTMLNames.h"
35 #include "HTMLParserIdioms.h"
36 #include "HTMLSelectElement.h"
37 #include "NodeRenderStyle.h"
38 #include "NodeRenderingContext.h"
39 #include "NodeTraversal.h"
40 #include "RenderMenuList.h"
41 #include "RenderTheme.h"
42 #include "ScriptElement.h"
43 #include "StyleResolver.h"
44 #include "Text.h"
45 #include <wtf/Vector.h>
46 #include <wtf/text/StringBuilder.h>
47
48 namespace WebCore {
49
50 using namespace HTMLNames;
51
52 HTMLOptionElement::HTMLOptionElement(const QualifiedName& tagName, Document* document)
53     : HTMLElement(tagName, document)
54     , m_disabled(false)
55     , m_isSelected(false)
56 {
57     ASSERT(hasTagName(optionTag));
58     setHasCustomStyleCallbacks();
59 }
60
61 PassRefPtr<HTMLOptionElement> HTMLOptionElement::create(Document* document)
62 {
63     return adoptRef(new HTMLOptionElement(optionTag, document));
64 }
65
66 PassRefPtr<HTMLOptionElement> HTMLOptionElement::create(const QualifiedName& tagName, Document* document)
67 {
68     return adoptRef(new HTMLOptionElement(tagName, document));
69 }
70
71 PassRefPtr<HTMLOptionElement> HTMLOptionElement::createForJSConstructor(Document* document, const String& data, const String& value,
72         bool defaultSelected, bool selected, ExceptionCode& ec)
73 {
74     RefPtr<HTMLOptionElement> element = adoptRef(new HTMLOptionElement(optionTag, document));
75
76     RefPtr<Text> text = Text::create(document, data.isNull() ? "" : data);
77
78     ec = 0;
79     element->appendChild(text.release(), ec);
80     if (ec)
81         return 0;
82
83     if (!value.isNull())
84         element->setValue(value);
85     if (defaultSelected)
86         element->setAttribute(selectedAttr, emptyAtom);
87     element->setSelected(selected);
88
89     return element.release();
90 }
91
92 void HTMLOptionElement::attach(const AttachContext& context)
93 {
94     HTMLElement::attach(context);
95     // If after attaching nothing called styleForRenderer() on this node we
96     // manually cache the value. This happens if our parent doesn't have a
97     // renderer like <optgroup> or if it doesn't allow children like <select>.
98     if (!m_style && parentNode()->renderStyle())
99         updateNonRenderStyle();
100 }
101
102 void HTMLOptionElement::detach(const AttachContext& context)
103 {
104     m_style.clear();
105     HTMLElement::detach(context);
106 }
107
108 bool HTMLOptionElement::isFocusable() const
109 {
110     // Option elements do not have a renderer so we check the renderStyle instead.
111     return supportsFocus() && renderStyle() && renderStyle()->display() != NONE;
112 }
113
114 String HTMLOptionElement::text() const
115 {
116     Document* document = this->document();
117     String text;
118
119     // WinIE does not use the label attribute, so as a quirk, we ignore it.
120     if (!document->inQuirksMode())
121         text = fastGetAttribute(labelAttr);
122
123     // FIXME: The following treats an element with the label attribute set to
124     // the empty string the same as an element with no label attribute at all.
125     // Is that correct? If it is, then should the label function work the same way?
126     if (text.isEmpty())
127         text = collectOptionInnerText();
128
129     // FIXME: Is displayStringModifiedByEncoding helpful here?
130     // If it's correct here, then isn't it needed in the value and label functions too?
131     return document->displayStringModifiedByEncoding(text).stripWhiteSpace(isHTMLSpace).simplifyWhiteSpace(isHTMLSpace);
132 }
133
134 void HTMLOptionElement::setText(const String &text, ExceptionCode& ec)
135 {
136     RefPtr<Node> protectFromMutationEvents(this);
137
138     // Changing the text causes a recalc of a select's items, which will reset the selected
139     // index to the first item if the select is single selection with a menu list. We attempt to
140     // preserve the selected item.
141     RefPtr<HTMLSelectElement> select = ownerSelectElement();
142     bool selectIsMenuList = select && select->usesMenuList();
143     int oldSelectedIndex = selectIsMenuList ? select->selectedIndex() : -1;
144
145     // Handle the common special case where there's exactly 1 child node, and it's a text node.
146     Node* child = firstChild();
147     if (child && child->isTextNode() && !child->nextSibling())
148         toText(child)->setData(text, ec);
149     else {
150         removeChildren();
151         appendChild(Text::create(document(), text), ec);
152     }
153     
154     if (selectIsMenuList && select->selectedIndex() != oldSelectedIndex)
155         select->setSelectedIndex(oldSelectedIndex);
156 }
157
158 void HTMLOptionElement::accessKeyAction(bool)
159 {
160     HTMLSelectElement* select = ownerSelectElement();
161     if (select)
162         select->accessKeySetSelectedIndex(index());
163 }
164
165 int HTMLOptionElement::index() const
166 {
167     // It would be faster to cache the index, but harder to get it right in all cases.
168
169     HTMLSelectElement* selectElement = ownerSelectElement();
170     if (!selectElement)
171         return 0;
172
173     int optionIndex = 0;
174
175     const Vector<HTMLElement*>& items = selectElement->listItems();
176     size_t length = items.size();
177     for (size_t i = 0; i < length; ++i) {
178         if (!isHTMLOptionElement(items[i]))
179             continue;
180         if (items[i] == this)
181             return optionIndex;
182         ++optionIndex;
183     }
184
185     return 0;
186 }
187
188 void HTMLOptionElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
189 {
190 #if ENABLE(DATALIST_ELEMENT)
191     if (name == valueAttr) {
192         if (HTMLDataListElement* dataList = ownerDataListElement())
193             dataList->optionElementChildrenChanged();
194     } else
195 #endif
196     if (name == disabledAttr) {
197         bool oldDisabled = m_disabled;
198         m_disabled = !value.isNull();
199         if (oldDisabled != m_disabled) {
200             didAffectSelector(AffectedSelectorDisabled | AffectedSelectorEnabled);
201             if (renderer() && renderer()->style()->hasAppearance())
202                 renderer()->theme()->stateChanged(renderer(), EnabledState);
203         }
204     } else if (name == selectedAttr) {
205         // FIXME: This doesn't match what the HTML specification says.
206         // The specification implies that removing the selected attribute or
207         // changing the value of a selected attribute that is already present
208         // has no effect on whether the element is selected. Further, it seems
209         // that we need to do more than just set m_isSelected to select in that
210         // case; we'd need to do the other work from the setSelected function.
211         m_isSelected = !value.isNull();
212     } else
213         HTMLElement::parseAttribute(name, value);
214 }
215
216 String HTMLOptionElement::value() const
217 {
218     const AtomicString& value = fastGetAttribute(valueAttr);
219     if (!value.isNull())
220         return value;
221     return collectOptionInnerText().stripWhiteSpace(isHTMLSpace).simplifyWhiteSpace(isHTMLSpace);
222 }
223
224 void HTMLOptionElement::setValue(const String& value)
225 {
226     setAttribute(valueAttr, value);
227 }
228
229 bool HTMLOptionElement::selected()
230 {
231     if (HTMLSelectElement* select = ownerSelectElement())
232         select->updateListItemSelectedStates();
233     return m_isSelected;
234 }
235
236 void HTMLOptionElement::setSelected(bool selected)
237 {
238     if (m_isSelected == selected)
239         return;
240
241     setSelectedState(selected);
242
243     if (HTMLSelectElement* select = ownerSelectElement())
244         select->optionSelectionStateChanged(this, selected);
245 }
246
247 void HTMLOptionElement::setSelectedState(bool selected)
248 {
249     if (m_isSelected == selected)
250         return;
251
252     m_isSelected = selected;
253     didAffectSelector(AffectedSelectorChecked);
254
255     if (HTMLSelectElement* select = ownerSelectElement())
256         select->invalidateSelectedItems();
257 }
258
259 void HTMLOptionElement::childrenChanged(bool changedByParser, Node* beforeChange, Node* afterChange, int childCountDelta)
260 {
261 #if ENABLE(DATALIST_ELEMENT)
262     if (HTMLDataListElement* dataList = ownerDataListElement())
263         dataList->optionElementChildrenChanged();
264     else
265 #endif
266     if (HTMLSelectElement* select = ownerSelectElement())
267         select->optionElementChildrenChanged();
268     HTMLElement::childrenChanged(changedByParser, beforeChange, afterChange, childCountDelta);
269 }
270
271 #if ENABLE(DATALIST_ELEMENT)
272 HTMLDataListElement* HTMLOptionElement::ownerDataListElement() const
273 {
274     for (ContainerNode* parent = parentNode(); parent ; parent = parent->parentNode()) {
275         if (parent->hasTagName(datalistTag))
276             return static_cast<HTMLDataListElement*>(parent);
277     }
278     return 0;
279 }
280 #endif
281
282 HTMLSelectElement* HTMLOptionElement::ownerSelectElement() const
283 {
284     ContainerNode* select = parentNode();
285     while (select && !select->hasTagName(selectTag))
286         select = select->parentNode();
287
288     if (!select)
289         return 0;
290
291     return toHTMLSelectElement(select);
292 }
293
294 String HTMLOptionElement::label() const
295 {
296     const AtomicString& label = fastGetAttribute(labelAttr);
297     if (!label.isNull())
298         return label; 
299     return collectOptionInnerText().stripWhiteSpace(isHTMLSpace).simplifyWhiteSpace(isHTMLSpace);
300 }
301
302 void HTMLOptionElement::setLabel(const String& label)
303 {
304     setAttribute(labelAttr, label);
305 }
306
307 void HTMLOptionElement::updateNonRenderStyle()
308 {
309     m_style = document()->ensureStyleResolver()->styleForElement(this);
310 }
311
312 RenderStyle* HTMLOptionElement::nonRendererStyle() const
313 {
314     return m_style.get();
315 }
316
317 PassRefPtr<RenderStyle> HTMLOptionElement::customStyleForRenderer()
318 {
319     // styleForRenderer is called whenever a new style should be associated
320     // with an Element so now is a good time to update our cached style.
321     updateNonRenderStyle();
322     return m_style;
323 }
324
325 void HTMLOptionElement::didRecalcStyle(StyleChange)
326 {
327     // FIXME: This is nasty, we ask our owner select to repaint even if the new
328     // style is exactly the same.
329     if (HTMLSelectElement* select = ownerSelectElement()) {
330         if (RenderObject* renderer = select->renderer())
331             renderer->repaint();
332     }
333 }
334
335 String HTMLOptionElement::textIndentedToRespectGroupLabel() const
336 {
337     ContainerNode* parent = parentNode();
338     if (parent && parent->hasTagName(optgroupTag))
339         return "    " + text();
340     return text();
341 }
342
343 bool HTMLOptionElement::isDisabledFormControl() const
344 {
345     if (ownElementDisabled())
346         return true;
347
348     if (!parentNode() || !parentNode()->isHTMLElement())
349         return false;
350
351     HTMLElement* parentElement = static_cast<HTMLElement*>(parentNode());
352     return parentElement->hasTagName(optgroupTag) && parentElement->isDisabledFormControl();
353 }
354
355 Node::InsertionNotificationRequest HTMLOptionElement::insertedInto(ContainerNode* insertionPoint)
356 {
357     if (HTMLSelectElement* select = ownerSelectElement()) {
358         select->setRecalcListItems();
359         // Do not call selected() since calling updateListItemSelectedStates()
360         // at this time won't do the right thing. (Why, exactly?)
361         // FIXME: Might be better to call this unconditionally, always passing m_isSelected,
362         // rather than only calling it if we are selected.
363         if (m_isSelected)
364             select->optionSelectionStateChanged(this, true);
365         select->scrollToSelection();
366     }
367
368     return HTMLElement::insertedInto(insertionPoint);
369 }
370
371 String HTMLOptionElement::collectOptionInnerText() const
372 {
373     StringBuilder text;
374     for (Node* node = firstChild(); node; ) {
375         if (node->isTextNode())
376             text.append(node->nodeValue());
377         // Text nodes inside script elements are not part of the option text.
378         if (node->isElementNode() && toScriptElementIfPossible(toElement(node)))
379             node = NodeTraversal::nextSkippingChildren(node, this);
380         else
381             node = NodeTraversal::next(node, this);
382     }
383     return text.toString();
384 }
385
386 } // namespace