ladybird/Userland/Libraries/LibWeb/DOM/HTMLCollection.h
Timothy Flynn 5133491714 LibWeb: Expose HTMLCollection's root element to its subclasses
For example, HTMLOptionsCollection will need to access its root
HTMLSelectElement.
2022-03-22 02:08:15 +01:00

70 lines
1.9 KiB
C++

/*
* Copyright (c) 2021, Andreas Kling <kling@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/FlyString.h>
#include <AK/Function.h>
#include <AK/Noncopyable.h>
#include <LibWeb/Bindings/Wrappable.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 RefCounted<HTMLCollection>
, public Bindings::Wrappable {
AK_MAKE_NONCOPYABLE(HTMLCollection);
AK_MAKE_NONMOVABLE(HTMLCollection);
public:
using WrapperType = Bindings::HTMLCollectionWrapper;
static NonnullRefPtr<HTMLCollection> create(ParentNode& root, Function<bool(Element const&)> filter)
{
return adopt_ref(*new HTMLCollection(root, move(filter)));
}
~HTMLCollection();
size_t length();
Element* item(size_t index) const;
Element* named_item(FlyString const& name) const;
Vector<NonnullRefPtr<Element>> collect_matching_elements() const;
Vector<String> supported_property_names() const;
bool is_supported_property_index(u32) const;
protected:
HTMLCollection(ParentNode& root, Function<bool(Element const&)> filter);
NonnullRefPtr<ParentNode> root() { return m_root; }
private:
NonnullRefPtr<ParentNode> m_root;
Function<bool(Element const&)> m_filter;
};
}
namespace Web::Bindings {
HTMLCollectionWrapper* wrap(JS::GlobalObject&, DOM::HTMLCollection&);
}