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
|
/*
* Copyright (C) 2021-2023 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "InlineItemsBuilder.h"
#include "FontCascade.h"
#include "InlineSoftLineBreakItem.h"
#include "RenderStyleInlines.h"
#include "StyleResolver.h"
#include "TextUtil.h"
#include "UnicodeBidi.h"
#include <wtf/Scope.h>
#include <wtf/text/TextBreakIterator.h>
#include <wtf/unicode/CharacterNames.h>
namespace WebCore {
namespace Layout {
struct WhitespaceContent {
size_t length { 0 };
bool isWordSeparator { true };
};
static std::optional<WhitespaceContent> moveToNextNonWhitespacePosition(StringView textContent, size_t startPosition, bool preserveNewline, bool preserveTab, bool stopAtWordSeparatorBoundary)
{
auto hasWordSeparatorCharacter = false;
auto isWordSeparatorCharacter = false;
auto isWhitespaceCharacter = [&](auto character) {
// white space processing in CSS affects only the document white space characters: spaces (U+0020), tabs (U+0009), and segment breaks.
auto isTreatedAsSpaceCharacter = character == space || (character == newlineCharacter && !preserveNewline) || (character == tabCharacter && !preserveTab);
isWordSeparatorCharacter = isTreatedAsSpaceCharacter;
hasWordSeparatorCharacter = hasWordSeparatorCharacter || isWordSeparatorCharacter;
return isTreatedAsSpaceCharacter || character == tabCharacter;
};
auto nextNonWhiteSpacePosition = startPosition;
while (nextNonWhiteSpacePosition < textContent.length() && isWhitespaceCharacter(textContent[nextNonWhiteSpacePosition])) {
if (UNLIKELY(stopAtWordSeparatorBoundary && hasWordSeparatorCharacter && !isWordSeparatorCharacter))
break;
++nextNonWhiteSpacePosition;
}
return nextNonWhiteSpacePosition == startPosition ? std::nullopt : std::make_optional(WhitespaceContent { nextNonWhiteSpacePosition - startPosition, hasWordSeparatorCharacter });
}
static unsigned moveToNextBreakablePosition(unsigned startPosition, CachedLineBreakIteratorFactory& lineBreakIteratorFactory, const RenderStyle& style)
{
auto textLength = lineBreakIteratorFactory.stringView().length();
auto startPositionForNextBreakablePosition = startPosition;
while (startPositionForNextBreakablePosition < textLength) {
auto nextBreakablePosition = TextUtil::findNextBreakablePosition(lineBreakIteratorFactory, startPositionForNextBreakablePosition, style);
// Oftentimes the next breakable position comes back as the start position (most notably hyphens).
if (nextBreakablePosition != startPosition)
return nextBreakablePosition - startPosition;
++startPositionForNextBreakablePosition;
}
return textLength - startPosition;
}
InlineItemsBuilder::InlineItemsBuilder(const ElementBox& formattingContextRoot, InlineFormattingState& formattingState)
: m_root(formattingContextRoot)
, m_formattingState(formattingState)
{
}
void InlineItemsBuilder::build(InlineItemPosition startPosition)
{
InlineItems inlineItems;
FormattingState::OutOfFlowBoxList outOfFlowBoxes;
collectInlineItems(inlineItems, outOfFlowBoxes, startPosition);
if (!root().style().isLeftToRightDirection() || contentRequiresVisualReordering()) {
// FIXME: Add support for partial, yet paragraph level bidi content handling.
breakAndComputeBidiLevels(inlineItems);
}
computeInlineTextItemWidths(inlineItems);
auto adjustInlineFormattingStateWithNewInlineItems = [&] {
if (!startPosition)
return m_formattingState.setInlineItems(WTFMove(inlineItems));
// Let's first remove the dirty inline items if there are any.
auto& currentInlineItems = m_formattingState.inlineItems();
if (startPosition.index >= currentInlineItems.size()) {
ASSERT_NOT_REACHED();
return m_formattingState.setInlineItems(WTFMove(inlineItems));
}
currentInlineItems.remove(startPosition.index, currentInlineItems.size() - startPosition.index);
m_formattingState.appendInlineItems(WTFMove(inlineItems));
};
adjustInlineFormattingStateWithNewInlineItems();
m_formattingState.setOutOfFlowBoxes(WTFMove(outOfFlowBoxes));
#if ASSERT_ENABLED
// Check if we've got matching inline box start/end pairs and unique inline level items (non-text, non-inline box items).
size_t inlineBoxStart = 0;
size_t inlineBoxEnd = 0;
auto inlineLevelItems = HashSet<const Box*> { };
for (auto& inlineItem : m_formattingState.inlineItems()) {
if (inlineItem.isInlineBoxStart())
++inlineBoxStart;
else if (inlineItem.isInlineBoxEnd())
++inlineBoxEnd;
else {
auto hasToBeUniqueLayoutBox = inlineItem.isBox() || inlineItem.isFloat() || inlineItem.isHardLineBreak();
if (hasToBeUniqueLayoutBox)
ASSERT(inlineLevelItems.add(&inlineItem.layoutBox()).isNewEntry);
}
}
ASSERT(inlineBoxStart == inlineBoxEnd);
#endif
}
using LayoutQueue = Vector<CheckedRef<const Box>>;
static bool traverseUntilDamaged(LayoutQueue& layoutQueue, const Box& root, const Box& firstDamagedLayoutBox)
{
if (&root == &firstDamagedLayoutBox)
return true;
auto shouldSkipSubtree = root.establishesFormattingContext();
if (!shouldSkipSubtree && is<ElementBox>(root) && downcast<ElementBox>(root).hasChild()) {
auto& firstChild = *downcast<ElementBox>(root).firstChild();
layoutQueue.append(firstChild);
if (traverseUntilDamaged(layoutQueue, firstChild, firstDamagedLayoutBox))
return true;
layoutQueue.takeLast();
}
if (auto* nextSibling = root.nextSibling()) {
layoutQueue.takeLast();
layoutQueue.append(*nextSibling);
if (traverseUntilDamaged(layoutQueue, *nextSibling, firstDamagedLayoutBox))
return true;
}
return false;
}
static LayoutQueue initializeLayoutQueue(const ElementBox& formattingContextRoot, InlineItemPosition startPosition, const InlineItems& currentInlineItems)
{
if (!formattingContextRoot.firstChild()) {
// There should always be at least one inflow child in this inline formatting context.
ASSERT_NOT_REACHED();
return { };
}
if (!startPosition)
return { *formattingContextRoot.firstChild() };
// For partial layout we need to build the layout queue up to the point where the new content is in order
// to be able to produce non-content type of trailing inline items.
// e.g <div><span<span>text</span></span> produces
// [inline box start][inline box start][text][inline box end][inline box end]
// and inserting new content after text
// <div><span><span>text more_text</span></span> should produce
// [inline box start][inline box start][text][ ][more_text][inline box end][inline box end]
// where we start processing the content at the new layout box and continue with whatever we have on the stack (layout queue).
if (startPosition.index >= currentInlineItems.size()) {
ASSERT_NOT_REACHED();
return { *formattingContextRoot.firstChild() };
}
auto& firstDamagedLayoutBox = currentInlineItems[startPosition.index].layoutBox();
auto& firstChild = *formattingContextRoot.firstChild();
LayoutQueue layoutQueue;
layoutQueue.append(firstChild);
traverseUntilDamaged(layoutQueue, firstChild, firstDamagedLayoutBox);
if (layoutQueue.isEmpty()) {
ASSERT_NOT_REACHED();
layoutQueue.append(*formattingContextRoot.firstChild());
}
return layoutQueue;
}
void InlineItemsBuilder::collectInlineItems(InlineItems& inlineItems, FormattingState::OutOfFlowBoxList& outOfFlowBoxes, InlineItemPosition startPosition)
{
// Traverse the tree and create inline items out of inline boxes and leaf nodes. This essentially turns the tree inline structure into a flat one.
// <span>text<span></span><img></span> -> [InlineBoxStart][InlineLevelBox][InlineBoxStart][InlineBoxEnd][InlineLevelBox][InlineBoxEnd]
auto layoutQueue = initializeLayoutQueue(root(), startPosition, m_formattingState.inlineItems());
auto partialContentOffset = [&](auto& inlineTextBox) -> std::optional<size_t> {
if (!startPosition)
return { };
auto& currentInlineItems = m_formattingState.inlineItems();
if (startPosition.index >= currentInlineItems.size()) {
ASSERT_NOT_REACHED();
return { };
}
auto& damagedInlineItem = currentInlineItems[startPosition.index];
if (&inlineTextBox != &damagedInlineItem.layoutBox())
return { };
if (is<InlineTextItem>(damagedInlineItem))
return downcast<InlineTextItem>(damagedInlineItem).start();
if (is<InlineSoftLineBreakItem>(damagedInlineItem))
return downcast<InlineSoftLineBreakItem>(damagedInlineItem).position();
ASSERT_NOT_REACHED();
return { };
};
while (!layoutQueue.isEmpty()) {
while (true) {
auto layoutBox = layoutQueue.last();
auto isInlineBoxWithInlineContent = layoutBox->isInlineBox() && !layoutBox->isInlineTextBox() && !layoutBox->isLineBreakBox() && !layoutBox->isOutOfFlowPositioned();
if (!isInlineBoxWithInlineContent)
break;
// This is the start of an inline box (e.g. <span>).
handleInlineBoxStart(layoutBox, inlineItems);
auto& inlineBox = downcast<ElementBox>(layoutBox);
if (!inlineBox.hasChild())
break;
layoutQueue.append(*inlineBox.firstChild());
}
while (!layoutQueue.isEmpty()) {
auto layoutBox = layoutQueue.takeLast();
if (layoutBox->isOutOfFlowPositioned()) {
// Let's not construct InlineItems for out-of-flow content as they don't participate in the inline layout.
// However to be able to static positioning them, we need to compute their approximate positions.
outOfFlowBoxes.append(layoutBox);
} else if (layoutBox->isInlineTextBox()) {
auto& inlineTextBox = downcast<InlineTextBox>(layoutBox);
handleTextContent(inlineTextBox, inlineItems, partialContentOffset(inlineTextBox));
} else if (layoutBox->isAtomicInlineLevelBox() || layoutBox->isLineBreakBox())
handleInlineLevelBox(layoutBox, inlineItems);
else if (layoutBox->isInlineBox())
handleInlineBoxEnd(layoutBox, inlineItems);
else if (layoutBox->isFloatingPositioned())
inlineItems.append({ layoutBox, InlineItem::Type::Float });
else
ASSERT_NOT_REACHED();
if (auto* nextSibling = layoutBox->nextSibling()) {
layoutQueue.append(*nextSibling);
break;
}
}
}
}
static void replaceNonPreservedNewLineAndTabCharactersAndAppend(const InlineTextBox& inlineTextBox, StringBuilder& paragraphContentBuilder)
{
// ubidi prefers non-preserved new lines/tabs as space characters.
if (TextUtil::shouldPreserveNewline(inlineTextBox))
return paragraphContentBuilder.append(inlineTextBox.content());
auto textContent = inlineTextBox.content();
auto contentLength = textContent.length();
auto needsUnicodeHandling = !textContent.is8Bit();
size_t nonReplacedContentStartPosition = 0;
for (size_t position = 0; position < contentLength;) {
// Note that because of proper code point boundary handling (see U16_NEXT), position is incremented in an unconventional way here.
auto startPosition = position;
auto isNewLineOrTabCharacter = [&] {
if (needsUnicodeHandling) {
UChar32 character;
U16_NEXT(textContent.characters16(), position, contentLength, character);
return character == newlineCharacter || character == tabCharacter;
}
auto isNewLineOrTab = textContent[position] == newlineCharacter || textContent[position] == tabCharacter;
++position;
return isNewLineOrTab;
};
if (!isNewLineOrTabCharacter())
continue;
if (nonReplacedContentStartPosition < startPosition)
paragraphContentBuilder.append(StringView(textContent).substring(nonReplacedContentStartPosition, startPosition - nonReplacedContentStartPosition));
paragraphContentBuilder.append(space);
nonReplacedContentStartPosition = position;
}
if (nonReplacedContentStartPosition < contentLength)
paragraphContentBuilder.append(StringView(textContent).right(contentLength - nonReplacedContentStartPosition));
}
struct BidiContext {
UnicodeBidi unicodeBidi;
bool isLeftToRightDirection { false };
bool isBlockLevel { false };
};
using BidiContextStack = Vector<BidiContext>;
enum class EnterExitType : uint8_t {
EnteringBlock,
ExitingBlock,
EnteringInlineBox,
ExitingInlineBox
};
static inline void handleEnterExitBidiContext(StringBuilder& paragraphContentBuilder, UnicodeBidi unicodeBidi, bool isLTR, EnterExitType enterExitType, BidiContextStack& bidiContextStack)
{
auto isEnteringBidi = enterExitType == EnterExitType::EnteringBlock || enterExitType == EnterExitType::EnteringInlineBox;
switch (unicodeBidi) {
case UnicodeBidi::Normal:
// The box does not open an additional level of embedding with respect to the bidirectional algorithm.
// For inline boxes, implicit reordering works across box boundaries.
break;
case UnicodeBidi::Embed:
// Isolate and embed values are enforced by default and redundant on the block level boxes.
if (enterExitType == EnterExitType::EnteringBlock)
break;
paragraphContentBuilder.append(isEnteringBidi ? (isLTR ? leftToRightEmbed : rightToLeftEmbed) : popDirectionalFormatting);
break;
case UnicodeBidi::Override:
paragraphContentBuilder.append(isEnteringBidi ? (isLTR ? leftToRightOverride : rightToLeftOverride) : popDirectionalFormatting);
break;
case UnicodeBidi::Isolate:
// Isolate and embed values are enforced by default and redundant on the block level boxes.
if (enterExitType == EnterExitType::EnteringBlock)
break;
paragraphContentBuilder.append(isEnteringBidi ? (isLTR ? leftToRightIsolate : rightToLeftIsolate) : popDirectionalIsolate);
break;
case UnicodeBidi::Plaintext:
paragraphContentBuilder.append(isEnteringBidi ? firstStrongIsolate : popDirectionalIsolate);
break;
case UnicodeBidi::IsolateOverride:
if (isEnteringBidi) {
paragraphContentBuilder.append(firstStrongIsolate);
paragraphContentBuilder.append(isLTR ? leftToRightOverride : rightToLeftOverride);
} else {
paragraphContentBuilder.append(popDirectionalFormatting);
paragraphContentBuilder.append(popDirectionalIsolate);
}
break;
default:
ASSERT_NOT_REACHED();
}
isEnteringBidi ? bidiContextStack.append({ unicodeBidi, isLTR, enterExitType == EnterExitType::EnteringBlock }) : bidiContextStack.removeLast();
}
using InlineItemOffsetList = Vector<std::optional<size_t>>;
static inline void buildBidiParagraph(const RenderStyle& rootStyle, const InlineItems& inlineItems, StringBuilder& paragraphContentBuilder, InlineItemOffsetList& inlineItemOffsetList)
{
auto bidiContextStack = BidiContextStack { };
handleEnterExitBidiContext(paragraphContentBuilder, rootStyle.unicodeBidi(), rootStyle.isLeftToRightDirection(), EnterExitType::EnteringBlock, bidiContextStack);
if (rootStyle.rtlOrdering() != Order::Logical)
handleEnterExitBidiContext(paragraphContentBuilder, UnicodeBidi::Override, rootStyle.isLeftToRightDirection(), EnterExitType::EnteringBlock, bidiContextStack);
const Box* lastInlineTextBox = nullptr;
size_t inlineTextBoxOffset = 0;
for (size_t index = 0; index < inlineItems.size(); ++index) {
auto& inlineItem = inlineItems[index];
auto& layoutBox = inlineItem.layoutBox();
auto appendTextBasedContent = [&] {
// Append the entire InlineTextBox content and keep track of individual inline item positions.
if (lastInlineTextBox == &layoutBox)
return;
inlineTextBoxOffset = paragraphContentBuilder.length();
replaceNonPreservedNewLineAndTabCharactersAndAppend(downcast<InlineTextBox>(layoutBox), paragraphContentBuilder);
lastInlineTextBox = &layoutBox;
};
if (inlineItem.isText()) {
appendTextBasedContent();
inlineItemOffsetList.uncheckedAppend({ inlineTextBoxOffset + downcast<InlineTextItem>(inlineItem).start() });
} else if (inlineItem.isBox()) {
inlineItemOffsetList.uncheckedAppend({ paragraphContentBuilder.length() });
paragraphContentBuilder.append(objectReplacementCharacter);
} else if (inlineItem.isInlineBoxStart() || inlineItem.isInlineBoxEnd()) {
// https://drafts.csswg.org/css-writing-modes/#unicode-bidi
auto& style = inlineItem.style();
auto initiatesControlCharacter = style.rtlOrdering() == Order::Logical && style.unicodeBidi() != UnicodeBidi::Normal;
if (!initiatesControlCharacter) {
// Opaque items do not have position in the bidi paragraph. They inherit their bidi level from the next inline item.
inlineItemOffsetList.uncheckedAppend({ });
continue;
}
inlineItemOffsetList.uncheckedAppend({ paragraphContentBuilder.length() });
auto isEnteringBidi = inlineItem.isInlineBoxStart();
handleEnterExitBidiContext(paragraphContentBuilder
, style.unicodeBidi()
, style.isLeftToRightDirection()
, isEnteringBidi ? EnterExitType::EnteringInlineBox : EnterExitType::ExitingInlineBox
, bidiContextStack
);
} else if (inlineItem.isSoftLineBreak()) {
// FIXME: Unwind the bidi stack for soft line break too.
appendTextBasedContent();
inlineItemOffsetList.uncheckedAppend({ inlineTextBoxOffset + downcast<InlineSoftLineBreakItem>(inlineItem).position() });
} else if (inlineItem.isHardLineBreak()) {
// Bidi handling requires us to close all the nested bidi contexts at the end of the line triggered by forced line breaks
// and re-open it for the content on the next line (i.e. paragraph handling).
auto copyOfBidiStack = bidiContextStack;
size_t blockLevelBidiContextIndex = 0;
auto unwindBidiContextStack = [&] {
// Unwind all the way up to the block entry.
ASSERT(!bidiContextStack.isEmpty());
size_t unwindingIndex = copyOfBidiStack.size() - 1;
while (unwindingIndex && !copyOfBidiStack[unwindingIndex].isBlockLevel) {
handleEnterExitBidiContext(paragraphContentBuilder
, copyOfBidiStack[unwindingIndex].unicodeBidi
, copyOfBidiStack[unwindingIndex].isLeftToRightDirection
, EnterExitType::ExitingInlineBox
, bidiContextStack
);
--unwindingIndex;
}
blockLevelBidiContextIndex = unwindingIndex;
// and unwind the block entries as well.
do {
ASSERT(copyOfBidiStack[unwindingIndex].isBlockLevel);
handleEnterExitBidiContext(paragraphContentBuilder
, copyOfBidiStack[unwindingIndex].unicodeBidi
, copyOfBidiStack[unwindingIndex].isLeftToRightDirection
, EnterExitType::ExitingBlock
, bidiContextStack
);
} while (unwindingIndex--);
};
unwindBidiContextStack();
inlineItemOffsetList.uncheckedAppend({ paragraphContentBuilder.length() });
paragraphContentBuilder.append(newlineCharacter);
auto rewindBidiContextStack = [&] {
for (size_t blockLevelIndex = 0; blockLevelIndex <= blockLevelBidiContextIndex; ++blockLevelIndex) {
handleEnterExitBidiContext(paragraphContentBuilder
, copyOfBidiStack[blockLevelIndex].unicodeBidi
, copyOfBidiStack[blockLevelIndex].isLeftToRightDirection
, EnterExitType::EnteringBlock
, bidiContextStack
);
}
for (size_t inlineLevelIndex = blockLevelBidiContextIndex + 1; inlineLevelIndex < copyOfBidiStack.size(); ++inlineLevelIndex) {
handleEnterExitBidiContext(paragraphContentBuilder
, copyOfBidiStack[inlineLevelIndex].unicodeBidi
, copyOfBidiStack[inlineLevelIndex].isLeftToRightDirection
, EnterExitType::EnteringInlineBox
, bidiContextStack
);
}
};
rewindBidiContextStack();
} else if (inlineItem.isWordBreakOpportunity()) {
// Soft wrap opportunity markers are opaque to bidi.
inlineItemOffsetList.uncheckedAppend({ });
} else if (inlineItem.isFloat()) {
// Floats are not part of the inline content which make them opaque to bidi.
inlineItemOffsetList.uncheckedAppend({ });
} else
ASSERT_NOT_IMPLEMENTED_YET();
}
}
void InlineItemsBuilder::breakAndComputeBidiLevels(InlineItems& inlineItems)
{
ASSERT(!inlineItems.isEmpty());
StringBuilder paragraphContentBuilder;
InlineItemOffsetList inlineItemOffsets;
inlineItemOffsets.reserveInitialCapacity(inlineItems.size());
buildBidiParagraph(root().style(), inlineItems, paragraphContentBuilder, inlineItemOffsets);
if (paragraphContentBuilder.isEmpty()) {
// Style may trigger visual reordering even on a completely empty content.
// e.g. <div><span style="direction:rtl"></span></div>
// Let's not try to do bidi handling when there's no content to reorder.
return;
}
auto mayNotUseBlockDirection = root().style().unicodeBidi() == UnicodeBidi::Plaintext;
if (!contentRequiresVisualReordering() && mayNotUseBlockDirection && TextUtil::directionForTextContent(paragraphContentBuilder) == TextDirection::LTR) {
// UnicodeBidi::Plaintext makes directionality calculated without taking parent direction property into account.
return;
}
ASSERT(inlineItemOffsets.size() == inlineItems.size());
// 1. Setup the bidi boundary loop by calling ubidi_setPara with the paragraph text.
// 2. Call ubidi_getLogicalRun to advance to the next bidi boundary until we hit the end of the content.
// 3. Set the computed bidi level on the associated inline items. Split them as needed.
UBiDi* ubidi = ubidi_open();
auto closeUBiDiOnExit = makeScopeExit([&] {
ubidi_close(ubidi);
});
UBiDiLevel rootBidiLevel = UBIDI_DEFAULT_LTR;
bool useHeuristicBaseDirection = root().style().unicodeBidi() == UnicodeBidi::Plaintext;
if (!useHeuristicBaseDirection)
rootBidiLevel = root().style().isLeftToRightDirection() ? UBIDI_LTR : UBIDI_RTL;
auto bidiContent = StringView { paragraphContentBuilder }.upconvertedCharacters();
auto bidiContentLength = paragraphContentBuilder.length();
UErrorCode error = U_ZERO_ERROR;
ASSERT(bidiContentLength);
ubidi_setPara(ubidi
, bidiContent
, bidiContentLength
, rootBidiLevel
, nullptr
, &error);
if (U_FAILURE(error)) {
ASSERT_NOT_REACHED();
return;
}
size_t inlineItemIndex = 0;
auto hasSeenOpaqueItem = false;
for (size_t currentPosition = 0; currentPosition < bidiContentLength;) {
UBiDiLevel bidiLevel;
int32_t endPosition = currentPosition;
ubidi_getLogicalRun(ubidi, currentPosition, &endPosition, &bidiLevel);
auto setBidiLevelOnRange = [&](size_t bidiEnd, auto bidiLevelForRange) {
// We should always have inline item(s) associated with a bidi range.
ASSERT(inlineItemIndex < inlineItemOffsets.size());
// Start of the range is always where we left off (bidi ranges do not have gaps).
for (; inlineItemIndex < inlineItemOffsets.size(); ++inlineItemIndex) {
auto offset = inlineItemOffsets[inlineItemIndex];
auto& inlineItem = inlineItems[inlineItemIndex];
if (!offset) {
// This is an opaque item. Let's post-process it.
hasSeenOpaqueItem = true;
inlineItem.setBidiLevel(bidiLevelForRange);
continue;
}
if (*offset >= bidiEnd) {
// This inline item is outside of the bidi range.
break;
}
inlineItem.setBidiLevel(bidiLevelForRange);
if (!inlineItem.isText())
continue;
// Check if this text item is on bidi boundary and needs splitting.
auto& inlineTextItem = downcast<InlineTextItem>(inlineItem);
auto endPosition = *offset + inlineTextItem.length();
if (endPosition > bidiEnd) {
inlineItems.insert(inlineItemIndex + 1, inlineTextItem.split(bidiEnd - *offset));
// Right side is going to be processed at the next bidi range.
inlineItemOffsets.insert(inlineItemIndex + 1, bidiEnd);
++inlineItemIndex;
break;
}
}
};
setBidiLevelOnRange(endPosition, bidiLevel);
currentPosition = endPosition;
}
auto setBidiLevelForOpaqueInlineItems = [&] {
if (!hasSeenOpaqueItem)
return;
// Let's not confuse ubidi with non-content entries.
// Opaque runs are excluded from the visual list (ie. only empty inline boxes should be kept around as bidi content -to figure out their visual order).
enum class InlineBoxHasContent : bool { No, Yes };
Vector<InlineBoxHasContent> inlineBoxContentFlagStack;
inlineBoxContentFlagStack.reserveInitialCapacity(inlineItems.size());
for (auto index = inlineItems.size(); index--;) {
auto& inlineItem = inlineItems[index];
if (inlineItem.isInlineBoxStart()) {
ASSERT(!inlineBoxContentFlagStack.isEmpty());
if (inlineBoxContentFlagStack.takeLast() == InlineBoxHasContent::Yes)
inlineItems[index].setBidiLevel(InlineItem::opaqueBidiLevel);
continue;
}
if (inlineItem.isInlineBoxEnd()) {
inlineBoxContentFlagStack.append(InlineBoxHasContent::No);
inlineItem.setBidiLevel(InlineItem::opaqueBidiLevel);
continue;
}
if (inlineItem.isWordBreakOpportunity()) {
inlineItem.setBidiLevel(InlineItem::opaqueBidiLevel);
continue;
}
// Mark the inline box stack with "content yes", when we come across a content type of inline item.
if (!inlineItem.isText() || !downcast<InlineTextItem>(inlineItem).isWhitespace() || TextUtil::shouldPreserveSpacesAndTabs(inlineItem.layoutBox()))
inlineBoxContentFlagStack.fill(InlineBoxHasContent::Yes);
}
};
setBidiLevelForOpaqueInlineItems();
}
static inline bool canCacheMeasuredWidthOnInlineTextItem(const InlineTextBox& inlineTextBox, size_t start, size_t length, bool isWhitespace)
{
// Do not cache when:
// 1. first-line style's unique font properties may produce non-matching width values.
// 2. position dependent content is present (preserved tab character atm).
if (&inlineTextBox.style() != &inlineTextBox.firstLineStyle() && inlineTextBox.style().fontCascade() != inlineTextBox.firstLineStyle().fontCascade())
return false;
if (!isWhitespace || !TextUtil::shouldPreserveSpacesAndTabs(inlineTextBox))
return true;
// FIXME: Currently we opt out of caching only when we see a preserved \t character (position dependent measured width).
auto textContent = inlineTextBox.content();
for (auto index = start; index < start + length; ++index) {
if (textContent[index] == tabCharacter)
return false;
}
return true;
}
void InlineItemsBuilder::computeInlineTextItemWidths(InlineItems& inlineItems)
{
for (auto& inlineItem : inlineItems) {
if (!inlineItem.isText())
continue;
auto& inlineTextItem = downcast<InlineTextItem>(inlineItem);
auto& inlineTextBox = inlineTextItem.inlineTextBox();
auto start = inlineTextItem.start();
auto length = inlineTextItem.length();
auto needsMeasuring = length && !inlineTextItem.isZeroWidthSpaceSeparator();
if (!needsMeasuring || !canCacheMeasuredWidthOnInlineTextItem(inlineTextBox, start, length, inlineTextItem.isWhitespace()))
continue;
inlineTextItem.setWidth(TextUtil::width(inlineTextItem, inlineTextItem.style().fontCascade(), start, start + length, { }));
}
}
void InlineItemsBuilder::handleTextContent(const InlineTextBox& inlineTextBox, InlineItems& inlineItems, std::optional<size_t> partialContentOffset)
{
auto text = inlineTextBox.content();
auto contentLength = text.length();
if (!contentLength)
return inlineItems.append(InlineTextItem::createEmptyItem(inlineTextBox));
if (inlineTextBox.isCombined())
return inlineItems.append(InlineTextItem::createNonWhitespaceItem(inlineTextBox, { }, contentLength, UBIDI_DEFAULT_LTR, false, { }));
m_contentRequiresVisualReordering = m_contentRequiresVisualReordering || TextUtil::containsStrongDirectionalityText(text);
auto& style = inlineTextBox.style();
auto shouldPreserveSpacesAndTabs = TextUtil::shouldPreserveSpacesAndTabs(inlineTextBox);
auto shouldPreserveNewline = TextUtil::shouldPreserveNewline(inlineTextBox);
auto lineBreakIteratorFactory = CachedLineBreakIteratorFactory { text, style.computedLocale(), TextUtil::lineBreakIteratorMode(style.lineBreak()), TextUtil::contentAnalysis(style.wordBreak()) };
auto currentPosition = partialContentOffset.value_or(0lu);
ASSERT(currentPosition <= contentLength);
while (currentPosition < contentLength) {
auto handleSegmentBreak = [&] {
// Segment breaks with preserve new line style (white-space: pre, pre-wrap, break-spaces and pre-line) compute to forced line break.
auto isSegmentBreakCandidate = text[currentPosition] == newlineCharacter;
if (!isSegmentBreakCandidate || !shouldPreserveNewline)
return false;
inlineItems.append(InlineSoftLineBreakItem::createSoftLineBreakItem(inlineTextBox, currentPosition++));
return true;
};
if (handleSegmentBreak())
continue;
auto handleWhitespace = [&] {
auto stopAtWordSeparatorBoundary = shouldPreserveSpacesAndTabs && style.fontCascade().wordSpacing();
auto whitespaceContent = moveToNextNonWhitespacePosition(text, currentPosition, shouldPreserveNewline, shouldPreserveSpacesAndTabs, stopAtWordSeparatorBoundary);
if (!whitespaceContent)
return false;
ASSERT(whitespaceContent->length);
if (style.whiteSpaceCollapse() == WhiteSpaceCollapse::BreakSpaces) {
// https://www.w3.org/TR/css-text-3/#white-space-phase-1
// For break-spaces, a soft wrap opportunity exists after every space and every tab.
// FIXME: if this turns out to be a perf hit with too many individual whitespace inline items, we should transition this logic to line breaking.
for (size_t i = 0; i < whitespaceContent->length; ++i)
inlineItems.append(InlineTextItem::createWhitespaceItem(inlineTextBox, currentPosition + i, 1, UBIDI_DEFAULT_LTR, whitespaceContent->isWordSeparator, { }));
} else
inlineItems.append(InlineTextItem::createWhitespaceItem(inlineTextBox, currentPosition, whitespaceContent->length, UBIDI_DEFAULT_LTR, whitespaceContent->isWordSeparator, { }));
currentPosition += whitespaceContent->length;
return true;
};
if (handleWhitespace())
continue;
auto handleNonBreakingSpace = [&] {
if (style.nbspMode() != NBSPMode::Space) {
// Let's just defer to regular non-whitespace inline items when non breaking space needs no special handling.
return false;
}
auto startPosition = currentPosition;
auto endPosition = startPosition;
for (; endPosition < contentLength; ++endPosition) {
if (text[endPosition] != noBreakSpace)
break;
}
if (startPosition == endPosition)
return false;
for (auto index = startPosition; index < endPosition; ++index)
inlineItems.append(InlineTextItem::createNonWhitespaceItem(inlineTextBox, index, 1, UBIDI_DEFAULT_LTR, { }, { }));
currentPosition = endPosition;
return true;
};
if (handleNonBreakingSpace())
continue;
auto handleNonWhitespace = [&] {
auto startPosition = currentPosition;
auto endPosition = startPosition;
auto hasTrailingSoftHyphen = false;
if (style.hyphens() == Hyphens::None) {
// Let's merge candidate InlineTextItems separated by soft hyphen when the style says so.
do {
endPosition += moveToNextBreakablePosition(endPosition, lineBreakIteratorFactory, style);
ASSERT(startPosition < endPosition);
} while (endPosition < contentLength && text[endPosition - 1] == softHyphen);
} else {
endPosition += moveToNextBreakablePosition(startPosition, lineBreakIteratorFactory, style);
ASSERT(startPosition < endPosition);
hasTrailingSoftHyphen = text[endPosition - 1] == softHyphen;
}
ASSERT_IMPLIES(style.hyphens() == Hyphens::None, !hasTrailingSoftHyphen);
inlineItems.append(InlineTextItem::createNonWhitespaceItem(inlineTextBox, startPosition, endPosition - startPosition, UBIDI_DEFAULT_LTR, hasTrailingSoftHyphen, { }));
currentPosition = endPosition;
return true;
};
if (handleNonWhitespace())
continue;
// Unsupported content?
ASSERT_NOT_REACHED();
}
}
void InlineItemsBuilder::handleInlineBoxStart(const Box& inlineBox, InlineItems& inlineItems)
{
inlineItems.append({ inlineBox, InlineItem::Type::InlineBoxStart });
auto& style = inlineBox.style();
m_contentRequiresVisualReordering = m_contentRequiresVisualReordering || !style.isLeftToRightDirection() || (style.rtlOrdering() == Order::Logical && style.unicodeBidi() != UnicodeBidi::Normal);
}
void InlineItemsBuilder::handleInlineBoxEnd(const Box& inlineBox, InlineItems& inlineItems)
{
inlineItems.append({ inlineBox, InlineItem::Type::InlineBoxEnd });
// Inline box end item itself can not trigger bidi content.
ASSERT(contentRequiresVisualReordering() || inlineBox.style().isLeftToRightDirection() || inlineBox.style().rtlOrdering() == Order::Visual || inlineBox.style().unicodeBidi() == UnicodeBidi::Normal);
}
void InlineItemsBuilder::handleInlineLevelBox(const Box& layoutBox, InlineItems& inlineItems)
{
if (layoutBox.isAtomicInlineLevelBox())
return inlineItems.append({ layoutBox, InlineItem::Type::Box });
if (layoutBox.isLineBreakBox())
return inlineItems.append({ layoutBox, layoutBox.isWordBreakOpportunity() ? InlineItem::Type::WordBreakOpportunity : InlineItem::Type::HardLineBreak });
ASSERT_NOT_REACHED();
}
}
}
|