Multi-Process Find-in-Page.

third_party/WebKit/public/web/WebLocalFrame.h

 // 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.
 
 #ifndef WebLocalFrame_h
 #define WebLocalFrame_h
 
 #include "WebFrame.h"
 #include "WebFrameLoadType.h"
 
@@ skipping 232 matching lines @@
         bool wrapWithinFrame,
         WebRect* selectionRect,
         bool* activeNow = nullptr) = 0;
 
     // Notifies the frame that we are no longer interested in searching.
     // This will abort any asynchronous scoping effort already under way
     // (see the function scopeStringMatches for details) and erase all
     // tick-marks and highlighting from the previous search.  If
     // clearSelection is true, it will also make sure the end state for the
     // find operation does not leave a selection.  This can occur when the
-    // user clears the search string but does not close the find box.
-    virtual void stopFinding(bool clearSelection) = 0;
+    // user clears the search string but does not close the find box.  If
+    // activateSelection is true, the find-in-page selection will be
+    // activated, if one exists.
+    virtual void stopFinding(bool clearSelection, bool activateSelection) = 0;

[dcheng, 2016/05/18 21:29:21]

enum instead of two bools (since the bools are mutually exclusive anyway)

[paulmeyer, 2016/05/19 20:08:36]

Done.

 
     // Counts how many times a particular string occurs within the frame.
     // It also retrieves the location of the string and updates a vector in
     // the frame so that tick-marks and highlighting can be drawn.  This
     // function does its work asynchronously, by running for a certain
     // time-slice and then scheduling itself (co-operative multitasking) to
     // be invoked later (repeating the process until all matches have been
     // found).  This allows multiple frames to be searched at the same time
     // and provides a way to cancel at any time (see
     // cancelPendingScopingEffort).  The parameter searchText specifies
@@ skipping 22 matching lines @@
     // current version. Should be called only on the main frame.
     virtual int findMatchMarkersVersion() const = 0;
 
     // Returns the bounding box of the active find-in-page match marker or an
     // empty rect if no such marker exists. The rect is returned in find-in-page
     // coordinates whatever frame the active marker is.
     // Should be called only on the main frame.
     virtual WebFloatRect activeFindMatchRect() = 0;
 
     // Swaps the contents of the provided vector with the bounding boxes of the
-    // find-in-page match markers from all frames. The bounding boxes are returned
-    // in find-in-page coordinates. This method should be called only on the main frame.
+    // find-in-page match markers from all frames. The bounding boxes are
+    // returned in find-in-page coordinates. This method should be called only
+    // on the main frame.
     virtual void findMatchRects(WebVector<WebFloatRect>&) = 0;
 
-    // Selects the find-in-page match in the appropriate frame closest to the
-    // provided point in find-in-page coordinates. Returns the ordinal of such
-    // match or -1 if none could be found. If not null, selectionRect is set to
-    // the bounding box of the selected match in window coordinates.
-    // This method should be called only on the main frame.
+    // Selects the find-in-page match closest to the provided point in
+    // find-in-page coordinates. Returns the ordinal of such match or -1 if none
+    // could be found. If not null, selectionRect is set to the bounding box of
+    // the selected match in window coordinates.  This method should be called
+    // only on the main frame.
     virtual int selectNearestFindMatch(const WebFloatPoint&,
         WebRect* selectionRect)
         = 0;
 
+    // Returns the distance (squared) to the closest find-in-page match from the

[dcheng, 2016/05/18 21:29:21]

Maybe name this distanceToNearestFindMatch() to make it clear what it returns.

I guess you could call it distanceSquaredToNearestFindMatch(), but that doesn't
seem like a super important detail.

[paulmeyer, 2016/05/19 20:08:36]

Done. I didn't add "squared" because I agree that it isn't important. Some
places along the way mention that the distance is squared, and some don't. Since
these distances are just used comparatively, the fact that they are squared is
just an implementation detail.

+    // provided point, in find-in-page coordinates.
+    virtual float nearestFindMatch(const WebFloatPoint&) = 0;
+
     // Set the tickmarks for the frame. This will override the default tickmarks
     // generated by find results. If this is called with an empty array, the
     // default behavior will be restored.
     virtual void setTickmarks(const WebVector<WebRect>&) = 0;
 
+    // Clears the active find match in the frame, if one exists.
+    virtual void clearActiveFindMatch() = 0;
+
     // Context menu -----------------------------------------------------------
 
     // Returns the node that the context menu opened over.
     virtual WebNode contextMenuNode() const = 0;
 
     // Returns the WebFrameWidget associated with this frame if there is one or
     // nullptr otherwise.
     virtual WebWidget* frameWidget() const = 0;
 
 protected:
     explicit WebLocalFrame(WebTreeScopeType scope) : WebFrame(scope) { }
 
     // Inherited from WebFrame, but intentionally hidden: it never makes sense
     // to call these on a WebLocalFrame.
     bool isWebLocalFrame() const override = 0;
     WebLocalFrame* toWebLocalFrame() override = 0;
     bool isWebRemoteFrame() const override = 0;
     WebRemoteFrame* toWebRemoteFrame() override = 0;
 };
 
 } // namespace blink
 
 #endif // WebLocalFrame_h