[macOS] Color wells should appear pressed when presenting a color picker
[WebKit-https.git] / Source / WebCore / html / HTMLInputElement.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2000 Dirk Mueller (mueller@kde.org)
5  * Copyright (C) 2004-2018 Apple Inc. All rights reserved.
6  * Copyright (C) 2012 Samsung Electronics. All rights reserved.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #pragma once
26
27 #include "FileChooser.h"
28 #include "HTMLTextFormControlElement.h"
29 #include "StepRange.h"
30 #include <memory>
31 #include <wtf/WeakPtr.h>
32
33 #if PLATFORM(IOS)
34 #include "DateComponents.h"
35 #endif
36
37 namespace WebCore {
38
39 class DragData;
40 class FileList;
41 class HTMLDataListElement;
42 class HTMLImageLoader;
43 class Icon;
44 class InputType;
45 class ListAttributeTargetObserver;
46 class RadioButtonGroups;
47 class URL;
48
49 struct DateTimeChooserParameters;
50
51 struct InputElementClickState {
52     bool stateful { false };
53     bool checked { false };
54     bool indeterminate { false };
55     RefPtr<HTMLInputElement> checkedRadioButton;
56 };
57
58 class HTMLInputElement : public HTMLTextFormControlElement, public CanMakeWeakPtr<HTMLInputElement> {
59     WTF_MAKE_ISO_ALLOCATED(HTMLInputElement);
60 public:
61     static Ref<HTMLInputElement> create(const QualifiedName&, Document&, HTMLFormElement*, bool createdByParser);
62     virtual ~HTMLInputElement();
63
64     WEBCORE_EXPORT bool shouldAutocomplete() const final;
65
66     // For ValidityState
67     bool hasBadInput() const final;
68     bool patternMismatch() const final;
69     bool rangeUnderflow() const final;
70     bool rangeOverflow() const final;
71     bool stepMismatch() const final;
72     bool tooShort() const final;
73     bool tooLong() const final;
74     bool typeMismatch() const final;
75     bool valueMissing() const final;
76     bool isValid() const final;
77     WEBCORE_EXPORT String validationMessage() const final;
78
79     // Returns the minimum value for type=date, number, or range.  Don't call this for other types.
80     double minimum() const;
81     // Returns the maximum value for type=date, number, or range.  Don't call this for other types.
82     // This always returns a value which is >= minimum().
83     double maximum() const;
84     // Sets the "allowed value step" defined in the HTML spec to the specified double pointer.
85     // Returns false if there is no "allowed value step."
86     bool getAllowedValueStep(Decimal*) const;
87     StepRange createStepRange(AnyStepHandling) const;
88
89 #if ENABLE(DATALIST_ELEMENT)
90     std::optional<Decimal> findClosestTickMarkValue(const Decimal&);
91 #endif
92
93     WEBCORE_EXPORT ExceptionOr<void> stepUp(int = 1);
94     WEBCORE_EXPORT ExceptionOr<void> stepDown(int = 1);
95
96     bool isPresentingAttachedView() const;
97
98     // stepUp()/stepDown() for user-interaction.
99     bool isSteppable() const;
100
101     bool isTextButton() const;
102
103     bool isRadioButton() const;
104     WEBCORE_EXPORT bool isTextField() const final;
105     WEBCORE_EXPORT bool isSearchField() const;
106     bool isInputTypeHidden() const;
107     WEBCORE_EXPORT bool isPasswordField() const;
108     bool isCheckbox() const;
109     bool isRangeControl() const;
110
111 #if ENABLE(INPUT_TYPE_COLOR)
112     WEBCORE_EXPORT bool isColorControl() const;
113 #endif
114
115     // FIXME: It's highly likely that any call site calling this function should instead
116     // be using a different one. Many input elements behave like text fields, and in addition
117     // any unknown input type is treated as text. Consider, for example, isTextField or
118     // isTextField && !isPasswordField.
119     WEBCORE_EXPORT bool isText() const;
120
121     WEBCORE_EXPORT bool isEmailField() const;
122     bool isFileUpload() const;
123     bool isImageButton() const;
124     WEBCORE_EXPORT bool isNumberField() const;
125     bool isSubmitButton() const;
126     WEBCORE_EXPORT bool isTelephoneField() const;
127     WEBCORE_EXPORT bool isURLField() const;
128     WEBCORE_EXPORT bool isDateField() const;
129     WEBCORE_EXPORT bool isDateTimeField() const;
130     WEBCORE_EXPORT bool isDateTimeLocalField() const;
131     WEBCORE_EXPORT bool isMonthField() const;
132     WEBCORE_EXPORT bool isTimeField() const;
133     WEBCORE_EXPORT bool isWeekField() const;
134
135 #if PLATFORM(IOS)
136     DateComponents::Type dateType() const;
137 #endif
138
139     HTMLElement* containerElement() const;
140     
141     RefPtr<TextControlInnerTextElement> innerTextElement() const final;
142     RenderStyle createInnerTextStyle(const RenderStyle&) override;
143
144     HTMLElement* innerBlockElement() const;
145     HTMLElement* innerSpinButtonElement() const;
146     HTMLElement* capsLockIndicatorElement() const;
147     HTMLElement* resultsButtonElement() const;
148     HTMLElement* cancelButtonElement() const;
149     HTMLElement* sliderThumbElement() const;
150     HTMLElement* sliderTrackElement() const;
151     HTMLElement* placeholderElement() const final;
152     WEBCORE_EXPORT HTMLElement* autoFillButtonElement() const;
153
154     bool checked() const { return m_isChecked; }
155     WEBCORE_EXPORT void setChecked(bool, TextFieldEventBehavior = DispatchNoEvent);
156
157     // 'indeterminate' is a state independent of the checked state that causes the control to draw in a way that hides the actual state.
158     bool indeterminate() const { return m_isIndeterminate; }
159     WEBCORE_EXPORT void setIndeterminate(bool);
160     // shouldAppearChecked is used by the rendering tree/CSS while checked() is used by JS to determine checked state
161     bool shouldAppearChecked() const;
162     bool matchesIndeterminatePseudoClass() const final;
163     bool shouldAppearIndeterminate() const final;
164
165     WEBCORE_EXPORT unsigned size() const;
166     bool sizeShouldIncludeDecoration(int& preferredSize) const;
167     float decorationWidth() const;
168
169     WEBCORE_EXPORT void setType(const AtomicString&);
170
171     WEBCORE_EXPORT String value() const final;
172     WEBCORE_EXPORT ExceptionOr<void> setValue(const String&, TextFieldEventBehavior = DispatchNoEvent);
173     WEBCORE_EXPORT void setValueForUser(const String&);
174     // Checks if the specified string would be a valid value.
175     // We should not call this for types with no string value such as CHECKBOX and RADIO.
176     bool isValidValue(const String&) const;
177     bool hasDirtyValue() const { return !m_valueIfDirty.isNull(); };
178
179     String sanitizeValue(const String&) const;
180
181     String localizeValue(const String&) const;
182
183     // The value which is drawn by a renderer.
184     String visibleValue() const;
185
186     WEBCORE_EXPORT void setEditingValue(const String&);
187
188     WEBCORE_EXPORT double valueAsDate() const;
189     WEBCORE_EXPORT ExceptionOr<void> setValueAsDate(double);
190
191     WEBCORE_EXPORT double valueAsNumber() const;
192     WEBCORE_EXPORT ExceptionOr<void> setValueAsNumber(double, TextFieldEventBehavior = DispatchNoEvent);
193
194     String valueWithDefault() const;
195
196     // This function dispatches 'input' event for non-textfield types. Callers
197     // need to handle any DOM structure changes by event handlers, or need to
198     // delay the 'input' event with EventQueueScope.
199     void setValueFromRenderer(const String&);
200
201     bool canHaveSelection() const;
202
203     bool rendererIsNeeded(const RenderStyle&) final;
204     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) final;
205     void willAttachRenderers() final;
206     void didAttachRenderers() final;
207     void didDetachRenderers() final;
208
209     // FIXME: For isActivatedSubmit and setActivatedSubmit, we should use the NVI-idiom here by making
210     // it private virtual in all classes and expose a public method in HTMLFormControlElement to call
211     // the private virtual method.
212     bool isActivatedSubmit() const final;
213     void setActivatedSubmit(bool flag) final;
214
215     String altText() const;
216
217     void willDispatchEvent(Event&, InputElementClickState&);
218     void didDispatchClickEvent(Event&, const InputElementClickState&);
219
220     void didBlur();
221
222     int maxResults() const { return m_maxResults; }
223
224     WEBCORE_EXPORT String defaultValue() const;
225     WEBCORE_EXPORT void setDefaultValue(const String&);
226
227     Vector<String> acceptMIMETypes();
228     Vector<String> acceptFileExtensions();
229     String accept() const;
230     WEBCORE_EXPORT String alt() const;
231
232     WEBCORE_EXPORT ExceptionOr<void> setSize(unsigned);
233
234     URL src() const;
235
236     unsigned effectiveMaxLength() const;
237
238     bool multiple() const;
239
240     bool isAutoFilled() const { return m_isAutoFilled; }
241     WEBCORE_EXPORT void setAutoFilled(bool = true);
242
243     AutoFillButtonType lastAutoFillButtonType() const { return static_cast<AutoFillButtonType>(m_lastAutoFillButtonType); }
244     AutoFillButtonType autoFillButtonType() const { return static_cast<AutoFillButtonType>(m_autoFillButtonType); }
245     WEBCORE_EXPORT void setShowAutoFillButton(AutoFillButtonType);
246
247     bool hasAutoFillStrongPasswordButton() const  { return autoFillButtonType() == AutoFillButtonType::StrongPassword; }
248
249     bool isAutoFillAvailable() const { return m_isAutoFillAvailable; }
250     void setAutoFillAvailable(bool autoFillAvailable) { m_isAutoFillAvailable = autoFillAvailable; }
251
252     WEBCORE_EXPORT FileList* files();
253     WEBCORE_EXPORT void setFiles(RefPtr<FileList>&&);
254
255 #if ENABLE(DRAG_SUPPORT)
256     // Returns true if the given DragData has more than one dropped files.
257     bool receiveDroppedFiles(const DragData&);
258 #endif
259
260     Icon* icon() const;
261     String displayString() const;
262
263     // These functions are used for rendering the input active during a
264     // drag-and-drop operation.
265     bool canReceiveDroppedFiles() const;
266     void setCanReceiveDroppedFiles(bool);
267
268     void addSearchResult();
269     void onSearch();
270
271     bool willRespondToMouseClickEvents() override;
272
273 #if ENABLE(DATALIST_ELEMENT)
274     WEBCORE_EXPORT RefPtr<HTMLElement> list() const;
275     RefPtr<HTMLDataListElement> dataList() const;
276     void listAttributeTargetChanged();
277 #endif
278
279     Vector<HTMLInputElement*> radioButtonGroup() const;
280     HTMLInputElement* checkedRadioButtonForGroup() const;
281     bool isInRequiredRadioButtonGroup();
282     // Returns null if this isn't associated with any radio button group.
283     RadioButtonGroups* radioButtonGroups() const;
284
285     // Functions for InputType classes.
286     void setValueInternal(const String&, TextFieldEventBehavior);
287     bool isTextFormControlFocusable() const;
288     bool isTextFormControlKeyboardFocusable(KeyboardEvent*) const;
289     bool isTextFormControlMouseFocusable() const;
290     bool valueAttributeWasUpdatedAfterParsing() const { return m_valueAttributeWasUpdatedAfterParsing; }
291
292     void cacheSelectionInResponseToSetValue(int caretOffset) { cacheSelection(caretOffset, caretOffset, SelectionHasNoDirection); }
293
294     Color valueAsColor() const; // Returns transparent color if not type=color.
295     WEBCORE_EXPORT void selectColor(StringView); // Does nothing if not type=color. Simulates user selection of color; intended for testing.
296
297     String defaultToolTip() const;
298
299 #if ENABLE(MEDIA_CAPTURE)
300     MediaCaptureType mediaCaptureType() const;
301 #endif
302
303     static const unsigned maxEffectiveLength;
304
305     WEBCORE_EXPORT unsigned height() const;
306     WEBCORE_EXPORT unsigned width() const;
307     WEBCORE_EXPORT void setHeight(unsigned);
308     WEBCORE_EXPORT void setWidth(unsigned);
309
310     void blur() final;
311     void defaultBlur();
312
313     const AtomicString& name() const final;
314
315     void endEditing();
316
317     void setSpellcheckDisabledExceptTextReplacement(bool disabled) { m_isSpellcheckDisabledExceptTextReplacement = disabled; }
318     bool isSpellcheckDisabledExceptTextReplacement() const { return m_isSpellcheckDisabledExceptTextReplacement; }
319
320     static Vector<FileChooserFileInfo> filesFromFileInputFormControlState(const FormControlState&);
321
322     bool matchesReadWritePseudoClass() const final;
323     WEBCORE_EXPORT ExceptionOr<void> setRangeText(const String& replacement) final;
324     WEBCORE_EXPORT ExceptionOr<void> setRangeText(const String& replacement, unsigned start, unsigned end, const String& selectionMode) final;
325
326     HTMLImageLoader* imageLoader() { return m_imageLoader.get(); }
327     HTMLImageLoader& ensureImageLoader();
328
329 #if ENABLE(DATE_AND_TIME_INPUT_TYPES)
330     bool setupDateTimeChooserParameters(DateTimeChooserParameters&);
331 #endif
332
333     void capsLockStateMayHaveChanged();
334
335     bool shouldTruncateText(const RenderStyle&) const;
336
337     ExceptionOr<int> selectionStartForBindings() const;
338     ExceptionOr<void> setSelectionStartForBindings(int);
339
340     ExceptionOr<int> selectionEndForBindings() const;
341     ExceptionOr<void> setSelectionEndForBindings(int);
342
343     ExceptionOr<String> selectionDirectionForBindings() const;
344     ExceptionOr<void> setSelectionDirectionForBindings(const String&);
345
346     ExceptionOr<void> setSelectionRangeForBindings(int start, int end, const String& direction);
347
348 protected:
349     HTMLInputElement(const QualifiedName&, Document&, HTMLFormElement*, bool createdByParser);
350
351     void defaultEventHandler(Event&) override;
352
353 private:
354     enum AutoCompleteSetting { Uninitialized, On, Off };
355
356     void didAddUserAgentShadowRoot(ShadowRoot&) final;
357
358     void willChangeForm() final;
359     void didChangeForm() final;
360     InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) final;
361     void didFinishInsertingNode() final;
362     void removedFromAncestor(RemovalType, ContainerNode&) final;
363     void didMoveToNewDocument(Document& oldDocument, Document& newDocument) final;
364
365     bool hasCustomFocusLogic() const final;
366     bool isKeyboardFocusable(KeyboardEvent*) const final;
367     bool isMouseFocusable() const final;
368     bool isEnumeratable() const final;
369     bool supportLabels() const final;
370     void updateFocusAppearance(SelectionRestorationMode, SelectionRevealMode) final;
371     bool shouldUseInputMethod() final;
372
373     bool isInnerTextElementEditable() const final { return !hasAutoFillStrongPasswordButton() && HTMLTextFormControlElement::isInnerTextElementEditable(); }
374
375     bool canTriggerImplicitSubmission() const final { return isTextField(); }
376
377     const AtomicString& formControlType() const final;
378
379     bool shouldSaveAndRestoreFormControlState() const final;
380     FormControlState saveFormControlState() const final;
381     void restoreFormControlState(const FormControlState&) final;
382
383     void resignStrongPasswordAppearance();
384
385     bool canStartSelection() const final;
386
387     void accessKeyAction(bool sendMouseEvents) final;
388
389     void parseAttribute(const QualifiedName&, const AtomicString&) final;
390     bool isPresentationAttribute(const QualifiedName&) const final;
391     void collectStyleForPresentationAttribute(const QualifiedName&, const AtomicString&, MutableStyleProperties&) final;
392     void finishParsingChildren() final;
393     void parserDidSetAttributes() final;
394
395     void copyNonAttributePropertiesFromElement(const Element&) final;
396
397     bool appendFormData(DOMFormData&, bool) final;
398
399     bool isSuccessfulSubmitButton() const final;
400     bool matchesDefaultPseudoClass() const final;
401
402     void reset() final;
403
404     bool isURLAttribute(const Attribute&) const final;
405     bool isInRange() const final;
406     bool isOutOfRange() const final;
407
408     void resumeFromDocumentSuspension() final;
409 #if ENABLE(INPUT_TYPE_COLOR)
410     void prepareForDocumentSuspension() final;
411 #endif
412
413     void addSubresourceAttributeURLs(ListHashSet<URL>&) const final;
414
415     bool needsSuspensionCallback();
416     void registerForSuspensionCallbackIfNeeded();
417     void unregisterForSuspensionCallbackIfNeeded();
418
419     bool supportsMinLength() const { return isTextType(); }
420     bool supportsMaxLength() const { return isTextType(); }
421     bool isTextType() const;
422     bool tooShort(StringView, NeedsToCheckDirtyFlag) const;
423     bool tooLong(StringView, NeedsToCheckDirtyFlag) const;
424
425     bool supportsPlaceholder() const final;
426     void updatePlaceholderText() final;
427     bool isEmptyValue() const final;
428     void handleFocusEvent(Node* oldFocusedNode, FocusDirection) final;
429     void handleBlurEvent() final;
430
431     bool isOptionalFormControl() const final { return !isRequiredFormControl(); }
432     bool isRequiredFormControl() const final;
433     bool computeWillValidate() const final;
434     void requiredStateChanged() final;
435
436     void initializeInputType();
437     void updateType();
438     void runPostTypeUpdateTasks();
439
440     void subtreeHasChanged() final;
441     void disabledStateChanged() final;
442     void readOnlyStateChanged() final;
443
444 #if ENABLE(DATALIST_ELEMENT)
445     void resetListAttributeTargetObserver();
446 #endif
447     void maxLengthAttributeChanged(const AtomicString& newValue);
448     void minLengthAttributeChanged(const AtomicString& newValue);
449     void updateValueIfNeeded();
450
451     void addToRadioButtonGroup();
452     void removeFromRadioButtonGroup();
453
454     AtomicString m_name;
455     String m_valueIfDirty;
456     unsigned m_size;
457     short m_maxResults { -1 };
458     bool m_isChecked : 1;
459     bool m_reflectsCheckedAttribute : 1;
460     bool m_isIndeterminate : 1;
461     bool m_hasType : 1;
462     bool m_isActivatedSubmit : 1;
463     unsigned m_autocomplete : 2; // AutoCompleteSetting
464     bool m_isAutoFilled : 1;
465     unsigned m_autoFillButtonType : 3; // AutoFillButtonType
466     unsigned m_lastAutoFillButtonType : 3; // AutoFillButtonType
467     bool m_isAutoFillAvailable : 1;
468 #if ENABLE(DATALIST_ELEMENT)
469     bool m_hasNonEmptyList : 1;
470 #endif
471     bool m_stateRestored : 1;
472     bool m_parsingInProgress : 1;
473     bool m_valueAttributeWasUpdatedAfterParsing : 1;
474     bool m_wasModifiedByUser : 1;
475     bool m_canReceiveDroppedFiles : 1;
476 #if ENABLE(TOUCH_EVENTS)
477     bool m_hasTouchEventHandler : 1;
478 #endif
479     bool m_isSpellcheckDisabledExceptTextReplacement : 1;
480     RefPtr<InputType> m_inputType;
481     // The ImageLoader must be owned by this element because the loader code assumes
482     // that it lives as long as its owning element lives. If we move the loader into
483     // the ImageInput object we may delete the loader while this element lives on.
484     std::unique_ptr<HTMLImageLoader> m_imageLoader;
485 #if ENABLE(DATALIST_ELEMENT)
486     std::unique_ptr<ListAttributeTargetObserver> m_listAttributeTargetObserver;
487 #endif
488 };
489
490 }