Factor descendant iterator assertions into a class.
[WebKit-https.git] / Source / WebCore / dom / ChildIterator.h
1 /*
2  * Copyright (C) 2013 Apple 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 APPLE 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 APPLE 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 ChildIterator_h
27 #define ChildIterator_h
28
29 #include "ElementTraversal.h"
30
31 #if !ASSERT_DISABLED
32 #include "DescendantIteratorAssertions.h"
33 #endif
34
35 namespace WebCore {
36
37 template <typename ElementType>
38 class ChildIterator {
39 public:
40     ChildIterator();
41     ChildIterator(ElementType* current);
42     ChildIterator& operator++();
43     ElementType& operator*();
44     ElementType* operator->();
45     bool operator!=(const ChildIterator& other) const;
46
47 private:
48     ElementType* m_current;
49
50 #if !ASSERT_DISABLED
51     DescendantIteratorAssertions m_assertions;
52 #endif
53 };
54
55 template <typename ElementType>
56 class ChildIteratorAdapter {
57 public:
58     ChildIteratorAdapter(ContainerNode* root);
59     ChildIterator<ElementType> begin();
60     ChildIterator<ElementType> end();
61
62 private:
63     const ContainerNode* m_root;
64 };
65
66 ChildIteratorAdapter<Element> elementChildren(ContainerNode* root);
67 template <typename ElementType> ChildIteratorAdapter<ElementType> childrenOfType(ContainerNode* root);
68
69 template <typename ElementType>
70 inline ChildIterator<ElementType>::ChildIterator()
71     : m_current(nullptr)
72 {
73 }
74
75 template <typename ElementType>
76 inline ChildIterator<ElementType>::ChildIterator(ElementType* current)
77     : m_current(current)
78 #if !ASSERT_DISABLED
79     , m_assertions(current)
80 #endif
81 {
82 }
83
84 template <typename ElementType>
85 inline ChildIterator<ElementType>& ChildIterator<ElementType>::operator++()
86 {
87     ASSERT(m_current);
88     ASSERT(!m_assertions.domTreeHasMutated());
89     m_current = Traversal<ElementType>::nextSibling(m_current);
90 #if !ASSERT_DISABLED
91     // Drop the assertion when the iterator reaches the end.
92     if (!m_current)
93         m_assertions.dropEventDispatchAssertion();
94 #endif
95     return *this;
96 }
97
98 template <typename ElementType>
99 inline ElementType& ChildIterator<ElementType>::operator*()
100 {
101     ASSERT(m_current);
102     ASSERT(!m_assertions.domTreeHasMutated());
103     return *m_current;
104 }
105
106 template <typename ElementType>
107 inline ElementType* ChildIterator<ElementType>::operator->()
108 {
109     ASSERT(m_current);
110     ASSERT(!m_assertions.domTreeHasMutated());
111     return m_current;
112 }
113
114 template <typename ElementType>
115 inline bool ChildIterator<ElementType>::operator!=(const ChildIterator& other) const
116 {
117     ASSERT(!m_assertions.domTreeHasMutated());
118     return m_current != other.m_current;
119 }
120
121 template <typename ElementType>
122 inline ChildIteratorAdapter<ElementType>::ChildIteratorAdapter(ContainerNode* root)
123     : m_root(root)
124 {
125 }
126
127 template <typename ElementType>
128 inline ChildIterator<ElementType> ChildIteratorAdapter<ElementType>::begin()
129 {
130     return ChildIterator<ElementType>(Traversal<ElementType>::firstChild(m_root));
131 }
132
133 template <typename ElementType>
134 inline ChildIterator<ElementType> ChildIteratorAdapter<ElementType>::end()
135 {
136     return ChildIterator<ElementType>();
137 }
138
139 inline ChildIteratorAdapter<Element> elementChildren(ContainerNode* root)
140 {
141     return ChildIteratorAdapter<Element>(root);
142 }
143
144 template <typename ElementType>
145 inline ChildIteratorAdapter<ElementType> childrenOfType(ContainerNode* root)
146 {
147     return ChildIteratorAdapter<ElementType>(root);
148 }
149
150 }
151
152 #endif