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