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