14157821690e3852c970b05bd92382bb1d1195b0
[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 bool ColorInputType::isPresentingAttachedView() const
108 {
109     return !!m_chooser;
110 }
111
112 const AtomicString& ColorInputType::formControlType() const
113 {
114     return InputTypeNames::color();
115 }
116
117 bool ColorInputType::supportsRequired() const
118 {
119     return false;
120 }
121
122 String ColorInputType::fallbackValue() const
123 {
124     return "#000000"_s;
125 }
126
127 String ColorInputType::sanitizeValue(const String& proposedValue) const
128 {
129     if (!isValidSimpleColor(proposedValue))
130         return fallbackValue();
131
132     return proposedValue.convertToASCIILowercase();
133 }
134
135 Color ColorInputType::valueAsColor() const
136 {
137     ASSERT(element());
138     return parseSimpleColorValue(element()->value()).value();
139 }
140
141 void ColorInputType::createShadowSubtree()
142 {
143     ASSERT(element());
144     ASSERT(element()->shadowRoot());
145
146     Document& document = element()->document();
147     auto wrapperElement = HTMLDivElement::create(document);
148     wrapperElement->setPseudo(AtomicString("-webkit-color-swatch-wrapper", AtomicString::ConstructFromLiteral));
149     auto colorSwatch = HTMLDivElement::create(document);
150     colorSwatch->setPseudo(AtomicString("-webkit-color-swatch", AtomicString::ConstructFromLiteral));
151     wrapperElement->appendChild(colorSwatch);
152     element()->userAgentShadowRoot()->appendChild(wrapperElement);
153
154     updateColorSwatch();
155 }
156
157 void ColorInputType::setValue(const String& value, bool valueChanged, TextFieldEventBehavior eventBehavior)
158 {
159     InputType::setValue(value, valueChanged, eventBehavior);
160
161     if (!valueChanged)
162         return;
163
164     updateColorSwatch();
165     if (m_chooser)
166         m_chooser->setSelectedColor(valueAsColor());
167 }
168
169 void ColorInputType::handleDOMActivateEvent(Event& event)
170 {
171     ASSERT(element());
172     if (element()->isDisabledFormControl() || !element()->renderer())
173         return;
174
175     if (!UserGestureIndicator::processingUserGesture())
176         return;
177
178     if (Chrome* chrome = this->chrome()) {
179         if (!m_chooser)
180             m_chooser = chrome->createColorChooser(*this, valueAsColor());
181         else
182             m_chooser->reattachColorChooser(valueAsColor());
183     }
184
185     event.setDefaultHandled();
186 }
187
188 void ColorInputType::detach()
189 {
190     endColorChooser();
191 }
192
193 void ColorInputType::elementDidBlur()
194 {
195     endColorChooser();
196 }
197
198 bool ColorInputType::shouldRespectListAttribute()
199 {
200     return true;
201 }
202
203 bool ColorInputType::typeMismatchFor(const String& value) const
204 {
205     return !isValidSimpleColor(value);
206 }
207
208 bool ColorInputType::shouldResetOnDocumentActivation()
209 {
210     return true;
211 }
212
213 void ColorInputType::didChooseColor(const Color& color)
214 {
215     ASSERT(element());
216     if (element()->isDisabledFormControl() || color == valueAsColor())
217         return;
218     EventQueueScope scope;
219     element()->setValueFromRenderer(color.serialized());
220     updateColorSwatch();
221     element()->dispatchFormControlChangeEvent();
222 }
223
224 void ColorInputType::didEndChooser()
225 {
226     m_chooser = nullptr;
227     if (element()->renderer())
228         element()->renderer()->repaint();
229 }
230
231 void ColorInputType::endColorChooser()
232 {
233     if (m_chooser)
234         m_chooser->endChooser();
235 }
236
237 void ColorInputType::updateColorSwatch()
238 {
239     RefPtr<HTMLElement> colorSwatch = shadowColorSwatch();
240     if (!colorSwatch)
241         return;
242
243     ASSERT(element());
244     colorSwatch->setInlineStyleProperty(CSSPropertyBackgroundColor, element()->value(), false);
245 }
246
247 HTMLElement* ColorInputType::shadowColorSwatch() const
248 {
249     ASSERT(element());
250     RefPtr<ShadowRoot> shadow = element()->userAgentShadowRoot();
251     if (!shadow)
252         return nullptr;
253
254     auto wrapper = childrenOfType<HTMLDivElement>(*shadow).first();
255     if (!wrapper)
256         return nullptr;
257
258     return childrenOfType<HTMLDivElement>(*wrapper).first();
259 }
260
261 IntRect ColorInputType::elementRectRelativeToRootView() const
262 {
263     ASSERT(element());
264     if (!element()->renderer())
265         return IntRect();
266     return element()->document().view()->contentsToRootView(element()->renderer()->absoluteBoundingBoxRect());
267 }
268
269 Color ColorInputType::currentColor()
270 {
271     return valueAsColor();
272 }
273
274 bool ColorInputType::shouldShowSuggestions() const
275 {
276 #if ENABLE(DATALIST_ELEMENT)
277     ASSERT(element());
278     return element()->hasAttributeWithoutSynchronization(listAttr);
279 #else
280     return false;
281 #endif
282 }
283
284 Vector<Color> ColorInputType::suggestions() const
285 {
286     Vector<Color> suggestions;
287 #if ENABLE(DATALIST_ELEMENT)
288     ASSERT(element());
289     if (auto dataList = element()->dataList()) {
290         Ref<HTMLCollection> options = dataList->options();
291         unsigned length = options->length();
292         suggestions.reserveInitialCapacity(length);
293         for (unsigned i = 0; i != length; ++i) {
294             auto value = downcast<HTMLOptionElement>(*options->item(i)).value();
295             if (isValidSimpleColor(value))
296                 suggestions.uncheckedAppend(Color(value));
297         }
298     }
299 #endif
300     return suggestions;
301 }
302
303 void ColorInputType::selectColor(StringView string)
304 {
305     if (auto color = parseSimpleColorValue(string))
306         didChooseColor(color.value());
307 }
308
309 } // namespace WebCore
310
311 #endif // ENABLE(INPUT_TYPE_COLOR)