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 NodeIteratorBase_h
26#define NodeIteratorBase_h
27
28#include "platform/heap/Handle.h"
29#include "wtf/RefPtr.h"
30
31namespace blink {
32
33class ExceptionState;
34class Node;
35class NodeFilter;
36
37class NodeIteratorBase : public WillBeGarbageCollectedMixin {
38    DECLARE_EMPTY_VIRTUAL_DESTRUCTOR_WILL_BE_REMOVED(NodeIteratorBase);
39public:
40    Node* root() const { return m_root.get(); }
41    unsigned whatToShow() const { return m_whatToShow; }
42    NodeFilter* filter() const { return m_filter.get(); }
43    // |expandEntityReferences| first appeared in "DOM Level 2 Traversal and Range". However, this argument was
44    // never implemented, and, in DOM4, the function argument |expandEntityReferences| is removed from
45    // Document.createNodeIterator() and Document.createTreeWalker().
46    bool expandEntityReferences() const { return false; }
47
48    virtual void trace(Visitor*);
49
50protected:
51    NodeIteratorBase(PassRefPtrWillBeRawPtr<Node>, unsigned whatToShow, PassRefPtrWillBeRawPtr<NodeFilter>);
52    short acceptNode(Node*, ExceptionState&) const;
53
54private:
55    RefPtrWillBeMember<Node> m_root;
56    unsigned m_whatToShow;
57    RefPtrWillBeMember<NodeFilter> m_filter;
58};
59
60} // namespace blink
61
62#endif // NodeIteratorBase_h
63