Changeset 253857 in webkit

Timestamp:

Dec 20, 2019, 5:33:10 PM (5 years ago)

Author:

Megan Gardner

Message:

Paint highlights specified in CSS Highlight API
​https://bugs.webkit.org/show_bug.cgi?id=205318

Reviewed by Ryosuke Niwa.

LayoutTests/imported/w3c:

• web-platform-tests/css/css-highlight-api/highlight-text-across-elements-expected.html: Added.
• web-platform-tests/css/css-highlight-api/highlight-text-across-elements.html: Added.
• web-platform-tests/css/css-highlight-api/highlight-text-expected.html: Added.
• web-platform-tests/css/css-highlight-api/highlight-text.html: Added.

Source/WebCore:

Render highlights when present, similar to the way we render selection.

Tests: imported/w3c/web-platform-tests/css/css-highlight-api/highlight-text-across-elements.html

imported/w3c/web-platform-tests/css/css-highlight-api/highlight-text.html

• Modules/highlight/HighlightMap.h:

(WebCore::HighlightMap::map const):

Add a getter for the internal HashMap.

• rendering/InlineTextBox.cpp:

(WebCore::InlineTextBox::selectionState):
(WebCore::InlineTextBox::verifySelectionState const):
(WebCore::InlineTextBox::paint):
(WebCore::InlineTextBox::clampedStartEndForState const):
(WebCore::InlineTextBox::selectionStartEnd const):
(WebCore::InlineTextBox::highlightStartEnd const):
(WebCore::InlineTextBox::resolveStyleForMarkedText):

Use the highlight name from the HighlightRangeGroup to obtain the style from the renderer.

(WebCore::InlineTextBox::collectMarkedTextsForHighlights const):

Render the highlights when painting text. Determine if a highlight is present in the current RenderObject, and
add additional MarkedText to be rendered when painting

• rendering/InlineTextBox.h:
• rendering/MarkedText.cpp:

(WebCore::subdivide):

• rendering/MarkedText.h:

(WebCore::MarkedText::operator== const):

Expand MarkedText to take a style name.

• rendering/SelectionRangeData.cpp:

(WebCore::SelectionRangeData::setContext):
(WebCore::SelectionRangeData::selectionStateForRenderer):
(WebCore::SelectionRangeData::set):

• rendering/SelectionRangeData.h:

Leverage SelectionRangeData for highlights.

Tools:

Expand MarkedText to take a style name.

• TestWebKitAPI/Tests/WebCore/MarkedText.cpp:

(WebCore::operator<<):

Location:

trunk

Files:

• LayoutTests/highlight/highlight-world-leak-expected.txt (added)
• LayoutTests/highlight/highlight-world-leak.html (added)
• LayoutTests/highlight/resources (added)
• LayoutTests/highlight/resources/highlight-frame.html (added)
• LayoutTests/http/wpt/css/css-highlight-api (added)
• LayoutTests/http/wpt/css/css-highlight-api/highlight-text-across-elements-expected.html (added)
• LayoutTests/http/wpt/css/css-highlight-api/highlight-text-across-elements.html (added)
• LayoutTests/http/wpt/css/css-highlight-api/highlight-text-cascade-expected.html (added)
• LayoutTests/http/wpt/css/css-highlight-api/highlight-text-cascade.html (added)
• LayoutTests/http/wpt/css/css-highlight-api/highlight-text-expected.html (added)
• LayoutTests/http/wpt/css/css-highlight-api/highlight-text-replace-expected.html (added)
• LayoutTests/http/wpt/css/css-highlight-api/highlight-text-replace.html (added)
• LayoutTests/http/wpt/css/css-highlight-api/highlight-text.html (added)
• LayoutTests/imported/w3c/ChangeLog (modified) (1 diff)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/Modules/highlight/HighlightMap.h (modified) (1 diff)
• Source/WebCore/dom/Document.cpp (modified) (1 diff)
• Source/WebCore/rendering/InlineTextBox.cpp (modified) (10 diffs)
• Source/WebCore/rendering/InlineTextBox.h (modified) (3 diffs)
• Source/WebCore/rendering/MarkedText.cpp (modified) (1 diff)
• Source/WebCore/rendering/MarkedText.h (modified) (4 diffs)
• Source/WebCore/rendering/SelectionRangeData.cpp (modified) (1 diff)
• Source/WebCore/rendering/SelectionRangeData.h (modified) (2 diffs)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebCore/MarkedText.cpp (modified) (1 diff)

trunk/LayoutTests/imported/w3c/ChangeLog

@@ +1 @@
+2019-12-20  Megan Gardner  <megan_gardner@apple.com>
+
+        Paint highlights specified in CSS Highlight API
+        https://bugs.webkit.org/show_bug.cgi?id=205318
+
+        Reviewed by Ryosuke Niwa.
+
+        * web-platform-tests/css/css-highlight-api/highlight-text-across-elements-expected.html: Added.
+        * web-platform-tests/css/css-highlight-api/highlight-text-across-elements.html: Added.
+        * web-platform-tests/css/css-highlight-api/highlight-text-expected.html: Added.
+        * web-platform-tests/css/css-highlight-api/highlight-text.html: Added.
+
 2019-12-20  Chris Dumez  <cdumez@apple.com>
 

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2019-12-20  Megan Gardner  <megan_gardner@apple.com>
+
+        Paint highlights specified in CSS Highlight API
+        https://bugs.webkit.org/show_bug.cgi?id=205318
+
+        Reviewed by Ryosuke Niwa.
+
+        Render highlights when present, similar to the way we render selection.
+
+        Tests: imported/w3c/web-platform-tests/css/css-highlight-api/highlight-text-across-elements.html
+               imported/w3c/web-platform-tests/css/css-highlight-api/highlight-text.html
+
+        * Modules/highlight/HighlightMap.h:
+        (WebCore::HighlightMap::map const):
+
+        Add a getter for the internal HashMap.
+
+        * rendering/InlineTextBox.cpp:
+        (WebCore::InlineTextBox::selectionState):
+        (WebCore::InlineTextBox::verifySelectionState const):
+        (WebCore::InlineTextBox::paint):
+        (WebCore::InlineTextBox::clampedStartEndForState const):
+        (WebCore::InlineTextBox::selectionStartEnd const):
+        (WebCore::InlineTextBox::highlightStartEnd const):
+        (WebCore::InlineTextBox::resolveStyleForMarkedText):
+
+        Use the highlight name from the HighlightRangeGroup to obtain the style from the renderer.
+
+        (WebCore::InlineTextBox::collectMarkedTextsForHighlights const):
+
+        Render the highlights when painting text. Determine if a highlight is present in the current RenderObject, and
+        add additional MarkedText to be rendered when painting
+
+        * rendering/InlineTextBox.h:
+        * rendering/MarkedText.cpp:
+        (WebCore::subdivide):
+        * rendering/MarkedText.h:
+        (WebCore::MarkedText::operator== const):
+
+        Expand MarkedText to take a style name.
+
+        * rendering/SelectionRangeData.cpp:
+        (WebCore::SelectionRangeData::setContext):
+        (WebCore::SelectionRangeData::selectionStateForRenderer):
+        (WebCore::SelectionRangeData::set):
+        * rendering/SelectionRangeData.h:
+
+        Leverage SelectionRangeData for highlights.
+
 2019-12-20  Chris Dumez  <cdumez@apple.com>
 

trunk/Source/WebCore/Modules/highlight/HighlightMap.h

@@ -46 +46 @@
     
     RefPtr<HighlightRangeGroup> getGroupForKey(const String& key);
+    const HashMap<String, Ref<HighlightRangeGroup>>& map() const { return m_map; }
     
 private:

trunk/Source/WebCore/dom/Document.cpp

@@ -780 +780 @@
 
     clearScriptedAnimationController();
+    
+    if (m_highlightMap)
+        m_highlightMap->clear();
 
     m_pendingScrollEventTargetList = nullptr;

trunk/Source/WebCore/rendering/InlineTextBox.cpp

@@ -29 +29 @@
 #include "DocumentMarkerController.h"
 #include "Editor.h"
+#include "ElementRuleCollector.h"
 #include "EllipsisBox.h"
 #include "EventRegion.h"
 #include "Frame.h"
 #include "GraphicsContext.h"
+#include "HighlightMap.h"
 #include "HitTestResult.h"
 #include "ImageBuffer.h"
@@ -47 +49 @@
 #include "RenderView.h"
 #include "RenderedDocumentMarker.h"
+#include "RuntimeEnabledFeatures.h"
+#include "SelectionRangeData.h"
 #include "Text.h"
 #include "TextDecorationPainter.h"
@@ -153 +157 @@
 RenderObject::SelectionState InlineTextBox::selectionState()
 {
-    RenderObject::SelectionState state = renderer().selectionState();
+    auto state = verifySelectionState(renderer().selectionState(), renderer().view().selection());
+    
+    // FIXME: this code mutates selection state, but it's used at a simple getter elsewhere
+    // in this file. This code should likely live in SelectionRangeData, or somewhere else.
+    // <rdar://problem/58125978>
+    // https://bugs.webkit.org/show_bug.cgi?id=205528
+    // If there are ellipsis following, make sure their selection is updated.
+    if (m_truncation != cNoTruncation && root().ellipsisBox()) {
+        EllipsisBox* ellipsis = root().ellipsisBox();
+        if (state != RenderObject::SelectionNone) {
+            auto [selectionStart, selectionEnd] = selectionStartEnd();
+            // The ellipsis should be considered to be selected if the end of
+            // the selection is past the beginning of the truncation and the
+            // beginning of the selection is before or at the beginning of the
+            // truncation.
+            ellipsis->setSelectionState(selectionEnd >= m_truncation && selectionStart <= m_truncation ?
+                RenderObject::SelectionInside : RenderObject::SelectionNone);
+        } else
+            ellipsis->setSelectionState(RenderObject::SelectionNone);
+    }
+    
+    return state;
+}
+
+RenderObject::SelectionState InlineTextBox::verifySelectionState(RenderObject::SelectionState state, SelectionRangeData& selection) const
+{
     if (state == RenderObject::SelectionStart || state == RenderObject::SelectionEnd || state == RenderObject::SelectionBoth) {
-        auto& selection = renderer().view().selection();
         auto startPos = selection.startPosition();
         auto endPos = selection.endPosition();
@@ -175 +203 @@
         else if (state == RenderObject::SelectionBoth)
             state = RenderObject::SelectionNone;
-    }
-
-    // If there are ellipsis following, make sure their selection is updated.
-    if (m_truncation != cNoTruncation && root().ellipsisBox()) {
-        EllipsisBox* ellipsis = root().ellipsisBox();
-        if (state != RenderObject::SelectionNone) {
-            auto [selectionStart, selectionEnd] = selectionStartEnd();
-            // The ellipsis should be considered to be selected if the end of
-            // the selection is past the beginning of the truncation and the
-            // beginning of the selection is before or at the beginning of the
-            // truncation.
-            ellipsis->setSelectionState(selectionEnd >= m_truncation && selectionStart <= m_truncation ?
-                RenderObject::SelectionInside : RenderObject::SelectionNone);
-        } else
-            ellipsis->setSelectionState(RenderObject::SelectionNone);
     }
 
@@ -525 +538 @@
 
         Vector<MarkedText> markedTexts = collectMarkedTextsForDocumentMarkers(TextPaintPhase::Background);
+        auto highlightMarkedTexts = collectMarkedTextsForHighlights(TextPaintPhase::Background);
+        if (!highlightMarkedTexts.isEmpty())
+            markedTexts.appendVector(WTFMove(highlightMarkedTexts));
 #if ENABLE(TEXT_SELECTION)
         if (haveSelection && !useCustomUnderlines && !context.paintingDisabled()) {
@@ -558 +574 @@
         if (!isPrinting) {
             markedTexts.appendVector(collectMarkedTextsForDocumentMarkers(TextPaintPhase::Foreground));
+            auto highlightMarkedTexts = collectMarkedTextsForHighlights(TextPaintPhase::Foreground);
+            if (!highlightMarkedTexts.isEmpty())
+                markedTexts.appendVector(WTFMove(highlightMarkedTexts));
 
             bool shouldPaintDraggedContent = !(paintInfo.paintBehavior.contains(PaintBehavior::ExcludeSelection));
@@ -653 +672 @@
 }
 
-std::pair<unsigned, unsigned> InlineTextBox::selectionStartEnd() const
-{
-    auto selectionState = renderer().selectionState();
+std::pair<unsigned, unsigned> InlineTextBox::clampedStartEndForState(unsigned start, unsigned end, RenderObject::SelectionState selectionState) const
+{
     if (selectionState == RenderObject::SelectionInside)
         return { 0, clampedOffset(m_start + m_len) };
     
-    auto start = renderer().view().selection().startPosition();
-    auto end = renderer().view().selection().endPosition();
     if (selectionState == RenderObject::SelectionStart)
         end = renderer().text().length();
@@ -666 +682 @@
         start = 0;
     return { clampedOffset(start), clampedOffset(end) };
+}
+
+std::pair<unsigned, unsigned> InlineTextBox::selectionStartEnd() const
+{
+    auto selectionState = renderer().selectionState();
+    
+    return clampedStartEndForState(renderer().view().selection().startPosition(), renderer().view().selection().endPosition(), selectionState);
+}
+
+std::pair<unsigned, unsigned> InlineTextBox::highlightStartEnd(SelectionRangeData &rangeData) const
+{
+    auto state = rangeData.selectionStateForRenderer(renderer());
+    state = verifySelectionState(state, rangeData);
+    
+    if (state == RenderObject::SelectionNone)
+        return {0, 0};
+    
+    return clampedStartEndForState(rangeData.startPosition(), rangeData.endPosition(), state);
 }
 
@@ -770 +804 @@
     case MarkedText::SpellingError:
     case MarkedText::Unmarked:
+        break;
+    case MarkedText::Highlight:
+        if (auto renderStyle = parent()->renderer().getUncachedPseudoStyle({ PseudoId::Highlight, markedText.highlightName }, &parent()->renderer().style())) {
+            style.backgroundColor = renderStyle->backgroundColor();
+            style.textStyles.fillColor = renderStyle->computedStrokeColor();
+            style.textStyles.strokeColor = renderStyle->computedStrokeColor();
+            
+            auto color = renderStyle->visitedDependentColorWithColorFilter(CSSPropertyWebkitTextFillColor);
+            auto decorationStyle = renderStyle->textDecorationStyle();
+            auto decorations = renderStyle->textDecorationsInEffect();
+
+            if (decorations.containsAny({ TextDecoration::Underline, TextDecoration::Overline, TextDecoration::LineThrough })) {
+                style.textDecorationStyles.underlineColor = color;
+                style.textDecorationStyles.underlineStyle = decorationStyle;
+            }
+        }
         break;
     case MarkedText::DraggedContent:
@@ -964 +1014 @@
 }
 
+
+Vector<MarkedText> InlineTextBox::collectMarkedTextsForHighlights(TextPaintPhase phase) const
+{
+    if (!RuntimeEnabledFeatures::sharedFeatures().highlightAPIEnabled())
+        return { };
+    ASSERT_ARG(phase, phase == TextPaintPhase::Background || phase == TextPaintPhase::Foreground || phase == TextPaintPhase::Decoration);
+    UNUSED_PARAM(phase);
+    if (!renderer().textNode())
+        return { };
+
+    Vector<MarkedText> markedTexts;
+    auto& parentRenderer = parent()->renderer();
+    auto& parentStyle = parentRenderer.style();
+    for (auto& [highlightKey, highlightGroup] : renderer().document().highlightMap().map()) {
+        auto renderStyle = parentRenderer.getUncachedPseudoStyle({ PseudoId::Highlight, highlightKey }, &parentStyle);
+        if (!renderStyle)
+            continue;
+        for (auto& staticRange : highlightGroup->ranges()) {
+            Position startPos = createLegacyEditingPosition(staticRange->startContainer(), staticRange->startOffset());
+            Position endPos = createLegacyEditingPosition(staticRange->endContainer(), staticRange->endOffset());
+
+            if (startPos.isNotNull() && endPos.isNotNull()) {
+                RenderObject* startRenderer = startPos.deprecatedNode()->renderer();
+                int startOffset = startPos.deprecatedEditingOffset();
+                RenderObject* endRenderer = endPos.deprecatedNode()->renderer();
+                int endOffset = endPos.deprecatedEditingOffset();
+                ASSERT(startOffset >= 0 && endOffset >= 0);
+                if (!startRenderer || !endRenderer)
+                    continue;
+                auto highlightData = SelectionRangeData(renderer().view());
+                highlightData.setContext({startRenderer, endRenderer, static_cast<unsigned>(startOffset), static_cast<unsigned>(endOffset)});
+                auto [highlightStart, highlightEnd] = highlightStartEnd(highlightData);
+                if (highlightStart < highlightEnd)
+                    markedTexts.append({ highlightStart, highlightEnd, MarkedText::Highlight, nullptr, highlightKey });
+            }
+        }
+    }
+    return markedTexts;
+}
+
 FloatPoint InlineTextBox::textOriginFromBoxRect(const FloatRect& boxRect) const
 {

trunk/Source/WebCore/rendering/InlineTextBox.h

@@ -122 +122 @@
     bool isSelected(unsigned startPosition, unsigned endPosition) const;
     std::pair<unsigned, unsigned> selectionStartEnd() const;
+    std::pair<unsigned, unsigned> highlightStartEnd(SelectionRangeData&) const;
 
 protected:
@@ -133 +134 @@
     void extractLine() final;
     void attachLine() final;
+    
+    RenderObject::SelectionState verifySelectionState(RenderObject::SelectionState, SelectionRangeData&) const;
+    std::pair<unsigned, unsigned> clampedStartEndForState(unsigned, unsigned, RenderObject::SelectionState) const;
 
 public:
@@ -170 +174 @@
     Vector<MarkedText> collectMarkedTextsForDraggedContent();
     Vector<MarkedText> collectMarkedTextsForDocumentMarkers(TextPaintPhase) const;
+    Vector<MarkedText> collectMarkedTextsForHighlights(TextPaintPhase) const;
 
     MarkedTextStyle computeStyleForUnmarkedMarkedText(const PaintInfo&) const;

trunk/Source/WebCore/rendering/MarkedText.cpp

@@ -75 +75 @@
                 }
                 if (frontmost)
-                    result.append({ offsetSoFar, offsets[i].value, offsets[*frontmost].markedText->type, offsets[*frontmost].markedText->marker });
+                    result.append({ offsetSoFar, offsets[i].value, offsets[*frontmost].markedText->type, offsets[*frontmost].markedText->marker, offsets[*frontmost].markedText->highlightName });
             } else {
                 // The appended marked texts may not be in paint order. We will fix this up at the end of this function.
                 for (unsigned j = 0; j < i; ++j) {
                     if (!processedMarkedTexts.contains(offsets[j].markedText))
-                        result.append({ offsetSoFar, offsets[i].value, offsets[j].markedText->type, offsets[j].markedText->marker });
+                        result.append({ offsetSoFar, offsets[i].value, offsets[j].markedText->type, offsets[j].markedText->marker, offsets[j].markedText->highlightName });
                 }
             }

trunk/Source/WebCore/rendering/MarkedText.h

@@ -27 +27 @@
 
 #include <wtf/Vector.h>
+#include <wtf/text/WTFString.h>
 
 namespace WebCore {
@@ -41 +42 @@
         TextMatch,
         DictationAlternatives,
+        Highlight,
 #if PLATFORM(IOS_FAMILY)
         // FIXME: See <rdar://problem/8933352>. Also, remove the PLATFORM(IOS_FAMILY)-guard.
@@ -52 +54 @@
     Type type;
     const RenderedDocumentMarker* marker { nullptr };
+    String highlightName { };
 
     bool isEmpty() const { return endOffset <= startOffset; }
@@ -57 +60 @@
     bool operator==(const MarkedText& other) const
     {
-        return startOffset == other.startOffset && endOffset == other.endOffset && type == other.type && marker == other.marker;
+        return startOffset == other.startOffset && endOffset == other.endOffset && type == other.type && marker == other.marker && highlightName == other.highlightName;
     }
 };

trunk/Source/WebCore/rendering/SelectionRangeData.cpp

@@ -155 +155 @@
 }
 
+void SelectionRangeData::setContext(const Context& context)
+{
+    ASSERT(context.start() && context.end());
+    m_selectionContext = context;
+}
+
+RenderObject::SelectionState SelectionRangeData::selectionStateForRenderer(RenderObject& renderer)
+{
+    // FIXME: we shouldln't have to check that a renderer is a descendant of the render node
+    // from the range. This is likely because we aren't using VisiblePositions yet.
+    // Planned fix in a followup: <rdar://problem/58095923>
+    // https://bugs.webkit.org/show_bug.cgi?id=205529
+    
+    if (&renderer == m_selectionContext.start() || renderer.isDescendantOf(m_selectionContext.start())) {
+        if (m_selectionContext.start() && m_selectionContext.end() && m_selectionContext.start() == m_selectionContext.end())
+            return RenderObject::SelectionBoth;
+        if (m_selectionContext.start())
+            return RenderObject::SelectionStart;
+    }
+    if (&renderer == m_selectionContext.end() || renderer.isDescendantOf(m_selectionContext.end()))
+        return RenderObject::SelectionEnd;
+
+    RenderObject* selectionEnd = nullptr;
+    auto* selectionDataEnd = m_selectionContext.end();
+    if (selectionDataEnd)
+        selectionEnd = rendererAfterPosition(*selectionDataEnd, m_selectionContext.endPosition().value());
+    SelectionIterator selectionIterator(m_selectionContext.start());
+    for (auto* currentRenderer = m_selectionContext.start(); currentRenderer && currentRenderer != m_selectionContext.end(); currentRenderer = selectionIterator.next()) {
+        if (currentRenderer == m_selectionContext.start() || currentRenderer == m_selectionContext.end())
+            continue;
+        if (!currentRenderer->canBeSelectionLeaf())
+            continue;
+        if (&renderer == currentRenderer)
+            return RenderObject::SelectionInside;
+    }
+    return RenderObject::SelectionNone;
+    
+}
+
 void SelectionRangeData::set(const Context& selection, RepaintMode blockRepaintMode)
 {
-    // Make sure both our start and end objects are defined.
-    // Check www.msnbc.com and try clicking around to find the case where this happened.
     if ((selection.start() && !selection.end()) || (selection.end() && !selection.start()))
         return;

trunk/Source/WebCore/rendering/SelectionRangeData.h

@@ -72 +72 @@
         Optional<unsigned> m_endPosition;
     };
-
+    
+    void setContext(const Context&);
+    
     enum class RepaintMode { NewXOROld, NewMinusOld, Nothing };
     void set(const Context&, RepaintMode = RepaintMode::NewXOROld);
@@ -87 +89 @@
     IntRect boundsClippedToVisibleContent() const { return collectBounds(ClipToVisibleContent::Yes); }
     void repaint() const;
+    
+    RenderObject::SelectionState selectionStateForRenderer(RenderObject&);
 
 private:

trunk/Tools/ChangeLog

@@ +1 @@
+2019-12-20  Megan Gardner  <megan_gardner@apple.com>
+
+        Paint highlights specified in CSS Highlight API
+        https://bugs.webkit.org/show_bug.cgi?id=205318
+
+        Reviewed by Ryosuke Niwa.
+
+        Expand MarkedText to take a style name.
+
+        * TestWebKitAPI/Tests/WebCore/MarkedText.cpp:
+        (WebCore::operator<<):
+
 2019-12-20  Jonathan Bedard  <jbedard@apple.com>
 

trunk/Tools/TestWebKitAPI/Tests/WebCore/MarkedText.cpp

@@ -56 +56 @@
     case MarkedText::TextMatch:
         return os << "TextMatch";
+    case MarkedText::Highlight:
+        return os << "Highlight";
     case MarkedText::Unmarked:
         return os << "Unmarked";