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
33namespace WebCore {
34
35class NodeIterator final : public ScriptWrappable, public RefCounted<NodeIterator>, public NodeIteratorBase {
36 WTF_MAKE_ISO_ALLOCATED_EXPORT(NodeIterator, WEBCORE_EXPORT);
37public:
38 static Ref<NodeIterator> create(Node&, unsigned whatToShow, RefPtr<NodeFilter>&&);
39 WEBCORE_EXPORT ~NodeIterator();
40
41 WEBCORE_EXPORT ExceptionOr<RefPtr<Node>> nextNode();
42 WEBCORE_EXPORT ExceptionOr<RefPtr<Node>> previousNode();
43 void detach() { } // This is now a no-op as per the DOM specification.
44
45 Node* referenceNode() const { return m_referenceNode.node.get(); }
46 bool pointerBeforeReferenceNode() const { return m_referenceNode.isPointerBeforeNode; }
47
48 // This function is called before any node is removed from the document tree.
49 void nodeWillBeRemoved(Node&);
50
51private:
52 NodeIterator(Node&, unsigned whatToShow, RefPtr<NodeFilter>&&);
53
54 struct NodePointer {
55 RefPtr<Node> node;
56 bool isPointerBeforeNode { true };
57
58 NodePointer() = default;
59 NodePointer(Node&, bool);
60
61 void clear();
62 bool moveToNext(Node& root);
63 bool moveToPrevious(Node& root);
64 };
65
66 void updateForNodeRemoval(Node& nodeToBeRemoved, NodePointer&) const;
67
68 NodePointer m_referenceNode;
69 NodePointer m_candidateNode;
70};
71
72} // namespace WebCore
73