ladybird/Libraries/LibWeb/HTML/Parser/StackOfOpenElements.h

/*
 * Copyright (c) 2020-2022, Andreas Kling <andreas@ladybird.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <LibWeb/DOM/Element.h>
#include <LibWeb/Forward.h>

namespace Web::HTML {

// https://html.spec.whatwg.org/multipage/parsing.html#stack-of-open-elements
class StackOfOpenElements {
public:
    // Initially, the stack of open elements is empty.
    // The stack grows downwards; the topmost node on the stack is the first one added to the stack,
    // and the bottommost node of the stack is the most recently added node in the stack
    // (notwithstanding when the stack is manipulated in a random access fashion as part of the handling for misnested tags).

    StackOfOpenElements() = default;
    ~StackOfOpenElements();

    DOM::Element& first() { return *m_elements.first(); }
    DOM::Element& last() { return *m_elements.last(); }

    bool is_empty() const { return m_elements.is_empty(); }
    void push(GC::Ref<DOM::Element> element) { m_elements.append(element); }
    GC::Ref<DOM::Element> pop() { return *m_elements.take_last(); }
    void remove(DOM::Element const& element);
    void replace(DOM::Element const& to_remove, GC::Ref<DOM::Element> to_add);
    void insert_immediately_below(GC::Ref<DOM::Element> element_to_add, DOM::Element const& target);

    const DOM::Element& current_node() const { return *m_elements.last(); }
    DOM::Element& current_node() { return *m_elements.last(); }

    bool has_in_scope(FlyString const& tag_name) const;
    bool has_in_button_scope(FlyString const& tag_name) const;
    bool has_in_table_scope(FlyString const& tag_name) const;
    bool has_in_list_item_scope(FlyString const& tag_name) const;

    bool has_in_scope(const DOM::Element&) const;

    bool contains(const DOM::Element&) const;
    [[nodiscard]] bool contains_template_element() const;

    auto const& elements() const { return m_elements; }
    auto& elements() { return m_elements; }

    void pop_until_an_element_with_tag_name_has_been_popped(FlyString const& local_name);

    GC::Ptr<DOM::Element> topmost_special_node_below(DOM::Element const&);

    struct LastElementResult {
        GC::Ptr<DOM::Element> element;
        ssize_t index;
    };
    LastElementResult last_element_with_tag_name(FlyString const&);
    GC::Ptr<DOM::Element> element_immediately_above(DOM::Element const&);

    void visit_edges(JS::Cell::Visitor&);

private:
    bool has_in_scope_impl(FlyString const& tag_name, Vector<FlyString> const&) const;
    bool has_in_scope_impl(const DOM::Element& target_node, Vector<FlyString> const&) const;

    Vector<GC::Ref<DOM::Element>> m_elements;
};

}