INPUT_MULTIPLE_FIELDS_UI: Step-up/-down of hour field should respect min/max attributes
[WebKit-https.git] / Source / WebCore / html / TimeInputType.cpp
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32 #if ENABLE(INPUT_TYPE_TIME)
33 #include "TimeInputType.h"
34
35 #include "DateComponents.h"
36 #include "HTMLInputElement.h"
37 #include "HTMLNames.h"
38 #include "InputTypeNames.h"
39 #include <wtf/CurrentTime.h>
40 #include <wtf/DateMath.h>
41 #include <wtf/MathExtras.h>
42 #include <wtf/PassOwnPtr.h>
43
44 #if ENABLE(INPUT_MULTIPLE_FIELDS_UI)
45 #include "DateTimeFieldsState.h"
46 #include "PlatformLocale.h"
47 #include <wtf/text/WTFString.h>
48 #endif
49
50 namespace WebCore {
51
52 using namespace HTMLNames;
53
54 static const int timeDefaultStep = 60;
55 static const int timeDefaultStepBase = 0;
56 static const int timeStepScaleFactor = 1000;
57
58 TimeInputType::TimeInputType(HTMLInputElement*  element)
59     : BaseTimeInputType(element)
60 {
61 }
62
63 PassOwnPtr<InputType> TimeInputType::create(HTMLInputElement* element)
64 {
65     return adoptPtr(new TimeInputType(element));
66 }
67
68 void TimeInputType::attach()
69 {
70     observeFeatureIfVisible(FeatureObserver::InputTypeTime);
71 }
72
73 const AtomicString& TimeInputType::formControlType() const
74 {
75     return InputTypeNames::time();
76 }
77
78 DateComponents::Type TimeInputType::dateType() const
79 {
80     return DateComponents::Time;
81 }
82
83 Decimal TimeInputType::defaultValueForStepUp() const
84 {
85     double current = currentTimeMS();
86     double utcOffset = calculateUTCOffset();
87     double dstOffset = calculateDSTOffset(current, utcOffset);
88     int offset = static_cast<int>((utcOffset + dstOffset) / msPerMinute);
89     current += offset * msPerMinute;
90
91     DateComponents date;
92     date.setMillisecondsSinceMidnight(current);
93     double milliseconds = date.millisecondsSinceEpoch();
94     ASSERT(std::isfinite(milliseconds));
95     return Decimal::fromDouble(milliseconds);
96 }
97
98 StepRange TimeInputType::createStepRange(AnyStepHandling anyStepHandling) const
99 {
100     DEFINE_STATIC_LOCAL(const StepRange::StepDescription, stepDescription, (timeDefaultStep, timeDefaultStepBase, timeStepScaleFactor, StepRange::ScaledStepValueShouldBeInteger));
101
102     const Decimal stepBase = parseToNumber(element()->fastGetAttribute(minAttr), 0);
103     const Decimal minimum = parseToNumber(element()->fastGetAttribute(minAttr), Decimal::fromDouble(DateComponents::minimumTime()));
104     const Decimal maximum = parseToNumber(element()->fastGetAttribute(maxAttr), Decimal::fromDouble(DateComponents::maximumTime()));
105     const Decimal step = StepRange::parseStep(anyStepHandling, stepDescription, element()->fastGetAttribute(stepAttr));
106     return StepRange(stepBase, minimum, maximum, step, stepDescription);
107 }
108
109 bool TimeInputType::parseToDateComponentsInternal(const UChar* characters, unsigned length, DateComponents* out) const
110 {
111     ASSERT(out);
112     unsigned end;
113     return out->parseTime(characters, length, 0, end) && end == length;
114 }
115
116 bool TimeInputType::setMillisecondToDateComponents(double value, DateComponents* date) const
117 {
118     ASSERT(date);
119     return date->setMillisecondsSinceMidnight(value);
120 }
121
122 bool TimeInputType::isTimeField() const
123 {
124     return true;
125 }
126
127 #if ENABLE(INPUT_MULTIPLE_FIELDS_UI)
128
129 String TimeInputType::localizeValue(const String& proposedValue) const
130 {
131     DateComponents date;
132     if (!parseToDateComponents(proposedValue, &date))
133         return proposedValue;
134
135     Locale::FormatType formatType = shouldHaveSecondField(date) ? Locale::FormatTypeMedium : Locale::FormatTypeShort;
136
137     String localized = element()->locale().formatDateTime(date, formatType);
138     return localized.isEmpty() ? proposedValue : localized;
139 }
140
141 String TimeInputType::formatDateTimeFieldsState(const DateTimeFieldsState& dateTimeFieldsState) const
142 {
143     if (!dateTimeFieldsState.hasHour() || !dateTimeFieldsState.hasMinute() || !dateTimeFieldsState.hasAMPM())
144         return emptyString();
145     if (dateTimeFieldsState.hasMillisecond() && dateTimeFieldsState.millisecond())
146         return String::format("%02u:%02u:%02u.%03u",
147                 dateTimeFieldsState.hour23(),
148                 dateTimeFieldsState.minute(),
149                 dateTimeFieldsState.hasSecond() ? dateTimeFieldsState.second() : 0,
150                 dateTimeFieldsState.millisecond());
151     if (dateTimeFieldsState.hasSecond() && dateTimeFieldsState.second())
152         return String::format("%02u:%02u:%02u",
153                 dateTimeFieldsState.hour23(),
154                 dateTimeFieldsState.minute(),
155                 dateTimeFieldsState.second());
156     return String::format("%02u:%02u", dateTimeFieldsState.hour23(), dateTimeFieldsState.minute());
157 }
158
159 void TimeInputType::setupLayoutParameters(DateTimeEditElement::LayoutParameters& layoutParameters, const DateComponents& date) const
160 {
161     if (shouldHaveSecondField(date)) {
162         layoutParameters.dateTimeFormat = layoutParameters.locale.timeFormat();
163         layoutParameters.fallbackDateTimeFormat = "HH:mm:ss";
164     } else {
165         layoutParameters.dateTimeFormat = layoutParameters.locale.shortTimeFormat();
166         layoutParameters.fallbackDateTimeFormat = "HH:mm";
167     }
168     if (!parseToDateComponents(element()->fastGetAttribute(minAttr), &layoutParameters.minimum))
169         layoutParameters.minimum = DateComponents();
170     if (!parseToDateComponents(element()->fastGetAttribute(maxAttr), &layoutParameters.maximum))
171         layoutParameters.maximum = DateComponents();
172 }
173 #endif
174
175 } // namespace WebCore
176
177 #endif