Stowage/ladybird
2
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-12-08 06:09:58 +00:00
Code Issues Projects Releases Packages Wiki Activity
ladybird/Libraries/LibWeb/ARIA/ARIAMixin.h

100 lines
3.7 KiB
C
Raw Normal View History

LibWeb: Add Support for the ARIA Element Properties Element now supports getting and setting ARIA properties from JS and HTML.
2022-11-28 17:58:13 -06:00
/*
* Copyright (c) 2022, Jonah Shafran <jonahshafran@gmail.com>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
LibWeb: Port AriaData from DeprecatedString to String
2023-11-20 21:59:45 +13:00
#include <AK/String.h>
LibWeb: Add AriaData object to parse ARIAMixin data This provides an easily serializeable interface for us to use in IPC.
2023-02-25 15:50:34 -06:00
#include <AK/Vector.h>
#include <LibWeb/ARIA/AriaData.h>
LibWeb: Use a standard x-macro to create FlyString ARIA attribute names We are currently constructing the attribute names as FlyStrings every time we invoke one of the ARIA attributes getters/setters. If there are not any other instances of these strings in-memory, then we're thrashing the FlyString cache. Instead, let's follow suit of all other Web attributes - use an x-macro to generate the attribute names.
2024-12-05 08:33:26 -05:00
#include <LibWeb/ARIA/AttributeNames.h>
LibWeb: Move ARIA-related code into the Web::ARIA namespace ARIA has its own spec and is not part of the DOM spec, which is what the Web::DOM namespace is for (https://www.w3.org/TR/wai-aria-1.2/). This allows us to stay closer to the spec with function names and don't have to add the word "ARIA" to identifiers constantly - the namespace now provides that clarity.
2023-01-28 22:23:16 +00:00
#include <LibWeb/ARIA/Roles.h>
LibWeb: Enable EXPLICIT_SYMBOL_EXPORT
2025-07-19 19:35:33 -07:00
#include <LibWeb/Export.h>
LibWeb: Add Support for the ARIA Element Properties Element now supports getting and setting ARIA properties from JS and HTML.
2022-11-28 17:58:13 -06:00
#include <LibWeb/WebIDL/ExceptionOr.h>
LibWeb: Move ARIA-related code into the Web::ARIA namespace ARIA has its own spec and is not part of the DOM spec, which is what the Web::DOM namespace is for (https://www.w3.org/TR/wai-aria-1.2/). This allows us to stay closer to the spec with function names and don't have to add the word "ARIA" to identifiers constantly - the namespace now provides that clarity.
2023-01-28 22:23:16 +00:00
namespace Web::ARIA {
LibWeb: Add Support for the ARIA Element Properties Element now supports getting and setting ARIA properties from JS and HTML.
2022-11-28 17:58:13 -06:00
LibWeb: Implement ariaActiveDescendantElement spiritually closer to spec We are meant to store a weak reference to the element indicated by this attribute, rather than a GC-protected strong reference. This also hoists the "get the attr-associated element" AO into its own function, rather than being hidden in IDL, to match "get the attr-associated elements".
2025-04-24 16:00:14 -04:00
#define ENUMERATE_ARIA_ELEMENT_REFERENCING_ATTRIBUTES \
__ENUMERATE_ARIA_ATTRIBUTE(aria_active_descendant_element, aria_active_descendant)
LibWeb: Implement element-referencing ARIA attributes There are ARIA attributes, e.g. ariaControlsElements, which refer to a list of elements by their ID. For example: <div aria-controls="item1 item2"> The div.ariaControlsElements attribute would be a list of elements whose ID matches the values in the aria-controls attribute.
2025-04-24 13:41:12 -04:00
#define ENUMERATE_ARIA_ELEMENT_LIST_REFERENCING_ATTRIBUTES \
__ENUMERATE_ARIA_ATTRIBUTE(aria_controls_elements, aria_controls) \
__ENUMERATE_ARIA_ATTRIBUTE(aria_described_by_elements, aria_described_by) \
__ENUMERATE_ARIA_ATTRIBUTE(aria_details_elements, aria_details) \
__ENUMERATE_ARIA_ATTRIBUTE(aria_error_message_elements, aria_error_message) \
__ENUMERATE_ARIA_ATTRIBUTE(aria_flow_to_elements, aria_flow_to) \
__ENUMERATE_ARIA_ATTRIBUTE(aria_labelled_by_elements, aria_labelled_by) \
__ENUMERATE_ARIA_ATTRIBUTE(aria_owns_elements, aria_owns)
LibWeb: Enable EXPLICIT_SYMBOL_EXPORT
2025-07-19 19:35:33 -07:00
class WEB_API ARIAMixin {
LibWeb: Add Support for the ARIA Element Properties Element now supports getting and setting ARIA properties from JS and HTML.
2022-11-28 17:58:13 -06:00
public:
LibWeb: Move ariaActiveDescendantElement to ARIAMixin Not an issue right now, but all IDL types that include the ARIA mixin will need this.
2025-04-24 11:22:52 -04:00
virtual ~ARIAMixin();
LibWeb: Add Support for the ARIA Element Properties Element now supports getting and setting ARIA properties from JS and HTML.
2022-11-28 17:58:13 -06:00
LibWeb: Use a standard x-macro to create FlyString ARIA attribute names We are currently constructing the attribute names as FlyStrings every time we invoke one of the ARIA attributes getters/setters. If there are not any other instances of these strings in-memory, then we're thrashing the FlyString cache. Instead, let's follow suit of all other Web attributes - use an x-macro to generate the attribute names.
2024-12-05 08:33:26 -05:00
#define __ENUMERATE_ARIA_ATTRIBUTE(name, attribute) \
virtual Optional<String> name() const = 0; \
LibWeb: Avoid invoking Trusted Types where avoidable Prevents observably calling Trusted Types, which can run arbitrary JS, cause crashes due to use of MUST and allow arbitrary JS to modify internal elements.
2025-10-31 12:30:47 +00:00
virtual void set_##name(Optional<String> const&) = 0;
LibWeb: Use a standard x-macro to create FlyString ARIA attribute names We are currently constructing the attribute names as FlyStrings every time we invoke one of the ARIA attributes getters/setters. If there are not any other instances of these strings in-memory, then we're thrashing the FlyString cache. Instead, let's follow suit of all other Web attributes - use an x-macro to generate the attribute names.
2024-12-05 08:33:26 -05:00
ENUMERATE_ARIA_ATTRIBUTES
#undef __ENUMERATE_ARIA_ATTRIBUTE
LibWeb: Add Support for the ARIA Element Properties Element now supports getting and setting ARIA properties from JS and HTML.
2022-11-28 17:58:13 -06:00
// https://www.w3.org/TR/html-aria/#docconformance
Everywhere: Remove needless trailing semi-colons after functions This is a new option in clang-format-16.
2023-07-07 22:48:11 -04:00
virtual Optional<Role> default_role() const { return {}; }
LibWeb: Add Support for the ARIA Element Properties Element now supports getting and setting ARIA properties from JS and HTML.
2022-11-28 17:58:13 -06:00
LibWeb: Make ARIAMixin::to_element return a reference Let's avoid confusion on whether this method can return null. It can't. This also adds a non-const override, as that will be needed soon.
2025-04-24 11:18:07 -04:00
virtual DOM::Element& to_element() = 0;
virtual DOM::Element const& to_element() const = 0;
LibWeb: Add a to_element function to ARIAMixin This change adds a virtual to_element function to ARIAMixin, and overrides it in DOM::Element so it can then be used back inside ARIAMixin to get an element when needed (for example, when computing a role requires checking the roles of ancestors of an element).
2024-12-19 16:56:58 +09:00
LibWeb: Extract ARIA role-attribute checking out from role_or_default() This change separates the steps for checking the string value of the ARIA “role” attribute out from the element.role_or_default() function into a separate function — in order to expose a way to just check if the ARIA “role” attribute actually has a value, without also then computing a default role value if no “role” attribute value was found. Otherwise, without this change, the only available function for retrieving ARIA role values is the element.role_or_default() function — which always does the additional step of computing (and returning) a default role value if no “role” attribute is found.
2024-12-06 18:41:38 +09:00
Optional<Role> role_from_role_attribute_value() const;
LibWeb: Move ARIA-related code into the Web::ARIA namespace ARIA has its own spec and is not part of the DOM spec, which is what the Web::DOM namespace is for (https://www.w3.org/TR/wai-aria-1.2/). This allows us to stay closer to the spec with function names and don't have to add the word "ARIA" to identifiers constantly - the namespace now provides that clarity.
2023-01-28 22:23:16 +00:00
Optional<Role> role_or_default() const;
LibWeb: Add Support for the ARIA Element Properties Element now supports getting and setting ARIA properties from JS and HTML.
2022-11-28 17:58:13 -06:00
LibWeb: Add (exclude/include)_from_accessibility_tree These functions will be used in building the accessibility tree.
2022-12-11 10:53:37 -06:00
// 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;
LibWeb: Add has_global_aria_attribute This helper will be used to help determine tree inclusion.
2022-12-11 10:52:58 -06:00
bool has_global_aria_attribute() const;
LibWeb: Add AriaData object to parse ARIAMixin data This provides an easily serializeable interface for us to use in IPC.
2023-02-25 15:50:34 -06:00
// https://www.w3.org/TR/wai-aria-1.2/#valuetype_idref
LibWeb: Port AriaData from DeprecatedString to String
2023-11-20 21:59:45 +13:00
Optional<String> parse_id_reference(Optional<String> const&) const;
LibWeb: Add AriaData object to parse ARIAMixin data This provides an easily serializeable interface for us to use in IPC.
2023-02-25 15:50:34 -06:00
// https://www.w3.org/TR/wai-aria-1.2/#valuetype_idref_list
LibWeb: Port AriaData from DeprecatedString to String
2023-11-20 21:59:45 +13:00
Vector<String> parse_id_reference_list(Optional<String> const&) const;
LibWeb: Add AriaData object to parse ARIAMixin data This provides an easily serializeable interface for us to use in IPC.
2023-02-25 15:50:34 -06:00
LibWeb: Implement ariaActiveDescendantElement spiritually closer to spec We are meant to store a weak reference to the element indicated by this attribute, rather than a GC-protected strong reference. This also hoists the "get the attr-associated element" AO into its own function, rather than being hidden in IDL, to match "get the attr-associated elements".
2025-04-24 16:00:14 -04:00
#define __ENUMERATE_ARIA_ATTRIBUTE(attribute, referencing_attribute) \
GC::Ptr<DOM::Element> attribute() const; \
void set_##attribute(GC::Ptr<DOM::Element> value);
ENUMERATE_ARIA_ELEMENT_REFERENCING_ATTRIBUTES
#undef __ENUMERATE_ARIA_ATTRIBUTE
LibWeb: Move ariaActiveDescendantElement to ARIAMixin Not an issue right now, but all IDL types that include the ARIA mixin will need this.
2025-04-24 11:22:52 -04:00
LibJS+LibWeb: Use GC::Weak instead of AK::WeakPtr for GC-allocated types This makes some common types like JS::Object smaller (by 8 bytes) and yields a minor speed improvement on many benchmarks.
2025-10-16 11:13:54 +02:00
#define __ENUMERATE_ARIA_ATTRIBUTE(attribute, referencing_attribute) \
LibWeb: Shave 168 bytes off of ARIAMixin Instead of keeping the vectors inside ARIAMixin, point to the heap using OwnPtrs.
2025-11-07 12:02:27 +01:00
Optional<Vector<GC::Weak<DOM::Element>> const&> attribute() const; \
LibJS+LibWeb: Use GC::Weak instead of AK::WeakPtr for GC-allocated types This makes some common types like JS::Object smaller (by 8 bytes) and yields a minor speed improvement on many benchmarks.
2025-10-16 11:13:54 +02:00
void set_##attribute(Optional<Vector<GC::Weak<DOM::Element>>>); \
\
GC::Ptr<JS::Array> cached_##attribute() const; \
LibWeb: Implement caching of reflected element array attributes For attributes like Element.ariaControlsElements, which are a reflection of FrozenArray<Element>, we must return the same JS::Array object every time the attribute is invoked - until its contents have changed. This patch implements caching of the reflected array in accordance with the spec.
2025-04-25 13:47:08 -04:00
void set_cached_##attribute(GC::Ptr<JS::Array>);
LibWeb: Implement element-referencing ARIA attributes There are ARIA attributes, e.g. ariaControlsElements, which refer to a list of elements by their ID. For example: <div aria-controls="item1 item2"> The div.ariaControlsElements attribute would be a list of elements whose ID matches the values in the aria-controls attribute.
2025-04-24 13:41:12 -04:00
ENUMERATE_ARIA_ELEMENT_LIST_REFERENCING_ATTRIBUTES
#undef __ENUMERATE_ARIA_ATTRIBUTE
LibWeb: Add Support for the ARIA Element Properties Element now supports getting and setting ARIA properties from JS and HTML.
2022-11-28 17:58:13 -06:00
protected:
LibWeb: Move ariaActiveDescendantElement to ARIAMixin Not an issue right now, but all IDL types that include the ARIA mixin will need this.
2025-04-24 11:22:52 -04:00
ARIAMixin();
LibWeb: Implement caching of reflected element array attributes For attributes like Element.ariaControlsElements, which are a reflection of FrozenArray<Element>, we must return the same JS::Array object every time the attribute is invoked - until its contents have changed. This patch implements caching of the reflected array in accordance with the spec.
2025-04-25 13:47:08 -04:00
void visit_edges(GC::Cell::Visitor&);
LibWeb: Port AriaData from DeprecatedString to String
2023-11-20 21:59:45 +13:00
virtual bool id_reference_exists(String const&) const = 0;
LibWeb: Move ariaActiveDescendantElement to ARIAMixin Not an issue right now, but all IDL types that include the ARIA mixin will need this.
2025-04-24 11:22:52 -04:00
private:
LibWeb: Implement ariaActiveDescendantElement spiritually closer to spec We are meant to store a weak reference to the element indicated by this attribute, rather than a GC-protected strong reference. This also hoists the "get the attr-associated element" AO into its own function, rather than being hidden in IDL, to match "get the attr-associated elements".
2025-04-24 16:00:14 -04:00
#define __ENUMERATE_ARIA_ATTRIBUTE(attribute, referencing_attribute) \
LibJS+LibWeb: Use GC::Weak instead of AK::WeakPtr for GC-allocated types This makes some common types like JS::Object smaller (by 8 bytes) and yields a minor speed improvement on many benchmarks.
2025-10-16 11:13:54 +02:00
GC::Weak<DOM::Element> m_##attribute;
LibWeb: Implement ariaActiveDescendantElement spiritually closer to spec We are meant to store a weak reference to the element indicated by this attribute, rather than a GC-protected strong reference. This also hoists the "get the attr-associated element" AO into its own function, rather than being hidden in IDL, to match "get the attr-associated elements".
2025-04-24 16:00:14 -04:00
ENUMERATE_ARIA_ELEMENT_REFERENCING_ATTRIBUTES
#undef __ENUMERATE_ARIA_ATTRIBUTE
LibWeb: Implement element-referencing ARIA attributes There are ARIA attributes, e.g. ariaControlsElements, which refer to a list of elements by their ID. For example: <div aria-controls="item1 item2"> The div.ariaControlsElements attribute would be a list of elements whose ID matches the values in the aria-controls attribute.
2025-04-24 13:41:12 -04:00
#define __ENUMERATE_ARIA_ATTRIBUTE(attribute, referencing_attribute) \
LibWeb: Shave 168 bytes off of ARIAMixin Instead of keeping the vectors inside ARIAMixin, point to the heap using OwnPtrs.
2025-11-07 12:02:27 +01:00
OwnPtr<Vector<GC::Weak<DOM::Element>>> m_##attribute; \
LibWeb: Implement caching of reflected element array attributes For attributes like Element.ariaControlsElements, which are a reflection of FrozenArray<Element>, we must return the same JS::Array object every time the attribute is invoked - until its contents have changed. This patch implements caching of the reflected array in accordance with the spec.
2025-04-25 13:47:08 -04:00
GC::Ptr<JS::Array> m_cached_##attribute;
LibWeb: Implement element-referencing ARIA attributes There are ARIA attributes, e.g. ariaControlsElements, which refer to a list of elements by their ID. For example: <div aria-controls="item1 item2"> The div.ariaControlsElements attribute would be a list of elements whose ID matches the values in the aria-controls attribute.
2025-04-24 13:41:12 -04:00
ENUMERATE_ARIA_ELEMENT_LIST_REFERENCING_ATTRIBUTES
#undef __ENUMERATE_ARIA_ATTRIBUTE
LibWeb: Add Support for the ARIA Element Properties Element now supports getting and setting ARIA properties from JS and HTML.
2022-11-28 17:58:13 -06:00
};
}
Reference in a new issue Copy permalink