Invalidate caret during paint invalidation

third_party/WebKit/Source/core/editing/FrameSelection.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
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
  *
  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #ifndef FrameSelection_h
 #define FrameSelection_h
 
+#include <memory>
 #include "core/CoreExport.h"
 #include "core/dom/Range.h"
 #include "core/dom/SynchronousMutationObserver.h"
 #include "core/editing/EphemeralRange.h"
 #include "core/editing/VisiblePosition.h"
 #include "core/editing/VisibleSelection.h"
 #include "core/editing/iterators/TextIteratorBehavior.h"
 #include "core/layout/ScrollAlignment.h"
 #include "platform/Timer.h"
 #include "platform/geometry/IntRect.h"
 #include "platform/geometry/LayoutRect.h"
+#include "platform/graphics/PaintInvalidationReason.h"
 #include "platform/heap/Handle.h"
 #include "wtf/Noncopyable.h"
-#include <memory>
 
 namespace blink {
 
 class CharacterData;
 class DisplayItemClient;
 class LayoutBlock;
 class LocalFrame;
 class FrameCaret;
 class GranularityStrategy;
 class GraphicsContext;
 class HTMLFormElement;
 class SelectionEditor;
 class PendingSelection;
 class Text;
 class TextIteratorBehavior;
+struct PaintInvalidatorContext;
 
 enum class CursorAlignOnScroll { IfNeeded, Always };
 
 enum EUserTriggered { NotUserTriggered = 0, UserTriggered = 1 };
 
 enum RevealExtentOption { RevealExtent, DoNotRevealExtent };
 
 enum class SelectionDirectionalMode { NonDirectional, Directional };
 
 enum class CaretVisibility;
@@ skipping 113 matching lines @@
                           const VisiblePosition& extent,
                           TextGranularity);
 
   TextGranularity granularity() const { return m_granularity; }
 
   Position base() const { return selection().base(); }
   Position extent() const { return selection().extent(); }
   Position start() const { return selection().start(); }
   Position end() const { return selection().end(); }
 
-  // Returns true if specified layout block has caret. This function is
-  // called during InRecalStyle and InPaint.
-  bool hasCaretIn(const LayoutBlock&) const;
+  // Returns true if specified layout block should paint caret. This function is
+  // called during painting only.
+  bool shouldPaintCaret(const LayoutBlock&) const;
 
   // Bounds of (possibly transformed) caret in absolute coords
   IntRect absoluteCaretBounds();
 
   void didChangeFocus();
 
   bool isNone() const { return selection().isNone(); }
   bool isCaret() const { return selection().isCaret(); }
   bool isRange() const { return selection().isRange(); }
   bool isInPasswordField() const;
   bool isDirectional() const { return selection().isDirectional(); }
 
   // If this FrameSelection has a logical range which is still valid, this
   // function return its clone. Otherwise, the return value from underlying
   // VisibleSelection's firstRange() is returned.
   Range* firstRange() const;
 
   void documentAttached(Document*);
-  void dataWillChange(const CharacterData& node);
 
   void didLayout();
   bool isAppearanceDirty() const;
   void commitAppearanceIfNeeded(LayoutView&);
   void setCaretVisible(bool caretIsVisible);
-  void setCaretRectNeedsUpdate();
   void scheduleVisualUpdate() const;
-  void invalidateCaretRect(bool forceInvalidation = false);
+  void scheduleVisualUpdateForPaintInvalidationIfNeeded() const;
+
+  // Paint invalidation methods delegating to FrameCaret.
+  void clearPreviousCaretVisualRect(const LayoutBlock&);
+  void layoutBlockWillBeDestroyed(const LayoutBlock&);
+  void updateStyleAndLayoutIfNeeded();
+  void invalidatePaintIfNeeded(const LayoutBlock&,
+                               const PaintInvalidatorContext&,
+                               PaintInvalidationReason);
+
   void paintCaret(GraphicsContext&, const LayoutPoint&);
 
   // Used to suspend caret blinking while the mouse is down.
   void setCaretBlinkingSuspended(bool);
   bool isCaretBlinkingSuspended() const;
 
   // Focus
   void setFocused(bool);
   bool isFocused() const { return m_focused; }
   bool isFocusedAndActive() const;
@@ skipping 41 matching lines @@
 
   // TODO(yosin): We should check DOM tree version and style version in
   // |FrameSelection::selection()| to make sure we use updated selection,
   // rather than having |updateIfNeeded()|. Once, we update all layout tests
   // to use updated selection, we should make |updateIfNeeded()| private.
   void updateIfNeeded();
 
   DECLARE_TRACE();
 
  private:
+  friend class BlockPaintInvalidatorTest;
   friend class FrameSelectionTest;
   friend class PaintControllerPaintTestForSlimmingPaintV1AndV2;
   friend class SelectionControllerTest;
   FRIEND_TEST_ALL_PREFIXES(PaintControllerPaintTestForSlimmingPaintV1AndV2,
                            FullDocumentPaintingWithCaret);
 
   explicit FrameSelection(LocalFrame&);
 
-  // For |PaintControllerPaintTestForSlimmingPaintV1AndV2|.
   const DisplayItemClient& caretDisplayItemClientForTesting() const;
 
   // Note: We have |selectionInFlatTree()| for unit tests, we should
   // use |visibleSelection<EditingInFlatTreeStrategy>()|.
   const VisibleSelectionInFlatTree& selectionInFlatTree() const;
 
   template <typename Strategy>
   void setSelectionAlgorithm(const VisibleSelectionTemplate<Strategy>&,
                              SetSelectionOptions,
                              CursorAlignOnScroll,
@@ skipping 26 matching lines @@
   void nodeWillBeRemoved(Node&) final;
   void didUpdateCharacterData(CharacterData*,
                               unsigned offset,
                               unsigned oldLength,
                               unsigned newLength) final;
   void didMergeTextNodes(const Text& mergedNode,
                          const NodeWithIndex& nodeToBeRemovedWithIndex,
                          unsigned oldLength) final;
   void didSplitTextNode(const Text& oldNode) final;
 
-  // For unittests
-  bool shouldPaintCaretForTesting() const;
-  bool isPreviousCaretDirtyForTesting() const;
-
   Member<LocalFrame> m_frame;
   const Member<PendingSelection> m_pendingSelection;
   const Member<SelectionEditor> m_selectionEditor;
 
   TextGranularity m_granularity;
   LayoutUnit m_xPosForVerticalArrowNavigation;
 
   bool m_focused : 1;
 
   HandleVisibility m_handleVisibility = HandleVisibility::NotVisible;
 
   // Controls text granularity used to adjust the selection's extent in
   // moveRangeSelectionExtent.
   std::unique_ptr<GranularityStrategy> m_granularityStrategy;
 
   const Member<FrameCaret> m_frameCaret;
   bool m_useSecureKeyboardEntryWhenActive = false;
 };
 
 }  // namespace blink
 
 #ifndef NDEBUG
 // Outside the WebCore namespace for ease of invocation from gdb.
 void showTree(const blink::FrameSelection&);
 void showTree(const blink::FrameSelection*);
 #endif
 
 #endif  // FrameSelection_h