1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at https://mozilla.org/MPL/2.0/. */
//! Utilities for querying the layout, as needed by layout.
use std::sync::Arc;
use app_units::Au;
use euclid::default::{Point2D, Rect};
use euclid::{SideOffsets2D, Size2D, Vector2D};
use log::warn;
use script_layout_interface::wrapper_traits::{
LayoutNode, ThreadSafeLayoutElement, ThreadSafeLayoutNode,
};
use script_layout_interface::{LayoutElementType, LayoutNodeType, OffsetParentResponse};
use servo_arc::Arc as ServoArc;
use servo_url::ServoUrl;
use style::computed_values::display::T as Display;
use style::computed_values::position::T as Position;
use style::computed_values::visibility::T as Visibility;
use style::computed_values::white_space_collapse::T as WhiteSpaceCollapseValue;
use style::context::{QuirksMode, SharedStyleContext, StyleContext, ThreadLocalStyleContext};
use style::dom::{OpaqueNode, TElement};
use style::properties::style_structs::Font;
use style::properties::{
parse_one_declaration_into, ComputedValues, Importance, LonghandId, PropertyDeclarationBlock,
PropertyDeclarationId, PropertyId, ShorthandId, SourcePropertyDeclaration,
};
use style::selector_parser::PseudoElement;
use style::shared_lock::SharedRwLock;
use style::stylesheets::{CssRuleType, Origin, UrlExtraData};
use style::stylist::RuleInclusion;
use style::traversal::resolve_style;
use style::values::computed::Float;
use style::values::generics::font::LineHeight;
use style_traits::{ParsingMode, ToCss};
use crate::flow::inline::construct::{TextTransformation, WhitespaceCollapse};
use crate::fragment_tree::{BoxFragment, Fragment, FragmentFlags, FragmentTree, Tag};
use crate::geom::{PhysicalRect, PhysicalVec};
pub fn process_content_box_request(
requested_node: OpaqueNode,
fragment_tree: Option<Arc<FragmentTree>>,
) -> Option<Rect<Au>> {
let rects = fragment_tree?.get_content_boxes_for_node(requested_node);
if rects.is_empty() {
return None;
}
Some(
rects
.iter()
.fold(Rect::zero(), |unioned_rect, rect| rect.union(&unioned_rect)),
)
}
pub fn process_content_boxes_request(
requested_node: OpaqueNode,
fragment_tree: Option<Arc<FragmentTree>>,
) -> Vec<Rect<Au>> {
fragment_tree
.map(|tree| tree.get_content_boxes_for_node(requested_node))
.unwrap_or_default()
}
pub fn process_node_geometry_request(
requested_node: OpaqueNode,
fragment_tree: Option<Arc<FragmentTree>>,
) -> Rect<i32> {
if let Some(fragment_tree) = fragment_tree {
fragment_tree.get_border_dimensions_for_node(requested_node)
} else {
Rect::zero()
}
}
/// <https://drafts.csswg.org/cssom-view/#scrolling-area>
pub fn process_node_scroll_area_request(
requested_node: Option<OpaqueNode>,
fragment_tree: Option<Arc<FragmentTree>>,
) -> Rect<i32> {
let rect = match (fragment_tree, requested_node) {
(Some(tree), Some(node)) => tree.get_scrolling_area_for_node(node),
(Some(tree), None) => tree.get_scrolling_area_for_viewport(),
_ => return Rect::zero(),
};
Rect::new(
Point2D::new(rect.origin.x.to_f32_px(), rect.origin.y.to_f32_px()),
Size2D::new(rect.size.width.to_f32_px(), rect.size.height.to_f32_px()),
)
.round()
.to_i32()
.to_untyped()
}
/// Return the resolved value of property for a given (pseudo)element.
/// <https://drafts.csswg.org/cssom/#resolved-value>
pub fn process_resolved_style_request<'dom>(
context: &SharedStyleContext,
node: impl LayoutNode<'dom>,
pseudo: &Option<PseudoElement>,
property: &PropertyId,
fragment_tree: Option<Arc<FragmentTree>>,
) -> String {
if !node.as_element().unwrap().has_data() {
return process_resolved_style_request_for_unstyled_node(context, node, pseudo, property);
}
// We call process_resolved_style_request after performing a whole-document
// traversal, so in the common case, the element is styled.
let layout_element = node.to_threadsafe().as_element().unwrap();
let layout_element = match *pseudo {
None => Some(layout_element),
Some(PseudoElement::Before) => layout_element.get_before_pseudo(),
Some(PseudoElement::After) => layout_element.get_after_pseudo(),
Some(_) => {
warn!("Got unexpected pseudo element type!");
None
},
};
let layout_element = match layout_element {
None => {
// The pseudo doesn't exist, return nothing. Chrome seems to query
// the element itself in this case, Firefox uses the resolved value.
// https://www.w3.org/Bugs/Public/show_bug.cgi?id=29006
return String::new();
},
Some(layout_element) => layout_element,
};
let style = &*layout_element.resolved_style();
let longhand_id = match *property {
PropertyId::NonCustom(id) => match id.longhand_or_shorthand() {
Ok(longhand_id) => longhand_id,
Err(shorthand_id) => return shorthand_to_css_string(shorthand_id, style),
},
PropertyId::Custom(ref name) => {
return style.computed_value_to_string(PropertyDeclarationId::Custom(name));
},
}
.to_physical(style.writing_mode);
let computed_style =
|| style.computed_value_to_string(PropertyDeclarationId::Longhand(longhand_id));
let tag_to_find = Tag::new_pseudo(node.opaque(), *pseudo);
// https://drafts.csswg.org/cssom/#dom-window-getcomputedstyle
// Here we are trying to conform to the specification that says that getComputedStyle
// should return the used values in certain circumstances. For size and positional
// properties we might need to walk the Fragment tree to figure those out. We always
// fall back to returning the computed value.
// For line height, the resolved value is the computed value if it
// is "normal" and the used value otherwise.
if longhand_id == LonghandId::LineHeight {
let font = style.get_font();
let font_size = font.font_size.computed_size();
return match font.line_height {
LineHeight::Normal => computed_style(),
LineHeight::Number(value) => (font_size * value.0).to_css_string(),
LineHeight::Length(value) => value.0.to_css_string(),
};
}
// https://drafts.csswg.org/cssom/#dom-window-getcomputedstyle
// The properties that we calculate below all resolve to the computed value
// when the element is display:none or display:contents.
let display = style.get_box().display;
if display.is_none() || display.is_contents() {
return computed_style();
}
let fragment_tree = match fragment_tree {
Some(fragment_tree) => fragment_tree,
None => return computed_style(),
};
fragment_tree
.find(|fragment, _, containing_block| {
if Some(tag_to_find) != fragment.tag() {
return None;
}
let (content_rect, margins, padding) = match fragment {
Fragment::Box(ref box_fragment) | Fragment::Float(ref box_fragment) => {
if style.get_box().position != Position::Static {
let resolved_insets = || {
box_fragment.calculate_resolved_insets_if_positioned(containing_block)
};
match longhand_id {
LonghandId::Top => return Some(resolved_insets().top.to_css_string()),
LonghandId::Right => {
return Some(resolved_insets().right.to_css_string())
},
LonghandId::Bottom => {
return Some(resolved_insets().bottom.to_css_string())
},
LonghandId::Left => {
return Some(resolved_insets().left.to_css_string())
},
_ => {},
}
}
let content_rect = box_fragment.content_rect;
let margins = box_fragment.margin;
let padding = box_fragment.padding;
(content_rect, margins, padding)
},
Fragment::Positioning(positioning_fragment) => {
let content_rect = positioning_fragment.rect;
(content_rect, SideOffsets2D::zero(), SideOffsets2D::zero())
},
_ => return None,
};
// https://drafts.csswg.org/cssom/#resolved-value-special-case-property-like-height
// > 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.
//
// However, all browsers ignore that for margin and padding properties, and resolve to a length
// even if the property doesn't apply: https://github.com/w3c/csswg-drafts/issues/10391
match longhand_id {
LonghandId::Width if resolved_size_should_be_used_value(fragment) => {
Some(content_rect.size.width)
},
LonghandId::Height if resolved_size_should_be_used_value(fragment) => {
Some(content_rect.size.height)
},
LonghandId::MarginBottom => Some(margins.bottom),
LonghandId::MarginTop => Some(margins.top),
LonghandId::MarginLeft => Some(margins.left),
LonghandId::MarginRight => Some(margins.right),
LonghandId::PaddingBottom => Some(padding.bottom),
LonghandId::PaddingTop => Some(padding.top),
LonghandId::PaddingLeft => Some(padding.left),
LonghandId::PaddingRight => Some(padding.right),
_ => None,
}
.map(|value| value.to_css_string())
})
.unwrap_or_else(computed_style)
}
fn resolved_size_should_be_used_value(fragment: &Fragment) -> bool {
// https://drafts.csswg.org/css-sizing-3/#preferred-size-properties
// > Applies to: all elements except non-replaced inlines
match fragment {
Fragment::Box(box_fragment) => !box_fragment.is_inline_box(),
Fragment::Float(_) |
Fragment::Positioning(_) |
Fragment::AbsoluteOrFixedPositioned(_) |
Fragment::Image(_) |
Fragment::IFrame(_) => true,
Fragment::Text(_) => false,
}
}
pub fn process_resolved_style_request_for_unstyled_node<'dom>(
context: &SharedStyleContext,
node: impl LayoutNode<'dom>,
pseudo: &Option<PseudoElement>,
property: &PropertyId,
) -> String {
// In a display: none subtree. No pseudo-element exists.
if pseudo.is_some() {
return String::new();
}
let mut tlc = ThreadLocalStyleContext::new();
let mut context = StyleContext {
shared: context,
thread_local: &mut tlc,
};
let element = node.as_element().unwrap();
let styles = resolve_style(
&mut context,
element,
RuleInclusion::All,
pseudo.as_ref(),
None,
);
let style = styles.primary();
let longhand_id = match *property {
PropertyId::NonCustom(id) => match id.longhand_or_shorthand() {
Ok(longhand_id) => longhand_id,
Err(shorthand_id) => return shorthand_to_css_string(shorthand_id, style),
},
PropertyId::Custom(ref name) => {
return style.computed_value_to_string(PropertyDeclarationId::Custom(name));
},
};
// No need to care about used values here, since we're on a display: none
// subtree, use the resolved value.
style.computed_value_to_string(PropertyDeclarationId::Longhand(longhand_id))
}
fn shorthand_to_css_string(
id: style::properties::ShorthandId,
style: &style::properties::ComputedValues,
) -> String {
use style::values::resolved::Context;
let mut block = PropertyDeclarationBlock::new();
let mut dest = String::new();
for longhand in id.longhands() {
block.push(
style.computed_or_resolved_declaration(longhand, Some(&Context { style })),
Importance::Normal,
);
}
match block.shorthand_to_css(id, &mut dest) {
Ok(_) => dest.to_owned(),
Err(_) => String::new(),
}
}
pub fn process_offset_parent_query(
node: OpaqueNode,
fragment_tree: Option<Arc<FragmentTree>>,
) -> OffsetParentResponse {
process_offset_parent_query_inner(node, fragment_tree).unwrap_or_default()
}
#[inline]
fn process_offset_parent_query_inner(
node: OpaqueNode,
fragment_tree: Option<Arc<FragmentTree>>,
) -> Option<OffsetParentResponse> {
let fragment_tree = fragment_tree?;
struct NodeOffsetBoxInfo {
border_box: Rect<Au>,
offset_parent_node_address: Option<OpaqueNode>,
is_static_body_element: bool,
}
// https://www.w3.org/TR/2016/WD-cssom-view-1-20160317/#extensions-to-the-htmlelement-interface
let mut parent_node_addresses: Vec<Option<(OpaqueNode, bool)>> = Vec::new();
let tag_to_find = Tag::new(node);
let node_offset_box = fragment_tree.find(|fragment, level, containing_block| {
let base = fragment.base()?;
let is_body_element = base
.flags
.contains(FragmentFlags::IS_BODY_ELEMENT_OF_HTML_ELEMENT_ROOT);
if fragment.tag() == Some(tag_to_find) {
// Only consider the first fragment of the node found as per a
// possible interpretation of the specification: "[...] return the
// y-coordinate of the top border edge of the first CSS layout box
// associated with the element [...]"
//
// FIXME: Browsers implement this all differently (e.g., [1]) -
// Firefox does returns the union of all layout elements of some
// sort. Chrome returns the first fragment for a block element (the
// same as ours) or the union of all associated fragments in the
// first containing block fragment for an inline element. We could
// implement Chrome's behavior, but our fragment tree currently
// provides insufficient information.
//
// [1]: https://github.com/w3c/csswg-drafts/issues/4541
let fragment_relative_rect = match fragment {
Fragment::Box(fragment) | Fragment::Float(fragment) => fragment.border_rect(),
Fragment::Text(fragment) => fragment.rect,
Fragment::Positioning(fragment) => fragment.rect,
Fragment::AbsoluteOrFixedPositioned(_) |
Fragment::Image(_) |
Fragment::IFrame(_) => unreachable!(),
};
let mut border_box = fragment_relative_rect.translate(containing_block.origin.to_vector()).to_untyped();
// "If any of the following holds true return null and terminate
// this algorithm: [...] The element’s computed value of the
// `position` property is `fixed`."
let is_fixed = matches!(
fragment, Fragment::Box(fragment) if fragment.style.get_box().position == Position::Fixed
);
if is_body_element {
// "If the element is the HTML body element or [...] return zero
// and terminate this algorithm."
border_box.origin = Point2D::zero();
}
let offset_parent_node = if is_fixed {
None
} else {
// Find the nearest ancestor element eligible as `offsetParent`.
parent_node_addresses[..level]
.iter()
.rev()
.cloned()
.find_map(std::convert::identity)
};
Some(NodeOffsetBoxInfo {
border_box,
offset_parent_node_address: offset_parent_node.map(|node| node.0),
is_static_body_element: offset_parent_node.is_some_and(|node| node.1),
})
} else {
// Record the paths of the nodes being traversed.
let parent_node_address = match fragment {
Fragment::Box(fragment) | Fragment::Float(fragment) => {
let is_eligible_parent = is_eligible_parent(fragment);
let is_static_body_element = is_body_element &&
fragment.style.get_box().position == Position::Static;
match base.tag {
Some(tag) if is_eligible_parent && !tag.is_pseudo() => {
Some((tag.node, is_static_body_element))
},
_ => None,
}
},
Fragment::AbsoluteOrFixedPositioned(_) |
Fragment::IFrame(_) |
Fragment::Image(_) |
Fragment::Positioning(_) |
Fragment::Text(_) => None,
};
while parent_node_addresses.len() <= level {
parent_node_addresses.push(None);
}
parent_node_addresses[level] = parent_node_address;
None
}
});
// Bail out if the element doesn't have an associated fragment.
// "If any of the following holds true return null and terminate this
// algorithm: [...] The element does not have an associated CSS layout box."
// (`offsetParent`) "If the element is the HTML body element [...] return
// zero and terminate this algorithm." (others)
let node_offset_box = node_offset_box?;
let offset_parent_padding_box_corner = if let Some(offset_parent_node_address) =
node_offset_box.offset_parent_node_address
{
// The spec (https://www.w3.org/TR/cssom-view-1/#extensions-to-the-htmlelement-interface)
// says that offsetTop/offsetLeft are always relative to the padding box of the offsetParent.
// However, in practice this is not true in major browsers in the case that the offsetParent is the body
// element and the body element is position:static. In that case offsetLeft/offsetTop are computed
// relative to the root node's border box.
if node_offset_box.is_static_body_element {
fn extract_box_fragment(
fragment: &Fragment,
containing_block: &PhysicalRect<Au>,
) -> PhysicalVec<Au> {
let (Fragment::Box(fragment) | Fragment::Float(fragment)) = fragment else {
unreachable!();
};
// Again, take the *first* associated CSS layout box.
fragment.border_rect().origin.to_vector() + containing_block.origin.to_vector()
}
let containing_block = &fragment_tree.initial_containing_block;
let fragment = &(*fragment_tree.root_fragments[0].borrow());
if let Fragment::AbsoluteOrFixedPositioned(shared_fragment) = fragment {
let shared_fragment = &*shared_fragment.borrow();
let fragment = &*shared_fragment.fragment.as_ref().unwrap().borrow();
extract_box_fragment(fragment, containing_block)
} else {
extract_box_fragment(fragment, containing_block)
}
} else {
// Find the top and left padding edges of "the first CSS layout box
// associated with the `offsetParent` of the element".
//
// Since we saw `offset_parent_node_address` once, we should be able
// to find it again.
let offset_parent_node_tag = Tag::new(offset_parent_node_address);
fragment_tree
.find(|fragment, _, containing_block| {
match fragment {
Fragment::Box(fragment) | Fragment::Float(fragment) => {
if fragment.base.tag == Some(offset_parent_node_tag) {
// Again, take the *first* associated CSS layout box.
let padding_box_corner = fragment.padding_rect().origin.to_vector()
+ containing_block.origin.to_vector();
Some(padding_box_corner)
} else {
None
}
},
Fragment::AbsoluteOrFixedPositioned(_)
| Fragment::Text(_)
| Fragment::Image(_)
| Fragment::IFrame(_)
| Fragment::Positioning(_) => None,
}
})
.unwrap()
}
} else {
// "If the offsetParent of the element is null," subtract zero in the
// following step.
Vector2D::zero()
};
Some(OffsetParentResponse {
node_address: node_offset_box.offset_parent_node_address.map(Into::into),
// "Return the result of subtracting the x-coordinate of the left
// padding edge of the first CSS layout box associated with the
// `offsetParent` of the element from the x-coordinate of the left
// border edge of the first CSS layout box associated with the element,
// relative to the initial containing block origin, ignoring any
// transforms that apply to the element and its ancestors." (and vice
// versa for the top border edge)
rect: node_offset_box
.border_box
.translate(-offset_parent_padding_box_corner.to_untyped()),
})
}
/// Returns whether or not the element with the given style and body element determination
/// is eligible to be a parent element for offset* queries.
///
/// From <https://www.w3.org/TR/cssom-view-1/#dom-htmlelement-offsetparent>:
/// >
/// > Return the nearest ancestor element of the element for which at least one of the following is
/// > true and terminate this algorithm if such an ancestor is found:
/// > 1. The computed value of the position property is not static.
/// > 2. It is the HTML body element.
/// > 3. The computed value of the position property of the element is static and the ancestor is
/// > one of the following HTML elements: td, th, or table.
fn is_eligible_parent(fragment: &BoxFragment) -> bool {
fragment
.base
.flags
.contains(FragmentFlags::IS_BODY_ELEMENT_OF_HTML_ELEMENT_ROOT) ||
fragment.style.get_box().position != Position::Static ||
fragment
.base
.flags
.contains(FragmentFlags::IS_TABLE_TH_OR_TD_ELEMENT)
}
/// <https://html.spec.whatwg.org/multipage/#get-the-text-steps>
pub fn get_the_text_steps<'dom>(node: impl LayoutNode<'dom>) -> String {
// Step 1: If element is not being rendered or if the user agent is a non-CSS user agent, then
// return element's descendant text content.
// This is taken care of in HTMLElemnent code
// Step 2: Let results be a new empty list.
let mut results = Vec::new();
let mut max_req_line_break_count = 0;
// Step 3: For each child node node of element:
let mut state = Default::default();
for child in node.dom_children() {
// Step 1: Let current be the list resulting in running the rendered text collection steps with node.
let mut current = rendered_text_collection_steps(child, &mut state);
// Step 2: For each item item in current, append item to results.
results.append(&mut current);
}
let mut output = Vec::new();
for item in results {
match item {
InnerOrOuterTextItem::Text(s) => {
// Step 3.
if !s.is_empty() {
if max_req_line_break_count > 0 {
// Step 5.
output.push("\u{000A}".repeat(max_req_line_break_count));
max_req_line_break_count = 0;
}
output.push(s);
}
},
InnerOrOuterTextItem::RequiredLineBreakCount(count) => {
// Step 4.
if output.is_empty() {
// Remove required line break count at the start.
continue;
}
// Store the count if it's the max of this run, but it may be ignored if no text
// item is found afterwards, which means that these are consecutive line breaks at
// the end.
if count > max_req_line_break_count {
max_req_line_break_count = count;
}
},
}
}
output.into_iter().collect()
}
enum InnerOrOuterTextItem {
Text(String),
RequiredLineBreakCount(usize),
}
#[derive(Clone)]
struct RenderedTextCollectionState {
/// Used to make sure we don't add a `\n` before the first row
first_table_row: bool,
/// Used to make sure we don't add a `\t` before the first column
first_table_cell: bool,
/// Keeps track of whether we're inside a table, since there are special rules like ommiting everything that's not
/// inside a TableCell/TableCaption
within_table: bool,
/// Determines whether we truncate leading whitespaces for normal nodes or not
may_start_with_whitespace: bool,
/// Is set whenever we truncated a white space char, used to prepend a single space before the next element,
/// that way we truncate trailing white space without having to look ahead
did_truncate_trailing_white_space: bool,
/// Is set to true when we're rendering the children of TableCell/TableCaption elements, that way we render
/// everything inside those as normal, while omitting everything that's in a Table but NOT in a Cell/Caption
within_table_content: bool,
}
impl Default for RenderedTextCollectionState {
fn default() -> Self {
RenderedTextCollectionState {
first_table_row: true,
first_table_cell: true,
may_start_with_whitespace: true,
did_truncate_trailing_white_space: false,
within_table: false,
within_table_content: false,
}
}
}
/// <https://html.spec.whatwg.org/multipage/#rendered-text-collection-steps>
fn rendered_text_collection_steps<'dom>(
node: impl LayoutNode<'dom>,
state: &mut RenderedTextCollectionState,
) -> Vec<InnerOrOuterTextItem> {
// Step 1. Let items be the result of running the rendered text collection
// steps with each child node of node in tree order,
// and then concatenating the results to a single list.
let mut items = vec![];
if !node.is_connected() || !(node.is_element() || node.is_text_node()) {
return items;
}
match node.type_id() {
LayoutNodeType::Text => {
if let Some(element) = node.parent_node() {
match element.type_id() {
// Any text contained in these elements must be ignored.
LayoutNodeType::Element(LayoutElementType::HTMLCanvasElement) |
LayoutNodeType::Element(LayoutElementType::HTMLImageElement) |
LayoutNodeType::Element(LayoutElementType::HTMLIFrameElement) |
LayoutNodeType::Element(LayoutElementType::HTMLObjectElement) |
LayoutNodeType::Element(LayoutElementType::HTMLInputElement) |
LayoutNodeType::Element(LayoutElementType::HTMLTextAreaElement) |
LayoutNodeType::Element(LayoutElementType::HTMLMediaElement) => {
return items;
},
// Select/Option/OptGroup elements are handled a bit differently.
// Basically: a Select can only contain Options or OptGroups, while
// OptGroups may also contain Options. Everything else gets ignored.
LayoutNodeType::Element(LayoutElementType::HTMLOptGroupElement) => {
if let Some(element) = element.parent_node() {
if !matches!(
element.type_id(),
LayoutNodeType::Element(LayoutElementType::HTMLSelectElement)
) {
return items;
}
} else {
return items;
}
},
LayoutNodeType::Element(LayoutElementType::HTMLSelectElement) => return items,
_ => {},
}
// Tables are also a bit special, mainly by only allowing
// content within TableCell or TableCaption elements once
// we're inside a Table.
if state.within_table && !state.within_table_content {
return items;
}
let Some(style_data) = element.style_data() else {
return items;
};
let element_data = style_data.element_data.borrow();
let Some(style) = element_data.styles.get_primary() else {
return items;
};
// Step 2: If node's computed value of 'visibility' is not 'visible', then return items.
//
// We need to do this check here on the Text fragment, if we did it on the element and
// just skipped rendering all child nodes then there'd be no way to override the
// visibility in a child node.
if style.get_inherited_box().visibility != Visibility::Visible {
return items;
}
// Step 3: If node is not being rendered, then return items. For the purpose of this step,
// the following elements must act as described if the computed value of the 'display'
// property is not 'none':
let display = style.get_box().display;
if display == Display::None {
match element.type_id() {
// Even if set to Display::None, Option/OptGroup elements need to
// be rendered.
LayoutNodeType::Element(LayoutElementType::HTMLOptGroupElement) |
LayoutNodeType::Element(LayoutElementType::HTMLOptionElement) => {},
_ => {
return items;
},
}
}
let text_content = node.to_threadsafe().node_text_content();
let white_space_collapse = style.clone_white_space_collapse();
let preserve_whitespace = white_space_collapse == WhiteSpaceCollapseValue::Preserve;
let is_inline = matches!(
display,
Display::InlineBlock | Display::InlineFlex | Display::InlineGrid
);
// Now we need to decide on whether to remove beginning white space or not, this
// is mainly decided by the elements we rendered before, but may be overwritten by the white-space
// property.
let trim_beginning_white_space =
!preserve_whitespace && (state.may_start_with_whitespace || is_inline);
let with_white_space_rules_applied = WhitespaceCollapse::new(
text_content.chars(),
white_space_collapse,
trim_beginning_white_space,
);
// Step 4: If node is a Text node, then for each CSS text box produced by node, in
// content order, compute the text of the box after application of the CSS
// 'white-space' processing rules and 'text-transform' rules, set items to the list
// of the resulting strings, and return items. The CSS 'white-space' processing
// rules are slightly modified: collapsible spaces at the end of lines are always
// collapsed, but they are only removed if the line is the last line of the block,
// or it ends with a br element. Soft hyphens should be preserved.
let mut transformed_text: String = TextTransformation::new(
with_white_space_rules_applied,
style.clone_text_transform().case(),
)
.collect();
let is_preformatted_element =
white_space_collapse == WhiteSpaceCollapseValue::Preserve;
let is_final_character_whitespace = transformed_text
.chars()
.next_back()
.filter(char::is_ascii_whitespace)
.is_some();
let is_first_character_whitespace = transformed_text
.chars()
.next()
.filter(char::is_ascii_whitespace)
.is_some();
// By truncating trailing white space and then adding it back in once we
// encounter another text node we can ensure no trailing white space for
// normal text without having to look ahead
if state.did_truncate_trailing_white_space && !is_first_character_whitespace {
items.push(InnerOrOuterTextItem::Text(String::from(" ")));
};
if !transformed_text.is_empty() {
// Here we decide whether to keep or truncate the final white
// space character, if there is one.
if is_final_character_whitespace && !is_preformatted_element {
state.may_start_with_whitespace = false;
state.did_truncate_trailing_white_space = true;
transformed_text.pop();
} else {
state.may_start_with_whitespace = is_final_character_whitespace;
state.did_truncate_trailing_white_space = false;
}
items.push(InnerOrOuterTextItem::Text(transformed_text));
}
} else {
// If we don't have a parent element then there's no style data available,
// in this (pretty unlikely) case we just return the Text fragment as is.
items.push(InnerOrOuterTextItem::Text(
node.to_threadsafe().node_text_content().into(),
));
}
},
LayoutNodeType::Element(LayoutElementType::HTMLBRElement) => {
// Step 5: If node is a br element, then append a string containing a single U+000A
// LF code point to items.
state.did_truncate_trailing_white_space = false;
state.may_start_with_whitespace = true;
items.push(InnerOrOuterTextItem::Text(String::from("\u{000A}")));
},
_ => {
// First we need to gather some infos to setup the various flags
// before rendering the child nodes
let Some(style_data) = node.style_data() else {
return items;
};
let element_data = style_data.element_data.borrow();
let Some(style) = element_data.styles.get_primary() else {
return items;
};
let inherited_box = style.get_inherited_box();
if inherited_box.visibility != Visibility::Visible {
// If the element is not visible then we'll immediatly render all children,
// skipping all other processing.
// We can't just stop here since a child can override a parents visibility.
for child in node.dom_children() {
items.append(&mut rendered_text_collection_steps(child, state));
}
return items;
}
let style_box = style.get_box();
let display = style_box.display;
let mut surrounding_line_breaks = 0;
// Treat absolutely positioned or floated elements like Block elements
if style_box.position == Position::Absolute || style_box.float != Float::None {
surrounding_line_breaks = 1;
}
// Depending on the display property we have to do various things
// before we can render the child nodes.
match display {
Display::Table => {
surrounding_line_breaks = 1;
state.within_table = true;
},
// Step 6: If node's computed value of 'display' is 'table-cell',
// and node's CSS box is not the last 'table-cell' box of its
// enclosing 'table-row' box, then append a string containing
// a single U+0009 TAB code point to items.
Display::TableCell => {
if !state.first_table_cell {
items.push(InnerOrOuterTextItem::Text(String::from(
"\u{0009}", /* tab */
)));
// Make sure we don't add a white-space we removed from the previous node
state.did_truncate_trailing_white_space = false;
}
state.first_table_cell = false;
state.within_table_content = true;
},
// Step 7: If node's computed value of 'display' is 'table-row',
// and node's CSS box is not the last 'table-row' box of the nearest
// ancestor 'table' box, then append a string containing a single U+000A
// LF code point to items.
Display::TableRow => {
if !state.first_table_row {
items.push(InnerOrOuterTextItem::Text(String::from(
"\u{000A}", /* Line Feed */
)));
// Make sure we don't add a white-space we removed from the previous node
state.did_truncate_trailing_white_space = false;
}
state.first_table_row = false;
state.first_table_cell = true;
},
// Step 9: If node's used value of 'display' is block-level or 'table-caption',
// then append 1 (a required line break count) at the beginning and end of items.
Display::Block => {
surrounding_line_breaks = 1;
},
Display::TableCaption => {
surrounding_line_breaks = 1;
state.within_table_content = true;
},
Display::InlineFlex | Display::InlineGrid | Display::InlineBlock => {
// InlineBlock's are a bit strange, in that they don't produce a Linebreak, yet
// disable white space truncation before and after it, making it one of the few
// cases where one can have multiple white space characters following one another.
if state.did_truncate_trailing_white_space {
items.push(InnerOrOuterTextItem::Text(String::from(" ")));
state.did_truncate_trailing_white_space = false;
state.may_start_with_whitespace = true;
}
},
_ => {},
}
match node.type_id() {
// Step 8: If node is a p element, then append 2 (a required line break count) at
// the beginning and end of items.
LayoutNodeType::Element(LayoutElementType::HTMLParagraphElement) => {
surrounding_line_breaks = 2;
},
// Option/OptGroup elements should go on separate lines, by treating them like
// Block elements we can achieve that.
LayoutNodeType::Element(LayoutElementType::HTMLOptionElement) |
LayoutNodeType::Element(LayoutElementType::HTMLOptGroupElement) => {
surrounding_line_breaks = 1;
},
_ => {},
}
if surrounding_line_breaks > 0 {
items.push(InnerOrOuterTextItem::RequiredLineBreakCount(
surrounding_line_breaks,
));
state.did_truncate_trailing_white_space = false;
state.may_start_with_whitespace = true;
}
match node.type_id() {
// Any text/content contained in these elements is ignored.
// However we still need to check whether we have to prepend a
// space, since for example <span>asd <input> qwe</span> must
// product "asd qwe" (note the 2 spaces)
LayoutNodeType::Element(LayoutElementType::HTMLCanvasElement) |
LayoutNodeType::Element(LayoutElementType::HTMLImageElement) |
LayoutNodeType::Element(LayoutElementType::HTMLIFrameElement) |
LayoutNodeType::Element(LayoutElementType::HTMLObjectElement) |
LayoutNodeType::Element(LayoutElementType::HTMLInputElement) |
LayoutNodeType::Element(LayoutElementType::HTMLTextAreaElement) |
LayoutNodeType::Element(LayoutElementType::HTMLMediaElement) => {
if display != Display::Block && state.did_truncate_trailing_white_space {
items.push(InnerOrOuterTextItem::Text(String::from(" ")));
state.did_truncate_trailing_white_space = false;
};
state.may_start_with_whitespace = false;
},
_ => {
// Now we can finally iterate over all children, appending whatever
// they produce to items.
for child in node.dom_children() {
items.append(&mut rendered_text_collection_steps(child, state));
}
},
}
// Depending on the display property we still need to do some
// cleanup after rendering all child nodes
match display {
Display::InlineFlex | Display::InlineGrid | Display::InlineBlock => {
state.did_truncate_trailing_white_space = false;
state.may_start_with_whitespace = false;
},
Display::Table => {
state.within_table = false;
},
Display::TableCell | Display::TableCaption => {
state.within_table_content = false;
},
_ => {},
}
if surrounding_line_breaks > 0 {
items.push(InnerOrOuterTextItem::RequiredLineBreakCount(
surrounding_line_breaks,
));
state.did_truncate_trailing_white_space = false;
state.may_start_with_whitespace = true;
}
},
};
items
}
pub fn process_text_index_request(_node: OpaqueNode, _point: Point2D<Au>) -> Option<usize> {
None
}
pub fn process_resolved_font_style_query<'dom, E>(
context: &SharedStyleContext,
node: E,
value: &str,
url_data: ServoUrl,
shared_lock: &SharedRwLock,
) -> Option<ServoArc<Font>>
where
E: LayoutNode<'dom>,
{
fn create_font_declaration(
value: &str,
url_data: &ServoUrl,
quirks_mode: QuirksMode,
) -> Option<PropertyDeclarationBlock> {
let mut declarations = SourcePropertyDeclaration::default();
let result = parse_one_declaration_into(
&mut declarations,
PropertyId::NonCustom(ShorthandId::Font.into()),
value,
Origin::Author,
&UrlExtraData(url_data.get_arc()),
None,
ParsingMode::DEFAULT,
quirks_mode,
CssRuleType::Style,
);
let declarations = match result {
Ok(()) => {
let mut block = PropertyDeclarationBlock::new();
block.extend(declarations.drain(), Importance::Normal);
block
},
Err(_) => return None,
};
// TODO: Force to set line-height property to 'normal' font property.
Some(declarations)
}
fn resolve_for_declarations<'dom, E>(
context: &SharedStyleContext,
parent_style: Option<&ComputedValues>,
declarations: PropertyDeclarationBlock,
shared_lock: &SharedRwLock,
) -> ServoArc<ComputedValues>
where
E: LayoutNode<'dom>,
{
let parent_style = match parent_style {
Some(parent) => parent,
None => context.stylist.device().default_computed_values(),
};
context
.stylist
.compute_for_declarations::<E::ConcreteElement>(
&context.guards,
parent_style,
ServoArc::new(shared_lock.wrap(declarations)),
)
}
// https://html.spec.whatwg.org/multipage/#dom-context-2d-font
// 1. Parse the given font property value
let quirks_mode = context.quirks_mode();
let declarations = create_font_declaration(value, &url_data, quirks_mode)?;
// TODO: Reject 'inherit' and 'initial' values for the font property.
// 2. Get resolved styles for the parent element
let element = node.as_element().unwrap();
let parent_style = if node.is_connected() {
if element.has_data() {
node.to_threadsafe().as_element().unwrap().resolved_style()
} else {
let mut tlc = ThreadLocalStyleContext::new();
let mut context = StyleContext {
shared: context,
thread_local: &mut tlc,
};
let styles = resolve_style(&mut context, element, RuleInclusion::All, None, None);
styles.primary().clone()
}
} else {
let default_declarations =
create_font_declaration("10px sans-serif", &url_data, quirks_mode).unwrap();
resolve_for_declarations::<E>(context, None, default_declarations, shared_lock)
};
// 3. Resolve the parsed value with resolved styles of the parent element
let computed_values =
resolve_for_declarations::<E>(context, Some(&*parent_style), declarations, shared_lock);
Some(computed_values.clone_font())
}