Subtree caching implementation in blink-core

Source/core/paint/DisplayItemListPaintTest.cpp

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "config.h"
 #include "platform/graphics/paint/DisplayItemList.h"
 
 #include "core/layout/LayoutTestHelper.h"
 #include "core/layout/LayoutText.h"
 #include "core/layout/LayoutView.h"
@@ skipping 13 matching lines @@
 
 class DisplayItemListPaintTest : public RenderingTest {
 public:
     DisplayItemListPaintTest()
         : m_layoutView(nullptr)
         , m_originalSlimmingPaintEnabled(RuntimeEnabledFeatures::slimmingPaintEnabled()) { }
 
 protected:
     LayoutView& layoutView() { return *m_layoutView; }
     DisplayItemList& rootDisplayItemList() { return *layoutView().layer()->graphicsLayerBacking()->displayItemList(); }
-    const DisplayItems& newPaintListBeforeUpdate() { return rootDisplayItemList().m_newDisplayItems; }
+    const DisplayItems& newDisplayItemsBeforeUpdate() { return rootDisplayItemList().m_newDisplayItems; }
 
 private:
     void SetUp() override
     {
         RuntimeEnabledFeatures::setSlimmingPaintEnabled(true);
 
         RenderingTest::SetUp();
         enableCompositing();
 
         m_layoutView = document().view()->layoutView();
@@ skipping 13 matching lines @@
 // class is used to test only v2 behavior while maintaining v1 test coverage.
 class DisplayItemListPaintTestForSlimmingPaintV2 : public RenderingTest {
 public:
     DisplayItemListPaintTestForSlimmingPaintV2()
         : m_layoutView(nullptr)
         , m_originalSlimmingPaintV2Enabled(RuntimeEnabledFeatures::slimmingPaintV2Enabled()) { }
 
 protected:
     LayoutView& layoutView() { return *m_layoutView; }
     DisplayItemList& rootDisplayItemList() { return *layoutView().layer()->graphicsLayerBacking()->displayItemList(); }
-    const DisplayItems& newPaintListBeforeUpdate() { return rootDisplayItemList().m_newDisplayItems; }
+    const DisplayItems& newDisplayItemsBeforeUpdate() { return rootDisplayItemList().m_newDisplayItems; }
+
+    // Expose some document lifecycle steps.
+    void updateLifecyclePhasesToPaintForSlimmingPaintV2Clean() { document().view()->updateLifecyclePhasesInternal(FrameView::OnlyUpToPaintForSlimmingPaintV2Clean); }

[chrishtr, 2015/08/27 04:29:48]

These are just for testing? That's sad. Is it really necessary?

[Xianzhu, 2015/08/27 16:38:02]

The cached display items are only visible in display list after painting and
before committing (via newDisplayitemsBeforeUpdate). Without them we can only
test the final merged result of display lists and unable to check the cached
display items during line 308 to 319 below.

+    void compositeForSlimmingPaintV2() { document().view()->compositeForSlimmingPaintV2(); }
 
 private:
     void SetUp() override
     {
         ASSERT_TRUE(RuntimeEnabledFeatures::slimmingPaintEnabled());
         RuntimeEnabledFeatures::setSlimmingPaintV2Enabled(true);
 
         RenderingTest::SetUp();
         enableCompositing();
 
@@ skipping 38 matching lines @@
             EXPECT_EQ(expected[index].type(), actual[index].type()); \
         } \
     } while (false);
 
 #ifndef NDEBUG
 #define EXPECT_DISPLAY_LIST_WITH_RED_FILL_IN_DEBUG(actual, expectedSizeWithoutFill, ...) \
     EXPECT_DISPLAY_LIST_BASE( \
         actual, expectedSizeWithoutFill + 1, \
         TestDisplayItem(*document().layoutView()->layer()->graphicsLayerBacking(), DisplayItem::DebugRedFill), \
         __VA_ARGS__)
+#define EXPECT_DISPLAY_LIST_WITH_CACHED_RED_FILL_IN_DEBUG(actual, expectedSizeWithoutFill, ...) \
+    EXPECT_DISPLAY_LIST_BASE( \
+        actual, expectedSizeWithoutFill + 1, \
+        TestDisplayItem(*document().layoutView()->layer()->graphicsLayerBacking(), DisplayItem::drawingTypeToCachedDrawingType(DisplayItem::DebugRedFill)), \
+        __VA_ARGS__)
 #else
 #define EXPECT_DISPLAY_LIST_WITH_RED_FILL_IN_DEBUG EXPECT_DISPLAY_LIST_BASE
+#define EXPECT_DISPLAY_LIST_WITH_CACHED_RED_FILL_IN_DEBUG EXPECT_DISPLAY_LIST_BASE
 #endif
 
 TEST_F(DisplayItemListPaintTest, FullDocumentPaintingWithCaret)
 {
     setBodyInnerHTML("<div id='div' contentEditable='true' style='outline:none'>XYZ</div>");
     document().page()->focusController().setActive(true);
     document().page()->focusController().setFocused(true);
     LayoutView& layoutView = *document().layoutView();
     DeprecatedPaintLayer& rootLayer = *layoutView.layer();
     Element& div = *toElement(document().body()->firstChild());
@@ skipping 60 matching lines @@
         TestDisplayItem(newFirstTextBox, DisplayItem::paintPhaseToDrawingType(PaintPhaseForeground)),
         TestDisplayItem(secondTextBox, DisplayItem::paintPhaseToDrawingType(PaintPhaseForeground)));
 }
 
 TEST_F(DisplayItemListPaintTestForSlimmingPaintV2, FullDocumentPaintingWithCaret)
 {
     setBodyInnerHTML("<div id='div' contentEditable='true' style='outline:none'>XYZ</div>");
     document().page()->focusController().setActive(true);
     document().page()->focusController().setFocused(true);
     LayoutView& layoutView = *document().layoutView();
+    LayoutObject& html = *document().documentElement()->layoutObject();
     Element& div = *toElement(document().body()->firstChild());
     LayoutObject& divLayoutObject = *document().body()->firstChild()->layoutObject();
     InlineTextBox& textInlineBox = *toLayoutText(div.firstChild()->layoutObject())->firstTextBox();
 
     document().view()->updateAllLifecyclePhases();
 
-    EXPECT_DISPLAY_LIST_WITH_RED_FILL_IN_DEBUG(rootDisplayItemList().displayItems(), 2,
+    EXPECT_DISPLAY_LIST_WITH_RED_FILL_IN_DEBUG(rootDisplayItemList().displayItems(), 4,
         TestDisplayItem(layoutView, DisplayItem::BoxDecorationBackground),
-        TestDisplayItem(textInlineBox, DisplayItem::paintPhaseToDrawingType(PaintPhaseForeground)));
+        TestDisplayItem(html, DisplayItem::BeginSubsequence),
+        TestDisplayItem(textInlineBox, DisplayItem::paintPhaseToDrawingType(PaintPhaseForeground)),
+        TestDisplayItem(html, DisplayItem::EndSubsequence));
 
     div.focus();
     document().view()->updateAllLifecyclePhases();
 
-    EXPECT_DISPLAY_LIST_WITH_RED_FILL_IN_DEBUG(rootDisplayItemList().displayItems(), 3,
+    EXPECT_DISPLAY_LIST_WITH_RED_FILL_IN_DEBUG(rootDisplayItemList().displayItems(), 5,
         TestDisplayItem(layoutView, DisplayItem::BoxDecorationBackground),
+        TestDisplayItem(html, DisplayItem::BeginSubsequence),
         TestDisplayItem(textInlineBox, DisplayItem::paintPhaseToDrawingType(PaintPhaseForeground)),
-        TestDisplayItem(divLayoutObject, DisplayItem::Caret)); // New!
+        TestDisplayItem(divLayoutObject, DisplayItem::Caret), // New!
+        TestDisplayItem(html, DisplayItem::EndSubsequence));
 }
 
 TEST_F(DisplayItemListPaintTestForSlimmingPaintV2, InlineRelayout)
 {
     setBodyInnerHTML("<div id='div' style='width:100px; height: 200px'>AAAAAAAAAA BBBBBBBBBB</div>");
     LayoutView& layoutView = *document().layoutView();
+    LayoutObject& html = *document().documentElement()->layoutObject();
     Element& div = *toElement(document().body()->firstChild());
     LayoutBlock& divBlock = *toLayoutBlock(document().body()->firstChild()->layoutObject());
     LayoutText& text = *toLayoutText(divBlock.firstChild());
     InlineTextBox& firstTextBox = *text.firstTextBox();
 
     document().view()->updateAllLifecyclePhases();
 
-    EXPECT_DISPLAY_LIST_WITH_RED_FILL_IN_DEBUG(rootDisplayItemList().displayItems(), 2,
+    EXPECT_DISPLAY_LIST_WITH_RED_FILL_IN_DEBUG(rootDisplayItemList().displayItems(), 4,
         TestDisplayItem(layoutView, DisplayItem::BoxDecorationBackground),
-        TestDisplayItem(firstTextBox, DisplayItem::paintPhaseToDrawingType(PaintPhaseForeground)));
+        TestDisplayItem(html, DisplayItem::BeginSubsequence),
+        TestDisplayItem(firstTextBox, DisplayItem::paintPhaseToDrawingType(PaintPhaseForeground)),
+        TestDisplayItem(html, DisplayItem::EndSubsequence));
 
     div.setAttribute(HTMLNames::styleAttr, "width: 10px; height: 200px");
     document().view()->updateAllLifecyclePhases();
 
     LayoutText& newText = *toLayoutText(divBlock.firstChild());
     InlineTextBox& newFirstTextBox = *newText.firstTextBox();
     InlineTextBox& secondTextBox = *newText.firstTextBox()->nextTextBox();
 
-    EXPECT_DISPLAY_LIST_WITH_RED_FILL_IN_DEBUG(rootDisplayItemList().displayItems(), 3,
+    EXPECT_DISPLAY_LIST_WITH_RED_FILL_IN_DEBUG(rootDisplayItemList().displayItems(), 5,
         TestDisplayItem(layoutView, DisplayItem::BoxDecorationBackground),
+        TestDisplayItem(html, DisplayItem::BeginSubsequence),
         TestDisplayItem(newFirstTextBox, DisplayItem::paintPhaseToDrawingType(PaintPhaseForeground)),
-        TestDisplayItem(secondTextBox, DisplayItem::paintPhaseToDrawingType(PaintPhaseForeground)));
+        TestDisplayItem(secondTextBox, DisplayItem::paintPhaseToDrawingType(PaintPhaseForeground)),
+        TestDisplayItem(html, DisplayItem::EndSubsequence));
+}
+
+TEST_F(DisplayItemListPaintTestForSlimmingPaintV2, CachedSubsequence)
+{
+    setBodyInnerHTML(
+        "<div id='container1' style='position: relative; width: 200px; height: 200px; background-color: blue'>"
+        "  <div id='content1' style='width: 100px; height: 100px; background-color: red'></div>"
+        "</div>"
+        "<div id='container2' style='position: relative; width: 200px; height: 200px; background-color: blue'>"
+        "  <div id='content2' style='width: 100px; height: 100px; background-color: green'></div>"
+        "</div>");
+    document().view()->updateAllLifecyclePhases();
+
+    LayoutView& layoutView = *document().layoutView();
+    LayoutObject& html = *document().documentElement()->layoutObject();
+    LayoutObject& container1 = *document().getElementById("container1")->layoutObject();
+    LayoutObject& content1 = *document().getElementById("content1")->layoutObject();
+    LayoutObject& container2 = *document().getElementById("container2")->layoutObject();
+    LayoutObject& content2 = *document().getElementById("content2")->layoutObject();
+
+    EXPECT_DISPLAY_LIST_WITH_RED_FILL_IN_DEBUG(rootDisplayItemList().displayItems(), 11,
+        TestDisplayItem(layoutView, DisplayItem::BoxDecorationBackground),
+        TestDisplayItem(html, DisplayItem::BeginSubsequence),
+        TestDisplayItem(container1, DisplayItem::BeginSubsequence),
+        TestDisplayItem(container1, DisplayItem::BoxDecorationBackground),
+        TestDisplayItem(content1, DisplayItem::BoxDecorationBackground),
+        TestDisplayItem(container1, DisplayItem::EndSubsequence),
+        TestDisplayItem(container2, DisplayItem::BeginSubsequence),
+        TestDisplayItem(container2, DisplayItem::BoxDecorationBackground),
+        TestDisplayItem(content2, DisplayItem::BoxDecorationBackground),
+        TestDisplayItem(container2, DisplayItem::EndSubsequence),
+        TestDisplayItem(html, DisplayItem::EndSubsequence));
+
+    toHTMLElement(content1.node())->setAttribute(HTMLNames::styleAttr, "width: 100px; height: 100px; background-color: green");
+    updateLifecyclePhasesToPaintForSlimmingPaintV2Clean();
+
+    EXPECT_DISPLAY_LIST_WITH_CACHED_RED_FILL_IN_DEBUG(newDisplayItemsBeforeUpdate(), 8,
+        TestDisplayItem(layoutView, DisplayItem::drawingTypeToCachedDrawingType(DisplayItem::BoxDecorationBackground)),
+        TestDisplayItem(html, DisplayItem::BeginSubsequence),
+        TestDisplayItem(container1, DisplayItem::BeginSubsequence),
+        TestDisplayItem(container1, DisplayItem::drawingTypeToCachedDrawingType(DisplayItem::BoxDecorationBackground)),
+        TestDisplayItem(content1, DisplayItem::BoxDecorationBackground),
+        TestDisplayItem(container1, DisplayItem::EndSubsequence),
+        TestDisplayItem(container2, DisplayItem::CachedSubsequence),
+        TestDisplayItem(html, DisplayItem::EndSubsequence));
+
+    compositeForSlimmingPaintV2();
+
+    EXPECT_DISPLAY_LIST_WITH_RED_FILL_IN_DEBUG(rootDisplayItemList().displayItems(), 11,
+        TestDisplayItem(layoutView, DisplayItem::BoxDecorationBackground),
+        TestDisplayItem(html, DisplayItem::BeginSubsequence),
+        TestDisplayItem(container1, DisplayItem::BeginSubsequence),
+        TestDisplayItem(container1, DisplayItem::BoxDecorationBackground),
+        TestDisplayItem(content1, DisplayItem::BoxDecorationBackground),
+        TestDisplayItem(container1, DisplayItem::EndSubsequence),
+        TestDisplayItem(container2, DisplayItem::BeginSubsequence),
+        TestDisplayItem(container2, DisplayItem::BoxDecorationBackground),
+        TestDisplayItem(content2, DisplayItem::BoxDecorationBackground),
+        TestDisplayItem(container2, DisplayItem::EndSubsequence),
+        TestDisplayItem(html, DisplayItem::EndSubsequence));
 }
 
 } // namespace blink