[SPv2] Renaming and refactor about raster invalidation tracking

third_party/WebKit/Source/platform/graphics/paint/PaintController.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 "platform/graphics/paint/PaintController.h"
 
 #include "platform/graphics/GraphicsLayer.h"
 #include "platform/graphics/paint/DrawingDisplayItem.h"
 #include "platform/instrumentation/tracing/TraceEvent.h"
 #include "platform/wtf/AutoReset.h"
 #include "platform/wtf/text/StringBuilder.h"
 #include "third_party/skia/include/core/SkPictureAnalyzer.h"
 
 #ifndef NDEBUG
 #include "platform/graphics/LoggingCanvas.h"
 #include <stdio.h>
 #endif
 
 static constexpr int kMaxNumberOfSlowPathsBeforeVeto = 5;
 
 namespace blink {
 
 void PaintController::SetTracksRasterInvalidations(bool value) {
   if (value ||
       RuntimeEnabledFeatures::paintUnderInvalidationCheckingEnabled()) {
-    paint_chunks_raster_invalidation_tracking_map_ =
+    raster_invalidation_tracking_map_ =
         WTF::WrapUnique(new RasterInvalidationTrackingMap<const PaintChunk>);
   } else {
-    paint_chunks_raster_invalidation_tracking_map_ = nullptr;
+    raster_invalidation_tracking_map_ = nullptr;
   }
 }
 
 const PaintArtifact& PaintController::GetPaintArtifact() const {
   DCHECK(new_display_item_list_.IsEmpty());
   DCHECK(new_paint_chunks_.IsInInitialState());
   return current_paint_artifact_;
 }
 
 bool PaintController::UseCachedDrawingIfPossible(
@@ skipping 205 matching lines @@
   }
 #endif
 
   if (IsSkippingCache())
     display_item.SetSkippedCache();
 
   if (RuntimeEnabledFeatures::slimmingPaintV2Enabled()) {
     size_t last_chunk_index = new_paint_chunks_.LastChunkIndex();
     if (new_paint_chunks_.IncrementDisplayItemIndex(display_item)) {
       DCHECK(last_chunk_index != new_paint_chunks_.LastChunkIndex());
-      if (last_chunk_index != kNotFound)
-        GenerateChunkRasterInvalidationRects(
+      if (last_chunk_index != kNotFound) {
+        GenerateRasterInvalidations(
             new_paint_chunks_.PaintChunkAt(last_chunk_index));
+      }
     }
   }
 
 #if DCHECK_IS_ON()
   // Verify noop begin/end pairs have been removed.
   if (new_display_item_list_.size() >= 2 && display_item.IsEnd()) {
     const auto& begin_display_item =
         new_display_item_list_[new_display_item_list_.size() - 2];
     if (begin_display_item.IsBegin() && !begin_display_item.DrawsContent())
       DCHECK(!display_item.IsEndAndPairedWith(begin_display_item.GetType()));
@@ skipping 265 matching lines @@
                (int)new_display_item_list_.size() - num_cached_new_items_);
   num_cached_new_items_ = 0;
   // These data structures are used during painting only.
   DCHECK(!IsSkippingCache());
 #if DCHECK_IS_ON()
   new_display_item_indices_by_client_.clear();
 #endif
 
   if (RuntimeEnabledFeatures::slimmingPaintV2Enabled() &&
       !new_display_item_list_.IsEmpty())
-    GenerateChunkRasterInvalidationRects(new_paint_chunks_.LastChunk());
+    GenerateRasterInvalidations(new_paint_chunks_.LastChunk());
 
   int num_slow_paths = 0;
 
   current_cache_generation_ =
       DisplayItemClient::CacheGenerationOrInvalidationReason::Next();
 
   new_cached_subsequences_.swap(current_cached_subsequences_);
   new_cached_subsequences_.clear();
   last_cached_subsequence_end_ = 0;
   for (auto& item : current_cached_subsequences_) {
@@ skipping 38 matching lines @@
       }
     }
   }
 
   for (auto* client : skipped_cache_clients)
     client->SetDisplayItemsUncached();
 
   // The new list will not be appended to again so we can release unused memory.
   new_display_item_list_.ShrinkToFit();
 
-  if (paint_chunks_raster_invalidation_tracking_map_) {
+  if (raster_invalidation_tracking_map_) {
     for (const auto& chunk : current_paint_artifact_.PaintChunks())
-      paint_chunks_raster_invalidation_tracking_map_->Remove(&chunk);
+      raster_invalidation_tracking_map_->Remove(&chunk);
   }
   current_paint_artifact_ = PaintArtifact(
       std::move(new_display_item_list_), new_paint_chunks_.ReleasePaintChunks(),
       num_slow_paths <= kMaxNumberOfSlowPathsBeforeVeto);
 
   ResetCurrentListIndices();
   out_of_order_item_indices_.clear();
   out_of_order_chunk_indices_.clear();
   items_moved_into_new_list_.clear();
 
@@ skipping 52 matching lines @@
       current_paint_artifact_.GetDisplayItemList()
           .AllocateAndConstruct<DrawingDisplayItem>(display_item_client,
                                                     DisplayItem::kDebugDrawing,
                                                     std::move(record));
   display_item.SetSkippedCache();
   // TODO(wkorman): Only compute and append visual rect for drawings.
   current_paint_artifact_.GetDisplayItemList().AppendVisualRect(
       VisualRectForDisplayItem(display_item, offset_from_layout_object));
 }
 
-void PaintController::GenerateChunkRasterInvalidationRects(
-    PaintChunk& new_chunk) {
+void PaintController::GenerateRasterInvalidations(PaintChunk& new_chunk) {
   DCHECK(RuntimeEnabledFeatures::slimmingPaintV2Enabled());
   if (new_chunk.begin_index >=
       current_cached_subsequence_begin_index_in_new_list_)
     return;
 
   static FloatRect infinite_float_rect(LayoutRect::InfiniteIntRect());
   if (!new_chunk.id) {
-    AddRasterInvalidationInfo(nullptr, new_chunk, infinite_float_rect);
+    AddRasterInvalidation(nullptr, new_chunk, infinite_float_rect);
     return;
   }
 
   // Try to match old chunk sequentially first.
   const auto& old_chunks = current_paint_artifact_.PaintChunks();
   while (next_chunk_to_match_ < old_chunks.size()) {
     const PaintChunk& old_chunk = old_chunks[next_chunk_to_match_];
     if (new_chunk.Matches(old_chunk)) {
-      GenerateChunkRasterInvalidationRectsComparingOldChunk(new_chunk,
-                                                            old_chunk);
+      GenerateRasterInvalidationsComparingChunks(new_chunk, old_chunk);
       ++next_chunk_to_match_;
       return;
     }
 
     // Add skipped old chunks into the index.
     if (old_chunk.id) {
       auto it = out_of_order_chunk_indices_.find(&old_chunk.id->client);
       Vector<size_t>& indices =
           it == out_of_order_chunk_indices_.end()
               ? out_of_order_chunk_indices_
                     .insert(&old_chunk.id->client, Vector<size_t>())
                     .stored_value->value
               : it->value;
       indices.push_back(next_chunk_to_match_);
     }
     ++next_chunk_to_match_;
   }
 
   // Sequential matching reaches the end. Find from the out-of-order index.
   auto it = out_of_order_chunk_indices_.find(&new_chunk.id->client);
   if (it != out_of_order_chunk_indices_.end()) {
     for (size_t i : it->value) {
       if (new_chunk.Matches(old_chunks[i])) {
-        GenerateChunkRasterInvalidationRectsComparingOldChunk(new_chunk,
-                                                              old_chunks[i]);
+        GenerateRasterInvalidationsComparingChunks(new_chunk, old_chunks[i]);
         return;
       }
     }
   }
 
   // We reach here because the chunk is new.
-  AddRasterInvalidationInfo(nullptr, new_chunk, infinite_float_rect);
+  AddRasterInvalidation(nullptr, new_chunk, infinite_float_rect);
 }
 
-void PaintController::AddRasterInvalidationInfo(const DisplayItemClient* client,
-                                                PaintChunk& chunk,
-                                                const FloatRect& rect) {
+void PaintController::AddRasterInvalidation(const DisplayItemClient* client,
+                                            PaintChunk& chunk,
+                                            const FloatRect& rect) {
   chunk.raster_invalidation_rects.push_back(rect);
-  if (!paint_chunks_raster_invalidation_tracking_map_)
-    return;
+  if (raster_invalidation_tracking_map_)
+    TrackRasterInvalidation(client, chunk, rect);
+}
+
+void PaintController::TrackRasterInvalidation(const DisplayItemClient* client,
+                                              PaintChunk& chunk,
+                                              const FloatRect& rect) {
+  DCHECK(raster_invalidation_tracking_map_);
+
   RasterInvalidationInfo info;
   info.rect = EnclosingIntRect(rect);
   info.client = client;
   if (client) {
     info.client_debug_name = client->DebugName();
     info.reason = client->GetPaintInvalidationReason();
   }
-  RasterInvalidationTracking& tracking =
-      paint_chunks_raster_invalidation_tracking_map_->Add(&chunk);
-  tracking.tracked_raster_invalidations.push_back(info);
+  raster_invalidation_tracking_map_->Add(&chunk).invalidations.push_back(info);
 }
 
-void PaintController::GenerateChunkRasterInvalidationRectsComparingOldChunk(
+void PaintController::GenerateRasterInvalidationsComparingChunks(
     PaintChunk& new_chunk,
     const PaintChunk& old_chunk) {
   DCHECK(RuntimeEnabledFeatures::slimmingPaintV2Enabled());
 
   // TODO(wangxianzhu): Handle PaintInvalidationIncremental.
   // TODO(wangxianzhu): Optimize paint offset change.
 
   HashSet<const DisplayItemClient*> invalidated_clients_in_old_chunk;
   size_t highest_moved_to_index = 0;
   for (size_t old_index = old_chunk.begin_index;
        old_index < old_chunk.end_index; ++old_index) {
     const DisplayItem& old_item =
         current_paint_artifact_.GetDisplayItemList()[old_index];
     const DisplayItemClient* client_to_invalidate = nullptr;
     bool is_potentially_invalid_client = false;
     if (!old_item.HasValidClient()) {
       size_t moved_to_index = items_moved_into_new_list_[old_index];
       if (new_display_item_list_[moved_to_index].DrawsContent()) {
         if (moved_to_index < new_chunk.begin_index ||
             moved_to_index >= new_chunk.end_index) {
           // The item has been moved into another chunk, so need to invalidate
           // it in the old chunk.
           client_to_invalidate =
               &new_display_item_list_[moved_to_index].Client();
           // And invalidate in the new chunk into which the item was moved.
           PaintChunk& moved_to_chunk =
               new_paint_chunks_.FindChunkByDisplayItemIndex(moved_to_index);
-          AddRasterInvalidationInfo(
-              client_to_invalidate, moved_to_chunk,
-              FloatRect(client_to_invalidate->VisualRect()));
+          AddRasterInvalidation(client_to_invalidate, moved_to_chunk,
+                                FloatRect(client_to_invalidate->VisualRect()));
         } else if (moved_to_index < highest_moved_to_index) {
           // The item has been moved behind other cached items, so need to
           // invalidate the area that is probably exposed by the item moved
           // earlier.
           client_to_invalidate =
               &new_display_item_list_[moved_to_index].Client();
         } else {
           highest_moved_to_index = moved_to_index;
         }
       }
     } else if (old_item.DrawsContent()) {
       is_potentially_invalid_client = true;
       client_to_invalidate = &old_item.Client();
     }
     if (client_to_invalidate &&
         invalidated_clients_in_old_chunk.insert(client_to_invalidate)
             .is_new_entry) {
-      AddRasterInvalidationInfo(
+      AddRasterInvalidation(
           is_potentially_invalid_client ? nullptr : client_to_invalidate,
           new_chunk,
           FloatRect(current_paint_artifact_.GetDisplayItemList().VisualRect(
               old_index)));
     }
   }
 
   HashSet<const DisplayItemClient*> invalidated_clients_in_new_chunk;
   for (size_t new_index = new_chunk.begin_index;
        new_index < new_chunk.end_index; ++new_index) {
     const DisplayItem& new_item = new_display_item_list_[new_index];
     if (new_item.DrawsContent() && !ClientCacheIsValid(new_item.Client()) &&
         invalidated_clients_in_new_chunk.insert(&new_item.Client())
             .is_new_entry) {
-      AddRasterInvalidationInfo(&new_item.Client(), new_chunk,
-                                FloatRect(new_item.Client().VisualRect()));
+      AddRasterInvalidation(&new_item.Client(), new_chunk,
+                            FloatRect(new_item.Client().VisualRect()));
     }
   }
 }
 
 void PaintController::ShowUnderInvalidationError(
     const char* reason,
     const DisplayItem& new_item,
     const DisplayItem* old_item) const {
   LOG(ERROR) << under_invalidation_message_prefix_ << " " << reason;
 #ifndef NDEBUG
@@ skipping 121 matching lines @@
               show_paint_records
                   ? (DisplayItemList::JsonOptions::kShowPaintRecords |
                      DisplayItemList::JsonOptions::kShowClientDebugName)
                   : DisplayItemList::JsonOptions::kShowClientDebugName)
           ->ToPrettyJSONString()
           .Utf8()
           .data());
 }
 
 }  // namespace blink