1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-05-16 15:34:58 +00:00
serenity/Userland/Libraries/LibWeb/DOM/TreeWalker.h
2022-09-06 00:27:09 +02:00

80 lines
2.2 KiB
C++

/*
* Copyright (c) 2022, Andreas Kling <kling@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <LibWeb/DOM/NodeFilter.h>
namespace Web::DOM {
// https://dom.spec.whatwg.org/#treewalker
class TreeWalker final : public Bindings::PlatformObject {
JS_OBJECT(TreeWalker, JS::Object);
public:
static JS::NonnullGCPtr<TreeWalker> create(Node& root, unsigned what_to_show, JS::GCPtr<NodeFilter>);
explicit TreeWalker(Node& root);
virtual ~TreeWalker() override;
TreeWalker& impl() { return *this; }
NonnullRefPtr<Node> current_node() const;
void set_current_node(Node&);
JS::ThrowCompletionOr<RefPtr<Node>> parent_node();
JS::ThrowCompletionOr<RefPtr<Node>> first_child();
JS::ThrowCompletionOr<RefPtr<Node>> last_child();
JS::ThrowCompletionOr<RefPtr<Node>> previous_sibling();
JS::ThrowCompletionOr<RefPtr<Node>> next_sibling();
JS::ThrowCompletionOr<RefPtr<Node>> previous_node();
JS::ThrowCompletionOr<RefPtr<Node>> next_node();
NonnullRefPtr<Node> root() { return m_root; }
NodeFilter* filter() { return m_filter.ptr(); }
unsigned what_to_show() const { return m_what_to_show; }
private:
virtual void visit_edges(Cell::Visitor&) override;
enum class ChildTraversalType {
First,
Last,
};
JS::ThrowCompletionOr<RefPtr<Node>> traverse_children(ChildTraversalType);
enum class SiblingTraversalType {
Next,
Previous,
};
JS::ThrowCompletionOr<RefPtr<Node>> traverse_siblings(SiblingTraversalType);
JS::ThrowCompletionOr<NodeFilter::Result> filter(Node&);
// https://dom.spec.whatwg.org/#concept-traversal-root
NonnullRefPtr<DOM::Node> m_root;
// https://dom.spec.whatwg.org/#treewalker-current
NonnullRefPtr<DOM::Node> m_current;
// https://dom.spec.whatwg.org/#concept-traversal-whattoshow
unsigned m_what_to_show { 0 };
// https://dom.spec.whatwg.org/#concept-traversal-filter
JS::GCPtr<DOM::NodeFilter> m_filter;
// https://dom.spec.whatwg.org/#concept-traversal-active
bool m_active { false };
};
}
namespace Web::Bindings {
inline JS::Object* wrap(JS::Realm&, Web::DOM::TreeWalker& object) { return &object; }
using TreeWalkerWrapper = Web::DOM::TreeWalker;
}