2010-07-07 Eric Seidel <eric@webkit.org>
[WebKit-https.git] / WebCore / html / HTMLFormattingElementList.h
1 /*
2  * Copyright (C) 2010 Google, Inc. All Rights Reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY GOOGLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL GOOGLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef HTMLFormattingElementList_h
27 #define HTMLFormattingElementList_h
28
29 #include <wtf/Forward.h>
30 #include <wtf/RefPtr.h>
31 #include <wtf/Vector.h>
32
33 namespace WebCore {
34
35 class AtomicString;
36 class Element;
37
38 // This may end up merged into HTMLElementStack.
39 class HTMLFormattingElementList : public Noncopyable {
40 public:
41     HTMLFormattingElementList();
42     ~HTMLFormattingElementList();
43
44     // Ideally Entry would be private, but HTMLTreeBuilder has to coordinate
45     // between the HTMLFormattingElementList and HTMLElementStack and needs
46     // access to Entry::isMarker() and Entry::replaceElement() to do so.
47     class Entry {
48     public:
49         // Inline because they're hot and Vector<T> uses them.
50         Entry(Element* element)
51             : m_element(element)
52         {
53             ASSERT(element);
54         }
55         enum MarkerEntryType { MarkerEntry };
56         Entry(MarkerEntryType)
57             : m_element(0)
58         {
59         }
60         ~Entry() {}
61
62         bool isMarker() const { return !m_element; }
63
64         Element* element() const
65         {
66             // The fact that !m_element == isMarker() is an implementation detail
67             // callers should check isMarker() before calling element().
68             ASSERT(m_element);
69             return m_element.get();
70         }
71         void replaceElement(PassRefPtr<Element> element) { m_element = element; }
72
73         // Needed for use with Vector.  These are super-hot and must be inline.
74         bool operator==(const Entry& other) const { return m_element == other.m_element; }
75         bool operator!=(const Entry& other) const { return m_element != other.m_element; }
76
77     private:
78         RefPtr<Element> m_element;
79     };
80
81     class Bookmark {
82     public:
83         Bookmark(Element* before, Element* after)
84             : m_before(before)
85             , m_after(after)
86         {
87         }
88
89         void moveToAfter(Element* before)
90         {
91             m_before = before;
92             m_after = 0;
93         }
94
95         Element* elementBefore() const { return m_before; }
96         Element* elementAfter() const { return m_after; }
97
98     private:
99         Element* m_before;
100         Element* m_after;
101     };
102
103     bool isEmpty() const { return !size(); }
104     size_t size() const { return m_entries.size(); }
105
106     Element* closestElementInScopeWithName(const AtomicString&);
107
108     Entry* find(Element*);
109     bool contains(Element*);
110     void append(Element*);
111     void remove(Element*);
112
113     Bookmark bookmarkFor(Element*);
114     void insertAt(Element*, const Bookmark&);
115
116     void appendMarker();
117     void clearToLastMarker();
118
119     const Entry& at(size_t i) const { return m_entries[i]; }
120     Entry& at(size_t i) { return m_entries[i]; }
121
122 #ifndef NDEBUG
123     void show();
124 #endif
125
126 private:
127     Vector<Entry> m_entries;
128 };
129
130 }
131
132 #endif // HTMLFormattingElementList_h