RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-26 07:27:45 +00:00
Code Issues Activity Actions

LibWeb: Add support for DOM's TreeWalker

Browse source 
This patch adds TreeWalker (created via Document.createTreeWalker())
which allows you to traverse a filtered view of the DOM in all
directions.
This commit is contained in:
Andreas Kling 2022-03-09 14:37:48 +01:00
parent fabcee016f
commit acbdb95b0a
9 changed files with 487 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

75
Userland/Libraries/LibWeb/DOM/TreeWalker.h Normal file
View file

@ -0,0 +1,75 @@
/*
* Copyright (c) 2022, Andreas Kling <kling@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/RefCounted.h>
#include <LibWeb/Bindings/Wrappable.h>
#include <LibWeb/DOM/NodeFilter.h>
namespace Web::DOM {
// https://dom.spec.whatwg.org/#treewalker
class TreeWalker
: public RefCounted<TreeWalker>
, public Bindings::Wrappable {
public:
using WrapperType = Bindings::TreeWalkerWrapper;
static NonnullRefPtr<TreeWalker> create(Node& root, unsigned what_to_show, RefPtr<NodeFilter>);
virtual ~TreeWalker() override;
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; }
unsigned what_to_show() const { return m_what_to_show; }
private:
TreeWalker(Node& root);
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
RefPtr<DOM::NodeFilter> m_filter;
// https://dom.spec.whatwg.org/#concept-traversal-active
bool m_active { false };
};
}