summaryrefslogtreecommitdiff
path: root/Source/WebCore/html/CollectionTraversal.h
blob: 5c71ac75325cc2773a60395b08e1d5f45b8ead9e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
/*
 * Copyright (C) 2015 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef CollectionTraversal_h
#define CollectionTraversal_h

#include "CollectionType.h"
#include "ElementChildIterator.h"
#include "ElementDescendantIterator.h"

namespace WebCore {

template <CollectionTraversalType traversalType>
struct CollectionTraversal { };

template <>
struct CollectionTraversal<CollectionTraversalType::Descendants> {
    using Iterator = ElementDescendantIterator;

    static ElementDescendantIterator end(ContainerNode&) { return ElementDescendantIterator(); }

    template <typename CollectionClass>
    static ElementDescendantIterator begin(const CollectionClass&, ContainerNode& rootNode);

    template <typename CollectionClass>
    static ElementDescendantIterator last(const CollectionClass&, ContainerNode& rootNode);

    template <typename CollectionClass>
    static void traverseForward(const CollectionClass&, ElementDescendantIterator& current, unsigned count, unsigned& traversedCount);

    template <typename CollectionClass>
    static void traverseBackward(const CollectionClass&, ElementDescendantIterator& current, unsigned count);
};

template <typename CollectionClass>
inline ElementDescendantIterator CollectionTraversal<CollectionTraversalType::Descendants>::begin(const CollectionClass& collection, ContainerNode& rootNode)
{
    auto descendants = elementDescendants(rootNode);
    auto end = descendants.end();
    for (auto it = descendants.begin(); it != end; ++it) {
        if (collection.elementMatches(*it)) {
            // Drop iterator assertions because HTMLCollections / NodeList use a fine-grained invalidation scheme.
            it.dropAssertions();
            return it;
        }
    }
    return end;
}

template <typename CollectionClass>
inline ElementDescendantIterator CollectionTraversal<CollectionTraversalType::Descendants>::last(const CollectionClass& collection, ContainerNode& rootNode)
{
    auto descendants = elementDescendants(rootNode);
    ElementDescendantIterator invalid;
    for (auto it = descendants.last(); it != invalid; --it) {
        if (collection.elementMatches(*it)) {
            // Drop iterator assertions because HTMLCollections / NodeList use a fine-grained invalidation scheme.
            it.dropAssertions();
            return it;
        }
    }
    return invalid;
}

template <typename CollectionClass>
inline void CollectionTraversal<CollectionTraversalType::Descendants>::traverseForward(const CollectionClass& collection, ElementDescendantIterator& current, unsigned count, unsigned& traversedCount)
{
    ASSERT(collection.elementMatches(*current));
    ElementDescendantIterator invalid;
    for (traversedCount = 0; traversedCount < count; ++traversedCount) {
        do {
            ++current;
            if (current == invalid)
                return;
        } while (!collection.elementMatches(*current));
    }
}

template <typename CollectionClass>
inline void CollectionTraversal<CollectionTraversalType::Descendants>::traverseBackward(const CollectionClass& collection, ElementDescendantIterator& current, unsigned count)
{
    ASSERT(collection.elementMatches(*current));
    ElementDescendantIterator invalid;
    for (; count; --count) {
        do {
            --current;
            if (current == invalid)
                return;
        } while (!collection.elementMatches(*current));
    }
}

template <>
struct CollectionTraversal<CollectionTraversalType::ChildrenOnly> {
    using Iterator = ElementChildIterator<Element>;

    static ElementChildIterator<Element> end(ContainerNode& rootNode) { return ElementChildIterator<Element>(rootNode); }

    template <typename CollectionClass>
    static ElementChildIterator<Element> begin(const CollectionClass&, ContainerNode& rootNode);

    template <typename CollectionClass>
    static ElementChildIterator<Element> last(const CollectionClass&, ContainerNode& rootNode);

    template <typename CollectionClass>
    static void traverseForward(const CollectionClass&, ElementChildIterator<Element>& current, unsigned count, unsigned& traversedCount);

    template <typename CollectionClass>
    static void traverseBackward(const CollectionClass&, ElementChildIterator<Element>& current, unsigned count);
};

template <typename CollectionClass>
inline ElementChildIterator<Element> CollectionTraversal<CollectionTraversalType::ChildrenOnly>::begin(const CollectionClass& collection, ContainerNode& rootNode)
{
    auto children = childrenOfType<Element>(rootNode);
    auto end = children.end();
    for (auto it = children.begin(); it != end; ++it) {
        if (collection.elementMatches(*it)) {
            // Drop iterator assertions because HTMLCollections / NodeList use a fine-grained invalidation scheme.
            it.dropAssertions();
            return it;
        }
    }
    return end;
}

template <typename CollectionClass>
inline ElementChildIterator<Element> CollectionTraversal<CollectionTraversalType::ChildrenOnly>::last(const CollectionClass& collection, ContainerNode& rootNode)
{
    auto children = childrenOfType<Element>(rootNode);
    ElementChildIterator<Element> invalid(collection.rootNode());
    ElementChildIterator<Element> last(rootNode, children.last());
    for (auto it = last; it != invalid; --it) {
        if (collection.elementMatches(*it)) {
            // Drop iterator assertions because HTMLCollections / NodeList use a fine-grained invalidation scheme.
            it.dropAssertions();
            return it;
        }
    }
    return invalid;
}

template <typename CollectionClass>
inline void CollectionTraversal<CollectionTraversalType::ChildrenOnly>::traverseForward(const CollectionClass& collection, ElementChildIterator<Element>& current, unsigned count, unsigned& traversedCount)
{
    ASSERT(collection.elementMatches(*current));
    ElementChildIterator<Element> invalid(collection.rootNode());
    for (traversedCount = 0; traversedCount < count; ++traversedCount) {
        do {
            ++current;
            if (current == invalid)
                return;
        } while (!collection.elementMatches(*current));
    }
}

template <typename CollectionClass>
inline void CollectionTraversal<CollectionTraversalType::ChildrenOnly>::traverseBackward(const CollectionClass& collection, ElementChildIterator<Element>& current, unsigned count)
{
    ASSERT(collection.elementMatches(*current));
    ElementChildIterator<Element> invalid(collection.rootNode());
    for (; count; --count) {
        do {
            --current;
            if (current == invalid)
                return;
        } while (!collection.elementMatches(*current));
    }
}

template <>
struct CollectionTraversal<CollectionTraversalType::CustomForwardOnly> {
    using Iterator = Element*;

    static Element* end(ContainerNode&) { return nullptr; }

    template <typename CollectionClass>
    static Element* begin(const CollectionClass&, ContainerNode&);

    template <typename CollectionClass>
    static Element* last(const CollectionClass&, ContainerNode&);

    template <typename CollectionClass>
    static void traverseForward(const CollectionClass&, Element*& current, unsigned count, unsigned& traversedCount);

    template <typename CollectionClass>
    static void traverseBackward(const CollectionClass&, Element*&, unsigned count);
};

template <typename CollectionClass>
inline Element* CollectionTraversal<CollectionTraversalType::CustomForwardOnly>::begin(const CollectionClass& collection, ContainerNode&)
{
    return collection.customElementAfter(nullptr);
}

template <typename CollectionClass>
inline Element* CollectionTraversal<CollectionTraversalType::CustomForwardOnly>::last(const CollectionClass&, ContainerNode&)
{
    ASSERT_NOT_REACHED();
    return nullptr;
}

template <typename CollectionClass>
inline void CollectionTraversal<CollectionTraversalType::CustomForwardOnly>::traverseForward(const CollectionClass& collection, Element*& current, unsigned count, unsigned& traversedCount)
{
    Element* element = current;
    for (traversedCount = 0; traversedCount < count; ++traversedCount) {
        element = collection.customElementAfter(element);
        if (!element) {
            current = nullptr;
            return;
        }
    }
    current = element;
}

template <typename CollectionClass>
inline void CollectionTraversal<CollectionTraversalType::CustomForwardOnly>::traverseBackward(const CollectionClass&, Element*&, unsigned count)
{
    UNUSED_PARAM(count);
    ASSERT_NOT_REACHED();
}

} // namespace WebCore

#endif // CollectionTraversal_h