DOM event handling should pass Event around by reference.
[WebKit-https.git] / Source / WebCore / html / InputType.h
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  * Copyright (C) 2011, 2014-2015 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 #ifndef InputType_h
34 #define InputType_h
35
36 #include "HTMLTextFormControlElement.h"
37 #include "RenderPtr.h"
38 #include "StepRange.h"
39 #include <wtf/FastMalloc.h>
40 #include <wtf/Forward.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 DateComponents;
52 class DragData;
53 class Event;
54 class FileList;
55 class FormDataList;
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 TouchEvent;
65 class TextControlInnerTextElement;
66
67 struct InputElementClickState;
68
69 typedef int ExceptionCode;
70
71 // An InputType object represents the type-specific part of an HTMLInputElement.
72 // Do not expose instances of InputType and classes derived from it to classes
73 // other than HTMLInputElement.
74 class InputType {
75     WTF_MAKE_FAST_ALLOCATED;
76
77 public:
78     static std::unique_ptr<InputType> create(HTMLInputElement&, const AtomicString&);
79     static std::unique_ptr<InputType> createText(HTMLInputElement&);
80     virtual ~InputType();
81
82     static bool themeSupportsDataListUI(InputType*);
83
84     virtual const AtomicString& formControlType() const = 0;
85     virtual bool canChangeFromAnotherType() const;
86
87     // Type query functions.
88
89     // Any time we are using one of these functions it's best to refactor
90     // to add a virtual function to allow the input type object to do the
91     // work instead, or at least make a query function that asks a higher
92     // level question. These functions make the HTMLInputElement class
93     // inflexible because it's harder to add new input types if there is
94     // scattered code with special cases for various types.
95
96     virtual bool isCheckbox() const;
97     virtual bool isColorControl() const;
98     virtual bool isDateField() const;
99     virtual bool isDateTimeField() const;
100     virtual bool isDateTimeLocalField() const;
101     virtual bool isEmailField() const;
102     virtual bool isFileUpload() const;
103     virtual bool isHiddenType() const;
104     virtual bool isImageButton() const;
105     virtual bool supportLabels() const;
106     virtual bool isMonthField() const;
107     virtual bool isNumberField() const;
108     virtual bool isPasswordField() const;
109     virtual bool isRadioButton() const;
110     virtual bool isRangeControl() const;
111     virtual bool isSearchField() const;
112     virtual bool isSubmitButton() const;
113     virtual bool isTelephoneField() const;
114     virtual bool isTextButton() const;
115     virtual bool isTextField() const;
116     virtual bool isTextType() const;
117     virtual bool isTimeField() const;
118     virtual bool isURLField() const;
119     virtual bool isWeekField() const;
120
121     // Form value functions.
122
123     virtual bool shouldSaveAndRestoreFormControlState() const;
124     virtual FormControlState saveFormControlState() const;
125     virtual void restoreFormControlState(const FormControlState&);
126     virtual bool isFormDataAppendable() const;
127     virtual bool appendFormData(FormDataList&, bool multipart) const;
128
129     // DOM property functions.
130
131     virtual bool getTypeSpecificValue(String&); // Checked first, before internal storage or the value attribute.
132     virtual String fallbackValue() const; // Checked last, if both internal storage and value attribute are missing.
133     virtual String defaultValue() const; // Checked after even fallbackValue, only when the valueWithDefault function is called.
134     virtual double valueAsDate() const;
135     virtual void setValueAsDate(double, ExceptionCode&) const;
136     virtual double valueAsDouble() const;
137     virtual void setValueAsDouble(double, TextFieldEventBehavior, ExceptionCode&) const;
138     virtual void setValueAsDecimal(const Decimal&, TextFieldEventBehavior, ExceptionCode&) const;
139
140     // Validation functions.
141
142     virtual String validationMessage() const;
143     virtual bool supportsValidation() const;
144     virtual bool typeMismatchFor(const String&) const;
145     virtual bool supportsRequired() const;
146     virtual bool valueMissing(const String&) const;
147     virtual bool hasBadInput() const;
148     virtual bool patternMismatch(const String&) const;
149     bool rangeUnderflow(const String&) const;
150     bool rangeOverflow(const String&) const;
151     bool isInRange(const String&) const;
152     bool isOutOfRange(const String&) const;
153     virtual Decimal defaultValueForStepUp() const;
154     double minimum() const;
155     double maximum() const;
156     virtual bool sizeShouldIncludeDecoration(int defaultSize, int& preferredSize) const;
157     virtual float decorationWidth() const;
158     bool stepMismatch(const String&) const;
159     virtual bool getAllowedValueStep(Decimal*) const;
160     virtual StepRange createStepRange(AnyStepHandling) const;
161     virtual void stepUp(int, ExceptionCode&);
162     virtual void stepUpFromRenderer(int);
163     virtual String badInputText() const;
164     virtual String typeMismatchText() const;
165     virtual String valueMissingText() const;
166     virtual bool canSetStringValue() const;
167     virtual String localizeValue(const String&) const;
168     virtual String visibleValue() const;
169     virtual bool isEmptyValue() const;
170
171     // Type check for the current input value. We do nothing for some types
172     // though typeMismatchFor() does something for them because of value sanitization.
173     virtual bool typeMismatch() const;
174
175     // Return value of null string means "use the default value".
176     // This function must be called only by HTMLInputElement::sanitizeValue().
177     virtual String sanitizeValue(const String&) const;
178
179     // Event handlers.
180
181     virtual void handleClickEvent(MouseEvent&);
182     virtual void handleMouseDownEvent(MouseEvent&);
183     virtual void willDispatchClick(InputElementClickState&);
184     virtual void didDispatchClick(Event*, const InputElementClickState&);
185     virtual void handleDOMActivateEvent(Event&);
186     virtual void handleKeydownEvent(KeyboardEvent&);
187     virtual void handleKeypressEvent(KeyboardEvent&);
188     virtual void handleKeyupEvent(KeyboardEvent&);
189     virtual void handleBeforeTextInsertedEvent(BeforeTextInsertedEvent&);
190     virtual void forwardEvent(Event&);
191
192 #if ENABLE(TOUCH_EVENTS)
193     virtual void handleTouchEvent(TouchEvent&);
194 #endif
195
196     // Helpers for event handlers.
197
198     virtual bool shouldSubmitImplicitly(Event&);
199     virtual PassRefPtr<HTMLFormElement> formForSubmission() const;
200     virtual bool hasCustomFocusLogic() const;
201     virtual bool isKeyboardFocusable(KeyboardEvent&) const;
202     virtual bool isMouseFocusable() const;
203     virtual bool shouldUseInputMethod() const;
204     virtual void handleFocusEvent(Node* oldFocusedNode, FocusDirection);
205     virtual void handleBlurEvent();
206     virtual void accessKeyAction(bool sendMouseEvents);
207     virtual bool canBeSuccessfulSubmitButton();
208     virtual void subtreeHasChanged();
209     virtual void blur();
210
211 #if ENABLE(TOUCH_EVENTS)
212     virtual bool hasTouchEventHandler() const;
213 #endif
214
215     // Shadow tree handling.
216
217     virtual void createShadowSubtree();
218     virtual void destroyShadowSubtree();
219
220     virtual HTMLElement* containerElement() const { return nullptr; }
221     virtual HTMLElement* innerBlockElement() const { return nullptr; }
222     virtual TextControlInnerTextElement* innerTextElement() const { return nullptr; }
223     virtual HTMLElement* innerSpinButtonElement() const { return nullptr; }
224     virtual HTMLElement* capsLockIndicatorElement() const { return nullptr; }
225     virtual HTMLElement* autoFillButtonElement() const { return nullptr; }
226     virtual HTMLElement* resultsButtonElement() const { return nullptr; }
227     virtual HTMLElement* cancelButtonElement() const { return nullptr; }
228     virtual HTMLElement* sliderThumbElement() const { return nullptr; }
229     virtual HTMLElement* sliderTrackElement() const { return nullptr; }
230     virtual HTMLElement* placeholderElement() const;
231
232     // Miscellaneous functions.
233
234     virtual bool rendererIsNeeded();
235     virtual RenderPtr<RenderElement> createInputRenderer(RenderStyle&&);
236     virtual void addSearchResult();
237     virtual void attach();
238     virtual void detach();
239     virtual void minOrMaxAttributeChanged();
240     virtual void stepAttributeChanged();
241     virtual void altAttributeChanged();
242     virtual void srcAttributeChanged();
243     virtual void maxResultsAttributeChanged();
244     virtual bool shouldRespectAlignAttribute();
245     virtual FileList* files();
246     virtual void setFiles(PassRefPtr<FileList>);
247     virtual Icon* icon() const;
248     virtual bool shouldSendChangeEventAfterCheckedChanged();
249     virtual bool canSetValue(const String&);
250     virtual bool storesValueSeparateFromAttribute();
251     virtual void setValue(const String&, bool valueChanged, TextFieldEventBehavior);
252     virtual bool shouldResetOnDocumentActivation();
253     virtual bool shouldRespectListAttribute();
254     virtual bool isEnumeratable();
255     virtual bool isCheckable();
256     virtual bool isSteppable() const;
257     virtual bool shouldRespectHeightAndWidthAttributes();
258     virtual bool supportsPlaceholder() const;
259     virtual bool supportsReadOnly() const;
260     virtual void updateInnerTextValue();
261     virtual void updatePlaceholderText();
262     virtual void attributeChanged();
263     virtual void multipleAttributeChanged();
264     virtual void disabledAttributeChanged();
265     virtual void readonlyAttributeChanged();
266     virtual void requiredAttributeChanged();
267     virtual void capsLockStateMayHaveChanged();
268     virtual void updateAutoFillButton();
269     virtual String defaultToolTip() const;
270     virtual bool matchesIndeterminatePseudoClass() const;
271     virtual bool shouldAppearIndeterminate() const;
272     virtual bool supportsSelectionAPI() const;
273     virtual Color valueAsColor() const;
274     virtual void selectColor(const Color&);
275
276     // Parses the specified string for the type, and return
277     // the Decimal value for the parsing result if the parsing
278     // succeeds; Returns defaultValue otherwise. This function can
279     // return NaN or Infinity only if defaultValue is NaN or Infinity.
280     virtual Decimal parseToNumber(const String&, const Decimal& defaultValue) const;
281
282     // Parses the specified string for this InputType, and returns true if it
283     // is successfully parsed. An instance pointed by the DateComponents*
284     // parameter will have parsed values and be modified even if the parsing
285     // fails. The DateComponents* parameter may be null.
286     virtual bool parseToDateComponents(const String&, DateComponents*) const;
287
288     // Create a string representation of the specified Decimal value for the
289     // input type. If NaN or Infinity is specified, this returns an empty
290     // string. This should not be called for types without valueAsNumber.
291     virtual String serialize(const Decimal&) const;
292
293     // Gets width and height of the input element if the type of the
294     // element is image. It returns 0 if the element is not image type.
295     virtual unsigned height() const;
296     virtual unsigned width() const;
297
298     void dispatchSimulatedClickIfActive(KeyboardEvent&) const;
299
300 #if ENABLE(DATALIST_ELEMENT)
301     virtual void listAttributeTargetChanged();
302     virtual Optional<Decimal> findClosestTickMarkValue(const Decimal&);
303 #endif
304
305 #if ENABLE(DRAG_SUPPORT)
306     virtual bool receiveDroppedFiles(const DragData&);
307 #endif
308
309 #if PLATFORM(IOS)
310     virtual DateComponents::Type dateType() const;
311     virtual String displayString() const;
312 #endif
313
314 protected:
315     explicit InputType(HTMLInputElement& element) : m_element(element) { }
316     HTMLInputElement& element() const { return m_element; }
317     Chrome* chrome() const;
318     Decimal parseToNumberOrNaN(const String&) const;
319
320 private:
321     // Helper for stepUp()/stepDown(). Adds step value * count to the current value.
322     void applyStep(int count, AnyStepHandling, TextFieldEventBehavior, ExceptionCode&);
323
324     // Raw pointer because the HTMLInputElement object owns this InputType object.
325     HTMLInputElement& m_element;
326 };
327
328 } // namespace WebCore
329
330 #endif