Simplify and streamline some Color-related code to prepare for some Color/ExtendedCol...
[WebKit-https.git] / Source / WebCore / html / ColorInputType.cpp
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  * Copyright (C) 2015-2017 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::isColorControl() const
85 {
86     return true;
87 }
88
89 const AtomicString& ColorInputType::formControlType() const
90 {
91     return InputTypeNames::color();
92 }
93
94 bool ColorInputType::supportsRequired() const
95 {
96     return false;
97 }
98
99 String ColorInputType::fallbackValue() const
100 {
101     return ASCIILiteral("#000000");
102 }
103
104 String ColorInputType::sanitizeValue(const String& proposedValue) const
105 {
106     if (!isValidSimpleColor(proposedValue))
107         return fallbackValue();
108
109     return proposedValue.convertToASCIILowercase();
110 }
111
112 Color ColorInputType::valueAsColor() const
113 {
114     return parseSimpleColorValue(element().value()).value();
115 }
116
117 void ColorInputType::createShadowSubtree()
118 {
119     ASSERT(element().shadowRoot());
120
121     Document& document = element().document();
122     auto wrapperElement = HTMLDivElement::create(document);
123     wrapperElement->setPseudo(AtomicString("-webkit-color-swatch-wrapper", AtomicString::ConstructFromLiteral));
124     auto colorSwatch = HTMLDivElement::create(document);
125     colorSwatch->setPseudo(AtomicString("-webkit-color-swatch", AtomicString::ConstructFromLiteral));
126     wrapperElement->appendChild(colorSwatch);
127     element().userAgentShadowRoot()->appendChild(wrapperElement);
128
129     updateColorSwatch();
130 }
131
132 void ColorInputType::setValue(const String& value, bool valueChanged, TextFieldEventBehavior eventBehavior)
133 {
134     InputType::setValue(value, valueChanged, eventBehavior);
135
136     if (!valueChanged)
137         return;
138
139     updateColorSwatch();
140     if (m_chooser)
141         m_chooser->setSelectedColor(valueAsColor());
142 }
143
144 void ColorInputType::handleDOMActivateEvent(Event& event)
145 {
146     if (element().isDisabledFormControl() || !element().renderer())
147         return;
148
149     if (!UserGestureIndicator::processingUserGesture())
150         return;
151
152     if (Chrome* chrome = this->chrome()) {
153         if (!m_chooser)
154             m_chooser = chrome->createColorChooser(*this, valueAsColor());
155         else
156             m_chooser->reattachColorChooser(valueAsColor());
157     }
158
159     event.setDefaultHandled();
160 }
161
162 void ColorInputType::detach()
163 {
164     endColorChooser();
165 }
166
167 bool ColorInputType::shouldRespectListAttribute()
168 {
169     return InputType::themeSupportsDataListUI(this);
170 }
171
172 bool ColorInputType::typeMismatchFor(const String& value) const
173 {
174     return !isValidSimpleColor(value);
175 }
176
177 bool ColorInputType::shouldResetOnDocumentActivation()
178 {
179     return true;
180 }
181
182 void ColorInputType::didChooseColor(const Color& color)
183 {
184     if (element().isDisabledFormControl() || color == valueAsColor())
185         return;
186     EventQueueScope scope;
187     element().setValueFromRenderer(color.serialized());
188     updateColorSwatch();
189     element().dispatchFormControlChangeEvent();
190 }
191
192 void ColorInputType::didEndChooser()
193 {
194     m_chooser = nullptr;
195 }
196
197 void ColorInputType::endColorChooser()
198 {
199     if (m_chooser)
200         m_chooser->endChooser();
201 }
202
203 void ColorInputType::updateColorSwatch()
204 {
205     RefPtr<HTMLElement> colorSwatch = shadowColorSwatch();
206     if (!colorSwatch)
207         return;
208
209     colorSwatch->setInlineStyleProperty(CSSPropertyBackgroundColor, element().value(), false);
210 }
211
212 HTMLElement* ColorInputType::shadowColorSwatch() const
213 {
214     RefPtr<ShadowRoot> shadow = element().userAgentShadowRoot();
215     if (!shadow)
216         return nullptr;
217
218     auto wrapper = childrenOfType<HTMLDivElement>(*shadow).first();
219     if (!wrapper)
220         return nullptr;
221
222     return childrenOfType<HTMLDivElement>(*wrapper).first();
223 }
224
225 IntRect ColorInputType::elementRectRelativeToRootView() const
226 {
227     if (!element().renderer())
228         return IntRect();
229     return element().document().view()->contentsToRootView(element().renderer()->absoluteBoundingBoxRect());
230 }
231
232 Color ColorInputType::currentColor()
233 {
234     return valueAsColor();
235 }
236
237 bool ColorInputType::shouldShowSuggestions() const
238 {
239 #if ENABLE(DATALIST_ELEMENT)
240     return element().hasAttributeWithoutSynchronization(listAttr);
241 #else
242     return false;
243 #endif
244 }
245
246 Vector<Color> ColorInputType::suggestions() const
247 {
248     Vector<Color> suggestions;
249 #if ENABLE(DATALIST_ELEMENT)
250     if (auto dataList = element().dataList()) {
251         Ref<HTMLCollection> options = dataList->options();
252         unsigned length = options->length();
253         suggestions.reserveInitialCapacity(length);
254         for (unsigned i = 0; i != length; ++i) {
255             auto value = downcast<HTMLOptionElement>(*options->item(i)).value();
256             if (isValidSimpleColorString(value))
257                 suggestions.uncheckedAppend(Color(value));
258         }
259     }
260 #endif
261     return suggestions;
262 }
263
264 void ColorInputType::selectColor(StringView string)
265 {
266     if (auto color = parseSimpleColorValue(string))
267         didChooseColor(color.value());
268 }
269
270 } // namespace WebCore
271
272 #endif // ENABLE(INPUT_TYPE_COLOR)