Node: removedFrom() and insertedInto() should use references.
[WebKit-https.git] / Source / WebCore / html / FormAssociatedElement.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 FormAssociatedElement_h
25 #define FormAssociatedElement_h
26
27 #include "FormNamedItem.h"
28 #include <wtf/text/WTFString.h>
29
30 namespace WebCore {
31
32 class ContainerNode;
33 class Document;
34 class FormAttributeTargetObserver;
35 class FormDataList;
36 class HTMLElement;
37 class HTMLFormElement;
38 class Node;
39 class ValidationMessage;
40 class ValidityState;
41 class VisibleSelection;
42
43 class FormAssociatedElement : public FormNamedItem {
44 public:
45     virtual ~FormAssociatedElement();
46
47     void ref() { refFormAssociatedElement(); }
48     void deref() { derefFormAssociatedElement(); }
49
50     static HTMLFormElement* findAssociatedForm(const HTMLElement*, HTMLFormElement*);
51     HTMLFormElement* form() const { return m_form; }
52     ValidityState* validity();
53
54     virtual bool isFormControlElement() const = 0;
55     virtual bool isFormControlElementWithState() const;
56     virtual bool isEnumeratable() const = 0;
57
58     // Returns the 'name' attribute value. If this element has no name
59     // attribute, it returns an empty string instead of null string.
60     // Note that the 'name' IDL attribute doesn't use this function.
61     virtual const AtomicString& name() const;
62
63     // Override in derived classes to get the encoded name=value pair for submitting.
64     // Return true for a successful control (see HTML4-17.13.2).
65     virtual bool appendFormData(FormDataList&, bool) { return false; }
66
67     void formWillBeDestroyed();
68
69     void resetFormOwner();
70
71     void formRemovedFromTree(const Node* formRoot);
72
73     // ValidityState attribute implementations
74     bool customError() const;
75
76     // Override functions for patterMismatch, rangeOverflow, rangerUnderflow,
77     // stepMismatch, tooLong and valueMissing must call willValidate method.
78     virtual bool hasBadInput() const;
79     virtual bool patternMismatch() const;
80     virtual bool rangeOverflow() const;
81     virtual bool rangeUnderflow() const;
82     virtual bool stepMismatch() const;
83     virtual bool tooLong() const;
84     virtual bool typeMismatch() const;
85     virtual bool valueMissing() const;
86     virtual String validationMessage() const;
87     bool valid() const;
88     virtual void setCustomValidity(const String&);
89
90     void formAttributeTargetChanged();
91
92 protected:
93     FormAssociatedElement();
94
95     void insertedInto(ContainerNode&);
96     void removedFrom(ContainerNode&);
97     void didMoveToNewDocument(Document* oldDocument);
98
99     void setForm(HTMLFormElement*);
100     void formAttributeChanged();
101
102     // If you add an override of willChangeForm() or didChangeForm() to a class
103     // derived from this one, you will need to add a call to setForm(0) to the
104     // destructor of that class.
105     virtual void willChangeForm();
106     virtual void didChangeForm();
107
108     String customValidationMessage() const;
109
110 private:
111     virtual void refFormAssociatedElement() = 0;
112     virtual void derefFormAssociatedElement() = 0;
113
114     void resetFormAttributeTargetObserver();
115
116     virtual bool isFormAssociatedElement() OVERRIDE FINAL { return true; }
117
118     OwnPtr<FormAttributeTargetObserver> m_formAttributeTargetObserver;
119     HTMLFormElement* m_form;
120     OwnPtr<ValidityState> m_validityState;
121     String m_customValidationMessage;
122 };
123
124 inline const HTMLElement* toHTMLElement(const FormAssociatedElement* associatedElement)
125 {
126     return const_cast<FormAssociatedElement*>(associatedElement)->asHTMLElement();
127 }
128
129 inline HTMLElement* toHTMLElement(FormAssociatedElement* associatedElement)
130 {
131     return associatedElement->asHTMLElement();
132 }
133
134 } // namespace
135
136 #endif // FormAssociatedElement_h