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-2019 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#pragma once
26
27#include "ExceptionOr.h"
28#include "NodeFilter.h"
29#include "ScriptWrappable.h"
30#include "Traversal.h"
31#include <wtf/IsoMalloc.h>
32#include <wtf/RefCounted.h>
33
34namespace WebCore {
35
36class TreeWalker final : public ScriptWrappable, public RefCounted<TreeWalker>, public NodeIteratorBase {
37 WTF_MAKE_ISO_ALLOCATED_EXPORT(TreeWalker, WEBCORE_EXPORT);
38public:
39 static Ref<TreeWalker> create(Node& rootNode, unsigned long whatToShow, RefPtr<NodeFilter>&& filter)
40 {
41 return adoptRef(*new TreeWalker(rootNode, whatToShow, WTFMove(filter)));
42 }
43
44 Node& currentNode() { return m_current.get(); }
45 const Node& currentNode() const { return m_current.get(); }
46
47 WEBCORE_EXPORT void setCurrentNode(Node&);
48
49 WEBCORE_EXPORT ExceptionOr<Node*> parentNode();
50 WEBCORE_EXPORT ExceptionOr<Node*> firstChild();
51 WEBCORE_EXPORT ExceptionOr<Node*> lastChild();
52 WEBCORE_EXPORT ExceptionOr<Node*> previousSibling();
53 WEBCORE_EXPORT ExceptionOr<Node*> nextSibling();
54 WEBCORE_EXPORT ExceptionOr<Node*> previousNode();
55 WEBCORE_EXPORT ExceptionOr<Node*> nextNode();
56
57private:
58 TreeWalker(Node&, unsigned long whatToShow, RefPtr<NodeFilter>&&);
59
60 enum class SiblingTraversalType { Previous, Next };
61 template<SiblingTraversalType> ExceptionOr<Node*> traverseSiblings();
62
63 Node* setCurrent(Ref<Node>&&);
64
65 Ref<Node> m_current;
66};
67
68} // namespace WebCore
69