f587b042623e474ffa8756cec83f40492053536d
[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 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 "ImageLoaderClient.h"
31 #include "StepRange.h"
32
33 namespace WebCore {
34
35 class CheckedRadioButtons;
36 class DragData;
37 class FileList;
38 class HTMLDataListElement;
39 class HTMLOptionElement;
40 class Icon;
41 class InputType;
42 class KURL;
43 class ListAttributeTargetObserver;
44 struct DateTimeChooserParameters;
45
46 class HTMLInputElement : public HTMLTextFormControlElement, public ImageLoaderClientBase<HTMLInputElement> {
47 public:
48     static PassRefPtr<HTMLInputElement> create(const QualifiedName&, Document*, HTMLFormElement*, bool createdByParser);
49     virtual ~HTMLInputElement();
50
51     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitspeechchange);
52
53     virtual HTMLInputElement* toInputElement() { return this; }
54
55     virtual bool shouldAutocomplete() const;
56
57     // For ValidityState
58     virtual bool hasBadInput() const OVERRIDE;
59     virtual bool patternMismatch() const OVERRIDE;
60     virtual bool rangeUnderflow() const OVERRIDE;
61     virtual bool rangeOverflow() const;
62     virtual bool stepMismatch() const OVERRIDE;
63     virtual bool tooLong() const OVERRIDE;
64     virtual bool typeMismatch() const OVERRIDE;
65     virtual bool valueMissing() const OVERRIDE;
66     virtual String validationMessage() const OVERRIDE;
67
68     // Returns the minimum value for type=date, number, or range.  Don't call this for other types.
69     double minimum() const;
70     // Returns the maximum value for type=date, number, or range.  Don't call this for other types.
71     // This always returns a value which is >= minimum().
72     double maximum() const;
73     // Sets the "allowed value step" defined in the HTML spec to the specified double pointer.
74     // Returns false if there is no "allowed value step."
75     bool getAllowedValueStep(Decimal*) const;
76     StepRange createStepRange(AnyStepHandling) const;
77
78 #if ENABLE(DATALIST_ELEMENT)
79     Decimal findClosestTickMarkValue(const Decimal&);
80 #endif
81
82     // Implementations of HTMLInputElement::stepUp() and stepDown().
83     void stepUp(int, ExceptionCode&);
84     void stepDown(int, ExceptionCode&);
85     void stepUp(ExceptionCode& ec) { stepUp(1, ec); }
86     void stepDown(ExceptionCode& ec) { stepDown(1, ec); }
87     // stepUp()/stepDown() for user-interaction.
88     bool isSteppable() const;
89
90     bool isTextButton() const;
91
92     bool isRadioButton() const;
93     bool isTextField() const;
94     bool isSearchField() const;
95     bool isInputTypeHidden() const;
96     bool isPasswordField() const;
97     bool isCheckbox() const;
98     bool isRangeControl() const;
99
100     // FIXME: It's highly likely that any call site calling this function should instead
101     // be using a different one. Many input elements behave like text fields, and in addition
102     // any unknown input type is treated as text. Consider, for example, isTextField or
103     // isTextField && !isPasswordField.
104     bool isText() const;
105
106     bool isEmailField() const;
107     bool isFileUpload() const;
108     bool isImageButton() const;
109     bool isNumberField() const;
110     bool isSubmitButton() const;
111     bool isTelephoneField() const;
112     bool isURLField() const;
113     bool isDateField() const;
114     bool isDateTimeField() const;
115     bool isDateTimeLocalField() const;
116     bool isMonthField() const;
117     bool isTimeField() const;
118     bool isWeekField() const;
119
120 #if ENABLE(INPUT_SPEECH)
121     bool isSpeechEnabled() const;
122 #endif
123
124     HTMLElement* containerElement() const;
125     virtual HTMLElement* innerTextElement() const;
126     HTMLElement* innerBlockElement() const;
127     HTMLElement* innerSpinButtonElement() const;
128     HTMLElement* resultsButtonElement() const;
129     HTMLElement* cancelButtonElement() const;
130 #if ENABLE(INPUT_SPEECH)
131     HTMLElement* speechButtonElement() const;
132 #endif
133     HTMLElement* sliderThumbElement() const;
134     HTMLElement* sliderTrackElement() const;
135     virtual HTMLElement* placeholderElement() const;
136
137     bool checked() const { return m_isChecked; }
138     void setChecked(bool, TextFieldEventBehavior = DispatchNoEvent);
139
140     // 'indeterminate' is a state independent of the checked state that causes the control to draw in a way that hides the actual state.
141     bool indeterminate() const { return m_isIndeterminate; }
142     void setIndeterminate(bool);
143     // shouldAppearChecked is used by the rendering tree/CSS while checked() is used by JS to determine checked state
144     bool shouldAppearChecked() const;
145     virtual bool isIndeterminate() const;
146
147     int size() const;
148     bool sizeShouldIncludeDecoration(int& preferredSize) const;
149
150     void setType(const String&);
151
152     String value() const;
153     void setValue(const String&, ExceptionCode&, TextFieldEventBehavior = DispatchNoEvent);
154     void setValue(const String&, TextFieldEventBehavior = DispatchNoEvent);
155     void setValueForUser(const String&);
156     // Checks if the specified string would be a valid value.
157     // We should not call this for types with no string value such as CHECKBOX and RADIO.
158     bool isValidValue(const String&) const;
159     bool hasDirtyValue() const { return !m_valueIfDirty.isNull(); };
160
161     String sanitizeValue(const String&) const;
162
163     String localizeValue(const String&) const;
164
165     // The value which is drawn by a renderer.
166     String visibleValue() const;
167
168     const String& suggestedValue() const;
169     void setSuggestedValue(const String&);
170
171     void setEditingValue(const String&);
172
173     double valueAsDate() const;
174     void setValueAsDate(double, ExceptionCode&);
175
176     double valueAsNumber() const;
177     void setValueAsNumber(double, ExceptionCode&, TextFieldEventBehavior = DispatchNoEvent);
178
179     String valueWithDefault() const;
180
181     void setValueFromRenderer(const String&);
182
183     bool canHaveSelection() const;
184
185     virtual bool rendererIsNeeded(const NodeRenderingContext&);
186     virtual RenderObject* createRenderer(RenderArena*, RenderStyle*);
187     virtual void detach();
188
189     // FIXME: For isActivatedSubmit and setActivatedSubmit, we should use the NVI-idiom here by making
190     // it private virtual in all classes and expose a public method in HTMLFormControlElement to call
191     // the private virtual method.
192     virtual bool isActivatedSubmit() const;
193     virtual void setActivatedSubmit(bool flag);
194
195     String altText() const;
196
197     int maxResults() const { return m_maxResults; }
198
199     String defaultValue() const;
200     void setDefaultValue(const String&);
201
202     Vector<String> acceptMIMETypes();
203     Vector<String> acceptFileExtensions();
204     String accept() const;
205     String alt() const;
206
207     void setSize(unsigned);
208     void setSize(unsigned, ExceptionCode&);
209
210     KURL src() const;
211
212     virtual int maxLength() const;
213     void setMaxLength(int, ExceptionCode&);
214
215     bool multiple() const;
216
217     bool isAutofilled() const { return m_isAutofilled; }
218     void setAutofilled(bool = true);
219
220     FileList* files();
221     void setFiles(PassRefPtr<FileList>);
222
223     // Returns true if the given DragData has more than one dropped files.
224     bool receiveDroppedFiles(const DragData*);
225
226 #if ENABLE(FILE_SYSTEM)
227     String droppedFileSystemId();
228 #endif
229
230     Icon* icon() const;
231     // These functions are used for rendering the input active during a
232     // drag-and-drop operation.
233     bool canReceiveDroppedFiles() const;
234     void setCanReceiveDroppedFiles(bool);
235
236     void addSearchResult();
237     void onSearch();
238
239     virtual bool willRespondToMouseClickEvents() OVERRIDE;
240
241 #if ENABLE(DATALIST_ELEMENT)
242     HTMLElement* list() const;
243     HTMLDataListElement* dataList() const;
244     void listAttributeTargetChanged();
245 #endif
246
247     HTMLInputElement* checkedRadioButtonForGroup() const;
248     bool isInRequiredRadioButtonGroup();
249
250     // Functions for InputType classes.
251     void setValueInternal(const String&, TextFieldEventBehavior);
252     bool isTextFormControlFocusable() const;
253     bool isTextFormControlKeyboardFocusable(KeyboardEvent*) const;
254     bool isTextFormControlMouseFocusable() const;
255     bool valueAttributeWasUpdatedAfterParsing() const { return m_valueAttributeWasUpdatedAfterParsing; }
256
257     void cacheSelectionInResponseToSetValue(int caretOffset) { cacheSelection(caretOffset, caretOffset, SelectionHasNoDirection); }
258
259 #if ENABLE(INPUT_TYPE_COLOR)
260     // For test purposes.
261     void selectColorInColorChooser(const Color&);
262 #endif
263
264     String defaultToolTip() const;
265
266 #if ENABLE(MEDIA_CAPTURE)
267     String capture() const;
268     void setCapture(const String& value);
269 #endif
270
271     static const int maximumLength;
272
273     unsigned height() const;
274     unsigned width() const;
275     void setHeight(unsigned);
276     void setWidth(unsigned);
277
278     virtual void blur() OVERRIDE;
279     void defaultBlur();
280     void defaultFocus(bool restorePreviousSelection);
281     virtual void focus(bool restorePreviousSelection = true) OVERRIDE;
282
283     virtual const AtomicString& name() const OVERRIDE;
284
285     void endEditing();
286
287     static Vector<FileChooserFileInfo> filesFromFileInputFormControlState(const FormControlState&);
288
289     virtual bool matchesReadOnlyPseudoClass() const OVERRIDE;
290     virtual bool matchesReadWritePseudoClass() const OVERRIDE;
291     virtual void setRangeText(const String& replacement, ExceptionCode&) OVERRIDE;
292     virtual void setRangeText(const String& replacement, unsigned start, unsigned end, const String& selectionMode, ExceptionCode&) OVERRIDE;
293
294 #if ENABLE(DATE_AND_TIME_INPUT_TYPES)
295     bool setupDateTimeChooserParameters(DateTimeChooserParameters&);
296 #endif
297     virtual void reportMemoryUsage(MemoryObjectInfo*) const OVERRIDE;
298
299 protected:
300     HTMLInputElement(const QualifiedName&, Document*, HTMLFormElement*, bool createdByParser);
301     void createShadowSubtree();
302     virtual void defaultEventHandler(Event*);
303     // FIXME: Author shadows should be allowed
304     // https://bugs.webkit.org/show_bug.cgi?id=92608
305     virtual bool areAuthorShadowsAllowed() const OVERRIDE { return false; }
306
307 private:
308     enum AutoCompleteSetting { Uninitialized, On, Off };
309
310     virtual void willChangeForm() OVERRIDE;
311     virtual void didChangeForm() OVERRIDE;
312     virtual InsertionNotificationRequest insertedInto(ContainerNode*) OVERRIDE;
313     virtual void removedFrom(ContainerNode*) OVERRIDE;
314     virtual void didMoveToNewDocument(Document* oldDocument) OVERRIDE;
315
316     virtual bool hasCustomFocusLogic() const OVERRIDE;
317     virtual bool isKeyboardFocusable(KeyboardEvent*) const;
318     virtual bool isMouseFocusable() const;
319     virtual bool isEnumeratable() const;
320     virtual bool supportLabels() const OVERRIDE;
321     virtual void updateFocusAppearance(bool restorePreviousSelection);
322     virtual bool shouldUseInputMethod();
323
324     virtual bool isTextFormControl() const { return isTextField(); }
325
326     virtual bool canTriggerImplicitSubmission() const { return isTextField(); }
327
328     virtual const AtomicString& formControlType() const;
329
330     virtual bool shouldSaveAndRestoreFormControlState() const OVERRIDE;
331     virtual FormControlState saveFormControlState() const OVERRIDE;
332     virtual void restoreFormControlState(const FormControlState&) OVERRIDE;
333
334     virtual bool canStartSelection() const;
335
336     virtual void accessKeyAction(bool sendMouseEvents);
337
338     virtual void parseAttribute(const QualifiedName&, const AtomicString&) OVERRIDE;
339     virtual bool isPresentationAttribute(const QualifiedName&) const OVERRIDE;
340     virtual void collectStyleForPresentationAttribute(const Attribute&, StylePropertySet*) OVERRIDE;
341     virtual void finishParsingChildren();
342
343     virtual void copyNonAttributePropertiesFromElement(const Element&);
344
345     virtual void attach();
346
347     virtual bool appendFormData(FormDataList&, bool);
348
349     virtual bool isSuccessfulSubmitButton() const;
350
351     virtual void reset();
352
353     virtual void* preDispatchEventHandler(Event*);
354     virtual void postDispatchEventHandler(Event*, void* dataFromPreDispatch);
355
356     virtual bool isURLAttribute(const Attribute&) const OVERRIDE;
357
358     virtual bool isInRange() const;
359     virtual bool isOutOfRange() const;
360
361     virtual void documentDidResumeFromPageCache();
362
363     virtual void addSubresourceAttributeURLs(ListHashSet<KURL>&) const;
364
365     bool needsSuspensionCallback();
366     void registerForSuspensionCallbackIfNeeded();
367     void unregisterForSuspensionCallbackIfNeeded();
368
369     bool supportsMaxLength() const { return isTextType(); }
370     bool isTextType() const;
371     bool tooLong(const String&, NeedsToCheckDirtyFlag) const;
372
373     virtual bool supportsPlaceholder() const;
374     virtual void updatePlaceholderText();
375     virtual bool isEmptyValue() const OVERRIDE { return innerTextValue().isEmpty(); }
376     virtual bool isEmptySuggestedValue() const { return suggestedValue().isEmpty(); }
377     virtual void handleFocusEvent();
378     virtual void handleBlurEvent();
379
380     virtual bool isOptionalFormControl() const { return !isRequiredFormControl(); }
381     virtual bool isRequiredFormControl() const;
382     virtual bool recalcWillValidate() const;
383     virtual void requiredAttributeChanged() OVERRIDE;
384
385     void updateType();
386     
387     virtual void subtreeHasChanged();
388
389 #if ENABLE(DATALIST_ELEMENT)
390     void resetListAttributeTargetObserver();
391 #endif
392     void parseMaxLengthAttribute(const AtomicString&);
393     void updateValueIfNeeded();
394
395     // Returns null if this isn't associated with any radio button group.
396     CheckedRadioButtons* checkedRadioButtons() const;
397     void addToRadioButtonGroup();
398     void removeFromRadioButtonGroup();
399
400     AtomicString m_name;
401     String m_valueIfDirty;
402     String m_suggestedValue;
403     int m_size;
404     int m_maxLength;
405     short m_maxResults;
406     bool m_isChecked : 1;
407     bool m_reflectsCheckedAttribute : 1;
408     bool m_isIndeterminate : 1;
409     bool m_hasType : 1;
410     bool m_isActivatedSubmit : 1;
411     unsigned m_autocomplete : 2; // AutoCompleteSetting
412     bool m_isAutofilled : 1;
413 #if ENABLE(DATALIST_ELEMENT)
414     bool m_hasNonEmptyList : 1;
415 #endif
416     bool m_stateRestored : 1;
417     bool m_parsingInProgress : 1;
418     bool m_valueAttributeWasUpdatedAfterParsing : 1;
419     bool m_wasModifiedByUser : 1;
420     bool m_canReceiveDroppedFiles : 1;
421 #if ENABLE(TOUCH_EVENTS)
422     bool m_hasTouchEventHandler : 1;
423 #endif
424     OwnPtr<InputType> m_inputType;
425 #if ENABLE(DATALIST_ELEMENT)
426     OwnPtr<ListAttributeTargetObserver> m_listAttributeTargetObserver;
427 #endif
428 };
429
430 } //namespace
431 #endif