Invalidate caret during paint invalidation

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

 /*
  * Copyright (C) 2004, 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
  *    notice, this list of conditions and the following disclaimer in the
@@ skipping 20 matching lines @@
 #include "core/editing/PositionWithAffinity.h"
 #include "platform/Timer.h"
 #include "platform/geometry/LayoutRect.h"
 #include "platform/heap/GarbageCollected.h"
 #include "platform/heap/Member.h"
 #include <memory>
 
 namespace blink {
 
 class CaretDisplayItemClient;
-class CharacterData;
 class DisplayItemClient;
 class Document;
 class GraphicsContext;
-class Node;
+class LayoutBlock;
 class LocalFrame;
 class SelectionEditor;
 
 enum class CaretVisibility { Visible, Hidden };
 
 class CORE_EXPORT FrameCaret final
     : public GarbageCollectedFinalized<FrameCaret>,
       public SynchronousMutationObserver {
   USING_GARBAGE_COLLECTED_MIXIN(FrameCaret);
 
  public:
   FrameCaret(LocalFrame&, const SelectionEditor&);
   ~FrameCaret();
 
-  const DisplayItemClient& displayItemClient() const;
+  void setVisualRect(const LayoutRect&);
+  const DisplayItemClient& getDisplayItemClient() const;
+
   bool isActive() const { return caretPosition().isNotNull(); }
 
   void documentAttached(Document*);
   void updateAppearance();
 
   // Used to suspend caret blinking while the mouse is down.
   void setCaretBlinkingSuspended(bool suspended) {
     m_isCaretBlinkingSuspended = suspended;
   }
   bool isCaretBlinkingSuspended() const { return m_isCaretBlinkingSuspended; }
   void stopCaretBlinkTimer();
   void startBlinkCaret();
+  void setCaretVisibility(CaretVisibility);
+  IntRect absoluteCaretBounds() const;
 
-  void setCaretVisibility(CaretVisibility);
-  void setCaretRectNeedsUpdate();
-  // If |forceInvalidation| is true the caret's previous and new rectangles
-  // are forcibly invalidated regardless of the state of the blink timer.
-  void invalidateCaretRect(bool forceInvalidation);
-  IntRect absoluteCaretBounds() const;
+  // Return the caret rect in local coordinate space of |caretLayoutBlock|.

[wkorman, 2017/01/31 20:40:28]

Suggest adding to comment to define rect more explicitly, like, is it already
enclosing. Similar for other rect methods added/changed, as long as we are here.
Could do in separate change where you note you'll look into the expand by 1
which may no longer be needed.

+  LayoutRect caretLocalRect() const;
+  LayoutBlock* caretLayoutBlock() const;
+
+  void setMayNeedPaintInvalidation();
+  void setNeedsPaintInvalidation();
 
   bool shouldShowBlockCursor() const { return m_shouldShowBlockCursor; }
   void setShouldShowBlockCursor(bool);
 
   void paintCaret(GraphicsContext&, const LayoutPoint&);
 
-  void dataWillChange(const CharacterData&);
-
   // For unittests
   bool shouldPaintCaretForTesting() const { return m_shouldPaintCaret; }
-  bool isPreviousCaretDirtyForTesting() const { return m_previousCaretNode; }
 
   DECLARE_TRACE();
 
  private:
   friend class FrameSelectionTest;
 
   const PositionWithAffinity caretPosition() const;
 
   bool shouldBlinkCaret() const;
   void caretBlinkTimerFired(TimerBase*);
   bool caretPositionIsValidForDocument(const Document&) const;
 
   // Implementation of |SynchronousMutationObserver| member functions.
   void contextDestroyed(Document*) final;

[yosin_UTC9, 2017/01/31 20:12:58]

Since FrameCaret doesn't hold |Node| anymore, FrameCaret should not be derived
from |ynchronousMutationObserver|.
|contextDestroyed()| just does stopping caret blink time, we can safely remove
|contextDestroyed()|.

[Xianzhu, 2017/02/02 23:42:06]

Great. Done.

-  void nodeWillBeRemoved(Node&) final;
+
+  void scheduleVisualUpdate();
 
   const Member<const SelectionEditor> m_selectionEditor;
   const Member<LocalFrame> m_frame;
   const std::unique_ptr<CaretDisplayItemClient> m_caretBase;
-  // The last node which painted the caret. Retained for clearing the old
-  // caret when it moves.
-  Member<Node> m_previousCaretNode;
-  Member<Node> m_previousCaretAnchorNode;
-  LayoutRect m_previousCaretRect;
   CaretVisibility m_caretVisibility;
-  CaretVisibility m_previousCaretVisibility;
   // TODO(https://crbug.com/668758): Consider using BeginFrame update for this.
   TaskRunnerTimer<FrameCaret> m_caretBlinkTimer;
-  bool m_caretRectDirty : 1;
   bool m_shouldPaintCaret : 1;
   bool m_isCaretBlinkingSuspended : 1;
   bool m_shouldShowBlockCursor : 1;
 
   DISALLOW_COPY_AND_ASSIGN(FrameCaret);
 };
 
 }  // namespace blink
 
 #endif  // FrameCaret_h