ladybird/Libraries/LibWeb/HTML/FormAssociatedElement.cpp

/*
 * Copyright (c) 2021, Andreas Kling <andreas@ladybird.org>
 * Copyright (c) 2024, Jelle Raaijmakers <jelle@ladybird.org>
 * Copyright (c) 2024, Tim Ledbetter <tim.ledbetter@ladybird.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#include <LibUnicode/CharacterTypes.h>
#include <LibUnicode/Segmenter.h>
#include <LibWeb/DOM/Document.h>
#include <LibWeb/DOM/EditingHostManager.h>
#include <LibWeb/DOM/Event.h>
#include <LibWeb/DOM/Position.h>
#include <LibWeb/DOM/SelectionchangeEventDispatching.h>
#include <LibWeb/GraphemeEdgeTracker.h>
#include <LibWeb/HTML/Focus.h>
#include <LibWeb/HTML/FormAssociatedElement.h>
#include <LibWeb/HTML/HTMLButtonElement.h>
#include <LibWeb/HTML/HTMLDataListElement.h>
#include <LibWeb/HTML/HTMLFieldSetElement.h>
#include <LibWeb/HTML/HTMLFormElement.h>
#include <LibWeb/HTML/HTMLInputElement.h>
#include <LibWeb/HTML/HTMLLegendElement.h>
#include <LibWeb/HTML/HTMLSelectElement.h>
#include <LibWeb/HTML/HTMLTextAreaElement.h>
#include <LibWeb/HTML/Parser/HTMLParser.h>
#include <LibWeb/HTML/ValidityState.h>
#include <LibWeb/Infra/Strings.h>
#include <LibWeb/Layout/TextNode.h>
#include <LibWeb/Painting/Paintable.h>
#include <LibWeb/Selection/Selection.h>

namespace Web::HTML {

static SelectionDirection string_to_selection_direction(Optional<String> value)
{
    if (!value.has_value())
        return SelectionDirection::None;
    if (value.value() == "forward"sv)
        return SelectionDirection::Forward;
    if (value.value() == "backward"sv)
        return SelectionDirection::Backward;
    return SelectionDirection::None;
}

void FormAssociatedElement::set_form(HTMLFormElement* form)
{
    if (m_form)
        m_form->remove_associated_element({}, form_associated_element_to_html_element());
    m_form = form;
    if (m_form)
        m_form->add_associated_element({}, form_associated_element_to_html_element());
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#dom-cva-validity
GC::Ref<ValidityState const> FormAssociatedElement::validity() const
{
    auto& realm = form_associated_element_to_html_element().realm();
    return realm.create<ValidityState>(realm, *this);
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#dom-cva-setcustomvalidity
void FormAssociatedElement::set_custom_validity(String& error)
{
    // The setCustomValidity(error) method steps are:

    // 1. Set error to the result of normalizing newlines given error.
    error = Infra::normalize_newlines(error);

    // 2. Set the custom validity error message to error.
    m_custom_validity_error_message = error;
}

bool FormAssociatedElement::enabled() const
{
    // https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#concept-fe-disabled
    auto const& html_element = form_associated_element_to_html_element();

    // A form control is disabled if any of the following are true:
    // - The element is a button, input, select, textarea, or form-associated custom element, and the disabled attribute is specified on this element (regardless of its value); or
    // FIXME: This doesn't check for form-associated custom elements.
    if ((is<HTMLButtonElement>(html_element) || is<HTMLInputElement>(html_element) || is<HTMLSelectElement>(html_element) || is<HTMLTextAreaElement>(html_element)) && html_element.has_attribute(HTML::AttributeNames::disabled))
        return false;

    // - The element is a descendant of a fieldset element whose disabled attribute is specified, and is not a descendant of that fieldset element's first legend element child, if any.
    for (auto* fieldset_ancestor = html_element.first_ancestor_of_type<HTMLFieldSetElement>(); fieldset_ancestor; fieldset_ancestor = fieldset_ancestor->first_ancestor_of_type<HTMLFieldSetElement>()) {
        if (fieldset_ancestor->has_attribute(HTML::AttributeNames::disabled)) {
            auto* first_legend_element_child = fieldset_ancestor->first_child_of_type<HTMLLegendElement>();
            if (!first_legend_element_child || !html_element.is_descendant_of(*first_legend_element_child))
                return false;
        }
    }

    return true;
}

void FormAssociatedElement::set_parser_inserted(Badge<HTMLParser>)
{
    m_parser_inserted = true;
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#association-of-controls-and-forms:nodes-are-inserted
void FormAssociatedElement::form_node_was_inserted()
{
    // 1. If the form-associated element's parser inserted flag is set, then return.
    if (m_parser_inserted)
        return;

    // 2. Reset the form owner of the form-associated element.
    reset_form_owner();
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#association-of-controls-and-forms:nodes-are-removed
void FormAssociatedElement::form_node_was_removed()
{
    // 1. If the form-associated element has a form owner and the form-associated element and its form owner are no longer in the same tree, then reset the form owner of the form-associated element.
    if (m_form && &form_associated_element_to_html_element().root() != &m_form->root())
        reset_form_owner();
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#association-of-controls-and-forms:attr-fae-form-2
void FormAssociatedElement::form_node_was_moved()
{
    // When a listed form-associated element's form attribute is set, changed, or removed, then the user agent must reset the form owner of that element.
    if (m_form && &form_associated_element_to_html_element().root() != &m_form->root())
        reset_form_owner();
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#association-of-controls-and-forms:category-listed-3
void FormAssociatedElement::form_node_attribute_changed(FlyString const& name, Optional<String> const& value)
{
    // When a listed form-associated element's form attribute is set, changed, or removed, then the user agent must
    // reset the form owner of that element.
    if (name == HTML::AttributeNames::form) {
        auto& html_element = form_associated_element_to_html_element();

        if (value.has_value())
            html_element.document().add_form_associated_element_with_form_attribute(*this);
        else
            html_element.document().remove_form_associated_element_with_form_attribute(*this);

        reset_form_owner();
    }
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#association-of-controls-and-forms:category-listed-4
void FormAssociatedElement::element_id_changed(Badge<DOM::Document>)
{
    // When a listed form-associated element has a form attribute and the ID of any of the elements in the tree changes,
    // then the user agent must reset the form owner of that form-associated element.
    VERIFY(form_associated_element_to_html_element().has_attribute(HTML::AttributeNames::form));
    reset_form_owner();
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#association-of-controls-and-forms:category-listed-5
void FormAssociatedElement::element_with_id_was_added_or_removed(Badge<DOM::Document>)
{
    // When a listed form-associated element has a form attribute and an element with an ID is inserted into or removed
    // from the Document, then the user agent must reset the form owner of that form-associated element.
    VERIFY(form_associated_element_to_html_element().has_attribute(HTML::AttributeNames::form));
    reset_form_owner();
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#reset-the-form-owner
void FormAssociatedElement::reset_form_owner()
{
    auto& html_element = form_associated_element_to_html_element();

    // 1. Unset element's parser inserted flag.
    m_parser_inserted = false;

    // 2. If all of the following conditions are true
    //    - element's form owner is not null
    //    - element is not listed or its form content attribute is not present
    //    - element's form owner is its nearest form element ancestor after the change to the ancestor chain
    //    then do nothing, and return.
    if (m_form
        && (!is_listed() || !html_element.has_attribute(HTML::AttributeNames::form))
        && html_element.first_ancestor_of_type<HTMLFormElement>() == m_form.ptr()) {
        return;
    }

    // 3. Set element's form owner to null.
    set_form(nullptr);

    // 4. If element is listed, has a form content attribute, and is connected, then:
    if (is_listed() && html_element.has_attribute(HTML::AttributeNames::form) && html_element.is_connected()) {
        // 1. If the first element in element's tree, in tree order, to have an ID that is identical to element's form content attribute's value, is a form element, then associate the element with that form element.
        auto form_value = html_element.attribute(HTML::AttributeNames::form);
        html_element.root().for_each_in_inclusive_subtree_of_type<HTMLFormElement>([this, &form_value](HTMLFormElement& form_element) {
            if (form_element.id() == form_value) {
                set_form(&form_element);
                return TraversalDecision::Break;
            }

            return TraversalDecision::Continue;
        });
    }

    // 5. Otherwise, if element has an ancestor form element, then associate element with the nearest such ancestor form element.
    else {
        auto* form_ancestor = html_element.first_ancestor_of_type<HTMLFormElement>();
        if (form_ancestor)
            set_form(form_ancestor);
    }
}

// https://w3c.github.io/webdriver/#dfn-clear-algorithm
void FormAssociatedElement::clear_algorithm()
{
    // When the clear algorithm is invoked for an element that does not define its own clear algorithm, its reset
    // algorithm must be invoked instead.
    reset_algorithm();
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#dom-fs-formaction
String FormAssociatedElement::form_action() const
{
    // The formAction IDL attribute must reflect the formaction content attribute, except that on getting, when the content attribute is missing or its value is the empty string,
    // the element's node document's URL must be returned instead.
    auto& html_element = form_associated_element_to_html_element();
    auto form_action_attribute = html_element.attribute(HTML::AttributeNames::formaction);
    if (!form_action_attribute.has_value() || form_action_attribute.value().is_empty()) {
        return html_element.document().url_string();
    }

    auto document_base_url = html_element.document().base_url();
    if (auto maybe_url = document_base_url.complete_url(form_action_attribute.value()); maybe_url.has_value())
        return maybe_url->to_string();
    return {};
}

WebIDL::ExceptionOr<void> FormAssociatedElement::set_form_action(String const& value)
{
    auto& html_element = form_associated_element_to_html_element();
    return html_element.set_attribute(HTML::AttributeNames::formaction, value);
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#dom-cva-reportvalidity
bool FormAssociatedElement::report_validity()
{
    // The reportValidity() method, when invoked, must run the report validity steps on this element.
    return report_validity_steps();
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#dom-cva-checkvalidity
bool FormAssociatedElement::check_validity()
{
    // The checkValidity() method, when invoked, must run the check validity steps on this element.
    return check_validity_steps();
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#dom-cva-willvalidate
bool FormAssociatedElement::will_validate() const
{
    // The willValidate attribute's getter must return true, if this element is a candidate for constraint validation,
    // and false otherwise (i.e., false if any conditions are barring it from constraint validation).
    return is_candidate_for_constraint_validation();
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#check-validity-steps
bool FormAssociatedElement::check_validity_steps()
{
    // 1. If element is a candidate for constraint validation and does not satisfy its constraints
    if (is_candidate_for_constraint_validation() && !satisfies_its_constraints()) {
        auto& element = form_associated_element_to_html_element();
        // 1. Fire an event named invalid at element, with the cancelable attribute initialized to true
        element.dispatch_event(DOM::Event::create(element.realm(), EventNames::invalid, { .cancelable = true }));
        // 2. Return false.
        return false;
    }
    return true;
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#report-validity-steps
bool FormAssociatedElement::report_validity_steps()
{
    // 1. If element is a candidate for constraint validation and does not satisfy its constraints, then:
    if (is_candidate_for_constraint_validation() && !satisfies_its_constraints()) {
        auto& element = form_associated_element_to_html_element();
        // 1. Let report be the result of firing an event named invalid at element, with the cancelable attribute initialized to true.
        auto report = element.dispatch_event(DOM::Event::create(element.realm(), EventNames::invalid, { .cancelable = true }));

        // 2. If report is true, then report the problems with the constraints of this element to the user. When reporting the problem with the constraints to the user,
        //    the user agent may run the focusing steps for element, and may change the scrolling position of the document, or perform some other action that brings
        //    element to the user's attention. User agents may report more than one constraint violation, if element suffers from multiple problems at once.
        // FIXME: Does this align with other browsers?
        if (report && element.check_visibility({})) {
            run_focusing_steps(&element);
            DOM::ScrollIntoViewOptions scroll_options;
            scroll_options.block = Bindings::ScrollLogicalPosition::Nearest;
            scroll_options.inline_ = Bindings::ScrollLogicalPosition::Nearest;
            scroll_options.behavior = Bindings::ScrollBehavior::Instant;
            (void)element.scroll_into_view(scroll_options);
        }

        // 3. Return false.
        return false;
    }

    // 2. Return true.
    return true;
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#candidate-for-constraint-validation
bool FormAssociatedElement::is_candidate_for_constraint_validation() const
{
    // A submittable element is a candidate for constraint validation except when a condition has barred the element from constraint validation.
    if (!is_submittable())
        return false;

    // https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#enabling-and-disabling-form-controls%3A-the-disabled-attribute%3Abarred-from-constraint-validation
    // If an element is disabled, it is barred from constraint validation.
    if (!enabled())
        return false;

    auto const& html_element = form_associated_element_to_html_element();

    // https://html.spec.whatwg.org/multipage/form-elements.html#the-datalist-element%3Abarred-from-constraint-validation
    // If an element has a datalist element ancestor, it is barred from constraint validation.
    if (html_element.first_ancestor_of_type<HTMLDataListElement>())
        return false;

    if (is<HTMLInputElement>(html_element)) {
        auto const& input_element = as<HTMLInputElement>(html_element);

        // https://html.spec.whatwg.org/multipage/input.html#hidden-state-(type%3Dhidden)%3Abarred-from-constraint-validation
        // If an input element's type attribute is in the Hidden state, it is barred from constraint validation.
        if (input_element.type_state() == HTMLInputElement::TypeAttributeState::Hidden)
            return false;

        // https://html.spec.whatwg.org/multipage/input.html#reset-button-state-(type%3Dreset)%3Abarred-from-constraint-validation
        // When an input element's type attribute is in the Reset Button state, the rules in this section apply.
        // The element is barred from constraint validation.
        if (input_element.type_state() == HTMLInputElement::TypeAttributeState::ResetButton)
            return false;

        // https://html.spec.whatwg.org/multipage/input.html#button-state-(type%3Dbutton)%3Abarred-from-constraint-validation
        // When an input element's type attribute is in the Button state, the rules in this section apply.
        // The element is barred from constraint validation.
        if (input_element.type_state() == HTMLInputElement::TypeAttributeState::Button)
            return false;

        // https://html.spec.whatwg.org/multipage/input.html#the-readonly-attribute%3Abarred-from-constraint-validation
        // If the readonly attribute is specified on an input element, the element is barred from constraint validation.
        if (input_element.has_attribute(HTML::AttributeNames::readonly))
            return false;
    }

    if (is<HTMLButtonElement>(html_element)) {
        auto const& button_element = as<HTMLButtonElement>(html_element);

        // https://html.spec.whatwg.org/multipage/form-elements.html#the-button-element%3Abarred-from-constraint-validation
        // If the element is not a submit button, the element is barred from constraint validation.
        if (!button_element.is_submit_button())
            return false;
    }

    if (is<HTMLTextAreaElement>(html_element)) {
        // https://html.spec.whatwg.org/multipage/form-elements.html#the-textarea-element%3Abarred-from-constraint-validation
        // If the readonly attribute is specified on a textarea element, the element is barred from constraint validation.
        if (html_element.has_attribute(HTML::AttributeNames::readonly))
            return false;
    }

    return true;
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#concept-fv-valid
bool FormAssociatedElement::satisfies_its_constraints() const
{
    return !(
        suffering_from_being_missing() || suffering_from_a_type_mismatch() || suffering_from_a_pattern_mismatch() || suffering_from_being_too_long() || suffering_from_being_too_short() || suffering_from_an_underflow() || suffering_from_an_overflow() || suffering_from_a_step_mismatch() || suffering_from_bad_input() || suffering_from_a_custom_error());
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#concept-fs-novalidate
bool FormAssociatedElement::novalidate_state() const
{
    // The no-validate state of an element is true if the element is a submit button ...
    if (!is_submit_button())
        return false;

    // ..., and the element's formnovalidate attribute is present, ...
    auto const& html_element = form_associated_element_to_html_element();
    if (html_element.has_attribute(HTML::AttributeNames::formnovalidate))
        return true;

    // ... or if the element's form owner's novalidate attribute is present, ...
    auto* form = this->form();
    if (form && form->has_attribute(HTML::AttributeNames::novalidate))
        return true;

    // ... and false otherwise.
    return false;
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#limiting-user-input-length%3A-the-maxlength-attribute%3Asuffering-from-being-too-long
bool FormAssociatedElement::suffering_from_being_too_long() const
{
    // FIXME: Implement this.
    return false;
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#setting-minimum-input-length-requirements%3A-the-minlength-attribute%3Asuffering-from-being-too-short
bool FormAssociatedElement::suffering_from_being_too_short() const
{
    // FIXME: Implement this.
    return false;
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#suffering-from-a-custom-error
bool FormAssociatedElement::suffering_from_a_custom_error() const
{
    // When a control's custom validity error message (as set by the element's setCustomValidity() method or ElementInternals's setValidity() method) is not the empty
    // string.
    return !m_custom_validity_error_message.is_empty();
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#concept-textarea/input-relevant-value
void FormAssociatedTextControlElement::relevant_value_was_changed()
{
    auto the_relevant_value = relevant_value();
    auto relevant_value_length = the_relevant_value.length_in_code_units();

    // 1. If the element has a selection:
    if (m_selection_start < m_selection_end) {
        // 1. If the start of the selection is now past the end of the relevant value, set it to
        //    the end of the relevant value.
        if (m_selection_start > relevant_value_length)
            m_selection_start = relevant_value_length;

        // 2. If the end of the selection is now past the end of the relevant value, set it to the
        //    end of the relevant value.
        if (m_selection_end > relevant_value_length)
            m_selection_end = relevant_value_length;

        // 3. If the user agent does not support empty selection, and both the start and end of the
        //    selection are now pointing to the end of the relevant value, then instead set the
        //    element's text entry cursor position to the end of the relevant value, removing any
        //    selection.
        // NOTE: We support empty selections.
        return;
    }

    // 2. Otherwise, the element must have a text entry cursor position position. If it is now past
    //    the end of the relevant value, set it to the end of the relevant value.
    if (m_selection_start > relevant_value_length)
        m_selection_start = relevant_value_length;
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#dom-textarea/input-select
WebIDL::ExceptionOr<void> FormAssociatedTextControlElement::select()
{
    // 1. If this element is an input element, and either select() does not apply to this element
    //    or the corresponding control has no selectable text, return.
    auto& html_element = form_associated_element_to_html_element();
    if (is<HTMLInputElement>(html_element)) {
        auto& input_element = static_cast<HTMLInputElement&>(html_element);
        if (!input_element.select_applies() || !input_element.has_selectable_text())
            return {};
    }

    // 2. Set the selection range with 0 and infinity.
    set_the_selection_range(0, NumericLimits<WebIDL::UnsignedLong>::max());
    return {};
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#dom-textarea/input-selectionstart
Optional<WebIDL::UnsignedLong> FormAssociatedTextControlElement::selection_start_binding() const
{
    // 1. If this element is an input element, and selectionStart does not apply to this element, return null.
    auto const& html_element = form_associated_element_to_html_element();
    if (is<HTMLInputElement>(html_element)) {
        auto const& input_element = static_cast<HTMLInputElement const&>(html_element);
        if (!input_element.selection_or_range_applies())
            return {};
    }

    // 2. If there is no selection, return the code unit offset within the relevant value to the character that
    //    immediately follows the text entry cursor.
    if (m_selection_start == m_selection_end) {
        return m_selection_start;
    }

    // 3. Return the code unit offset within the relevant value to the character that immediately follows the start of
    //    the selection.
    return m_selection_start < m_selection_end ? m_selection_start : m_selection_end;
}

WebIDL::UnsignedLong FormAssociatedTextControlElement::selection_start() const
{
    return m_selection_start < m_selection_end ? m_selection_start : m_selection_end;
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#textFieldSelection:dom-textarea/input-selectionstart-2
WebIDL::ExceptionOr<void> FormAssociatedTextControlElement::set_selection_start_binding(Optional<WebIDL::UnsignedLong> const& value)
{
    // 1. If this element is an input element, and selectionStart does not apply to this element,
    //    throw an "InvalidStateError" DOMException.
    auto& html_element = form_associated_element_to_html_element();
    if (is<HTMLInputElement>(html_element)) {
        auto& input_element = static_cast<HTMLInputElement&>(html_element);
        if (!input_element.selection_or_range_applies())
            return WebIDL::InvalidStateError::create(html_element.realm(), "setSelectionStart does not apply to this input type"_utf16);
    }

    // 2. Let end be the value of this element's selectionEnd attribute.
    auto end = m_selection_end;

    // 3. If end is less than the given value, set end to the given value.
    if (value.has_value() && end < value.value())
        end = value.value();

    // 4. Set the selection range with the given value, end, and the value of this element's
    //    selectionDirection attribute.
    set_the_selection_range(value, end, selection_direction_state());
    return {};
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#dom-textarea/input-selectionend
Optional<WebIDL::UnsignedLong> FormAssociatedTextControlElement::selection_end_binding() const
{
    // 1. If this element is an input element, and selectionEnd does not apply to this element, return
    //    null.
    auto const& html_element = form_associated_element_to_html_element();
    if (is<HTMLInputElement>(html_element)) {
        auto const& input_element = static_cast<HTMLInputElement const&>(html_element);
        if (!input_element.selection_or_range_applies())
            return {};
    }

    // 2. If there is no selection, return the code unit offset within the relevant value to the
    //    character that immediately follows the text entry cursor.
    if (m_selection_start == m_selection_end) {
        return m_selection_start;
    }

    // 3. Return the code unit offset within the relevant value to the character that immediately
    //    follows the end of the selection.
    return m_selection_start < m_selection_end ? m_selection_end : m_selection_start;
}

WebIDL::UnsignedLong FormAssociatedTextControlElement::selection_end() const
{
    return m_selection_start < m_selection_end ? m_selection_end : m_selection_start;
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#textFieldSelection:dom-textarea/input-selectionend-3
WebIDL::ExceptionOr<void> FormAssociatedTextControlElement::set_selection_end_binding(Optional<WebIDL::UnsignedLong> const& value)
{
    // 1. If this element is an input element, and selectionEnd does not apply to this element,
    //    throw an "InvalidStateError" DOMException.
    auto& html_element = form_associated_element_to_html_element();
    if (is<HTMLInputElement>(html_element)) {
        auto& input_element = static_cast<HTMLInputElement&>(html_element);
        if (!input_element.selection_or_range_applies())
            return WebIDL::InvalidStateError::create(html_element.realm(), "setSelectionEnd does not apply to this input type"_utf16);
    }

    // 2. Set the selection range with the value of this element's selectionStart attribute, the
    //    given value, and the value of this element's selectionDirection attribute.
    set_the_selection_range(m_selection_start, value, selection_direction_state());
    return {};
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#selection-direction
Optional<String> FormAssociatedTextControlElement::selection_direction() const
{
    // 1. If this element is an input element, and selectionDirection does not apply to this
    //    element, return null.
    auto const& html_element = form_associated_element_to_html_element();
    if (is<HTMLInputElement>(html_element)) {
        auto const& input_element = static_cast<HTMLInputElement const&>(html_element);
        if (!input_element.selection_or_range_applies())
            return {};
    }

    // 2. Return this element's selection direction.
    switch (m_selection_direction) {
    case SelectionDirection::Forward:
        return "forward"_string;
    case SelectionDirection::Backward:
        return "backward"_string;
    case SelectionDirection::None:
        return "none"_string;
    default:
        VERIFY_NOT_REACHED();
    }
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#set-the-selection-direction
void FormAssociatedTextControlElement::set_selection_direction(Optional<String> direction)
{
    // To set the selection direction of an element to a given direction, update the element's
    // selection direction to the given direction, unless the direction is "none" and the
    // platform does not support that direction; in that case, update the element's selection
    // direction to "forward".
    m_selection_direction = string_to_selection_direction(direction);
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#dom-textarea/input-selectiondirection
WebIDL::ExceptionOr<void> FormAssociatedTextControlElement::set_selection_direction_binding(Optional<String> direction)
{
    // 1. If this element is an input element, and selectionDirection does not apply to this element,
    //    throw an "InvalidStateError" DOMException.
    auto const& html_element = form_associated_element_to_html_element();
    if (is<HTMLInputElement>(html_element)) {
        auto const& input_element = static_cast<HTMLInputElement const&>(html_element);
        if (!input_element.selection_direction_applies())
            return WebIDL::InvalidStateError::create(input_element.realm(), "selectionDirection does not apply to element"_utf16);
    }

    set_the_selection_range(m_selection_start, m_selection_end, string_to_selection_direction(direction));
    return {};
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#dom-textarea/input-setrangetext
WebIDL::ExceptionOr<void> FormAssociatedTextControlElement::set_range_text_binding(Utf16String const& replacement)
{
    return set_range_text_binding(replacement, m_selection_start, m_selection_end);
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#dom-textarea/input-setrangetext
WebIDL::ExceptionOr<void> FormAssociatedTextControlElement::set_range_text_binding(Utf16String const& replacement, WebIDL::UnsignedLong start, WebIDL::UnsignedLong end, Bindings::SelectionMode selection_mode)
{
    auto& html_element = form_associated_element_to_html_element();

    // 1. If this element is an input element, and setRangeText() does not apply to this element,
    //    throw an "InvalidStateError" DOMException.
    if (is<HTMLInputElement>(html_element) && !static_cast<HTMLInputElement&>(html_element).selection_or_range_applies())
        return WebIDL::InvalidStateError::create(html_element.realm(), "setRangeText does not apply to this input type"_utf16);

    return set_range_text(replacement, start, end, selection_mode);
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#dom-textarea/input-setrangetext
WebIDL::ExceptionOr<void> FormAssociatedTextControlElement::set_range_text(Utf16String const& replacement, WebIDL::UnsignedLong start, WebIDL::UnsignedLong end, Bindings::SelectionMode selection_mode)
{
    auto& html_element = form_associated_element_to_html_element();

    // 2. Set this element's dirty value flag to true.
    set_dirty_value_flag(true);

    // 3. If the method has only one argument, then let start and end have the values of the selectionStart attribute and the selectionEnd attribute respectively.
    //    Otherwise, let start, end have the values of the second and third arguments respectively.
    // NOTE: This is handled by the caller.

    // 4. If start is greater than end, then throw an "IndexSizeError" DOMException.
    if (start > end)
        return WebIDL::IndexSizeError::create(html_element.realm(), "The start argument must be less than or equal to the end argument"_utf16);

    // 5. If start is greater than the length of the relevant value of the text control, then set it to the length of the relevant value of the text control.
    auto the_relevant_value = relevant_value();
    auto relevant_value_length = the_relevant_value.length_in_code_units();
    if (start > relevant_value_length)
        start = relevant_value_length;

    // 6. If end is greater than the length of the relevant value of the text control, then set it to the length of the relevant value of the text control.
    if (end > relevant_value_length)
        end = relevant_value_length;

    // 7. Let selection start be the current value of the selectionStart attribute.
    auto selection_start = m_selection_start;

    // 8. Let selection end be the current value of the selectionEnd attribute.
    auto selection_end = m_selection_end;

    // 9. If start is less than end, delete the sequence of code units within the element's relevant value starting with
    //    the code unit at the startth position and ending with the code unit at the (end-1)th position.
    if (start < end) {
        StringBuilder builder(StringBuilder::Mode::UTF16, the_relevant_value.length_in_code_units() - (end - start));
        builder.append(the_relevant_value.substring_view(0, start));
        builder.append(the_relevant_value.substring_view(end));

        the_relevant_value = builder.to_utf16_string();
    }

    // 10. Insert the value of the first argument into the text of the relevant value of the text control, immediately before the startth code unit.
    StringBuilder builder(StringBuilder::Mode::UTF16, the_relevant_value.length_in_code_units() + replacement.length_in_code_units());
    builder.append(the_relevant_value.substring_view(0, start));
    builder.append(replacement);
    builder.append(the_relevant_value.substring_view(start));

    the_relevant_value = builder.to_utf16_string();
    TRY(set_relevant_value(the_relevant_value));

    // 11. Let new length be the length of the value of the first argument.
    auto new_length = replacement.length_in_code_units();

    // 12. Let new end be the sum of start and new length.
    auto new_end = start + new_length;

    // 13. Run the appropriate set of substeps from the following list:
    switch (selection_mode) {
    // If the fourth argument's value is "select"
    case Bindings::SelectionMode::Select:
        // Let selection start be start.
        selection_start = start;

        // Let selection end be new end.
        selection_end = new_end;
        break;

    // If the fourth argument's value is "start"
    case Bindings::SelectionMode::Start:
        // Let selection start and selection end be start.
        selection_start = start;
        selection_end = start;
        break;

    // If the fourth argument's value is "end"
    case Bindings::SelectionMode::End:
        selection_start = new_end;
        selection_end = new_end;
        break;

    // If the fourth argument's value is "preserve"
    case Bindings::SelectionMode::Preserve:
        // 1. Let old length be end minus start.
        auto old_length = end - start;

        // 2. Let delta be new length minus old length.
        auto delta = new_length - old_length;

        // 3. If selection start is greater than end, then increment it by delta.
        //    (If delta is negative, i.e. the new text is shorter than the old text, then this will decrease the value of selection start.)
        //    Otherwise: if selection start is greater than start, then set it to start.
        //    (This snaps the start of the selection to the start of the new text if it was in the middle of the text that it replaced.)
        if (selection_start > end)
            selection_start += delta;
        else if (selection_start > start)
            selection_start = start;

        // 4. If selection end is greater than end, then increment it by delta in the same way.
        //    Otherwise: if selection end is greater than start, then set it to new end.
        //    (This snaps the end of the selection to the end of the new text if it was in the middle of the text that it replaced.)
        if (selection_end > end)
            selection_end += delta;
        else if (selection_end > start)
            selection_end = new_end;
        break;
    }

    // 14. Set the selection range with selection start and selection end.
    set_the_selection_range(selection_start, selection_end);

    return {};
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#dom-textarea/input-setselectionrange
WebIDL::ExceptionOr<void> FormAssociatedTextControlElement::set_selection_range(Optional<WebIDL::UnsignedLong> start, Optional<WebIDL::UnsignedLong> end, Optional<String> direction)
{
    // 1. If this element is an input element, and setSelectionRange() does not apply to this
    //    element, throw an "InvalidStateError" DOMException.
    auto& html_element = form_associated_element_to_html_element();
    if (is<HTMLInputElement>(html_element) && !static_cast<HTMLInputElement&>(html_element).selection_or_range_applies())
        return WebIDL::InvalidStateError::create(html_element.realm(), "setSelectionRange does not apply to this input type"_utf16);

    // 2. Set the selection range with start, end, and direction.
    set_the_selection_range(start, end, string_to_selection_direction(direction));
    return {};
}

// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#set-the-selection-range
void FormAssociatedTextControlElement::set_the_selection_range(Optional<WebIDL::UnsignedLong> start, Optional<WebIDL::UnsignedLong> end, SelectionDirection direction, SelectionSource source)
{
    // 1. If start is null, let start be 0.
    start = start.value_or(0);

    // 2. If end is null, let end be 0.
    end = end.value_or(0);

    // 3. Set the selection of the text control to the sequence of code units within the relevant
    //    value starting with the code unit at the startth position (in logical order) and ending
    //    with the code unit at the (end-1)th position. Arguments greater than the length of the
    //    relevant value of the text control (including the special value infinity) must be treated
    //    as pointing at the end of the text control.
    auto the_relevant_value = relevant_value();
    auto relevant_value_length = the_relevant_value.length_in_code_units();

    auto new_selection_start = AK::min(start.value(), relevant_value_length);
    auto new_selection_end = AK::min(end.value(), relevant_value_length);

    //    If end is less than or equal to start, then the start of the selection and the end of the
    //    selection must both be placed immediately before the character with offset end. In UAs
    //    where there is no concept of an empty selection, this must set the cursor to be just
    //    before the character with offset end.
    new_selection_start = AK::min(new_selection_start, new_selection_end);

    bool was_modified = m_selection_start != new_selection_start || m_selection_end != new_selection_end;
    m_selection_start = new_selection_start;
    m_selection_end = new_selection_end;

    // 4. If direction is not identical to either "backward" or "forward", or if the direction
    //    argument was not given, set direction to "none".
    // NOTE: This is handled by the argument's default value and ::string_to_selection_direction().

    // 5. Set the selection direction of the text control to direction.
    was_modified |= m_selection_direction != direction;
    m_selection_direction = direction;

    // 6. If the previous steps caused the selection of the text control to be modified (in either
    //    extent or direction), then queue an element task on the user interaction task source
    //    given the element to fire an event named select at the element, with the bubbles attribute
    //    initialized to true.
    if (was_modified) {
        auto& html_element = form_associated_element_to_html_element();

        // AD-HOC: We don't fire the event if the user moves the cursor without selecting any text.
        //         This is not in the spec but matches how other browsers behave.
        if (source == SelectionSource::DOM || m_selection_start != m_selection_end) {
            html_element.queue_an_element_task(Task::Source::UserInteraction, [&html_element] {
                auto select_event = DOM::Event::create(html_element.realm(), EventNames::select, { .bubbles = true });
                static_cast<DOM::EventTarget*>(&html_element)->dispatch_event(select_event);
            });
        }

        selection_was_changed();
    }
}

void FormAssociatedTextControlElement::handle_insert(Utf16String const& data)
{
    auto text_node = form_associated_element_to_text_node();
    if (!text_node || !is_mutable())
        return;

    auto data_for_insertion = data;

    if (auto max_length = text_node->max_length(); max_length.has_value()) {
        auto remaining_length = *max_length - text_node->length_in_utf16_code_units();
        if (remaining_length < data.length_in_code_units())
            data_for_insertion = Utf16String::from_utf16(data.substring_view(0, remaining_length));
    }

    auto selection_start = this->selection_start();
    auto selection_end = this->selection_end();
    MUST(set_range_text(data_for_insertion, selection_start, selection_end, Bindings::SelectionMode::End));

    text_node->invalidate_style(DOM::StyleInvalidationReason::EditingInsertion);
    did_edit_text_node();
}

void FormAssociatedTextControlElement::handle_delete(DeleteDirection direction)
{
    auto text_node = form_associated_element_to_text_node();
    if (!text_node || !is_mutable())
        return;

    auto selection_start = this->selection_start();
    auto selection_end = this->selection_end();

    if (selection_start == selection_end) {
        if (direction == DeleteDirection::Backward) {
            if (auto offset = text_node->grapheme_segmenter().previous_boundary(m_selection_end); offset.has_value())
                selection_start = *offset;
        } else {
            if (auto offset = text_node->grapheme_segmenter().next_boundary(m_selection_end); offset.has_value())
                selection_end = *offset;
        }
    }

    MUST(set_range_text({}, selection_start, selection_end, Bindings::SelectionMode::End));
}

EventResult FormAssociatedTextControlElement::handle_return_key(FlyString const&)
{
    auto* input_element = as_if<HTMLInputElement>(form_associated_element_to_html_element());
    if (!input_element)
        return EventResult::Dropped;

    if (auto* form = input_element->form())
        form->implicitly_submit_form().release_value_but_fixme_should_propagate_errors();
    else
        input_element->commit_pending_changes();

    return EventResult::Handled;
}

void FormAssociatedTextControlElement::collapse_selection_to_offset(size_t position)
{
    m_selection_start = position;
    m_selection_end = position;
}

void FormAssociatedTextControlElement::selection_was_changed()
{
    auto& element = form_associated_element_to_html_element();
    if (is<HTML::HTMLInputElement>(element)) {
        schedule_a_selectionchange_event(static_cast<HTML::HTMLInputElement&>(element), element.document());
    } else if (is<HTML::HTMLTextAreaElement>(element)) {
        schedule_a_selectionchange_event(static_cast<HTML::HTMLTextAreaElement&>(element), element.document());
    } else {
        VERIFY_NOT_REACHED();
    }

    auto text_node = form_associated_element_to_text_node();
    if (!text_node)
        return;
    auto* text_paintable = text_node->paintable();
    if (!text_paintable)
        return;
    if (m_selection_start == m_selection_end) {
        text_paintable->set_selection_state(Painting::Paintable::SelectionState::None);
        text_node->document().reset_cursor_blink_cycle();
    } else {
        text_paintable->set_selection_state(Painting::Paintable::SelectionState::StartAndEnd);
    }
    text_paintable->set_needs_display();
}

void FormAssociatedTextControlElement::select_all()
{
    auto text_node = form_associated_element_to_text_node();
    if (!text_node)
        return;
    set_the_selection_range(0, text_node->length());
    selection_was_changed();
}

void FormAssociatedTextControlElement::set_selection_anchor(GC::Ref<DOM::Node> anchor_node, size_t anchor_offset)
{
    auto editing_host_manager = form_associated_element_to_html_element().document().editing_host_manager();
    editing_host_manager->set_selection_anchor(anchor_node, anchor_offset);
    auto text_node = form_associated_element_to_text_node();
    if (!text_node || anchor_node != text_node)
        return;
    collapse_selection_to_offset(anchor_offset);
    selection_was_changed();
}

void FormAssociatedTextControlElement::set_selection_focus(GC::Ref<DOM::Node> focus_node, size_t focus_offset)
{
    auto editing_host_manager = form_associated_element_to_html_element().document().editing_host_manager();
    editing_host_manager->set_selection_focus(focus_node, focus_offset);
    auto text_node = form_associated_element_to_text_node();
    if (!text_node || focus_node != text_node)
        return;
    m_selection_end = focus_offset;
    selection_was_changed();
}

void FormAssociatedTextControlElement::move_cursor_to_start(CollapseSelection collapse)
{
    auto text_node = form_associated_element_to_text_node();
    if (!text_node)
        return;
    if (collapse == CollapseSelection::Yes) {
        collapse_selection_to_offset(0);
    } else {
        m_selection_end = 0;
    }
    selection_was_changed();
}

void FormAssociatedTextControlElement::move_cursor_to_end(CollapseSelection collapse)
{
    auto text_node = form_associated_element_to_text_node();
    if (!text_node)
        return;
    if (collapse == CollapseSelection::Yes) {
        collapse_selection_to_offset(text_node->length());
    } else {
        m_selection_end = text_node->length();
    }
    selection_was_changed();
}

void FormAssociatedTextControlElement::increment_cursor_position_offset(CollapseSelection collapse)
{
    auto const text_node = form_associated_element_to_text_node();
    if (!text_node)
        return;
    if (auto offset = text_node->grapheme_segmenter().next_boundary(m_selection_end); offset.has_value()) {
        if (collapse == CollapseSelection::Yes) {
            collapse_selection_to_offset(*offset);
        } else {
            m_selection_end = *offset;
        }
    }
    selection_was_changed();
}

void FormAssociatedTextControlElement::decrement_cursor_position_offset(CollapseSelection collapse)
{
    auto const text_node = form_associated_element_to_text_node();
    if (!text_node)
        return;
    if (auto offset = text_node->grapheme_segmenter().previous_boundary(m_selection_end); offset.has_value()) {
        if (collapse == CollapseSelection::Yes) {
            collapse_selection_to_offset(*offset);
        } else {
            m_selection_end = *offset;
        }
    }
    selection_was_changed();
}

void FormAssociatedTextControlElement::increment_cursor_position_to_next_word(CollapseSelection collapse)
{
    auto const text_node = form_associated_element_to_text_node();
    if (!text_node)
        return;

    while (true) {
        if (auto offset = text_node->word_segmenter().next_boundary(m_selection_end); offset.has_value()) {
            auto word = text_node->data().substring_view(m_selection_end, *offset - m_selection_end);
            if (collapse == CollapseSelection::Yes) {
                collapse_selection_to_offset(*offset);
            } else {
                m_selection_end = *offset;
            }
            if (Unicode::Segmenter::should_continue_beyond_word(word))
                continue;
        }
        break;
    }

    selection_was_changed();
}

void FormAssociatedTextControlElement::decrement_cursor_position_to_previous_word(CollapseSelection collapse)
{
    auto const text_node = form_associated_element_to_text_node();
    if (!text_node)
        return;

    while (true) {
        if (auto offset = text_node->word_segmenter().previous_boundary(m_selection_end); offset.has_value()) {
            auto word = text_node->data().substring_view(*offset, m_selection_end - *offset);
            if (collapse == CollapseSelection::Yes) {
                collapse_selection_to_offset(*offset);
            } else {
                m_selection_end = *offset;
            }
            if (Unicode::Segmenter::should_continue_beyond_word(word))
                continue;
        }
        break;
    }

    selection_was_changed();
}

static constexpr size_t find_line_start(Utf16View const& view, size_t offset)
{
    while (offset != 0 && view.code_unit_at(offset - 1) != '\n')
        --offset;
    return offset;
}

static constexpr size_t find_line_end(Utf16View const& view, size_t offset)
{
    auto length = view.length_in_code_units();
    while (offset < length && view.code_unit_at(offset) != '\n')
        ++offset;
    return offset;
}

static float measure_text_width(Layout::TextNode const& text_node, Utf16View const& text)
{
    if (text.is_empty())
        return 0;

    auto segmenter = text_node.grapheme_segmenter().clone();
    segmenter->set_segmented_text(text);

    Layout::TextNode::ChunkIterator iterator { text_node, text, *segmenter, false, false };
    float width = 0;

    for (auto chunk = iterator.next(); chunk.has_value(); chunk = iterator.next())
        width += chunk->font->width(chunk->view);

    return width;
}

static size_t translate_position_across_lines(Layout::TextNode const& text_node, Utf16View const& source_line, Utf16View const& target_line)
{
    GraphemeEdgeTracker tracker(measure_text_width(text_node, source_line));
    auto previous_index = 0uz;

    text_node.grapheme_segmenter().clone()->for_each_boundary(target_line, [&](auto index) {
        auto current_width = measure_text_width(text_node, target_line.substring_view(previous_index, index - previous_index));

        if (tracker.update(index - previous_index, current_width) == IterationDecision::Break)
            return IterationDecision::Break;

        previous_index = index;
        return IterationDecision::Continue;
    });

    return tracker.resolve();
}

void FormAssociatedTextControlElement::increment_cursor_position_to_next_line(CollapseSelection collapse)
{
    auto dom_node = form_associated_element_to_text_node();
    if (!dom_node)
        return;

    auto const* layout_node = as_if<Layout::TextNode>(dom_node->layout_node());
    if (!layout_node)
        return;

    auto text = dom_node->data().utf16_view();
    auto new_offset = text.length_in_code_units();

    if (auto current_line_end = find_line_end(text, m_selection_end); current_line_end < text.length_in_code_units()) {
        auto current_line_start = find_line_start(text, m_selection_end);
        auto current_line_text = text.substring_view(current_line_start, m_selection_end - current_line_start);

        auto next_line_start = current_line_end + 1;
        auto next_line_length = find_line_end(text, next_line_start) - next_line_start;
        auto next_line_text = text.substring_view(next_line_start, next_line_length);

        new_offset = next_line_start + translate_position_across_lines(*layout_node, current_line_text, next_line_text);
    }

    if (collapse == CollapseSelection::Yes)
        collapse_selection_to_offset(new_offset);
    else
        m_selection_end = new_offset;

    selection_was_changed();
}

void FormAssociatedTextControlElement::decrement_cursor_position_to_previous_line(CollapseSelection collapse)
{
    auto dom_node = form_associated_element_to_text_node();
    if (!dom_node)
        return;

    auto const* layout_node = as_if<Layout::TextNode>(dom_node->layout_node());
    if (!layout_node)
        return;

    auto text = dom_node->data().utf16_view();
    auto new_offset = 0uz;

    if (auto current_line_start = find_line_start(text, m_selection_end); current_line_start != 0) {
        auto current_line_text = text.substring_view(current_line_start, m_selection_end - current_line_start);

        auto previous_line_start = find_line_start(text, current_line_start - 1);
        auto previous_line_length = current_line_start - previous_line_start - 1;
        auto previous_line_text = text.substring_view(previous_line_start, previous_line_length);

        new_offset = previous_line_start + translate_position_across_lines(*layout_node, current_line_text, previous_line_text);
    }

    if (collapse == CollapseSelection::Yes)
        collapse_selection_to_offset(new_offset);
    else
        m_selection_end = new_offset;

    selection_was_changed();
}

GC::Ptr<DOM::Position> FormAssociatedTextControlElement::cursor_position() const
{
    auto const node = form_associated_element_to_text_node();
    if (!node)
        return nullptr;
    if (m_selection_start == m_selection_end)
        return DOM::Position::create(node->realm(), const_cast<DOM::Text&>(*node), m_selection_start);
    return nullptr;
}

GC::Ref<JS::Cell> FormAssociatedTextControlElement::as_cell()
{
    return form_associated_element_to_html_element();
}

}