1/*
2 * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3 * Copyright (C) 2000 Frederik Holljen (frederik.holljen@hig.no)
4 * Copyright (C) 2001 Peter Kelly (pmk@post.com)
5 * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
6 * Copyright (C) 2004, 2008 Apple Inc. All rights reserved.
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16 * Library General Public License for more details.
17 *
18 * You should have received a copy of the GNU Library General Public License
19 * along with this library; see the file COPYING.LIB.  If not, write to
20 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 * Boston, MA 02110-1301, USA.
22 *
23 */
24
25#ifndef NodeIterator_h
26#define NodeIterator_h
27
28#include "bindings/core/v8/ScriptWrappable.h"
29#include "core/dom/NodeFilter.h"
30#include "core/dom/NodeIteratorBase.h"
31#include "platform/heap/Handle.h"
32#include "wtf/PassRefPtr.h"
33#include "wtf/RefCounted.h"
34
35namespace blink {
36
37class ExceptionState;
38
39class NodeIterator FINAL : public RefCountedWillBeGarbageCollected<NodeIterator>, public ScriptWrappable, public NodeIteratorBase {
40    DEFINE_WRAPPERTYPEINFO();
41    WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(NodeIterator);
42public:
43    static PassRefPtrWillBeRawPtr<NodeIterator> create(PassRefPtrWillBeRawPtr<Node> rootNode, unsigned whatToShow, PassRefPtrWillBeRawPtr<NodeFilter> filter)
44    {
45        return adoptRefWillBeNoop(new NodeIterator(rootNode, whatToShow, filter));
46    }
47
48#if !ENABLE(OILPAN)
49    ~NodeIterator();
50#endif
51
52    PassRefPtrWillBeRawPtr<Node> nextNode(ExceptionState&);
53    PassRefPtrWillBeRawPtr<Node> previousNode(ExceptionState&);
54    void detach();
55
56    Node* referenceNode() const { return m_referenceNode.node.get(); }
57    bool pointerBeforeReferenceNode() const { return m_referenceNode.isPointerBeforeNode; }
58
59    // This function is called before any node is removed from the document tree.
60    void nodeWillBeRemoved(Node&);
61
62    virtual void trace(Visitor*) OVERRIDE;
63
64private:
65    NodeIterator(PassRefPtrWillBeRawPtr<Node>, unsigned whatToShow, PassRefPtrWillBeRawPtr<NodeFilter>);
66
67    class NodePointer {
68        DISALLOW_ALLOCATION();
69    public:
70        NodePointer();
71        NodePointer(PassRefPtrWillBeRawPtr<Node>, bool);
72
73        void clear();
74        bool moveToNext(Node* root);
75        bool moveToPrevious(Node* root);
76
77        RefPtrWillBeMember<Node> node;
78        bool isPointerBeforeNode;
79
80        void trace(Visitor* visitor)
81        {
82            visitor->trace(node);
83        }
84    };
85
86    void updateForNodeRemoval(Node& nodeToBeRemoved, NodePointer&) const;
87
88    NodePointer m_referenceNode;
89    NodePointer m_candidateNode;
90};
91
92} // namespace blink
93
94#endif // NodeIterator_h
95