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