XPathNodeSet.h revision ab9e7a118cf1ea2e3a93dce683b2ded3e7291ddb 
1/*
2 * Copyright (C) 2007 Alexey Proskuryakov <ap@webkit.org>
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 COMPUTER, 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 COMPUTER, 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 XPathNodeSet_h
27#define XPathNodeSet_h
28
29#if ENABLE(XPATH)
30
31#include <wtf/Vector.h>
32#include <wtf/Forward.h>
33
34#include "Node.h"
35
36namespace WebCore {
37
38    namespace XPath {
39
40        class NodeSet {
41            WTF_MAKE_FAST_ALLOCATED;
42        public:
43            NodeSet() : m_isSorted(true), m_subtreesAreDisjoint(false) { }
44
45            size_t size() const { return m_nodes.size(); }
46            bool isEmpty() const { return !m_nodes.size(); }
47            Node* operator[](unsigned i) const { return m_nodes.at(i).get(); }
48            void reserveCapacity(size_t newCapacity) { m_nodes.reserveCapacity(newCapacity); }
49            void clear() { m_nodes.clear(); }
50            void swap(NodeSet& other) { std::swap(m_isSorted, other.m_isSorted); std::swap(m_subtreesAreDisjoint, other.m_subtreesAreDisjoint); m_nodes.swap(other.m_nodes); }
51
52            // NodeSet itself does not verify that nodes in it are unique.
53            void append(Node* node) { m_nodes.append(node); }
54            void append(PassRefPtr<Node> node) { m_nodes.append(node); }
55            void append(const NodeSet& nodeSet) { m_nodes.append(nodeSet.m_nodes); }
56
57            // Returns the set's first node in document order, or 0 if the set is empty.
58            Node* firstNode() const;
59
60            // Returns 0 if the set is empty.
61            Node* anyNode() const;
62
63            // NodeSet itself doesn't check if it contains nodes in document order - the caller should tell it if it does not.
64            void markSorted(bool isSorted) { m_isSorted = isSorted; }
65            bool isSorted() const { return m_isSorted || m_nodes.size() < 2; }
66
67            void sort() const;
68
69            // No node in the set is ancestor of another. Unlike m_isSorted, this is assumed to be false, unless the caller sets it to true.
70            void markSubtreesDisjoint(bool disjoint) { m_subtreesAreDisjoint = disjoint; }
71            bool subtreesAreDisjoint() const { return m_subtreesAreDisjoint || m_nodes.size() < 2; }
72
73            void reverse();
74
75        private:
76            bool m_isSorted;
77            bool m_subtreesAreDisjoint;
78            Vector<RefPtr<Node> > m_nodes;
79        };
80
81    }
82}
83
84#endif // ENABLE(XPATH)
85#endif // XPathNodeSet_h
86