ladybird/Libraries/LibWeb/ARIA/ARIAMixin.h

/*
 * Copyright (c) 2022, Jonah Shafran <jonahshafran@gmail.com>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <AK/String.h>
#include <AK/Vector.h>
#include <LibWeb/ARIA/AriaData.h>
#include <LibWeb/ARIA/AttributeNames.h>
#include <LibWeb/ARIA/Roles.h>
#include <LibWeb/WebIDL/ExceptionOr.h>

namespace Web::ARIA {

class ARIAMixin {
public:
    virtual ~ARIAMixin();

#define __ENUMERATE_ARIA_ATTRIBUTE(name, attribute) \
    virtual Optional<String> name() const = 0;      \
    virtual WebIDL::ExceptionOr<void> set_##name(Optional<String> const&) = 0;
    ENUMERATE_ARIA_ATTRIBUTES
#undef __ENUMERATE_ARIA_ATTRIBUTE

    // https://www.w3.org/TR/html-aria/#docconformance
    virtual Optional<Role> default_role() const { return {}; }

    virtual DOM::Element& to_element() = 0;
    virtual DOM::Element const& to_element() const = 0;

    Optional<Role> role_from_role_attribute_value() const;
    Optional<Role> role_or_default() const;

    // https://www.w3.org/TR/wai-aria-1.2/#tree_exclusion
    virtual bool exclude_from_accessibility_tree() const = 0;

    // https://www.w3.org/TR/wai-aria-1.2/#tree_inclusion
    virtual bool include_in_accessibility_tree() const = 0;

    bool has_global_aria_attribute() const;

    // https://www.w3.org/TR/wai-aria-1.2/#valuetype_idref
    Optional<String> parse_id_reference(Optional<String> const&) const;

    // https://www.w3.org/TR/wai-aria-1.2/#valuetype_idref_list
    Vector<String> parse_id_reference_list(Optional<String> const&) const;

    GC::Ptr<DOM::Element> aria_active_descendant_element() { return m_aria_active_descendant_element; }
    void set_aria_active_descendant_element(GC::Ptr<DOM::Element> value) { m_aria_active_descendant_element = value; }

protected:
    ARIAMixin();

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

    virtual bool id_reference_exists(String const&) const = 0;

private:
    GC::Ptr<DOM::Element> m_aria_active_descendant_element;
};

}