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