src/third_party/WebKit/Source/core/xml/XPathNodeSet.h

   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 #include "core/dom/Node.h"
  30 #include "wtf/Forward.h"
  31 #include "wtf/Vector.h"
  32
  33 namespace blink {
  34
  35 namespace XPath {
  36
  37 class NodeSet : public NoBaseWillBeGarbageCollected<NodeSet> {
  38     WTF_MAKE_FAST_ALLOCATED_WILL_BE_REMOVED;
  39 public:
  40     static PassOwnPtrWillBeRawPtr<NodeSet> create() { return adoptPtrWillBeNoop(new NodeSet); }
  41     static PassOwnPtrWillBeRawPtr<NodeSet> create(const NodeSet&);
  42     void trace(Visitor* visitor) { visitor->trace(m_nodes); }
  43
  44     size_t size() const { return m_nodes.size(); }
  45     bool isEmpty() const { return !m_nodes.size(); }
  46     Node* operator[](unsigned i) const { return m_nodes.at(i).get(); }
  47     void reserveCapacity(size_t newCapacity) { m_nodes.reserveCapacity(newCapacity); }
  48     void clear() { m_nodes.clear(); }
  49     void swap(NodeSet& other) { std::swap(m_isSorted, other.m_isSorted); std::swap(m_subtreesAreDisjoint, other.m_subtreesAreDisjoint); m_nodes.swap(other.m_nodes); }
  50
  51     // NodeSet itself does not verify that nodes in it are unique.
  52     void append(PassRefPtrWillBeRawPtr<Node> node) { m_nodes.append(node); }
  53     void append(const NodeSet& nodeSet) { m_nodes.appendVector(nodeSet.m_nodes); }
  54
  55     // Returns the set's first node in document order, or 0 if the set is empty.
  56     Node* firstNode() const;
  57
  58     // Returns 0 if the set is empty.
  59     Node* anyNode() const;
  60
  61     // NodeSet itself doesn't check if it contains nodes in document order - the
  62     // caller should tell it if it does not.
  63     void markSorted(bool isSorted) { m_isSorted = isSorted; }
  64     bool isSorted() const { return m_isSorted || m_nodes.size() < 2; }
  65
  66     void sort() const;
  67
  68     // No node in the set is ancestor of another. Unlike m_isSorted, this is
  69     // 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     NodeSet() : m_isSorted(true), m_subtreesAreDisjoint(false) { }
  77     void traversalSort() const;
  78
  79     bool m_isSorted;
  80     bool m_subtreesAreDisjoint;
  81     WillBeHeapVector<RefPtrWillBeMember<Node> > m_nodes;
  82 };
  83
  84 }
  85
  86 }
  87 #endif // XPathNodeSet_h