Cleanup static_cast<HTMLFormElement*> by using toHTMLFormElement()
[WebKit-https.git] / Source / WebCore / html / HTMLFormControlElement.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, 2008, 2009, 2010 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #ifndef HTMLFormControlElement_h
25 #define HTMLFormControlElement_h
26
27 #include "FormAssociatedElement.h"
28 #include "LabelableElement.h"
29
30 #if ENABLE(IOS_AUTOCORRECT_AND_AUTOCAPITALIZE)
31 #include "Autocapitalize.h"
32 #endif
33
34 namespace WebCore {
35
36 class FormDataList;
37 class HTMLFieldSetElement;
38 class HTMLFormElement;
39 class HTMLLegendElement;
40 class ValidationMessage;
41
42 // HTMLFormControlElement is the default implementation of FormAssociatedElement,
43 // and form-associated element implementations should use HTMLFormControlElement
44 // unless there is a special reason.
45 class HTMLFormControlElement : public LabelableElement, public FormAssociatedElement {
46 public:
47     virtual ~HTMLFormControlElement();
48
49     HTMLFormElement* form() const { return FormAssociatedElement::form(); }
50
51     String formEnctype() const;
52     void setFormEnctype(const String&);
53     String formMethod() const;
54     void setFormMethod(const String&);
55     bool formNoValidate() const;
56
57     void ancestorDisabledStateWasChanged();
58
59     virtual void reset() { }
60
61     virtual bool formControlValueMatchesRenderer() const { return m_valueMatchesRenderer; }
62     virtual void setFormControlValueMatchesRenderer(bool b) { m_valueMatchesRenderer = b; }
63
64     bool wasChangedSinceLastFormControlChangeEvent() const { return m_wasChangedSinceLastFormControlChangeEvent; }
65     void setChangedSinceLastFormControlChangeEvent(bool);
66
67     virtual void dispatchFormControlChangeEvent();
68     void dispatchChangeEvent();
69     void dispatchFormControlInputEvent();
70
71     virtual bool isDisabledFormControl() const OVERRIDE;
72
73     virtual bool isFocusable() const OVERRIDE;
74     virtual bool isEnumeratable() const OVERRIDE { return false; }
75
76     bool isRequired() const;
77
78     const AtomicString& type() const { return formControlType(); }
79
80     virtual const AtomicString& formControlType() const = 0;
81
82     virtual bool canTriggerImplicitSubmission() const { return false; }
83
84     // Override in derived classes to get the encoded name=value pair for submitting.
85     // Return true for a successful control (see HTML4-17.13.2).
86     virtual bool appendFormData(FormDataList&, bool) OVERRIDE { return false; }
87
88     virtual bool isSuccessfulSubmitButton() const { return false; }
89     virtual bool isActivatedSubmit() const { return false; }
90     virtual void setActivatedSubmit(bool) { }
91
92 #if ENABLE(IOS_AUTOCORRECT_AND_AUTOCAPITALIZE)
93     bool autocorrect() const;
94     void setAutocorrect(bool);
95
96     WebAutocapitalizeType autocapitalizeType() const;
97     const AtomicString& autocapitalize() const;
98     void setAutocapitalize(const AtomicString&);
99 #endif
100
101     virtual bool willValidate() const OVERRIDE;
102     void updateVisibleValidationMessage();
103     void hideVisibleValidationMessage();
104     bool checkValidity(Vector<RefPtr<FormAssociatedElement>>* unhandledInvalidControls = 0);
105     // This must be called when a validation constraint or control value is changed.
106     void setNeedsValidityCheck();
107     virtual void setCustomValidity(const String&) OVERRIDE;
108
109     bool isReadOnly() const { return m_isReadOnly; }
110     bool isDisabledOrReadOnly() const { return isDisabledFormControl() || m_isReadOnly; }
111
112     bool hasAutofocused() { return m_hasAutofocused; }
113     void setAutofocused() { m_hasAutofocused = true; }
114
115     static HTMLFormControlElement* enclosingFormControlElement(Node*);
116
117     using Node::ref;
118     using Node::deref;
119
120 protected:
121     HTMLFormControlElement(const QualifiedName& tagName, Document&, HTMLFormElement*);
122
123     virtual void parseAttribute(const QualifiedName&, const AtomicString&) OVERRIDE;
124     virtual void requiredAttributeChanged();
125     virtual void disabledAttributeChanged();
126     virtual void didAttachRenderers() OVERRIDE;
127     virtual InsertionNotificationRequest insertedInto(ContainerNode&) OVERRIDE;
128     virtual void removedFrom(ContainerNode&) OVERRIDE;
129     virtual void didMoveToNewDocument(Document* oldDocument) OVERRIDE;
130
131     virtual bool supportsFocus() const OVERRIDE;
132     virtual bool isKeyboardFocusable(KeyboardEvent*) const OVERRIDE;
133     virtual bool isMouseFocusable() const OVERRIDE;
134
135     virtual void didRecalcStyle(Style::Change) OVERRIDE;
136
137     virtual void dispatchBlurEvent(PassRefPtr<Element> newFocusedElement) OVERRIDE;
138
139     // This must be called any time the result of willValidate() has changed.
140     void setNeedsWillValidateCheck();
141     virtual bool recalcWillValidate() const;
142
143     bool validationMessageShadowTreeContains(const Node&) const;
144
145 private:
146     virtual void refFormAssociatedElement() OVERRIDE { ref(); }
147     virtual void derefFormAssociatedElement() OVERRIDE { deref(); }
148
149     virtual bool isFormControlElement() const OVERRIDE { return true; }
150     virtual bool alwaysCreateUserAgentShadowRoot() const OVERRIDE { return true; }
151
152     virtual short tabIndex() const OVERRIDE FINAL;
153
154     virtual HTMLFormElement* virtualForm() const OVERRIDE;
155     virtual bool isDefaultButtonForForm() const OVERRIDE;
156     virtual bool isValidFormControlElement() OVERRIDE;
157     void updateAncestorDisabledState() const;
158
159     virtual HTMLElement& asHTMLElement() OVERRIDE FINAL { return *this; }
160     virtual const HTMLFormControlElement& asHTMLElement() const OVERRIDE FINAL { return *this; }
161     virtual HTMLFormControlElement* asFormNamedItem() OVERRIDE FINAL { return this; }
162
163     OwnPtr<ValidationMessage> m_validationMessage;
164     bool m_disabled : 1;
165     bool m_isReadOnly : 1;
166     bool m_isRequired : 1;
167     bool m_valueMatchesRenderer : 1;
168
169     enum AncestorDisabledState { AncestorDisabledStateUnknown, AncestorDisabledStateEnabled, AncestorDisabledStateDisabled };
170     mutable AncestorDisabledState m_ancestorDisabledState;
171     enum DataListAncestorState { Unknown, InsideDataList, NotInsideDataList };
172     mutable enum DataListAncestorState m_dataListAncestorState;
173
174     // The initial value of m_willValidate depends on the derived class. We can't
175     // initialize it with a virtual function in the constructor. m_willValidate
176     // is not deterministic as long as m_willValidateInitialized is false.
177     mutable bool m_willValidateInitialized: 1;
178     mutable bool m_willValidate : 1;
179
180     // Cache of validity()->valid().
181     // But "candidate for constraint validation" doesn't affect m_isValid.
182     bool m_isValid : 1;
183
184     bool m_wasChangedSinceLastFormControlChangeEvent : 1;
185
186     bool m_hasAutofocused : 1;
187 };
188
189 void isHTMLFormControlElement(const HTMLFormControlElement&); // Catch unnecessary runtime check of type known at compile time.
190 inline bool isHTMLFormControlElement(const Element& element) { return element.isFormControlElement(); }
191 inline bool isHTMLFormControlElement(const Node& node) { return node.isElementNode() && toElement(node).isFormControlElement(); }
192 template <> inline bool isElementOfType<const HTMLFormControlElement>(const Element& element) { return isHTMLFormControlElement(element); }
193
194 NODE_TYPE_CASTS(HTMLFormControlElement)
195
196 FORM_ASSOCIATED_ELEMENT_TYPE_CASTS(HTMLFormControlElement, isFormControlElement())
197
198 } // namespace
199
200 #endif