[iOS] Add support for input[type=color]
[WebKit-https.git] / Source / WebCore / html / ColorInputType.cpp
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  * Copyright (C) 2015-2018 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
34 #if ENABLE(INPUT_TYPE_COLOR)
35
36 #include "ColorInputType.h"
37
38 #include "CSSPropertyNames.h"
39 #include "Chrome.h"
40 #include "Color.h"
41 #include "ElementChildIterator.h"
42 #include "Event.h"
43 #include "HTMLDataListElement.h"
44 #include "HTMLDivElement.h"
45 #include "HTMLInputElement.h"
46 #include "HTMLOptionElement.h"
47 #include "InputTypeNames.h"
48 #include "RenderView.h"
49 #include "ScopedEventQueue.h"
50 #include "ShadowRoot.h"
51 #include "UserGestureIndicator.h"
52
53 namespace WebCore {
54
55 using namespace HTMLNames;
56
57 // https://html.spec.whatwg.org/multipage/infrastructure.html#valid-simple-colour
58 static bool isValidSimpleColor(StringView string)
59 {
60     if (string.length() != 7)
61         return false;
62     if (string[0] != '#')
63         return false;
64     for (unsigned i = 1; i < 7; ++i) {
65         if (!isASCIIHexDigit(string[i]))
66             return false;
67     }
68     return true;
69 }
70
71 // https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#rules-for-parsing-simple-colour-values
72 static std::optional<RGBA32> parseSimpleColorValue(StringView string)
73 {
74     if (!isValidSimpleColor(string))
75         return std::nullopt;
76     return makeRGB(toASCIIHexValue(string[1], string[2]), toASCIIHexValue(string[3], string[4]), toASCIIHexValue(string[5], string[6]));
77 }
78
79 ColorInputType::~ColorInputType()
80 {
81     endColorChooser();
82 }
83
84 bool ColorInputType::isMouseFocusable() const
85 {
86     ASSERT(element());
87     return element()->isTextFormControlFocusable();
88 }
89
90 bool ColorInputType::isKeyboardFocusable(KeyboardEvent*) const
91 {
92     ASSERT(element());
93 #if PLATFORM(IOS)
94     if (element()->isReadOnly())
95         return false;
96
97     return element()->isTextFormControlFocusable();
98 #endif
99     return false;
100 }
101
102 bool ColorInputType::isColorControl() const
103 {
104     return true;
105 }
106
107 const AtomicString& ColorInputType::formControlType() const
108 {
109     return InputTypeNames::color();
110 }
111
112 bool ColorInputType::supportsRequired() const
113 {
114     return false;
115 }
116
117 String ColorInputType::fallbackValue() const
118 {
119     return "#000000"_s;
120 }
121
122 String ColorInputType::sanitizeValue(const String& proposedValue) const
123 {
124     if (!isValidSimpleColor(proposedValue))
125         return fallbackValue();
126
127     return proposedValue.convertToASCIILowercase();
128 }
129
130 Color ColorInputType::valueAsColor() const
131 {
132     ASSERT(element());
133     return parseSimpleColorValue(element()->value()).value();
134 }
135
136 void ColorInputType::createShadowSubtree()
137 {
138     ASSERT(element());
139     ASSERT(element()->shadowRoot());
140
141     Document& document = element()->document();
142     auto wrapperElement = HTMLDivElement::create(document);
143     wrapperElement->setPseudo(AtomicString("-webkit-color-swatch-wrapper", AtomicString::ConstructFromLiteral));
144     auto colorSwatch = HTMLDivElement::create(document);
145     colorSwatch->setPseudo(AtomicString("-webkit-color-swatch", AtomicString::ConstructFromLiteral));
146     wrapperElement->appendChild(colorSwatch);
147     element()->userAgentShadowRoot()->appendChild(wrapperElement);
148
149     updateColorSwatch();
150 }
151
152 void ColorInputType::setValue(const String& value, bool valueChanged, TextFieldEventBehavior eventBehavior)
153 {
154     InputType::setValue(value, valueChanged, eventBehavior);
155
156     if (!valueChanged)
157         return;
158
159     updateColorSwatch();
160     if (m_chooser)
161         m_chooser->setSelectedColor(valueAsColor());
162 }
163
164 void ColorInputType::handleDOMActivateEvent(Event& event)
165 {
166     ASSERT(element());
167     if (element()->isDisabledFormControl() || !element()->renderer())
168         return;
169
170     if (!UserGestureIndicator::processingUserGesture())
171         return;
172
173     if (Chrome* chrome = this->chrome()) {
174         if (!m_chooser)
175             m_chooser = chrome->createColorChooser(*this, valueAsColor());
176         else
177             m_chooser->reattachColorChooser(valueAsColor());
178     }
179
180     event.setDefaultHandled();
181 }
182
183 void ColorInputType::detach()
184 {
185     endColorChooser();
186 }
187
188 bool ColorInputType::shouldRespectListAttribute()
189 {
190     return InputType::themeSupportsDataListUI(this);
191 }
192
193 bool ColorInputType::typeMismatchFor(const String& value) const
194 {
195     return !isValidSimpleColor(value);
196 }
197
198 bool ColorInputType::shouldResetOnDocumentActivation()
199 {
200     return true;
201 }
202
203 void ColorInputType::didChooseColor(const Color& color)
204 {
205     ASSERT(element());
206     if (element()->isDisabledFormControl() || color == valueAsColor())
207         return;
208     EventQueueScope scope;
209     element()->setValueFromRenderer(color.serialized());
210     updateColorSwatch();
211     element()->dispatchFormControlChangeEvent();
212 }
213
214 void ColorInputType::didEndChooser()
215 {
216     m_chooser = nullptr;
217 }
218
219 void ColorInputType::endColorChooser()
220 {
221     if (m_chooser)
222         m_chooser->endChooser();
223 }
224
225 void ColorInputType::updateColorSwatch()
226 {
227     RefPtr<HTMLElement> colorSwatch = shadowColorSwatch();
228     if (!colorSwatch)
229         return;
230
231     ASSERT(element());
232     colorSwatch->setInlineStyleProperty(CSSPropertyBackgroundColor, element()->value(), false);
233 }
234
235 HTMLElement* ColorInputType::shadowColorSwatch() const
236 {
237     ASSERT(element());
238     RefPtr<ShadowRoot> shadow = element()->userAgentShadowRoot();
239     if (!shadow)
240         return nullptr;
241
242     auto wrapper = childrenOfType<HTMLDivElement>(*shadow).first();
243     if (!wrapper)
244         return nullptr;
245
246     return childrenOfType<HTMLDivElement>(*wrapper).first();
247 }
248
249 IntRect ColorInputType::elementRectRelativeToRootView() const
250 {
251     ASSERT(element());
252     if (!element()->renderer())
253         return IntRect();
254     return element()->document().view()->contentsToRootView(element()->renderer()->absoluteBoundingBoxRect());
255 }
256
257 Color ColorInputType::currentColor()
258 {
259     return valueAsColor();
260 }
261
262 bool ColorInputType::shouldShowSuggestions() const
263 {
264 #if ENABLE(DATALIST_ELEMENT)
265     ASSERT(element());
266     return element()->hasAttributeWithoutSynchronization(listAttr);
267 #else
268     return false;
269 #endif
270 }
271
272 Vector<Color> ColorInputType::suggestions() const
273 {
274     Vector<Color> suggestions;
275 #if ENABLE(DATALIST_ELEMENT)
276     ASSERT(element());
277     if (auto dataList = element()->dataList()) {
278         Ref<HTMLCollection> options = dataList->options();
279         unsigned length = options->length();
280         suggestions.reserveInitialCapacity(length);
281         for (unsigned i = 0; i != length; ++i) {
282             auto value = downcast<HTMLOptionElement>(*options->item(i)).value();
283             if (isValidSimpleColor(value))
284                 suggestions.uncheckedAppend(Color(value));
285         }
286     }
287 #endif
288     return suggestions;
289 }
290
291 void ColorInputType::selectColor(StringView string)
292 {
293     if (auto color = parseSimpleColorValue(string))
294         didChooseColor(color.value());
295 }
296
297 } // namespace WebCore
298
299 #endif // ENABLE(INPUT_TYPE_COLOR)