Add support for reportValidity() on form and form control elements
[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, 2016 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 #pragma once
25
26 #include "Autofill.h"
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     WEBCORE_EXPORT String formEnctype() const;
52     WEBCORE_EXPORT void setFormEnctype(const String&);
53     WEBCORE_EXPORT String formMethod() const;
54     WEBCORE_EXPORT void setFormMethod(const String&);
55     bool formNoValidate() const;
56     WEBCORE_EXPORT String formAction() const;
57     WEBCORE_EXPORT void setFormAction(const AtomicString&);
58
59     void setAncestorDisabled(bool isDisabled);
60
61     virtual void reset() { }
62
63     bool formControlValueMatchesRenderer() const { return m_valueMatchesRenderer; }
64     void setFormControlValueMatchesRenderer(bool b) { m_valueMatchesRenderer = b; }
65
66     bool wasChangedSinceLastFormControlChangeEvent() const { return m_wasChangedSinceLastFormControlChangeEvent; }
67     void setChangedSinceLastFormControlChangeEvent(bool);
68
69     virtual void dispatchFormControlChangeEvent();
70     void dispatchChangeEvent();
71     void dispatchFormControlInputEvent();
72
73     bool isDisabledFormControl() const override;
74
75     bool isFocusable() const override;
76     bool isEnumeratable() const override { return false; }
77
78     bool isRequired() const;
79
80     const AtomicString& type() const { return formControlType(); }
81
82     virtual const AtomicString& formControlType() const = 0;
83
84     virtual bool canTriggerImplicitSubmission() const { return false; }
85
86     // Override in derived classes to get the encoded name=value pair for submitting.
87     // Return true for a successful control (see HTML4-17.13.2).
88     bool appendFormData(FormDataList&, bool) override { return false; }
89
90     virtual bool isSuccessfulSubmitButton() const { return false; }
91     virtual bool isActivatedSubmit() const { return false; }
92     virtual void setActivatedSubmit(bool) { }
93
94 #if ENABLE(IOS_AUTOCORRECT_AND_AUTOCAPITALIZE)
95     WEBCORE_EXPORT bool autocorrect() const;
96     WEBCORE_EXPORT void setAutocorrect(bool);
97
98     WEBCORE_EXPORT WebAutocapitalizeType autocapitalizeType() const;
99     WEBCORE_EXPORT const AtomicString& autocapitalize() const;
100     WEBCORE_EXPORT void setAutocapitalize(const AtomicString&);
101 #endif
102
103     WEBCORE_EXPORT bool willValidate() const final;
104     void updateVisibleValidationMessage();
105     void hideVisibleValidationMessage();
106     WEBCORE_EXPORT bool checkValidity(Vector<RefPtr<HTMLFormControlElement>>* unhandledInvalidControls = nullptr);
107     bool reportValidity();
108     void focusAndShowValidationMessage();
109     // This must be called when a validation constraint or control value is changed.
110     void updateValidity();
111     void setCustomValidity(const String&) override;
112
113     bool isReadOnly() const { return m_isReadOnly; }
114     bool isDisabledOrReadOnly() const { return isDisabledFormControl() || m_isReadOnly; }
115
116     bool hasAutofocused() { return m_hasAutofocused; }
117     void setAutofocused() { m_hasAutofocused = true; }
118
119     static HTMLFormControlElement* enclosingFormControlElement(Node*);
120
121     WEBCORE_EXPORT String autocomplete() const;
122     WEBCORE_EXPORT void setAutocomplete(const String&);
123
124     AutofillMantle autofillMantle() const;
125
126     WEBCORE_EXPORT AutofillData autofillData() const;
127
128     using Node::ref;
129     using Node::deref;
130
131 protected:
132     HTMLFormControlElement(const QualifiedName& tagName, Document&, HTMLFormElement*);
133
134     bool disabledByAncestorFieldset() const { return m_disabledByAncestorFieldset; }
135
136     void parseAttribute(const QualifiedName&, const AtomicString&) override;
137     virtual void disabledAttributeChanged();
138     virtual void disabledStateChanged();
139     virtual void readOnlyAttributeChanged();
140     virtual void requiredAttributeChanged();
141     void didAttachRenderers() override;
142     InsertionNotificationRequest insertedInto(ContainerNode&) override;
143     void finishedInsertingSubtree() override;
144     void removedFrom(ContainerNode&) override;
145     void didMoveToNewDocument(Document* oldDocument) override;
146
147     bool supportsFocus() const override;
148     bool isKeyboardFocusable(KeyboardEvent&) const override;
149     bool isMouseFocusable() const override;
150
151     void didRecalcStyle(Style::Change) override;
152
153     void dispatchBlurEvent(RefPtr<Element>&& newFocusedElement) override;
154
155     // This must be called any time the result of willValidate() has changed.
156     void setNeedsWillValidateCheck();
157     virtual bool computeWillValidate() const;
158
159     bool validationMessageShadowTreeContains(const Node&) const;
160
161     void willChangeForm() override;
162     void didChangeForm() override;
163
164 private:
165     void refFormAssociatedElement() override { ref(); }
166     void derefFormAssociatedElement() override { deref(); }
167
168     bool matchesValidPseudoClass() const override;
169     bool matchesInvalidPseudoClass() const override;
170
171     bool isFormControlElement() const final { return true; }
172     bool alwaysCreateUserAgentShadowRoot() const override { return true; }
173
174     int tabIndex() const final;
175
176     HTMLFormElement* virtualForm() const override;
177     bool isValidFormControlElement() const;
178
179     bool computeIsDisabledByFieldsetAncestor() const;
180
181     HTMLElement& asHTMLElement() final { return *this; }
182     const HTMLFormControlElement& asHTMLElement() const final { return *this; }
183     HTMLFormControlElement* asFormNamedItem() final { return this; }
184
185     std::unique_ptr<ValidationMessage> m_validationMessage;
186     bool m_disabled : 1;
187     bool m_isReadOnly : 1;
188     bool m_isRequired : 1;
189     bool m_valueMatchesRenderer : 1;
190     bool m_disabledByAncestorFieldset : 1;
191
192     enum DataListAncestorState { Unknown, InsideDataList, NotInsideDataList };
193     mutable enum DataListAncestorState m_dataListAncestorState;
194
195     // The initial value of m_willValidate depends on the derived class. We can't
196     // initialize it with a virtual function in the constructor. m_willValidate
197     // is not deterministic as long as m_willValidateInitialized is false.
198     mutable bool m_willValidateInitialized: 1;
199     mutable bool m_willValidate : 1;
200
201     // Cache of validity()->valid().
202     // But "candidate for constraint validation" doesn't affect m_isValid.
203     bool m_isValid : 1;
204
205     bool m_wasChangedSinceLastFormControlChangeEvent : 1;
206
207     bool m_hasAutofocused : 1;
208 };
209
210 } // namespace WebCore
211
212 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::HTMLFormControlElement)
213     static bool isType(const WebCore::Element& element) { return element.isFormControlElement(); }
214     static bool isType(const WebCore::Node& node) { return is<WebCore::Element>(node) && isType(downcast<WebCore::Element>(node)); }
215     static bool isType(const WebCore::FormAssociatedElement& element) { return element.isFormControlElement(); }
216 SPECIALIZE_TYPE_TRAITS_END()