[Datalist] Add button to TextFieldInputs with a datalist
[WebKit-https.git] / Source / WebCore / html / InputType.h
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  * Copyright (C) 2011-2018 Apple Inc. All rights reserved.
4  * Copyright (C) 2012 Samsung Electronics. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  *     * Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *     * Redistributions in binary form must reproduce the above
13  * copyright notice, this list of conditions and the following disclaimer
14  * in the documentation and/or other materials provided with the
15  * distribution.
16  *     * Neither the name of Google Inc. nor the names of its
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 #pragma once
34
35 #include "HTMLTextFormControlElement.h"
36 #include "RenderPtr.h"
37 #include "StepRange.h"
38 #include <wtf/FastMalloc.h>
39 #include <wtf/Forward.h>
40 #include <wtf/RefCounted.h>
41 #include <wtf/RefPtr.h>
42
43 #if PLATFORM(IOS)
44 #include "DateComponents.h"
45 #endif
46
47 namespace WebCore {
48
49 class BeforeTextInsertedEvent;
50 class Chrome;
51 class DOMFormData;
52 class DateComponents;
53 class DragData;
54 class Event;
55 class FileList;
56 class HTMLElement;
57 class HTMLFormElement;
58 class HTMLInputElement;
59 class Icon;
60 class KeyboardEvent;
61 class MouseEvent;
62 class Node;
63 class RenderStyle;
64 class TextControlInnerTextElement;
65 class TouchEvent;
66
67 struct InputElementClickState;
68
69 // An InputType object represents the type-specific part of an HTMLInputElement.
70 // Do not expose instances of InputType and classes derived from it to classes
71 // other than HTMLInputElement.
72 class InputType : public RefCounted<InputType> {
73     WTF_MAKE_FAST_ALLOCATED;
74
75 public:
76     static Ref<InputType> create(HTMLInputElement&, const AtomicString&);
77     static Ref<InputType> createText(HTMLInputElement&);
78     virtual ~InputType();
79
80     static bool themeSupportsDataListUI(InputType*);
81
82     virtual const AtomicString& formControlType() const = 0;
83
84     // Type query functions.
85
86     // Any time we are using one of these functions it's best to refactor
87     // to add a virtual function to allow the input type object to do the
88     // work instead, or at least make a query function that asks a higher
89     // level question. These functions make the HTMLInputElement class
90     // inflexible because it's harder to add new input types if there is
91     // scattered code with special cases for various types.
92
93     virtual bool isCheckbox() const;
94     virtual bool isColorControl() const;
95     virtual bool isDateField() const;
96     virtual bool isDateTimeField() const;
97     virtual bool isDateTimeLocalField() const;
98     virtual bool isEmailField() const;
99     virtual bool isFileUpload() const;
100     virtual bool isHiddenType() const;
101     virtual bool isImageButton() const;
102     virtual bool supportLabels() const;
103     virtual bool isMonthField() const;
104     virtual bool isNumberField() const;
105     virtual bool isPasswordField() const;
106     virtual bool isRadioButton() const;
107     virtual bool isRangeControl() const;
108     virtual bool isSearchField() const;
109     virtual bool isSubmitButton() const;
110     virtual bool isTelephoneField() const;
111     virtual bool isTextButton() const;
112     virtual bool isTextField() const;
113     virtual bool isTextType() const;
114     virtual bool isTimeField() const;
115     virtual bool isURLField() const;
116     virtual bool isWeekField() const;
117
118     // Form value functions.
119
120     virtual bool shouldSaveAndRestoreFormControlState() const;
121     virtual FormControlState saveFormControlState() const;
122     virtual void restoreFormControlState(const FormControlState&);
123     virtual bool isFormDataAppendable() const;
124     virtual bool appendFormData(DOMFormData&, bool multipart) const;
125
126     // DOM property functions.
127
128     virtual bool getTypeSpecificValue(String&); // Checked first, before internal storage or the value attribute.
129     virtual String fallbackValue() const; // Checked last, if both internal storage and value attribute are missing.
130     virtual String defaultValue() const; // Checked after even fallbackValue, only when the valueWithDefault function is called.
131     virtual double valueAsDate() const;
132     virtual ExceptionOr<void> setValueAsDate(double) const;
133     virtual double valueAsDouble() const;
134     virtual ExceptionOr<void> setValueAsDouble(double, TextFieldEventBehavior) const;
135     virtual ExceptionOr<void> setValueAsDecimal(const Decimal&, TextFieldEventBehavior) const;
136
137     // Validation functions.
138
139     virtual String validationMessage() const;
140     virtual bool supportsValidation() const;
141     virtual bool typeMismatchFor(const String&) const;
142     virtual bool supportsRequired() const;
143     virtual bool valueMissing(const String&) const;
144     virtual bool hasBadInput() const;
145     virtual bool patternMismatch(const String&) const;
146     bool rangeUnderflow(const String&) const;
147     bool rangeOverflow(const String&) const;
148     bool isInRange(const String&) const;
149     bool isOutOfRange(const String&) const;
150     virtual Decimal defaultValueForStepUp() const;
151     double minimum() const;
152     double maximum() const;
153     virtual bool sizeShouldIncludeDecoration(int defaultSize, int& preferredSize) const;
154     virtual float decorationWidth() const;
155     bool stepMismatch(const String&) const;
156     virtual bool getAllowedValueStep(Decimal*) const;
157     virtual StepRange createStepRange(AnyStepHandling) const;
158     virtual ExceptionOr<void> stepUp(int);
159     virtual void stepUpFromRenderer(int);
160     virtual String badInputText() const;
161     virtual String typeMismatchText() const;
162     virtual String valueMissingText() const;
163     virtual bool canSetStringValue() const;
164     virtual String localizeValue(const String&) const;
165     virtual String visibleValue() const;
166     virtual bool isEmptyValue() const;
167
168     // Type check for the current input value. We do nothing for some types
169     // though typeMismatchFor() does something for them because of value sanitization.
170     virtual bool typeMismatch() const;
171
172     // Return value of null string means "use the default value".
173     // This function must be called only by HTMLInputElement::sanitizeValue().
174     virtual String sanitizeValue(const String&) const;
175
176     // Event handlers.
177
178     virtual void handleClickEvent(MouseEvent&);
179     virtual void handleMouseDownEvent(MouseEvent&);
180     virtual void willDispatchClick(InputElementClickState&);
181     virtual void didDispatchClick(Event&, const InputElementClickState&);
182     virtual void handleDOMActivateEvent(Event&);
183     virtual void handleKeydownEvent(KeyboardEvent&);
184     virtual void handleKeypressEvent(KeyboardEvent&);
185     virtual void handleKeyupEvent(KeyboardEvent&);
186     virtual void handleBeforeTextInsertedEvent(BeforeTextInsertedEvent&);
187     virtual void forwardEvent(Event&);
188
189 #if ENABLE(TOUCH_EVENTS)
190     virtual void handleTouchEvent(TouchEvent&);
191 #endif
192
193     // Helpers for event handlers.
194
195     virtual bool shouldSubmitImplicitly(Event&);
196     virtual bool hasCustomFocusLogic() const;
197     virtual bool isKeyboardFocusable(KeyboardEvent*) const;
198     virtual bool isMouseFocusable() const;
199     virtual bool shouldUseInputMethod() const;
200     virtual void handleFocusEvent(Node* oldFocusedNode, FocusDirection);
201     virtual void handleBlurEvent();
202     virtual void accessKeyAction(bool sendMouseEvents);
203     virtual bool canBeSuccessfulSubmitButton();
204     virtual void subtreeHasChanged();
205     virtual void blur();
206
207     virtual void elementDidBlur() { }
208
209 #if ENABLE(TOUCH_EVENTS)
210     virtual bool hasTouchEventHandler() const;
211 #endif
212
213     // Shadow tree handling.
214
215     virtual void createShadowSubtree();
216     virtual void destroyShadowSubtree();
217
218     virtual HTMLElement* containerElement() const { return nullptr; }
219     virtual HTMLElement* innerBlockElement() const { return nullptr; }
220     virtual RefPtr<TextControlInnerTextElement> innerTextElement() const;
221     virtual HTMLElement* innerSpinButtonElement() const { return nullptr; }
222     virtual HTMLElement* capsLockIndicatorElement() const { return nullptr; }
223     virtual HTMLElement* autoFillButtonElement() const { return nullptr; }
224     virtual HTMLElement* resultsButtonElement() const { return nullptr; }
225     virtual HTMLElement* cancelButtonElement() const { return nullptr; }
226     virtual HTMLElement* sliderThumbElement() const { return nullptr; }
227     virtual HTMLElement* sliderTrackElement() const { return nullptr; }
228     virtual HTMLElement* placeholderElement() const;
229 #if ENABLE(DATALIST_ELEMENT)
230     virtual HTMLElement* dataListButtonElement() const { return nullptr; }
231 #endif
232
233     // Miscellaneous functions.
234
235     virtual bool rendererIsNeeded();
236     virtual RenderPtr<RenderElement> createInputRenderer(RenderStyle&&);
237     virtual void addSearchResult();
238     virtual void attach();
239     virtual void detach();
240     virtual bool shouldRespectAlignAttribute();
241     virtual FileList* files();
242     virtual void setFiles(RefPtr<FileList>&&);
243     virtual Icon* icon() const;
244     virtual bool shouldSendChangeEventAfterCheckedChanged();
245     virtual bool canSetValue(const String&);
246     virtual bool storesValueSeparateFromAttribute();
247     virtual void setValue(const String&, bool valueChanged, TextFieldEventBehavior);
248     virtual bool shouldResetOnDocumentActivation();
249     virtual bool shouldRespectListAttribute();
250     virtual bool isEnumeratable();
251     virtual bool isCheckable();
252     virtual bool isSteppable() const;
253     virtual bool shouldRespectHeightAndWidthAttributes();
254     virtual bool supportsPlaceholder() const;
255     virtual bool supportsReadOnly() const;
256     virtual void updateInnerTextValue();
257     virtual void updatePlaceholderText();
258     virtual void attributeChanged(const QualifiedName&) { }
259     virtual void disabledStateChanged() { }
260     virtual void readOnlyStateChanged() { }
261     virtual void requiredStateChanged() { }
262     virtual void capsLockStateMayHaveChanged();
263     virtual void updateAutoFillButton();
264     virtual String defaultToolTip() const;
265     virtual bool matchesIndeterminatePseudoClass() const;
266     virtual bool shouldAppearIndeterminate() const;
267     virtual bool supportsSelectionAPI() const;
268     virtual Color valueAsColor() const;
269     virtual void selectColor(StringView);
270
271     // Parses the specified string for the type, and return
272     // the Decimal value for the parsing result if the parsing
273     // succeeds; Returns defaultValue otherwise. This function can
274     // return NaN or Infinity only if defaultValue is NaN or Infinity.
275     virtual Decimal parseToNumber(const String&, const Decimal& defaultValue) const;
276
277     // Parses the specified string for this InputType, and returns true if it
278     // is successfully parsed. An instance pointed by the DateComponents*
279     // parameter will have parsed values and be modified even if the parsing
280     // fails. The DateComponents* parameter may be null.
281     virtual bool parseToDateComponents(const String&, DateComponents*) const;
282
283     // Create a string representation of the specified Decimal value for the
284     // input type. If NaN or Infinity is specified, this returns an empty
285     // string. This should not be called for types without valueAsNumber.
286     virtual String serialize(const Decimal&) const;
287
288     // Gets width and height of the input element if the type of the
289     // element is image. It returns 0 if the element is not image type.
290     virtual unsigned height() const;
291     virtual unsigned width() const;
292
293     void dispatchSimulatedClickIfActive(KeyboardEvent&) const;
294
295 #if ENABLE(DATALIST_ELEMENT)
296     virtual bool isShowingList() const { return false; };
297     virtual void listAttributeTargetChanged();
298     virtual std::optional<Decimal> findClosestTickMarkValue(const Decimal&);
299 #endif
300
301 #if ENABLE(DRAG_SUPPORT)
302     virtual bool receiveDroppedFiles(const DragData&);
303 #endif
304
305 #if PLATFORM(IOS)
306     virtual DateComponents::Type dateType() const;
307 #endif
308     virtual String displayString() const;
309
310 protected:
311     explicit InputType(HTMLInputElement& element)
312         : m_element(makeWeakPtr(element)) { }
313     HTMLInputElement* element() const { return m_element.get(); }
314     Chrome* chrome() const;
315     Decimal parseToNumberOrNaN(const String&) const;
316
317 private:
318     // Helper for stepUp()/stepDown(). Adds step value * count to the current value.
319     ExceptionOr<void> applyStep(int count, AnyStepHandling, TextFieldEventBehavior);
320
321     // Raw pointer because the HTMLInputElement object owns this InputType object.
322     WeakPtr<HTMLInputElement> m_element;
323 };
324
325 } // namespace WebCore
326
327 #define SPECIALIZE_TYPE_TRAITS_INPUT_TYPE(ToValueTypeName, predicate) \
328 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
329 static bool isType(const WebCore::InputType& input) { return input.predicate; } \
330 SPECIALIZE_TYPE_TRAITS_END()