HTMLCollection's caches should be owned by either ElementRareData or Document
[WebKit-https.git] / Source / WebCore / html / HTMLFormElement.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 HTMLFormElement_h
25 #define HTMLFormElement_h
26
27 #include "CheckedRadioButtons.h"
28 #include "FormState.h"
29 #include "FormSubmission.h"
30 #include "HTMLElement.h"
31 #include <wtf/OwnPtr.h>
32
33 namespace WebCore {
34
35 class Event;
36 class FormAssociatedElement;
37 class FormData;
38 class HTMLFormControlElement;
39 class HTMLImageElement;
40 class HTMLInputElement;
41 class HTMLFormCollection;
42 class TextEncoding;
43
44 class HTMLFormElement : public HTMLElement {
45 public:
46     static PassRefPtr<HTMLFormElement> create(Document*);
47     static PassRefPtr<HTMLFormElement> create(const QualifiedName&, Document*);
48     virtual ~HTMLFormElement();
49
50     HTMLCollection* elements();
51     void getNamedElements(const AtomicString&, Vector<RefPtr<Node> >&);
52
53     unsigned length() const;
54     Node* item(unsigned index);
55
56     String enctype() const { return m_attributes.encodingType(); }
57     void setEnctype(const String&);
58
59     String encoding() const { return m_attributes.encodingType(); }
60     void setEncoding(const String& value) { setEnctype(value); }
61
62     bool shouldAutocomplete() const;
63
64     // FIXME: Should rename these two functions to say "form control" or "form-associated element" instead of "form element".
65     void registerFormElement(FormAssociatedElement*);
66     void removeFormElement(FormAssociatedElement*);
67
68     void registerImgElement(HTMLImageElement*);
69     void removeImgElement(HTMLImageElement*);
70
71     bool prepareForSubmission(Event*);
72     void submit();
73     void submitFromJavaScript();
74     void reset();
75
76     // Used to indicate a malformed state to keep from applying the bottom margin of the form.
77     // FIXME: Would probably be better to call this wasUnclosed; that's more specific.
78     void setMalformed(bool malformed) { m_wasMalformed = malformed; }
79     bool isMalformed() const { return m_wasMalformed; }
80
81     void setDemoted(bool demoted) { m_wasDemoted = demoted; }
82
83     void submitImplicitly(Event*, bool fromImplicitSubmissionTrigger);
84     bool formWouldHaveSecureSubmission(const String& url);
85
86     String name() const;
87
88     bool noValidate() const;
89
90     String acceptCharset() const { return m_attributes.acceptCharset(); }
91     void setAcceptCharset(const String&);
92
93     String action() const;
94     void setAction(const String&);
95
96     String method() const;
97     void setMethod(const String&);
98
99     virtual String target() const;
100
101     bool wasUserSubmitted() const;
102
103     HTMLFormControlElement* defaultButton() const;
104
105     bool checkValidity();
106
107     HTMLFormControlElement* elementForAlias(const AtomicString&);
108     void addElementAlias(HTMLFormControlElement*, const AtomicString& alias);
109
110     CheckedRadioButtons& checkedRadioButtons() { return m_checkedRadioButtons; }
111
112     const Vector<FormAssociatedElement*>& associatedElements() const { return m_associatedElements; }
113     const Vector<HTMLImageElement*>& imageElements() const { return m_imageElements; }
114
115     void getTextFieldValues(StringPairVector& fieldNamesAndValues) const;
116
117 private:
118     HTMLFormElement(const QualifiedName&, Document*);
119
120     virtual bool rendererIsNeeded(const NodeRenderingContext&);
121     virtual InsertionNotificationRequest insertedInto(ContainerNode*) OVERRIDE;
122     virtual void didNotifyDescendantInsertions(ContainerNode*) OVERRIDE;
123     virtual void removedFrom(ContainerNode*) OVERRIDE;
124
125     virtual void handleLocalEvents(Event*);
126
127     virtual void parseAttribute(const Attribute&) OVERRIDE;
128     virtual bool isURLAttribute(const Attribute&) const OVERRIDE;
129
130     virtual void documentDidResumeFromPageCache();
131
132     virtual void didMoveToNewDocument(Document* oldDocument) OVERRIDE;
133
134     virtual bool shouldRegisterAsNamedItem() const OVERRIDE { return true; }
135
136     void submit(Event*, bool activateSubmitButton, bool processingUserGesture, FormSubmissionTrigger);
137
138     unsigned formElementIndexWithFormAttribute(Element*);
139     unsigned formElementIndex(FormAssociatedElement*);
140
141     // Returns true if the submission should proceed.
142     bool validateInteractively(Event*);
143
144     // Validates each of the controls, and stores controls of which 'invalid'
145     // event was not canceled to the specified vector. Returns true if there
146     // are any invalid controls in this form.
147     bool checkInvalidControlsAndCollectUnhandled(Vector<RefPtr<FormAssociatedElement> >&);
148
149     typedef HashMap<RefPtr<AtomicStringImpl>, RefPtr<HTMLFormControlElement> > AliasMap;
150
151     FormSubmission::Attributes m_attributes;
152     OwnPtr<AliasMap> m_elementAliases;
153
154     CheckedRadioButtons m_checkedRadioButtons;
155
156     unsigned m_associatedElementsBeforeIndex;
157     unsigned m_associatedElementsAfterIndex;
158     Vector<FormAssociatedElement*> m_associatedElements;
159     Vector<HTMLImageElement*> m_imageElements;
160
161     bool m_wasUserSubmitted;
162     bool m_isSubmittingOrPreparingForSubmission;
163     bool m_shouldSubmit;
164
165     bool m_isInResetFunction;
166
167     bool m_wasMalformed;
168     bool m_wasDemoted;
169 };
170
171 } // namespace WebCore
172
173 #endif // HTMLFormElement_h