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