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