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