Stop bringing in the std namespace
[WebKit-https.git] / Source / WebCore / html / RangeInputType.cpp
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  * Copyright (C) 2011 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include "config.h"
33 #include "RangeInputType.h"
34
35 #include "AXObjectCache.h"
36 #include "ExceptionCodePlaceholder.h"
37 #include "HTMLDivElement.h"
38 #include "HTMLInputElement.h"
39 #include "HTMLNames.h"
40 #include "HTMLParserIdioms.h"
41 #include "InputTypeNames.h"
42 #include "KeyboardEvent.h"
43 #include "MouseEvent.h"
44 #include "PlatformMouseEvent.h"
45 #include "RenderSlider.h"
46 #include "ScopedEventQueue.h"
47 #include "ShadowRoot.h"
48 #include "SliderThumbElement.h"
49 #include "StepRange.h"
50 #include <limits>
51 #include <wtf/MathExtras.h>
52 #include <wtf/PassOwnPtr.h>
53
54 #if ENABLE(TOUCH_EVENTS)
55 #include "Touch.h"
56 #include "TouchEvent.h"
57 #include "TouchList.h"
58 #endif
59
60 #if ENABLE(DATALIST_ELEMENT)
61 #include "HTMLDataListElement.h"
62 #include "HTMLOptionElement.h"
63 #endif
64
65 namespace WebCore {
66
67 using namespace HTMLNames;
68
69 static const int rangeDefaultMinimum = 0;
70 static const int rangeDefaultMaximum = 100;
71 static const int rangeDefaultStep = 1;
72 static const int rangeDefaultStepBase = 0;
73 static const int rangeStepScaleFactor = 1;
74
75 static Decimal ensureMaximum(const Decimal& proposedValue, const Decimal& minimum, const Decimal& fallbackValue)
76 {
77     return proposedValue >= minimum ? proposedValue : std::max(minimum, fallbackValue);
78 }
79
80 OwnPtr<InputType> RangeInputType::create(HTMLInputElement& element)
81 {
82     return adoptPtr(new RangeInputType(element));
83 }
84
85 RangeInputType::RangeInputType(HTMLInputElement& element)
86     : InputType(element)
87 #if ENABLE(DATALIST_ELEMENT)
88     , m_tickMarkValuesDirty(true)
89 #endif
90 {
91 }
92
93 void RangeInputType::attach()
94 {
95     observeFeatureIfVisible(FeatureObserver::InputTypeRange);
96 }
97
98 bool RangeInputType::isRangeControl() const
99 {
100     return true;
101 }
102
103 const AtomicString& RangeInputType::formControlType() const
104 {
105     return InputTypeNames::range();
106 }
107
108 double RangeInputType::valueAsDouble() const
109 {
110     return parseToDoubleForNumberType(element().value());
111 }
112
113 void RangeInputType::setValueAsDecimal(const Decimal& newValue, TextFieldEventBehavior eventBehavior, ExceptionCode&) const
114 {
115     element().setValue(serialize(newValue), eventBehavior);
116 }
117
118 bool RangeInputType::typeMismatchFor(const String& value) const
119 {
120     return !value.isEmpty() && !std::isfinite(parseToDoubleForNumberType(value));
121 }
122
123 bool RangeInputType::supportsRequired() const
124 {
125     return false;
126 }
127
128 StepRange RangeInputType::createStepRange(AnyStepHandling anyStepHandling) const
129 {
130     DEFINE_STATIC_LOCAL(const StepRange::StepDescription, stepDescription, (rangeDefaultStep, rangeDefaultStepBase, rangeStepScaleFactor));
131
132     const Decimal minimum = parseToNumber(element().fastGetAttribute(minAttr), rangeDefaultMinimum);
133     const Decimal maximum = ensureMaximum(parseToNumber(element().fastGetAttribute(maxAttr), rangeDefaultMaximum), minimum, rangeDefaultMaximum);
134
135     const AtomicString& precisionValue = element().fastGetAttribute(precisionAttr);
136     if (!precisionValue.isNull()) {
137         const Decimal step = equalIgnoringCase(precisionValue, "float") ? Decimal::nan() : 1;
138         return StepRange(minimum, minimum, maximum, step, stepDescription);
139     }
140
141     const Decimal step = StepRange::parseStep(anyStepHandling, stepDescription, element().fastGetAttribute(stepAttr));
142     return StepRange(minimum, minimum, maximum, step, stepDescription);
143 }
144
145 bool RangeInputType::isSteppable() const
146 {
147     return true;
148 }
149
150 void RangeInputType::handleMouseDownEvent(MouseEvent* event)
151 {
152     if (element().isDisabledOrReadOnly())
153         return;
154
155     Node* targetNode = event->target()->toNode();
156     if (event->button() != LeftButton || !targetNode)
157         return;
158     ASSERT(element().shadowRoot());
159     if (targetNode != &element() && !targetNode->isDescendantOf(element().userAgentShadowRoot()))
160         return;
161     SliderThumbElement& thumb = typedSliderThumbElement();
162     if (targetNode == &thumb)
163         return;
164     thumb.dragFrom(event->absoluteLocation());
165 }
166
167 #if ENABLE(TOUCH_EVENTS)
168 #if ENABLE(TOUCH_SLIDER)
169 void RangeInputType::handleTouchEvent(TouchEvent* event)
170 {
171     if (element().isDisabledOrReadOnly())
172         return;
173
174     if (event->type() == eventNames().touchendEvent) {
175         event->setDefaultHandled();
176         return;
177     }
178
179     TouchList* touches = event->targetTouches();
180     if (touches->length() == 1) {
181         typedSliderThumbElement().setPositionFromPoint(touches->item(0)->absoluteLocation());
182         event->setDefaultHandled();
183     }
184 }
185
186 bool RangeInputType::hasTouchEventHandler() const
187 {
188     return true;
189 }
190 #endif
191 #endif
192
193 void RangeInputType::handleKeydownEvent(KeyboardEvent* event)
194 {
195     if (element().isDisabledOrReadOnly())
196         return;
197
198     const String& key = event->keyIdentifier();
199
200     const Decimal current = parseToNumberOrNaN(element().value());
201     ASSERT(current.isFinite());
202
203     StepRange stepRange(createStepRange(RejectAny));
204
205
206     // FIXME: We can't use stepUp() for the step value "any". So, we increase
207     // or decrease the value by 1/100 of the value range. Is it reasonable?
208     const Decimal step = equalIgnoringCase(element().fastGetAttribute(stepAttr), "any") ? (stepRange.maximum() - stepRange.minimum()) / 100 : stepRange.step();
209     const Decimal bigStep = std::max((stepRange.maximum() - stepRange.minimum()) / 10, step);
210
211     bool isVertical = false;
212     if (element().renderer()) {
213         ControlPart part = element().renderer()->style()->appearance();
214         isVertical = part == SliderVerticalPart || part == MediaVolumeSliderPart;
215     }
216
217     Decimal newValue;
218     if (key == "Up")
219         newValue = current + step;
220     else if (key == "Down")
221         newValue = current - step;
222     else if (key == "Left")
223         newValue = isVertical ? current + step : current - step;
224     else if (key == "Right")
225         newValue = isVertical ? current - step : current + step;
226     else if (key == "PageUp")
227         newValue = current + bigStep;
228     else if (key == "PageDown")
229         newValue = current - bigStep;
230     else if (key == "Home")
231         newValue = isVertical ? stepRange.maximum() : stepRange.minimum();
232     else if (key == "End")
233         newValue = isVertical ? stepRange.minimum() : stepRange.maximum();
234     else
235         return; // Did not match any key binding.
236
237     newValue = stepRange.clampValue(newValue);
238
239     if (newValue != current) {
240         EventQueueScope scope;
241         TextFieldEventBehavior eventBehavior = DispatchChangeEvent;
242         setValueAsDecimal(newValue, eventBehavior, IGNORE_EXCEPTION);
243
244         if (AXObjectCache* cache = element().document().existingAXObjectCache())
245             cache->postNotification(&element(), AXObjectCache::AXValueChanged);
246         element().dispatchFormControlChangeEvent();
247     }
248
249     event->setDefaultHandled();
250 }
251
252 void RangeInputType::createShadowSubtree()
253 {
254     ASSERT(element().userAgentShadowRoot());
255
256     Document& document = element().document();
257     RefPtr<HTMLDivElement> track = HTMLDivElement::create(document);
258     track->setPseudo(AtomicString("-webkit-slider-runnable-track", AtomicString::ConstructFromLiteral));
259     track->appendChild(SliderThumbElement::create(document), IGNORE_EXCEPTION);
260     RefPtr<HTMLElement> container = SliderContainerElement::create(document);
261     container->appendChild(track.release(), IGNORE_EXCEPTION);
262     element().userAgentShadowRoot()->appendChild(container.release(), IGNORE_EXCEPTION);
263 }
264
265 HTMLElement* RangeInputType::sliderTrackElement() const
266 {
267     ASSERT(element().userAgentShadowRoot());
268     ASSERT(element().userAgentShadowRoot()->firstChild()); // container
269     ASSERT(element().userAgentShadowRoot()->firstChild()->isHTMLElement());
270     ASSERT(element().userAgentShadowRoot()->firstChild()->firstChild()); // track
271
272     return &toHTMLElement(*element().userAgentShadowRoot()->firstChild()->firstChild());
273 }
274
275 SliderThumbElement& RangeInputType::typedSliderThumbElement() const
276 {
277     ASSERT(sliderTrackElement()->firstChild()); // thumb
278     ASSERT(sliderTrackElement()->firstChild()->isHTMLElement());
279
280     return static_cast<SliderThumbElement&>(*sliderTrackElement()->firstChild());
281 }
282
283 HTMLElement* RangeInputType::sliderThumbElement() const
284 {
285     return &typedSliderThumbElement();
286 }
287
288 RenderElement* RangeInputType::createRenderer(RenderStyle&) const
289 {
290     return new RenderSlider(element());
291 }
292
293 Decimal RangeInputType::parseToNumber(const String& src, const Decimal& defaultValue) const
294 {
295     return parseToDecimalForNumberType(src, defaultValue);
296 }
297
298 String RangeInputType::serialize(const Decimal& value) const
299 {
300     if (!value.isFinite())
301         return String();
302     return serializeForNumberType(value);
303 }
304
305 // FIXME: Could share this with BaseClickableWithKeyInputType and BaseCheckableInputType if we had a common base class.
306 void RangeInputType::accessKeyAction(bool sendMouseEvents)
307 {
308     InputType::accessKeyAction(sendMouseEvents);
309
310     element().dispatchSimulatedClick(0, sendMouseEvents ? SendMouseUpDownEvents : SendNoEvents);
311 }
312
313 void RangeInputType::minOrMaxAttributeChanged()
314 {
315     InputType::minOrMaxAttributeChanged();
316
317     // Sanitize the value.
318     if (element().hasDirtyValue())
319         element().setValue(element().value());
320
321     typedSliderThumbElement().setPositionFromValue();
322 }
323
324 void RangeInputType::setValue(const String& value, bool valueChanged, TextFieldEventBehavior eventBehavior)
325 {
326     InputType::setValue(value, valueChanged, eventBehavior);
327
328     if (!valueChanged)
329         return;
330
331     typedSliderThumbElement().setPositionFromValue();
332 }
333
334 String RangeInputType::fallbackValue() const
335 {
336     return serializeForNumberType(createStepRange(RejectAny).defaultValue());
337 }
338
339 String RangeInputType::sanitizeValue(const String& proposedValue) const
340 {
341     StepRange stepRange(createStepRange(RejectAny));
342     const Decimal proposedNumericValue = parseToNumber(proposedValue, stepRange.defaultValue());
343     return serializeForNumberType(stepRange.clampValue(proposedNumericValue));
344 }
345
346 bool RangeInputType::shouldRespectListAttribute()
347 {
348     return InputType::themeSupportsDataListUI(this);
349 }
350
351 #if ENABLE(DATALIST_ELEMENT)
352 void RangeInputType::listAttributeTargetChanged()
353 {
354     m_tickMarkValuesDirty = true;
355     HTMLElement* sliderTrackElement = this->sliderTrackElement();
356     if (sliderTrackElement->renderer())
357         sliderTrackElement->renderer()->setNeedsLayout();
358 }
359
360 void RangeInputType::updateTickMarkValues()
361 {
362     if (!m_tickMarkValuesDirty)
363         return;
364     m_tickMarkValues.clear();
365     m_tickMarkValuesDirty = false;
366     HTMLDataListElement* dataList = element().dataList();
367     if (!dataList)
368         return;
369     RefPtr<HTMLCollection> options = dataList->options();
370     m_tickMarkValues.reserveCapacity(options->length());
371     for (unsigned i = 0; i < options->length(); ++i) {
372         Node* node = options->item(i);
373         HTMLOptionElement* optionElement = toHTMLOptionElement(node);
374         String optionValue = optionElement->value();
375         if (!element().isValidValue(optionValue))
376             continue;
377         m_tickMarkValues.append(parseToNumber(optionValue, Decimal::nan()));
378     }
379     m_tickMarkValues.shrinkToFit();
380     std::sort(m_tickMarkValues.begin(), m_tickMarkValues.end());
381 }
382
383 Decimal RangeInputType::findClosestTickMarkValue(const Decimal& value)
384 {
385     updateTickMarkValues();
386     if (!m_tickMarkValues.size())
387         return Decimal::nan();
388
389     size_t left = 0;
390     size_t right = m_tickMarkValues.size();
391     size_t middle;
392     while (true) {
393         ASSERT(left <= right);
394         middle = left + (right - left) / 2;
395         if (!middle)
396             break;
397         if (middle == m_tickMarkValues.size() - 1 && m_tickMarkValues[middle] < value) {
398             middle++;
399             break;
400         }
401         if (m_tickMarkValues[middle - 1] <= value && m_tickMarkValues[middle] >= value)
402             break;
403
404         if (m_tickMarkValues[middle] < value)
405             left = middle;
406         else
407             right = middle;
408     }
409     const Decimal closestLeft = middle ? m_tickMarkValues[middle - 1] : Decimal::infinity(Decimal::Negative);
410     const Decimal closestRight = middle != m_tickMarkValues.size() ? m_tickMarkValues[middle] : Decimal::infinity(Decimal::Positive);
411     if (closestRight - value < value - closestLeft)
412         return closestRight;
413     return closestLeft;
414 }
415 #endif
416
417 } // namespace WebCore