Invalidate caret during paint invalidation

third_party/WebKit/Source/core/editing/CaretDisplayItemClient.h

 /*
  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 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
@@ skipping 19 matching lines @@
 #include "core/editing/PositionWithAffinity.h"
 #include "platform/geometry/IntRect.h"
 #include "platform/geometry/LayoutRect.h"
 #include "platform/graphics/paint/DisplayItem.h"
 #include "wtf/Noncopyable.h"
 
 namespace blink {
 
 class GraphicsContext;
 class LayoutBlock;
+struct PaintInvalidatorContext;
 
 class CaretDisplayItemClient final : public DisplayItemClient {
   WTF_MAKE_NONCOPYABLE(CaretDisplayItemClient);
 
  public:
   CaretDisplayItemClient();
   virtual ~CaretDisplayItemClient();
 
+  // TODO(yosin,wangxianzhu): Make these two static functions private or
+  // combine them into updateForPaintInvalidation() when the callsites in
+  // FrameCaret are removed.
+
   // Creating VisiblePosition causes synchronous layout so we should use the
   // PositionWithAffinity version if possible.
   // A position in HTMLTextFromControlElement is a typical example.
   static LayoutRect computeCaretRect(const PositionWithAffinity& caretPosition);
+  static LayoutBlock* caretLayoutBlock(const Node*);
 
-  void paintCaret(Node*,
-                  GraphicsContext&,
-                  const LayoutRect& caretLocalRect,
-                  const LayoutPoint&,
-                  DisplayItem::Type);
+  // Called indirectly from LayoutObject::clearPreviousVisualRects().
+  void clearPreviousVisualRect(const LayoutBlock& block) {
+    if (shouldPaintCaret(block))
+      m_visualRect = LayoutRect();
+  }
 
-  static LayoutBlock* caretLayoutObject(Node*);
-  void invalidateLocalCaretRect(Node*, const LayoutRect&);
+  void layoutBlockWillBeDestroyed(const LayoutBlock& block) {
+    if (!shouldPaintCaret(block))
+      return;
+    m_visualRect = LayoutRect();
+    m_layoutBlock = nullptr;
+  }
+
+  // Called when a FrameView finishes layout. Updates style and geometry of the
+  // caret for paint invalidation and painting.
+  void updateStyleAndLayoutIfNeeded(const PositionWithAffinity& caretPosition);
+
+  // Called during LayoutBlock paint invalidation.
+  void invalidatePaintIfNeeded(
+      const LayoutBlock&,
+      const PaintInvalidatorContext&,
+      PaintInvalidationReason layoutBlockPaintInvalidationReason);
+
+  bool shouldPaintCaret(const LayoutBlock& block) const {
+    return &block == m_layoutBlock;
+  }
+  void paintCaret(GraphicsContext&,
+                  const LayoutPoint& paintOffset,
+                  DisplayItem::Type) const;
 
   // DisplayItemClient methods.
   LayoutRect visualRect() const final;
   String debugName() const final;
 
  private:
+  // These are updated by updateStyleAndLayoutIfNeeded().
+  Color m_color;
+  LayoutRect m_localRect;
+  LayoutBlock* m_layoutBlock = nullptr;
+
+  // This is set to the previous m_layoutBlock if m_layoutLayout will change
+  // during updateStyleAndLayoutIfNeeded() and can be used in
+  // invalidatePaintIfNeeded() only.
+  const LayoutBlock* m_previousLayoutBlock = nullptr;
+
+  // This is updated by invalidatePaintIfNeeded().
   LayoutRect m_visualRect;
+
+  bool m_needsPaintInvalidation = false;
 };
 
 }  // namespace blink
 
 #endif  // CaretDisplayItemClient_h