81 lines
3.3 KiB
C++
81 lines
3.3 KiB
C++
/*
|
|
* Copyright (c) 2021-2022, Andreas Kling <kling@serenityos.org>
|
|
* Copyright (c) 2023, Luke Wilde <lukew@serenityos.org>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/DeprecatedFlyString.h>
|
|
#include <AK/Function.h>
|
|
#include <LibJS/Heap/GCPtr.h>
|
|
#include <LibWeb/Bindings/LegacyPlatformObject.h>
|
|
#include <LibWeb/Forward.h>
|
|
|
|
namespace Web::DOM {
|
|
|
|
// NOTE: HTMLCollection is in the DOM namespace because it's part of the DOM specification.
|
|
|
|
// This class implements a live, filtered view of a DOM subtree.
|
|
// When constructing an HTMLCollection, you provide a root node + a filter.
|
|
// The filter is a simple Function object that answers the question
|
|
// "is this Element part of the collection?"
|
|
|
|
// FIXME: HTMLCollection currently does no caching. It will re-filter on every access!
|
|
// We should teach it how to cache results. The main challenge is invalidating
|
|
// these caches, since this needs to happen on various kinds of DOM mutation.
|
|
|
|
class HTMLCollection : public Bindings::LegacyPlatformObject {
|
|
WEB_PLATFORM_OBJECT(HTMLCollection, Bindings::LegacyPlatformObject);
|
|
|
|
public:
|
|
enum class Scope {
|
|
Children,
|
|
Descendants,
|
|
};
|
|
[[nodiscard]] static JS::NonnullGCPtr<HTMLCollection> create(ParentNode& root, Scope, Function<bool(Element const&)> filter);
|
|
|
|
virtual ~HTMLCollection() override;
|
|
|
|
size_t length() const;
|
|
Element* item(size_t index) const;
|
|
Element* named_item(FlyString const& name) const;
|
|
|
|
JS::MarkedVector<Element*> collect_matching_elements() const;
|
|
|
|
virtual WebIDL::ExceptionOr<JS::Value> item_value(size_t index) const override;
|
|
virtual WebIDL::ExceptionOr<JS::Value> named_item_value(DeprecatedFlyString const& name) const override;
|
|
virtual Vector<DeprecatedString> supported_property_names() const override;
|
|
virtual bool is_supported_property_index(u32) const override;
|
|
|
|
protected:
|
|
HTMLCollection(ParentNode& root, Scope, Function<bool(Element const&)> filter);
|
|
|
|
virtual void initialize(JS::Realm&) override;
|
|
|
|
JS::NonnullGCPtr<ParentNode> root() { return *m_root; }
|
|
|
|
private:
|
|
virtual void visit_edges(Cell::Visitor&) override;
|
|
|
|
// ^Bindings::LegacyPlatformObject
|
|
virtual bool supports_indexed_properties() const override { return true; }
|
|
virtual bool supports_named_properties() const override { return true; }
|
|
virtual bool has_indexed_property_setter() const override { return false; }
|
|
virtual bool has_named_property_setter() const override { return false; }
|
|
virtual bool has_named_property_deleter() const override { return false; }
|
|
virtual bool has_legacy_override_built_ins_interface_extended_attribute() const override { return false; }
|
|
virtual bool has_legacy_unenumerable_named_properties_interface_extended_attribute() const override { return true; }
|
|
virtual bool has_global_interface_extended_attribute() const override { return false; }
|
|
virtual bool indexed_property_setter_has_identifier() const override { return false; }
|
|
virtual bool named_property_setter_has_identifier() const override { return false; }
|
|
virtual bool named_property_deleter_has_identifier() const override { return false; }
|
|
|
|
JS::NonnullGCPtr<ParentNode> m_root;
|
|
Function<bool(Element const&)> m_filter;
|
|
|
|
Scope m_scope { Scope::Descendants };
|
|
};
|
|
|
|
}
|