ladybird/Libraries/LibWeb/CSS/CSSStyleProperties.cpp

1412 lines
71 KiB
C++
Raw Normal View History

/*
* Copyright (c) 2018-2024, Andreas Kling <andreas@ladybird.org>
* Copyright (c) 2023-2025, Sam Atkins <sam@ladybird.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include <LibWeb/Bindings/CSSStylePropertiesPrototype.h>
#include <LibWeb/Bindings/ExceptionOrUtils.h>
#include <LibWeb/Bindings/Intrinsics.h>
#include <LibWeb/CSS/CSSStyleProperties.h>
#include <LibWeb/CSS/ComputedProperties.h>
#include <LibWeb/CSS/Parser/Parser.h>
#include <LibWeb/CSS/PropertyNameAndID.h>
#include <LibWeb/CSS/StyleComputer.h>
#include <LibWeb/CSS/StyleValues/FitContentStyleValue.h>
#include <LibWeb/CSS/StyleValues/ImageStyleValue.h>
#include <LibWeb/CSS/StyleValues/KeywordStyleValue.h>
#include <LibWeb/CSS/StyleValues/LengthStyleValue.h>
#include <LibWeb/CSS/StyleValues/NumberStyleValue.h>
#include <LibWeb/CSS/StyleValues/PercentageStyleValue.h>
#include <LibWeb/CSS/StyleValues/ShorthandStyleValue.h>
#include <LibWeb/CSS/StyleValues/StyleValueList.h>
#include <LibWeb/CSS/StyleValues/TransformationStyleValue.h>
#include <LibWeb/DOM/Document.h>
#include <LibWeb/DOM/Element.h>
#include <LibWeb/Infra/Strings.h>
#include <LibWeb/Layout/Node.h>
#include <LibWeb/Painting/BoxModelMetrics.h>
#include <LibWeb/Painting/PaintableBox.h>
namespace Web::CSS {
GC_DEFINE_ALLOCATOR(CSSStyleProperties);
GC::Ref<CSSStyleProperties> CSSStyleProperties::create(JS::Realm& realm, Vector<StyleProperty> properties, OrderedHashMap<FlyString, StyleProperty> custom_properties)
{
// https://drafts.csswg.org/cssom/#dom-cssstylerule-style
// The style attribute must return a CSSStyleProperties object for the style rule, with the following properties:
// computed flag: Unset.
// readonly flag: Unset.
// declarations: The declared declarations in the rule, in specified order.
// parent CSS rule: The context object.
// owner node: Null.
return realm.create<CSSStyleProperties>(realm, Computed::No, Readonly::No, convert_declarations_to_specified_order(properties), move(custom_properties), OptionalNone {});
}
GC::Ref<CSSStyleProperties> CSSStyleProperties::create_resolved_style(JS::Realm& realm, Optional<DOM::AbstractElement> element_reference)
{
// https://drafts.csswg.org/cssom/#dom-window-getcomputedstyle
// 6. Return a live CSSStyleProperties object with the following properties:
// computed flag: Set.
// readonly flag: Set.
// declarations: decls.
// parent CSS rule: Null.
// owner node: obj.
// AD-HOC: Rather than instantiate with a list of decls, they're generated on demand.
return realm.create<CSSStyleProperties>(realm, Computed::Yes, Readonly::Yes, Vector<StyleProperty> {}, OrderedHashMap<FlyString, StyleProperty> {}, move(element_reference));
}
GC::Ref<CSSStyleProperties> CSSStyleProperties::create_element_inline_style(DOM::AbstractElement element_reference, Vector<StyleProperty> properties, OrderedHashMap<FlyString, StyleProperty> custom_properties)
{
// https://drafts.csswg.org/cssom/#dom-elementcssinlinestyle-style
// The style attribute must return a CSS declaration block object whose readonly flag is unset, whose parent CSS
// rule is null, and whose owner node is the context object.
auto& realm = element_reference.element().realm();
return realm.create<CSSStyleProperties>(realm, Computed::No, Readonly::No, convert_declarations_to_specified_order(properties), move(custom_properties), move(element_reference));
}
CSSStyleProperties::CSSStyleProperties(JS::Realm& realm, Computed computed, Readonly readonly, Vector<StyleProperty> properties, OrderedHashMap<FlyString, StyleProperty> custom_properties, Optional<DOM::AbstractElement> owner_node)
: CSSStyleDeclaration(realm, computed, readonly)
, m_properties(move(properties))
, m_custom_properties(move(custom_properties))
{
set_owner_node(move(owner_node));
}
// https://drafts.csswg.org/cssom/#concept-declarations-specified-order
Vector<StyleProperty> CSSStyleProperties::convert_declarations_to_specified_order(Vector<StyleProperty>& declarations)
{
// The specified order for declarations is the same as specified, but with shorthand properties expanded into their
// longhand properties, in canonical order. If a property is specified more than once (after shorthand expansion), only
// the one with greatest cascading order must be represented, at the same relative position as it was specified.
Vector<StyleProperty> specified_order_declarations;
for (auto declaration : declarations) {
StyleComputer::for_each_property_expanding_shorthands(declaration.property_id, declaration.value, [&](CSS::PropertyID longhand_id, CSS::StyleValue const& longhand_property_value) {
auto existing_entry_index = specified_order_declarations.find_first_index_if([&](StyleProperty const& existing_declaration) { return existing_declaration.property_id == longhand_id; });
if (existing_entry_index.has_value()) {
// If there is an existing entry for this property and it is a higher cascading order than the current entry, skip the current entry.
if (specified_order_declarations[existing_entry_index.value()].important == Important::Yes && declaration.important == Important::No)
return;
// Otherwise the existing entry has a lower cascading order and is removed.
specified_order_declarations.remove(existing_entry_index.value());
}
specified_order_declarations.append(StyleProperty {
.important = declaration.important,
.property_id = longhand_id,
.value = longhand_property_value });
});
}
return specified_order_declarations;
}
void CSSStyleProperties::initialize(JS::Realm& realm)
{
WEB_SET_PROTOTYPE_FOR_INTERFACE(CSSStyleProperties);
Base::initialize(realm);
}
void CSSStyleProperties::visit_edges(Visitor& visitor)
{
Base::visit_edges(visitor);
for (auto& property : m_properties) {
property.value->visit_edges(visitor);
}
}
// https://drafts.csswg.org/cssom/#dom-cssstyledeclaration-length
size_t CSSStyleProperties::length() const
{
// The length attribute must return the number of CSS declarations in the declarations.
if (is_computed()) {
if (!owner_node().has_value())
return 0;
return number_of_longhand_properties;
}
return m_properties.size() + m_custom_properties.size();
}
String CSSStyleProperties::item(size_t index) const
{
// The item(index) method must return the property name of the CSS declaration at position index.
// If there is no indexth object in the collection, then the method must return the empty string.
auto custom_properties_count = m_custom_properties.size();
if (index >= length())
return {};
if (is_computed()) {
auto property_id = static_cast<PropertyID>(index + to_underlying(first_longhand_property_id));
return string_from_property_id(property_id).to_string();
}
if (index < custom_properties_count) {
auto keys = m_custom_properties.keys();
auto custom_property = m_custom_properties.get(keys[index]);
return custom_property.ptr()->custom_name.to_string();
}
return CSS::string_from_property_id(m_properties[index - custom_properties_count].property_id).to_string();
}
Optional<StyleProperty> CSSStyleProperties::get_property(PropertyID property_id) const
{
return get_property_internal(PropertyNameAndID::from_id(property_id));
}
Optional<StyleProperty const&> CSSStyleProperties::custom_property(FlyString const& custom_property_name) const
{
if (is_computed()) {
if (!owner_node().has_value())
return {};
auto& element = owner_node()->element();
auto pseudo_element = owner_node()->pseudo_element();
element.document().update_style();
auto const* element_to_check = &element;
while (element_to_check) {
if (auto property = element_to_check->custom_properties(pseudo_element).get(custom_property_name); property.has_value())
return *property;
element_to_check = element_to_check->parent_element();
}
return {};
}
return m_custom_properties.get(custom_property_name);
}
// https://drafts.csswg.org/cssom/#dom-cssstyledeclaration-setproperty
WebIDL::ExceptionOr<void> CSSStyleProperties::set_property(FlyString const& property_name, StringView value, StringView priority)
{
// 1. If the computed flag is set, then throw a NoModificationAllowedError exception.
if (is_computed())
return WebIDL::NoModificationAllowedError::create(realm(), "Cannot modify properties in result of getComputedStyle()"_utf16);
// 2. If property is not a custom property, follow these substeps:
// 1. Let property be property converted to ASCII lowercase.
// 2. If property is not a case-sensitive match for a supported CSS property, then return.
// NB: This is handled inside PropertyNameAndID::from_string().
auto property = PropertyNameAndID::from_name(property_name);
if (!property.has_value())
return {};
// NB: The remaining steps are implemented in set_property_internal().
return set_property_internal(property.release_value(), value, priority);
}
// https://drafts.csswg.org/cssom/#dom-cssstyledeclaration-setproperty
WebIDL::ExceptionOr<void> CSSStyleProperties::set_property_internal(PropertyNameAndID const& property, StringView value, StringView priority)
{
// NB: Steps 1 and 2 only apply to the IDL method that invokes this.
// 3. If value is the empty string, invoke removeProperty() with property as argument and return.
if (value.is_empty()) {
MUST(remove_property_internal(property));
return {};
}
// 4. If priority is not the empty string and is not an ASCII case-insensitive match for the string "important", then return.
if (!priority.is_empty() && !priority.equals_ignoring_ascii_case("important"sv))
return {};
// 5. Let component value list be the result of parsing value for property property.
auto component_value_list = owner_node().has_value()
? parse_css_value(Parser::ParsingParams { owner_node()->element().document() }, value, property.id())
: parse_css_value(Parser::ParsingParams {}, value, property.id());
// 6. If component value list is null, then return.
if (!component_value_list)
return {};
// 7. Let updated be false.
bool updated = false;
// 8. If property is a shorthand property,
if (property_is_shorthand(property.id())) {
// then for each longhand property longhand that property maps to, in canonical order, follow these substeps:
StyleComputer::for_each_property_expanding_shorthands(property.id(), *component_value_list, [this, &updated, priority](PropertyID longhand_property_id, StyleValue const& longhand_value) {
// 1. Let longhand result be the result of set the CSS declaration longhand with the appropriate value(s) from component value list,
// with the important flag set if priority is not the empty string, and unset otherwise, and with the list of declarations being the declarations.
// 2. If longhand result is true, let updated be true.
updated |= set_a_css_declaration(longhand_property_id, longhand_value, !priority.is_empty() ? Important::Yes : Important::No);
});
}
// 9. Otherwise,
else {
if (property.is_custom_property()) {
StyleProperty style_property {
.important = !priority.is_empty() ? Important::Yes : Important::No,
.property_id = property.id(),
.value = component_value_list.release_nonnull(),
.custom_name = property.name(),
};
m_custom_properties.set(property.name(), style_property);
updated = true;
} else {
// let updated be the result of set the CSS declaration property with value component value list,
// with the important flag set if priority is not the empty string, and unset otherwise,
// and with the list of declarations being the declarations.
updated = set_a_css_declaration(property.id(), *component_value_list, !priority.is_empty() ? Important::Yes : Important::No);
}
}
// 10. If updated is true, update style attribute for the CSS declaration block.
if (updated) {
update_style_attribute();
// Non-standard: Invalidate style for the owners of our containing sheet, if any.
invalidate_owners(DOM::StyleInvalidationReason::CSSStylePropertiesSetProperty);
}
return {};
}
WebIDL::ExceptionOr<void> CSSStyleProperties::set_property(PropertyID property_id, StringView css_text, StringView priority)
{
return set_property_internal(PropertyNameAndID::from_id(property_id), css_text, priority);
}
static NonnullRefPtr<StyleValue const> style_value_for_length_percentage(LengthPercentage const& length_percentage)
{
if (length_percentage.is_percentage())
return PercentageStyleValue::create(length_percentage.percentage());
if (length_percentage.is_length())
return LengthStyleValue::create(length_percentage.length());
return length_percentage.calculated();
}
static NonnullRefPtr<StyleValue const> style_value_for_length_percentage_or_auto(LengthPercentageOrAuto const& length_percentage)
{
if (length_percentage.is_auto())
return KeywordStyleValue::create(Keyword::Auto);
if (length_percentage.is_percentage())
return PercentageStyleValue::create(length_percentage.percentage());
if (length_percentage.is_length())
return LengthStyleValue::create(length_percentage.length());
return length_percentage.calculated();
}
static NonnullRefPtr<StyleValue const> style_value_for_size(Size const& size)
{
if (size.is_none())
return KeywordStyleValue::create(Keyword::None);
if (size.is_percentage())
return PercentageStyleValue::create(size.percentage());
if (size.is_length())
return LengthStyleValue::create(size.length());
if (size.is_auto())
return KeywordStyleValue::create(Keyword::Auto);
if (size.is_calculated())
return size.calculated();
if (size.is_min_content())
return KeywordStyleValue::create(Keyword::MinContent);
if (size.is_max_content())
return KeywordStyleValue::create(Keyword::MaxContent);
if (size.is_fit_content()) {
if (auto available_space = size.fit_content_available_space(); available_space.has_value())
return FitContentStyleValue::create(available_space.release_value());
return FitContentStyleValue::create();
}
TODO();
}
static RefPtr<StyleValue const> style_value_for_shadow(ShadowStyleValue::ShadowType shadow_type, Vector<ShadowData> const& shadow_data)
{
if (shadow_data.is_empty())
return KeywordStyleValue::create(Keyword::None);
auto make_shadow_style_value = [shadow_type](ShadowData const& shadow) {
return ShadowStyleValue::create(
shadow_type,
ColorStyleValue::create_from_color(shadow.color, ColorSyntax::Modern),
style_value_for_length_percentage(shadow.offset_x),
style_value_for_length_percentage(shadow.offset_y),
style_value_for_length_percentage(shadow.blur_radius),
style_value_for_length_percentage(shadow.spread_distance),
shadow.placement);
};
if (shadow_data.size() == 1)
return make_shadow_style_value(shadow_data.first());
StyleValueVector style_values;
style_values.ensure_capacity(shadow_data.size());
for (auto& shadow : shadow_data)
style_values.unchecked_append(make_shadow_style_value(shadow));
return StyleValueList::create(move(style_values), StyleValueList::Separator::Comma);
}
// https://drafts.csswg.org/cssom/#dom-cssstyledeclaration-getpropertyvalue
String CSSStyleProperties::get_property_value(FlyString const& property_name) const
{
auto property = PropertyNameAndID::from_name(property_name);
if (!property.has_value())
return {};
if (auto style_property = get_property_internal(property.value()); style_property.has_value()) {
return style_property->value->to_string(
is_computed() ? SerializationMode::ResolvedValue
: SerializationMode::Normal);
}
return {};
}
// https://drafts.csswg.org/cssom/#dom-cssstyledeclaration-getpropertypriority
StringView CSSStyleProperties::get_property_priority(FlyString const& property_name) const
{
auto property_id = property_id_from_string(property_name);
if (!property_id.has_value())
return {};
if (property_id.value() == PropertyID::Custom) {
auto maybe_custom_property = custom_property(property_name);
if (!maybe_custom_property.has_value())
return {};
return maybe_custom_property.value().important == Important::Yes ? "important"sv : ""sv;
}
auto maybe_property = get_property(property_id.value());
if (!maybe_property.has_value())
return {};
return maybe_property->important == Important::Yes ? "important"sv : ""sv;
}
bool CSSStyleProperties::has_property(PropertyNameAndID const& property) const
{
return get_property_internal(property).has_value();
}
bool CSSStyleProperties::has_property(PropertyID property_id) const
{
return has_property(PropertyNameAndID::from_id(property_id));
}
RefPtr<StyleValue const> CSSStyleProperties::get_property_style_value(PropertyNameAndID const& property) const
{
if (auto style_property = get_property_internal(property); style_property.has_value())
return style_property->value;
return nullptr;
}
RefPtr<StyleValue const> CSSStyleProperties::get_property_style_value(PropertyID property_id) const
{
return get_property_style_value(PropertyNameAndID::from_id(property_id));
}
WebIDL::ExceptionOr<void> CSSStyleProperties::set_property_style_value(PropertyNameAndID const& property, NonnullRefPtr<StyleValue const> style_value)
{
if (is_computed()) {
return WebIDL::NoModificationAllowedError::create(realm(), "Cannot modify properties in result of getComputedStyle()"_utf16);
}
if (property.is_custom_property()) {
m_custom_properties.remove(property.name());
m_custom_properties.set(property.name(),
StyleProperty {
Important::No,
PropertyID::Custom,
style_value,
property.name() });
return {};
}
m_properties.remove_first_matching([&property](StyleProperty const& style_property) {
return style_property.property_id == property.id();
});
m_properties.append(StyleProperty {
.important = Important::No,
.property_id = property.id(),
.value = move(style_value),
});
return {};
}
// https://drafts.csswg.org/cssom/#dom-cssstyledeclaration-getpropertyvalue
Optional<StyleProperty> CSSStyleProperties::get_property_internal(PropertyNameAndID const& property) const
{
// NB: This is our own method to get a StyleProperty, but following the algorithm for getPropertyValue() which
// returns a String. (This way, we can use the same logic in other places.) That's why the spec steps talk
// about strings and then we do something different.
// 1. If property is not a custom property, follow these substeps:
if (!property.is_custom_property()) {
// 1. Let property be property converted to ASCII lowercase.
// NB: Done already by PropertyNameAndID.
// 2. If property is a shorthand property, then follow these substeps:
if (property_is_shorthand(property.id())) {
// 1. Let list be a new empty array.
Vector<ValueComparingNonnullRefPtr<StyleValue const>> list;
Optional<Important> last_important_flag;
// 2. For each longhand property longhand that property maps to, in canonical order, follow these substeps:
Vector<PropertyID> longhand_ids = longhands_for_shorthand(property.id());
for (auto longhand_property_id : longhand_ids) {
// 1. If longhand is a case-sensitive match for a property name of a CSS declaration in the declarations,
// let declaration be that CSS declaration, or null otherwise.
auto declaration = get_property_internal(PropertyNameAndID::from_id(longhand_property_id));
// 2. If declaration is null, then return the empty string.
if (!declaration.has_value())
return {};
// 3. Append the declaration to list.
list.append(declaration->value);
if (last_important_flag.has_value() && declaration->important != *last_important_flag)
return {};
last_important_flag = declaration->important;
}
// 3. If important flags of all declarations in list are same, then return the serialization of list.
// NOTE: Currently we implement property-specific shorthand serialization in ShorthandStyleValue::to_string().
return StyleProperty {
.important = last_important_flag.value(),
.property_id = property.id(),
.value = ShorthandStyleValue::create(property.id(), longhand_ids, list),
};
// 4. Return the empty string.
// NOTE: This is handled by the loop.
}
}
// 2. If property is a case-sensitive match for a property name of a CSS declaration in the declarations, then
// return the result of invoking serialize a CSS value of that declaration.
// 3. Return the empty string.
return get_direct_property(property);
}
Optional<StyleProperty> CSSStyleProperties::get_direct_property(PropertyNameAndID const& property_name_and_id) const
{
auto const property_id = property_name_and_id.id();
if (is_computed()) {
if (!owner_node().has_value())
return {};
auto abstract_element = *owner_node();
// https://www.w3.org/TR/cssom-1/#dom-window-getcomputedstyle
// NB: This is a partial enforcement of step 5 ("If elt is connected, ...")
if (!abstract_element.element().is_connected())
return {};
Layout::NodeWithStyle* layout_node = abstract_element.layout_node();
// Pending changes to an ancestor document's layout can affect an element's computed style e.g. an IFrame's
// width being changed can affect media query evaluation and the value of the `vw` unit.
// FIXME: This is likely overkill and can be optimized
for (auto const& navigable : abstract_element.document().ancestor_navigables()) {
if (navigable->active_document())
navigable->active_document()->update_layout(DOM::UpdateLayoutReason::ResolvedCSSStyleDeclarationProperty);
}
// FIXME: Be smarter about updating layout if there's no layout node.
// We may legitimately have no layout node if we're not visible, but this protects against situations
// where we're requesting the computed style before layout has happened.
if (!layout_node || property_needs_layout_for_getcomputedstyle(property_id)) {
abstract_element.document().update_layout(DOM::UpdateLayoutReason::ResolvedCSSStyleDeclarationProperty);
layout_node = abstract_element.layout_node();
} else {
// FIXME: If we had a way to update style for a single element, this would be a good place to use it.
abstract_element.document().update_style();
}
// FIXME: Somehow get custom properties if there's no layout node.
if (property_name_and_id.is_custom_property()) {
if (auto maybe_value = abstract_element.get_custom_property(property_name_and_id.name())) {
return StyleProperty {
.property_id = property_id,
.value = maybe_value.release_nonnull(),
.custom_name = property_name_and_id.name(),
};
}
return {};
}
if (!layout_node) {
auto style = abstract_element.document().style_computer().compute_style(abstract_element);
return StyleProperty {
.property_id = property_id,
.value = style->property(property_id),
};
}
auto value = style_value_for_computed_property(*layout_node, property_id);
if (!value)
return {};
return StyleProperty {
.property_id = property_id,
.value = *value,
};
}
if (property_name_and_id.is_custom_property())
return custom_property(property_name_and_id.name()).map([](auto& it) { return it; });
for (auto const& property : m_properties) {
if (property.property_id == property_id)
return property;
}
return {};
}
static RefPtr<StyleValue const> resolve_color_style_value(StyleValue const& style_value, Color computed_color)
{
if (style_value.is_color_function())
return style_value;
if (style_value.is_color()) {
auto& color_style_value = static_cast<ColorStyleValue const&>(style_value);
if (first_is_one_of(color_style_value.color_type(), ColorStyleValue::ColorType::Lab, ColorStyleValue::ColorType::OKLab, ColorStyleValue::ColorType::LCH, ColorStyleValue::ColorType::OKLCH))
return style_value;
}
return ColorStyleValue::create_from_color(computed_color, ColorSyntax::Modern);
}
RefPtr<StyleValue const> CSSStyleProperties::style_value_for_computed_property(Layout::NodeWithStyle const& layout_node, PropertyID property_id) const
{
if (!owner_node().has_value()) {
dbgln_if(LIBWEB_CSS_DEBUG, "Computed style for CSSStyleProperties without owner node was requested");
return nullptr;
}
auto used_value_for_property = [&layout_node, property_id](Function<CSSPixels(Painting::PaintableBox const&)>&& used_value_getter) -> Optional<CSSPixels> {
auto const& display = layout_node.computed_values().display();
if (!display.is_none() && !display.is_contents() && layout_node.first_paintable()) {
if (auto const* paintable_box = as_if<Painting::PaintableBox>(layout_node.first_paintable()))
return used_value_getter(*paintable_box);
dbgln("FIXME: Support getting used value for property `{}` on {}", string_from_property_id(property_id), layout_node.debug_description());
}
return {};
};
auto& element = owner_node()->element();
auto pseudo_element = owner_node()->pseudo_element();
auto used_value_for_inset = [&layout_node, used_value_for_property](LengthPercentageOrAuto const& start_side, LengthPercentageOrAuto const& end_side, Function<CSSPixels(Painting::PaintableBox const&)>&& used_value_getter) -> Optional<CSSPixels> {
if (!layout_node.is_positioned())
return {};
// FIXME: Support getting the used value when position is sticky.
if (layout_node.is_sticky_position())
return {};
if (!start_side.is_percentage() && !start_side.is_calculated() && !start_side.is_auto() && !end_side.is_auto())
return {};
return used_value_for_property(move(used_value_getter));
};
auto get_computed_value = [&element, pseudo_element](PropertyID property_id) -> auto const& {
return element.computed_properties(pseudo_element)->property(property_id);
};
if (property_is_logical_alias(property_id)) {
auto computed_properties = element.computed_properties(pseudo_element);
return style_value_for_computed_property(
layout_node,
map_logical_alias_to_physical_property(property_id, LogicalAliasMappingContext { computed_properties->writing_mode(), computed_properties->direction() }));
}
// A limited number of properties have special rules for producing their "resolved value".
// We also have to manually construct shorthands from their longhands here.
// Everything else uses the computed value.
// https://drafts.csswg.org/cssom/#resolved-values
// AD-HOC: We don't resolve logical properties here as we have already handled above
// The resolved value for a given longhand property can be determined as follows:
switch (property_id) {
// -> background-color
// -> border-block-end-color
// -> border-block-start-color
// -> border-bottom-color
// -> border-inline-end-color
// -> border-inline-start-color
// -> border-left-color
// -> border-right-color
// -> border-top-color
// -> box-shadow
// -> caret-color
// -> color
// -> outline-color
// -> A resolved value special case property like color defined in another specification
// The resolved value is the used value.
case PropertyID::BackgroundColor:
return resolve_color_style_value(get_computed_value(property_id), layout_node.computed_values().background_color());
case PropertyID::BorderBottomColor:
return resolve_color_style_value(get_computed_value(property_id), layout_node.computed_values().border_bottom().color);
case PropertyID::BorderLeftColor:
return resolve_color_style_value(get_computed_value(property_id), layout_node.computed_values().border_left().color);
case PropertyID::BorderRightColor:
return resolve_color_style_value(get_computed_value(property_id), layout_node.computed_values().border_right().color);
case PropertyID::BorderTopColor:
return resolve_color_style_value(get_computed_value(property_id), layout_node.computed_values().border_top().color);
case PropertyID::BoxShadow:
return style_value_for_shadow(ShadowStyleValue::ShadowType::Normal, layout_node.computed_values().box_shadow());
case PropertyID::CaretColor:
return resolve_color_style_value(get_computed_value(property_id), layout_node.computed_values().caret_color());
case PropertyID::Color:
return resolve_color_style_value(get_computed_value(property_id), layout_node.computed_values().color());
case PropertyID::OutlineColor:
return resolve_color_style_value(get_computed_value(property_id), layout_node.computed_values().outline_color());
case PropertyID::TextDecorationColor:
return resolve_color_style_value(get_computed_value(property_id), layout_node.computed_values().text_decoration_color());
// NB: text-shadow isn't listed, but is computed the same as box-shadow.
case PropertyID::TextShadow:
return style_value_for_shadow(ShadowStyleValue::ShadowType::Text, layout_node.computed_values().text_shadow());
// -> line-height
// The resolved value is normal if the computed value is normal, or the used value otherwise.
case PropertyID::LineHeight: {
auto const& line_height = get_computed_value(property_id);
if (line_height.is_keyword() && line_height.to_keyword() == Keyword::Normal)
return line_height;
return LengthStyleValue::create(Length::make_px(layout_node.computed_values().line_height()));
}
// -> block-size
// -> height
// -> inline-size
// -> margin-block-end
// -> margin-block-start
// -> margin-bottom
// -> margin-inline-end
// -> margin-inline-start
// -> margin-left
// -> margin-right
// -> margin-top
// -> padding-block-end
// -> padding-block-start
// -> padding-bottom
// -> padding-inline-end
// -> padding-inline-start
// -> padding-left
// -> padding-right
// -> padding-top
// -> width
// If the property applies to the element or pseudo-element and the resolved value of the
// display property is not none or contents, then the resolved value is the used value.
// Otherwise the resolved value is the computed value.
case PropertyID::Height: {
auto maybe_used_height = used_value_for_property([](auto const& paintable_box) { return paintable_box.content_height(); });
if (maybe_used_height.has_value())
return style_value_for_size(Size::make_px(maybe_used_height.release_value()));
return style_value_for_size(layout_node.computed_values().height());
}
case PropertyID::MarginBottom:
if (auto maybe_used_value = used_value_for_property([](auto const& paintable_box) { return paintable_box.box_model().margin.bottom; }); maybe_used_value.has_value())
return LengthStyleValue::create(Length::make_px(maybe_used_value.release_value()));
return style_value_for_length_percentage_or_auto(layout_node.computed_values().margin().bottom());
case PropertyID::MarginLeft:
if (auto maybe_used_value = used_value_for_property([](auto const& paintable_box) { return paintable_box.box_model().margin.left; }); maybe_used_value.has_value())
return LengthStyleValue::create(Length::make_px(maybe_used_value.release_value()));
return style_value_for_length_percentage_or_auto(layout_node.computed_values().margin().left());
case PropertyID::MarginRight:
if (auto maybe_used_value = used_value_for_property([](auto const& paintable_box) { return paintable_box.box_model().margin.right; }); maybe_used_value.has_value())
return LengthStyleValue::create(Length::make_px(maybe_used_value.release_value()));
return style_value_for_length_percentage_or_auto(layout_node.computed_values().margin().right());
case PropertyID::MarginTop:
if (auto maybe_used_value = used_value_for_property([](auto const& paintable_box) { return paintable_box.box_model().margin.top; }); maybe_used_value.has_value())
return LengthStyleValue::create(Length::make_px(maybe_used_value.release_value()));
return style_value_for_length_percentage_or_auto(layout_node.computed_values().margin().top());
case PropertyID::PaddingBottom:
if (auto maybe_used_value = used_value_for_property([](auto const& paintable_box) { return paintable_box.box_model().padding.bottom; }); maybe_used_value.has_value())
return LengthStyleValue::create(Length::make_px(maybe_used_value.release_value()));
return style_value_for_length_percentage_or_auto(layout_node.computed_values().padding().bottom());
case PropertyID::PaddingLeft:
if (auto maybe_used_value = used_value_for_property([](auto const& paintable_box) { return paintable_box.box_model().padding.left; }); maybe_used_value.has_value())
return LengthStyleValue::create(Length::make_px(maybe_used_value.release_value()));
return style_value_for_length_percentage_or_auto(layout_node.computed_values().padding().left());
case PropertyID::PaddingRight:
if (auto maybe_used_value = used_value_for_property([](auto const& paintable_box) { return paintable_box.box_model().padding.right; }); maybe_used_value.has_value())
return LengthStyleValue::create(Length::make_px(maybe_used_value.release_value()));
return style_value_for_length_percentage_or_auto(layout_node.computed_values().padding().right());
case PropertyID::PaddingTop:
if (auto maybe_used_value = used_value_for_property([](auto const& paintable_box) { return paintable_box.box_model().padding.top; }); maybe_used_value.has_value())
return LengthStyleValue::create(Length::make_px(maybe_used_value.release_value()));
return style_value_for_length_percentage_or_auto(layout_node.computed_values().padding().top());
case PropertyID::Width: {
auto maybe_used_width = used_value_for_property([](auto const& paintable_box) { return paintable_box.content_width(); });
if (maybe_used_width.has_value())
return style_value_for_size(Size::make_px(maybe_used_width.release_value()));
return style_value_for_size(layout_node.computed_values().width());
}
// -> bottom
// -> left
// -> inset-block-end
// -> inset-block-start
// -> inset-inline-end
// -> inset-inline-start
// -> right
// -> top
// -> A resolved value special case property like top defined in another specification
// If the property applies to a positioned element and the resolved value of the display property is not
// none or contents, and the property is not over-constrained, then the resolved value is the used value.
// Otherwise the resolved value is the computed value.
case PropertyID::Bottom: {
auto& inset = layout_node.computed_values().inset();
if (auto maybe_used_value = used_value_for_inset(inset.bottom(), inset.top(), [](auto const& paintable_box) { return paintable_box.box_model().inset.bottom; }); maybe_used_value.has_value())
return LengthStyleValue::create(Length::make_px(maybe_used_value.release_value()));
return style_value_for_length_percentage_or_auto(inset.bottom());
}
case PropertyID::Left: {
auto& inset = layout_node.computed_values().inset();
if (auto maybe_used_value = used_value_for_inset(inset.left(), inset.right(), [](auto const& paintable_box) { return paintable_box.box_model().inset.left; }); maybe_used_value.has_value())
return LengthStyleValue::create(Length::make_px(maybe_used_value.release_value()));
return style_value_for_length_percentage_or_auto(inset.left());
}
case PropertyID::Right: {
auto& inset = layout_node.computed_values().inset();
if (auto maybe_used_value = used_value_for_inset(inset.right(), inset.left(), [](auto const& paintable_box) { return paintable_box.box_model().inset.right; }); maybe_used_value.has_value())
return LengthStyleValue::create(Length::make_px(maybe_used_value.release_value()));
return style_value_for_length_percentage_or_auto(inset.right());
}
case PropertyID::Top: {
auto& inset = layout_node.computed_values().inset();
if (auto maybe_used_value = used_value_for_inset(inset.top(), inset.bottom(), [](auto const& paintable_box) { return paintable_box.box_model().inset.top; }); maybe_used_value.has_value())
return LengthStyleValue::create(Length::make_px(maybe_used_value.release_value()));
return style_value_for_length_percentage_or_auto(inset.top());
}
// -> A resolved value special case property defined in another specification
// As defined in the relevant specification.
case PropertyID::Transform: {
auto transformations = layout_node.computed_values().transformations();
if (transformations.is_empty())
return KeywordStyleValue::create(Keyword::None);
// https://drafts.csswg.org/css-transforms-2/#serialization-of-the-computed-value
// The transform property is a resolved value special case property. [CSSOM]
// When the computed value is a <transform-list>, the resolved value is one <matrix()> function or one <matrix3d()> function computed by the following algorithm:
// 1. Let transform be a 4x4 matrix initialized to the identity matrix.
// The elements m11, m22, m33 and m44 of transform must be set to 1; all other elements of transform must be set to 0.
auto transform = FloatMatrix4x4::identity();
// 2. Post-multiply all <transform-function>s in <transform-list> to transform.
VERIFY(layout_node.first_paintable());
auto const& paintable_box = as<Painting::PaintableBox const>(*layout_node.first_paintable());
for (auto transformation : transformations) {
transform = transform * transformation.to_matrix(paintable_box).release_value();
}
// https://drafts.csswg.org/css-transforms-1/#2d-matrix
auto is_2d_matrix = [](Gfx::FloatMatrix4x4 const& matrix) -> bool {
// A 3x2 transformation matrix,
// or a 4x4 matrix where the items m31, m32, m13, m23, m43, m14, m24, m34 are equal to 0
// and m33, m44 are equal to 1.
// NB: We only care about 4x4 matrices here.
// NB: Our elements are 0-indexed not 1-indexed, and in the opposite order.
if (matrix[0, 2] != 0 // m31
|| matrix[1, 2] != 0 // m32
|| matrix[2, 0] != 0 // m13
|| matrix[2, 1] != 0 // m23
|| matrix[2, 3] != 0 // m43
|| matrix[3, 0] != 0 // m14
|| matrix[3, 1] != 0 // m24
|| matrix[3, 2] != 0) // m34
return false;
if (matrix[2, 2] != 1 // m33
|| matrix[3, 3] != 1) // m44
return false;
return true;
};
// 3. Chose between <matrix()> or <matrix3d()> serialization:
// -> If transform is a 2D matrix
// Serialize transform to a <matrix()> function.
if (is_2d_matrix(transform)) {
StyleValueVector parameters {
NumberStyleValue::create(transform[0, 0]),
NumberStyleValue::create(transform[1, 0]),
NumberStyleValue::create(transform[0, 1]),
NumberStyleValue::create(transform[1, 1]),
NumberStyleValue::create(transform[0, 3]),
NumberStyleValue::create(transform[1, 3]),
};
return TransformationStyleValue::create(PropertyID::Transform, TransformFunction::Matrix, move(parameters));
}
// -> Otherwise
// Serialize transform to a <matrix3d()> function.
else {
StyleValueVector parameters {
NumberStyleValue::create(transform[0, 0]),
NumberStyleValue::create(transform[1, 0]),
NumberStyleValue::create(transform[2, 0]),
NumberStyleValue::create(transform[3, 0]),
NumberStyleValue::create(transform[0, 1]),
NumberStyleValue::create(transform[1, 1]),
NumberStyleValue::create(transform[2, 1]),
NumberStyleValue::create(transform[3, 1]),
NumberStyleValue::create(transform[0, 2]),
NumberStyleValue::create(transform[1, 2]),
NumberStyleValue::create(transform[2, 2]),
NumberStyleValue::create(transform[3, 2]),
NumberStyleValue::create(transform[0, 3]),
NumberStyleValue::create(transform[1, 3]),
NumberStyleValue::create(transform[2, 3]),
NumberStyleValue::create(transform[3, 3]),
};
return TransformationStyleValue::create(PropertyID::Transform, TransformFunction::Matrix3d, move(parameters));
}
}
// -> Any other property
// The resolved value is the computed value.
// NOTE: This is handled inside the `default` case.
case PropertyID::Contain: {
auto const& contain = layout_node.computed_values().contain();
if (contain.layout_containment && contain.style_containment && contain.paint_containment) {
if (contain.size_containment)
return KeywordStyleValue::create(Keyword::Strict);
if (!contain.inline_size_containment)
return KeywordStyleValue::create(Keyword::Content);
}
return get_computed_value(property_id);
}
case PropertyID::WebkitTextFillColor:
return resolve_color_style_value(get_computed_value(property_id), layout_node.computed_values().webkit_text_fill_color());
case PropertyID::LetterSpacing: {
// https://drafts.csswg.org/css-text-4/#letter-spacing-property
// For legacy reasons, a computed letter-spacing of zero yields a resolved value (getComputedStyle() return value) of normal.
if (layout_node.computed_values().letter_spacing() == 0)
return KeywordStyleValue::create(Keyword::Normal);
return get_computed_value(property_id);
}
case PropertyID::Custom:
dbgln_if(LIBWEB_CSS_DEBUG, "Computed style for custom properties was requested (?)");
return nullptr;
default:
// For grid-template-columns and grid-template-rows the resolved value is the used value.
// https://www.w3.org/TR/css-grid-2/#resolved-track-list-standalone
if (property_id == PropertyID::GridTemplateColumns) {
if (layout_node.first_paintable() && layout_node.first_paintable()->is_paintable_box()) {
auto const& paintable_box = as<Painting::PaintableBox const>(*layout_node.first_paintable());
if (auto used_values_for_grid_template_columns = paintable_box.used_values_for_grid_template_columns()) {
return used_values_for_grid_template_columns;
}
}
} else if (property_id == PropertyID::GridTemplateRows) {
if (layout_node.first_paintable() && layout_node.first_paintable()->is_paintable_box()) {
auto const& paintable_box = as<Painting::PaintableBox const>(*layout_node.first_paintable());
if (auto used_values_for_grid_template_rows = paintable_box.used_values_for_grid_template_rows()) {
return used_values_for_grid_template_rows;
}
}
} else if (property_id == PropertyID::ZIndex) {
if (auto z_index = layout_node.computed_values().z_index(); z_index.has_value()) {
return NumberStyleValue::create(z_index.value());
}
}
if (!property_is_shorthand(property_id))
return get_computed_value(property_id);
// Handle shorthands in a generic way
auto longhand_ids = longhands_for_shorthand(property_id);
StyleValueVector longhand_values;
longhand_values.ensure_capacity(longhand_ids.size());
for (auto longhand_id : longhand_ids)
longhand_values.append(style_value_for_computed_property(layout_node, longhand_id).release_nonnull());
return ShorthandStyleValue::create(property_id, move(longhand_ids), move(longhand_values));
}
}
// https://drafts.csswg.org/cssom/#dom-cssstyledeclaration-removeproperty
WebIDL::ExceptionOr<String> CSSStyleProperties::remove_property(FlyString const& property_name)
{
return remove_property_internal(PropertyNameAndID::from_name(property_name));
}
// https://drafts.csswg.org/cssom/#dom-cssstyledeclaration-removeproperty
WebIDL::ExceptionOr<String> CSSStyleProperties::remove_property_internal(Optional<PropertyNameAndID> const& property)
{
// 1. If the readonly flag is set, then throw a NoModificationAllowedError exception.
if (is_readonly())
return WebIDL::NoModificationAllowedError::create(realm(), "Cannot remove property: CSSStyleProperties is read-only."_utf16);
// 2. If property is not a custom property, let property be property converted to ASCII lowercase.
// NB: Already done by creating a PropertyNameAndID.
// NB: The spec doesn't reject invalid property names, it just lets them pass through.
// Attempting to remove a non-existent property is a no-op, so we can just skip over this section.
String value;
if (property.has_value()) {
// 3. Let value be the return value of invoking getPropertyValue() with property as argument.
// FIXME: Add an overload that takes PropertyNameAndID?
value = get_property_value(property->name());
Function<bool(PropertyNameAndID const&)> remove_declaration = [&](PropertyNameAndID const& property_to_remove) {
// 4. Let removed be false.
bool removed = false;
// 5. If property is a shorthand property, for each longhand property longhand that property maps to:
if (property_is_shorthand(property_to_remove.id())) {
for (auto longhand_property_id : longhands_for_shorthand(property_to_remove.id())) {
// 1. If longhand is not a property name of a CSS declaration in the declarations, continue.
// 2. Remove that CSS declaration and let removed be true.
removed |= remove_declaration(PropertyNameAndID::from_id(longhand_property_id));
}
} else {
// 6. Otherwise, if property is a case-sensitive match for a property name of a CSS declaration in the declarations, remove that CSS declaration and let removed be true.
if (property_to_remove.is_custom_property()) {
removed = m_custom_properties.remove(property_to_remove.name());
} else {
removed = m_properties.remove_first_matching([&](auto& entry) { return entry.property_id == property_to_remove.id(); });
}
}
return removed;
};
auto removed = remove_declaration(property.value());
// 7. If removed is true, Update style attribute for the CSS declaration block.
if (removed) {
update_style_attribute();
// Non-standard: Invalidate style for the owners of our containing sheet, if any.
invalidate_owners(DOM::StyleInvalidationReason::CSSStylePropertiesRemoveProperty);
}
}
// 8. Return value.
return value;
}
WebIDL::ExceptionOr<String> CSSStyleProperties::remove_property(PropertyID property_name)
{
return remove_property_internal(PropertyNameAndID::from_id(property_name));
}
// https://drafts.csswg.org/cssom/#dom-cssstyleproperties-cssfloat
String CSSStyleProperties::css_float() const
{
// The cssFloat attribute, on getting, must return the result of invoking getPropertyValue() with float as argument.
return get_property_value("float"_fly_string);
}
WebIDL::ExceptionOr<void> CSSStyleProperties::set_css_float(StringView value)
{
// On setting, the attribute must invoke setProperty() with float as first argument, as second argument the given value,
// and no third argument. Any exceptions thrown must be re-thrown.
return set_property("float"_fly_string, value, ""sv);
}
// https://www.w3.org/TR/cssom/#serialize-a-css-declaration-block
String CSSStyleProperties::serialized() const
{
// 1. Let list be an empty array.
Vector<String> list;
// 2. Let already serialized be an empty array.
HashTable<PropertyID> already_serialized;
Function<void(PropertyID)> append_property_to_already_serialized = [&](auto property) {
already_serialized.set(property);
// AD-HOC: The spec assumes that we only store values against expanded longhands, there are however limited
// circumstances where we store against shorthands directly in addition to the expanded longhands. For
// example if the value of the shorthand is unresolved we store an UnresolvedStyleValue against the
// shorthand directly and a PendingSubstitutionStyleValue against each of the longhands. In the case we
// serialize a shorthand directly we should also mark it's longhands as serialized to avoid serializing
// them separately.
if (property_is_shorthand(property)) {
for (auto longhand : longhands_for_shorthand(property))
append_property_to_already_serialized(longhand);
}
};
// NB: The spec treats custom properties the same as any other property, and expects the above loop to handle them.
// However, our implementation separates them from regular properties, so we need to handle them separately here.
// FIXME: Is the relative order of custom properties and regular properties supposed to be preserved?
for (auto const& declaration : m_custom_properties) {
// 1. Let property be declaration’s property name.
auto const& property = declaration.key;
// 2. If property is in already serialized, continue with the steps labeled declaration loop.
// NB: It is never in already serialized, as there are no shorthands for custom properties.
// 3. If property maps to one or more shorthand properties, let shorthands be an array of those shorthand properties, in preferred order.
// NB: There are no shorthands for custom properties.
// 4. Shorthand loop: For each shorthand in shorthands, follow these substeps: ...
// NB: There are no shorthands for custom properties.
// 5. Let value be the result of invoking serialize a CSS value of declaration.
auto value = declaration.value.value->to_string(Web::CSS::SerializationMode::Normal);
// 6. Let serialized declaration be the result of invoking serialize a CSS declaration with property name property, value value,
// and the important flag set if declaration has its important flag set.
// NB: We have to inline this here as the actual implementation does not accept custom properties.
String serialized_declaration = serialize_a_css_declaration(property, value, declaration.value.important);
// 7. Append serialized declaration to list.
list.append(move(serialized_declaration));
// 8. Append property to already serialized.
// NB: We don't need to do this, as we don't have shorthands for custom properties.
}
// 3. Declaration loop: For each CSS declaration declaration in declaration block’s declarations, follow these substeps:
for (auto& declaration : m_properties) {
// 1. Let property be declaration’s property name.
auto property = declaration.property_id;
// 2. If property is in already serialized, continue with the steps labeled declaration loop.
if (already_serialized.contains(property))
continue;
// 3. If property maps to one or more shorthand properties, let shorthands be an array of those shorthand properties, in preferred order.
if (property_maps_to_shorthand(property)) {
auto shorthands = shorthands_for_longhand(property);
// 4. Shorthand loop: For each shorthand in shorthands, follow these substeps:
for (auto shorthand : shorthands) {
// 1. Let longhands be an array consisting of all CSS declarations in declaration block’s declarations
// that are not in already serialized and have a property name that maps to one of the shorthand
// properties in shorthands.
Vector<StyleProperty> longhands;
for (auto const& longhand_declaration : m_properties) {
if (!already_serialized.contains(longhand_declaration.property_id) && shorthands_for_longhand(longhand_declaration.property_id).contains_slow(shorthand))
longhands.append(longhand_declaration);
}
// 2. If not all properties that map to shorthand are present in longhands, continue with the steps labeled shorthand loop.
if (any_of(expanded_longhands_for_shorthand(shorthand), [&](auto longhand_id) { return !any_of(longhands, [&](auto const& longhand_declaration) { return longhand_declaration.property_id == longhand_id; }); }))
continue;
// 3. Let current longhands be an empty array.
Vector<StyleProperty> current_longhands;
// 4. Append all CSS declarations in longhands that have a property name that maps to shorthand to current longhands.
for (auto const& longhand : longhands) {
if (shorthands_for_longhand(longhand.property_id).contains_slow(shorthand))
current_longhands.append(longhand);
}
// 5. If there are one or more CSS declarations in current longhands have their important flag set and
// one or more with it unset, continue with the steps labeled shorthand loop.
auto all_declarations_have_same_important_flag = true;
for (size_t i = 1; i < current_longhands.size(); ++i) {
if (current_longhands[i].important != current_longhands[0].important) {
all_declarations_have_same_important_flag = false;
break;
}
}
if (!all_declarations_have_same_important_flag)
continue;
// 6. If there is any declaration in declaration block in between the first and the last longhand
// in current longhands which belongs to the same logical property group, but has a different
// mapping logic as any of the longhands in current longhands, and is not in current
// longhands, continue with the steps labeled shorthand loop.
auto first_current_longhand_index = m_properties.find_first_index_if([&](StyleProperty const& current_declaration) { return current_declaration.property_id == current_longhands[0].property_id; });
auto last_current_longhand_index = m_properties.find_first_index_if([&](StyleProperty const& current_declaration) { return current_declaration.property_id == current_longhands[current_longhands.size() - 1].property_id; });
VERIFY(first_current_longhand_index.has_value());
VERIFY(last_current_longhand_index.has_value());
bool should_continue = false;
for (auto current_declaration_index = first_current_longhand_index.value(); current_declaration_index <= last_current_longhand_index.value(); ++current_declaration_index) {
// NB: Declaration is in current longhands
if (any_of(current_longhands, [&](auto const& current_longhand) { return current_longhand.property_id == m_properties[current_declaration_index].property_id; }))
continue;
auto logical_property_group_for_current_declaration = logical_property_group_for_property(m_properties[current_declaration_index].property_id);
if (!logical_property_group_for_current_declaration.has_value())
continue;
auto current_declaration_is_logical_alias = property_is_logical_alias(m_properties[current_declaration_index].property_id);
// NB: Declaration has any counterpart in current longhands with same logical property group but different mapping logic
if (any_of(current_longhands, [&](auto const& current_longhand) { return logical_property_group_for_property(current_longhand.property_id) == logical_property_group_for_current_declaration && property_is_logical_alias(current_longhand.property_id) != current_declaration_is_logical_alias; })) {
should_continue = true;
break;
}
}
if (should_continue)
continue;
// 7. Let value be the result of invoking serialize a CSS value with current longhands.
auto value = serialize_a_css_value(current_longhands);
// 8. If value is the empty string, continue with the steps labeled shorthand loop.
if (value.is_empty())
continue;
// 9. Let serialized declaration be the result of invoking serialize a CSS declaration with property
// name shorthand, value value, and the important flag set if the CSS declarations in current
// longhands have their important flag set.
auto serialized_declaration = serialize_a_css_declaration(string_from_property_id(shorthand), move(value), current_longhands.first().important);
// 10. Append serialized declaration to list.
list.append(move(serialized_declaration));
// 11. Append the property names of all items of current longhands to already serialized.
for (auto const& longhand : current_longhands)
append_property_to_already_serialized(longhand.property_id);
// 12. Continue with the steps labeled declaration loop.
}
}
// FIXME: File spec issue that this should only be run if we haven't serialized this declaration in the above shorthand loop.
if (!already_serialized.contains(declaration.property_id)) {
// 5. Let value be the result of invoking serialize a CSS value of declaration.
auto value = serialize_a_css_value(declaration);
// 6. Let serialized declaration be the result of invoking serialize a CSS declaration with property name property, value value,
// and the important flag set if declaration has its important flag set.
auto serialized_declaration = serialize_a_css_declaration(string_from_property_id(property), move(value), declaration.important);
// 7. Append serialized declaration to list.
list.append(move(serialized_declaration));
// 8. Append property to already serialized.
append_property_to_already_serialized(declaration.property_id);
}
}
// 4. Return list joined with " " (U+0020).
StringBuilder builder;
builder.join(' ', list);
return MUST(builder.to_string());
}
// https://www.w3.org/TR/cssom/#serialize-a-css-value
String CSSStyleProperties::serialize_a_css_value(StyleProperty const& declaration) const
{
// 1. If If this algorithm is invoked with a list list:
// NOTE: This is handled in other other overload of this method
// 2. Represent the value of the declaration as a list of CSS component values components that, when parsed
// according to the property’s grammar, would represent that value. Additionally:
// - If certain component values can appear in any order without changing the meaning of the value (a pattern
// typically represented by a double bar || in the value syntax), reorder the component values to use the
// canonical order of component values as given in the property definition table.
// - If component values can be omitted or replaced with a shorter representation without changing the meaning
// of the value, omit/replace them.
// - If either of the above syntactic translations would be less backwards-compatible, do not perform them.
// Spec Note: The rules described here outlines the general principles of serialization. For legacy reasons, some
// properties serialize in a different manner, which is intentionally undefined here due to lack of
// resources. Please consult your local reverse-engineer for details.
// 3. Remove any <whitespace-token>s from components.
// 4. Replace each component value in components with the result of invoking serialize a CSS component value.
// 5. Join the items of components into a single string, inserting " " (U+0020 SPACE) between each pair of items
// unless the second item is a "," (U+002C COMMA) Return the result.
// AD-HOC: As the spec is vague we don't follow it exactly here.
return declaration.value->to_string(Web::CSS::SerializationMode::Normal);
}
// https://www.w3.org/TR/cssom/#serialize-a-css-value
String CSSStyleProperties::serialize_a_css_value(Vector<StyleProperty> list) const
{
if (list.is_empty())
return String {};
// 1. Let shorthand be the first shorthand property, in preferred order, that exactly maps to all of the longhand properties in list.
Optional<PropertyID> shorthand = shorthands_for_longhand(list.first().property_id).first_matching([&](PropertyID shorthand) {
auto longhands_for_potential_shorthand = expanded_longhands_for_shorthand(shorthand);
// The potential shorthand exactly maps to all of the longhand properties in list if:
// a. The number of longhand properties in the list is equal to the number of longhand properties that the potential shorthand maps to.
if (longhands_for_potential_shorthand.size() != list.size())
return false;
// b. All longhand properties in the list are contained in the list of longhands for the potential shorthand.
return all_of(longhands_for_potential_shorthand, [&](auto longhand) { return any_of(list, [&](auto const& declaration) { return declaration.property_id == longhand; }); });
});
// 2. If there is no such shorthand or shorthand cannot exactly represent the values of all the properties in list, return the empty string.
if (!shorthand.has_value())
return String {};
// 3. Otherwise, serialize a CSS value from a hypothetical declaration of the property shorthand with its value representing the combined values of the declarations in list.
Function<ValueComparingNonnullRefPtr<ShorthandStyleValue const>(PropertyID)> make_shorthand_value = [&](PropertyID shorthand_id) {
auto longhand_ids = longhands_for_shorthand(shorthand_id);
Vector<ValueComparingNonnullRefPtr<StyleValue const>> longhand_values;
for (auto longhand_id : longhand_ids) {
if (property_is_shorthand(longhand_id))
longhand_values.append(make_shorthand_value(longhand_id));
else
longhand_values.append(list.first_matching([&](auto declaration) { return declaration.property_id == longhand_id; })->value);
}
return ShorthandStyleValue::create(shorthand_id, longhand_ids, longhand_values);
};
// FIXME: Not all shorthands are represented by ShorthandStyleValue, we still need to add support for those that don't.
return make_shorthand_value(shorthand.value())->to_string(SerializationMode::Normal);
}
// https://drafts.csswg.org/cssom/#dom-cssstyledeclaration-csstext
WebIDL::ExceptionOr<void> CSSStyleProperties::set_css_text(StringView css_text)
{
// 1. If the readonly flag is set, then throw a NoModificationAllowedError exception.
if (is_readonly()) {
return WebIDL::NoModificationAllowedError::create(realm(), "Cannot modify properties: CSSStyleProperties is read-only."_utf16);
}
// 2. Empty the declarations.
// 3. Parse the given value and, if the return value is not the empty list, insert the items in the list into the declarations, in specified order.
set_declarations_from_text(css_text);
// 4. Update style attribute for the CSS declaration block.
update_style_attribute();
// Non-standard: Invalidate style for the owners of our containing sheet, if any.
invalidate_owners(DOM::StyleInvalidationReason::CSSStylePropertiesTextChange);
return {};
}
void CSSStyleProperties::invalidate_owners(DOM::StyleInvalidationReason reason)
{
if (auto rule = parent_rule()) {
if (auto sheet = rule->parent_style_sheet()) {
sheet->invalidate_owners(reason);
}
}
}
// https://drafts.csswg.org/cssom/#set-a-css-declaration
bool CSSStyleProperties::set_a_css_declaration(PropertyID property_id, NonnullRefPtr<StyleValue const> value, Important important)
{
VERIFY(!is_computed());
// NOTE: The below algorithm is only suggested rather than required by the spec
// https://drafts.csswg.org/cssom/#example-a40690cb
// 1. If property is a case-sensitive match for a property name of a CSS declaration in declarations, follow these substeps:
auto maybe_target_index = m_properties.find_first_index_if([&](auto declaration) { return declaration.property_id == property_id; });
if (maybe_target_index.has_value()) {
// 1. Let target declaration be such CSS declaration.
auto target_declaration = m_properties[maybe_target_index.value()];
// 2. Let needs append be false.
bool needs_append = false;
auto logical_property_group_for_set_property = logical_property_group_for_property(property_id);
// NOTE: If the property of the declaration being set has no logical property group then it's not possible for
// one of the later declarations to share that logical property group so we can skip checking.
if (logical_property_group_for_set_property.has_value()) {
auto set_property_is_logical_alias = property_is_logical_alias(property_id);
// 3. For each declaration in declarations after target declaration:
for (size_t i = maybe_target_index.value() + 1; i < m_properties.size(); ++i) {
// 1. If declaration’s property name is not in the same logical property group as property, then continue.
if (logical_property_group_for_property(m_properties[i].property_id) != logical_property_group_for_set_property)
continue;
// 2. If declaration’ property name has the same mapping logic as property, then continue.
if (property_is_logical_alias(m_properties[i].property_id) == set_property_is_logical_alias)
continue;
// 3. Let needs append be true.
needs_append = true;
// 4. Break.
break;
}
}
// 4. If needs append is false, then:
if (!needs_append) {
// 1. Let needs update be false.
bool needs_update = false;
// 2. If target declaration’s value is not equal to component value list, then let needs update be true.
if (*target_declaration.value != *value)
needs_update = true;
// 3. If target declaration’s important flag is not equal to whether important flag is set, then let needs update be true.
if (target_declaration.important != important)
needs_update = true;
// 4. If needs update is false, then return false.
if (!needs_update)
return false;
// 5. Set target declaration’s value to component value list.
m_properties[maybe_target_index.value()].value = move(value);
// 6. If important flag is set, then set target declaration’s important flag, otherwise unset it.
m_properties[maybe_target_index.value()].important = important;
// 7. Return true.
return true;
}
// 5. Otherwise, remove target declaration from declarations.
m_properties.remove(maybe_target_index.value());
}
// 2. Append a new CSS declaration with property name property, value component value list, and important flag set
// if important flag is set to declarations.
m_properties.append(StyleProperty {
.important = important,
.property_id = property_id,
.value = move(value),
});
// 3. Return true
return true;
}
void CSSStyleProperties::empty_the_declarations()
{
m_properties.clear();
m_custom_properties.clear();
}
void CSSStyleProperties::set_the_declarations(Vector<StyleProperty> properties, OrderedHashMap<FlyString, StyleProperty> custom_properties)
{
m_properties = convert_declarations_to_specified_order(properties);
m_custom_properties = move(custom_properties);
}
void CSSStyleProperties::set_declarations_from_text(StringView css_text)
{
empty_the_declarations();
auto parsing_params = owner_node().has_value()
? Parser::ParsingParams(owner_node()->element().document())
: Parser::ParsingParams();
parsing_params.rule_context.append(Parser::RuleContext::Style);
auto style = parse_css_property_declaration_block(parsing_params, css_text);
set_the_declarations(style.properties, style.custom_properties);
}
}