Introduce TextFinder class for decoupling WebFrameImpl and text finder.

Source/web/WebFrameImpl.h

 /*
  * Copyright (C) 2009 Google 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:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 41 matching lines @@
 class Node;
 class Range;
 class SubstituteData;
 struct FrameLoadRequest;
 struct WindowFeatures;
 }
 
 namespace blink {
 class ChromePrintContext;
 class SharedWorkerRepositoryClientImpl;
+class TextFinder;
 class WebDataSourceImpl;
 class WebInputElement;
 class WebFrameClient;
 class WebPerformance;
 class WebPlugin;
 class WebPluginContainerImpl;
 class WebView;
 class WebViewImpl;
 struct WebPrintParams;
 
@@ skipping 193 matching lines @@
     WebCore::FrameView* frameView() const { return frame() ? frame()->view() : 0; }
 
     // Getters for the impls corresponding to Get(Provisional)DataSource. They
     // may return 0 if there is no corresponding data source.
     WebDataSourceImpl* dataSourceImpl() const;
     WebDataSourceImpl* provisionalDataSourceImpl() const;
 
     // Returns which frame has an active match. This function should only be
     // called on the main frame, as it is the only frame keeping track. Returned
     // value can be 0 if no frame has an active match.
-    WebFrameImpl* activeMatchFrame() const { return m_currentActiveMatchFrame; }
+    WebFrameImpl* activeMatchFrame() const;
 
     // Returns the active match in the current frame. Could be a null range if
     // the local frame has no active match.
-    WebCore::Range* activeMatch() const { return m_activeMatch.get(); }
+    WebCore::Range* activeMatch() const;
 
     // When a Find operation ends, we want to set the selection to what was active
     // and set focus to the first focusable node we find (starting with the first
     // node in the matched range and going up the inheritance chain). If we find
     // nothing to focus we focus the first focusable node in the range. This
     // allows us to set focus to a link (when we find text inside a link), which
     // allows us to navigate by pressing Enter after closing the Find box.
     void setFindEndstateFocusAndSelection();
 
     void didFail(const WebCore::ResourceError&, bool wasProvisional);
 
     // Sets whether the WebFrameImpl allows its document to be scrolled.
     // If the parameter is true, allow the document to be scrolled.
     // Otherwise, disallow scrolling.
     virtual void setCanHaveScrollbars(bool) OVERRIDE;
 
     WebCore::LocalFrame* frame() const { return m_frame.get(); }
     WebFrameClient* client() const { return m_client; }
     void setClient(WebFrameClient* client) { m_client = client; }
 
     WebPermissionClient* permissionClient() { return m_permissionClient; }
     SharedWorkerRepositoryClientImpl* sharedWorkerRepositoryClient() const { return m_sharedWorkerRepositoryClient.get(); }
 
     void setInputEventsTransformForEmulation(const WebCore::IntSize&, float);
 
     static void selectWordAroundPosition(WebCore::LocalFrame*, WebCore::VisiblePosition);
 
+    // Returns the text finder object if it already exists.
+    // Otherwise creates it and then returns.
+    TextFinder& ensureTextFinder();
+
+    // Invalidates vertical scrollbar only.
+    void invalidateScrollbar() const;
+
+    // Invalidates both content area and the scrollbar.
+    void invalidateAll() const;
+
 private:
-    class DeferredScopeStringMatches;
-    friend class DeferredScopeStringMatches;
     friend class FrameLoaderClientImpl;
 
-    struct FindMatch {
-        RefPtr<WebCore::Range> m_range;
-
-        // 1-based index within this frame.
-        int m_ordinal;
-
-        // In find-in-page coordinates.
-        // Lazily calculated by updateFindMatchRects.
-        WebCore::FloatRect m_rect;
-
-        FindMatch(PassRefPtr<WebCore::Range>, int ordinal);
-    };
-
-    // A bit mask specifying area of the frame to invalidate.
-    enum AreaToInvalidate {
-      InvalidateNothing,
-      InvalidateContentArea,
-      InvalidateScrollbar,   // Vertical scrollbar only.
-      InvalidateAll          // Both content area and the scrollbar.
-    };
-
     explicit WebFrameImpl(WebFrameClient*);
 
     // Sets the local WebCore frame and registers destruction observers.
     void setWebCoreFrame(PassRefPtr<WebCore::LocalFrame>);
 
-    // Notifies the delegate about a new selection rect.
-    void reportFindInPageSelection(
-        const WebRect& selectionRect, int activeMatchOrdinal, int identifier);
-
-    // Clear the find-in-page matches cache forcing rects to be fully
-    // calculated again next time updateFindMatchRects is called.
-    void clearFindMatchesCache();
-
-    // Check if the activeMatchFrame still exists in the frame tree.
-    bool isActiveMatchFrameValid() const;
-
-    // Return the index in the find-in-page cache of the match closest to the
-    // provided point in find-in-page coordinates, or -1 in case of error.
-    // The squared distance to the closest match is returned in the distanceSquared parameter.
-    int nearestFindMatch(const WebCore::FloatPoint&, float& distanceSquared);
-
-    // Select a find-in-page match marker in the current frame using a cache
-    // match index returned by nearestFindMatch. Returns the ordinal of the new
-    // selected match or -1 in case of error. Also provides the bounding box of
-    // the marker in window coordinates if selectionRect is not null.
-    int selectFindMatch(unsigned index, WebRect* selectionRect);
-
-    // Compute and cache the rects for FindMatches if required.
-    // Rects are automatically invalidated in case of content size changes,
-    // propagating the invalidation to child frames.
-    void updateFindMatchRects();
-
-    // Append the find-in-page match rects of the current frame to the provided vector.
-    void appendFindMatchRects(Vector<WebFloatRect>& frameRects);
-
-    // Invalidates a certain area within the frame.
-    void invalidateArea(AreaToInvalidate);
-
-    // Add a WebKit TextMatch-highlight marker to nodes in a range.
-    void addMarker(WebCore::Range*, bool activeMatch);
-
-    // Sets the markers within a range as active or inactive.
-    void setMarkerActive(WebCore::Range*, bool active);
-
-    // Returns the ordinal of the first match in the frame specified. This
-    // function enumerates the frames, starting with the main frame and up to (but
-    // not including) the frame passed in as a parameter and counts how many
-    // matches have been found.
-    int ordinalOfFirstMatchForFrame(WebFrameImpl*) const;
-
-    // Determines whether the scoping effort is required for a particular frame.
-    // It is not necessary if the frame is invisible, for example, or if this
-    // is a repeat search that already returned nothing last time the same prefix
-    // was searched.
-    bool shouldScopeMatches(const WTF::String& searchText);
-
-    // Removes the current frame from the global scoping effort and triggers any
-    // updates if appropriate. This method does not mark the scoping operation
-    // as finished.
-    void flushCurrentScopingEffort(int identifier);
-
-    // Finishes the current scoping effort and triggers any updates if appropriate.
-    void finishCurrentScopingEffort(int identifier);
-
-    // Queue up a deferred call to scopeStringMatches.
-    void scopeStringMatchesSoon(
-        int identifier, const WebString& searchText, const WebFindOptions&,
-        bool reset);
-
-    // Called by a DeferredScopeStringMatches instance.
-    void callScopeStringMatches(
-        DeferredScopeStringMatches*, int identifier, const WebString& searchText,
-        const WebFindOptions&, bool reset);
-
-    // Determines whether to invalidate the content area and scrollbar.
-    void invalidateIfNecessary();
-
     void loadJavaScriptURL(const WebCore::KURL&);
 
     // Returns a hit-tested VisiblePosition for the given point
     WebCore::VisiblePosition visiblePositionForWindowPoint(const WebPoint&);
 
     WebPlugin* focusedPluginIfInputMethodSupported();
 
     FrameLoaderClientImpl m_frameLoaderClientImpl;
 
     // The embedder retains a reference to the WebCore LocalFrame while it is active in the DOM. This
@@ skipping 10 matching lines @@
     WTF::HashSet<WebFrameImpl*> m_openedFrames;
 
     // Indicate whether the current LocalFrame is local or remote. Remote frames are
     // rendered in a different process from their parent frames.
     bool m_isRemote;
 
     WebFrameClient* m_client;
     WebPermissionClient* m_permissionClient;
     OwnPtr<SharedWorkerRepositoryClientImpl> m_sharedWorkerRepositoryClient;
 
-    // A way for the main frame to keep track of which frame has an active
-    // match. Should be 0 for all other frames.
-    WebFrameImpl* m_currentActiveMatchFrame;
-
-    // The range of the active match for the current frame.
-    RefPtr<WebCore::Range> m_activeMatch;
-
-    // The index of the active match for the current frame.
-    int m_activeMatchIndexInCurrentFrame;
-
-    // This flag is used by the scoping effort to determine if we need to figure
-    // out which rectangle is the active match. Once we find the active
-    // rectangle we clear this flag.
-    bool m_locatingActiveRect;
-
-    // The scoping effort can time out and we need to keep track of where we
-    // ended our last search so we can continue from where we left of.
-    RefPtr<WebCore::Range> m_resumeScopingFromRange;
-
-    // Keeps track of the last string this frame searched for. This is used for
-    // short-circuiting searches in the following scenarios: When a frame has
-    // been searched and returned 0 results, we don't need to search that frame
-    // again if the user is just adding to the search (making it more specific).
-    WTF::String m_lastSearchString;
-
-    // Keeps track of how many matches this frame has found so far, so that we
-    // don't loose count between scoping efforts, and is also used (in conjunction
-    // with m_lastSearchString) to figure out if we need to search the frame again.
-    int m_lastMatchCount;
-
-    // This variable keeps a cumulative total of matches found so far for ALL the
-    // frames on the page, and is only incremented by calling IncreaseMatchCount
-    // (on the main frame only). It should be -1 for all other frames.
-    int m_totalMatchCount;
-
-    // This variable keeps a cumulative total of how many frames are currently
-    // scoping, and is incremented/decremented on the main frame only.
-    // It should be -1 for all other frames.
-    int m_framesScopingCount;
-
-    // Identifier of the latest find-in-page request. Required to be stored in
-    // the frame in order to reply if required in case the frame is detached.
-    int m_findRequestIdentifier;
-
-    // Keeps track of whether there is an scoping effort ongoing in the frame.
-    bool m_scopingInProgress;
-
-    // Keeps track of whether the last find request completed its scoping effort
-    // without finding any matches in this frame.
-    bool m_lastFindRequestCompletedWithNoMatches;
-
-    // Keeps track of when the scoping effort should next invalidate the scrollbar
-    // and the frame area.
-    int m_nextInvalidateAfter;
-
-    // A list of all of the pending calls to scopeStringMatches.
-    Vector<DeferredScopeStringMatches*> m_deferredScopingWork;
-
-    // Version number incremented on the main frame only whenever the document
-    // find-in-page match markers change. It should be 0 for all other frames.
-    int m_findMatchMarkersVersion;
-
-    // Local cache of the find match markers currently displayed for this frame.
-    Vector<FindMatch> m_findMatchesCache;
-
-    // Determines if the rects in the find-in-page matches cache of this frame
-    // are invalid and should be recomputed.
-    bool m_findMatchRectsAreValid;
-
-    // Contents size when find-in-page match rects were last computed for this
-    // frame's cache.
-    WebCore::IntSize m_contentsSizeForCurrentFindMatchRects;
+    // Will be initialized after first call to find() or scopeStringMatches().
+    OwnPtr<TextFinder> m_textFinder;
 
     // Valid between calls to BeginPrint() and EndPrint(). Containts the print
     // information. Is used by PrintPage().
     OwnPtr<ChromePrintContext> m_printContext;
 
     // Stores the additional input events offset and scale when device metrics emulation is enabled.
     WebCore::IntSize m_inputEventsOffsetForEmulation;
     float m_inputEventsScaleFactorForEmulation;
 };
 
 DEFINE_TYPE_CASTS(WebFrameImpl, WebFrame, frame, true, true);
 
 } // namespace blink
 
 #endif