Implement support for the autocomplete attribute
[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 setAncestorDisabled(bool isDisabled);
58
59     virtual void reset() { }
60
61     bool formControlValueMatchesRenderer() const { return m_valueMatchesRenderer; }
62     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     WEBCORE_EXPORT bool autocorrect() const;
94     void setAutocorrect(bool);
95
96     WEBCORE_EXPORT WebAutocapitalizeType autocapitalizeType() const;
97     const AtomicString& autocapitalize() const;
98     void setAutocapitalize(const AtomicString&);
99 #endif
100
101     virtual bool willValidate() const override final;
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 updateValidity();
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     String autocomplete() const;
118     void setAutocomplete(const String&);
119
120     using Node::ref;
121     using Node::deref;
122
123 protected:
124     HTMLFormControlElement(const QualifiedName& tagName, Document&, HTMLFormElement*);
125
126     bool disabledByAncestorFieldset() const { return m_disabledByAncestorFieldset; }
127
128     virtual void parseAttribute(const QualifiedName&, const AtomicString&) override;
129     virtual void disabledAttributeChanged();
130     virtual void disabledStateChanged();
131     virtual void readOnlyAttributeChanged();
132     virtual void requiredAttributeChanged();
133     virtual void didAttachRenderers() override;
134     virtual InsertionNotificationRequest insertedInto(ContainerNode&) override;
135     void finishedInsertingSubtree() override;
136     virtual void removedFrom(ContainerNode&) override;
137     virtual void didMoveToNewDocument(Document* oldDocument) override;
138
139     virtual bool supportsFocus() const override;
140     virtual bool isKeyboardFocusable(KeyboardEvent*) const override;
141     virtual bool isMouseFocusable() const override;
142
143     virtual void didRecalcStyle(Style::Change) override;
144
145     virtual void dispatchBlurEvent(RefPtr<Element>&& newFocusedElement) override;
146
147     // This must be called any time the result of willValidate() has changed.
148     void setNeedsWillValidateCheck();
149     virtual bool computeWillValidate() const;
150
151     bool validationMessageShadowTreeContains(const Node&) const;
152
153     virtual void willChangeForm() override;
154     virtual void didChangeForm() override;
155
156 private:
157     virtual void refFormAssociatedElement() override { ref(); }
158     virtual void derefFormAssociatedElement() override { deref(); }
159
160     virtual bool matchesValidPseudoClass() const override;
161     virtual bool matchesInvalidPseudoClass() const override;
162
163     virtual bool isFormControlElement() const override final { return true; }
164     virtual bool alwaysCreateUserAgentShadowRoot() const override { return true; }
165
166     virtual short tabIndex() const override final;
167
168     virtual HTMLFormElement* virtualForm() const override;
169     virtual bool isDefaultButtonForForm() const override;
170     bool isValidFormControlElement() const;
171
172     bool computeIsDisabledByFieldsetAncestor() const;
173
174     virtual HTMLElement& asHTMLElement() override final { return *this; }
175     virtual const HTMLFormControlElement& asHTMLElement() const override final { return *this; }
176     virtual HTMLFormControlElement* asFormNamedItem() override final { return this; }
177
178     std::unique_ptr<ValidationMessage> m_validationMessage;
179     bool m_disabled : 1;
180     bool m_isReadOnly : 1;
181     bool m_isRequired : 1;
182     bool m_valueMatchesRenderer : 1;
183     bool m_disabledByAncestorFieldset : 1;
184
185     enum DataListAncestorState { Unknown, InsideDataList, NotInsideDataList };
186     mutable enum DataListAncestorState m_dataListAncestorState;
187
188     // The initial value of m_willValidate depends on the derived class. We can't
189     // initialize it with a virtual function in the constructor. m_willValidate
190     // is not deterministic as long as m_willValidateInitialized is false.
191     mutable bool m_willValidateInitialized: 1;
192     mutable bool m_willValidate : 1;
193
194     // Cache of validity()->valid().
195     // But "candidate for constraint validation" doesn't affect m_isValid.
196     bool m_isValid : 1;
197
198     bool m_wasChangedSinceLastFormControlChangeEvent : 1;
199
200     bool m_hasAutofocused : 1;
201 };
202
203 } // namespace WebCore
204
205 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::HTMLFormControlElement)
206     static bool isType(const WebCore::Element& element) { return element.isFormControlElement(); }
207     static bool isType(const WebCore::Node& node) { return is<WebCore::Element>(node) && isType(downcast<WebCore::Element>(node)); }
208     static bool isType(const WebCore::FormAssociatedElement& element) { return element.isFormControlElement(); }
209 SPECIALIZE_TYPE_TRAITS_END()
210
211 #endif