mandoline: Add find in page.

components/web_view/public/interfaces/frame.mojom

 // Copyright 2015 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.
 
 module web_view.mojom;
 
 import "network/public/interfaces/url_loader.mojom";
 
 // This files defines the interfaces and structures used for frames.
 //
@@ skipping 92 matching lines @@
   RequestNavigate(NavigationTargetType target_type,
                   uint32 target_frame_id,
                   mojo.URLRequest request);
 
   // The frame navigated locally, for example, pushState() navigations in an
   // HTML application.
   DidNavigateLocally(string url);
 
   // Dispatches a load event to the parent of the frame.
   DispatchLoadEventToParent();
+
+  // Reports the number of matches for a given find. This is an asynchronous

[sky, 2015/10/05 23:38:27]

nit: update grammar 'this is an asynchronous notification can fire'?

+  // notification can fire multiple times per HighlightFindResults() call.
+  OnFindInFrameCountUpdated(int32 request_id, int32 count,
+                            bool final_update);
+
+  // Reports which match is currently highlighted.
+  OnFindInPageSelectionUpdated(int32 request_id, int32 active_match_ordinal);
 };
 
 enum ViewConnectType {
   // Indicates the app is already a ViewTreeClient and the existing view should
   // be used. In this case the app is not asked for a new ViewTreeClient.
   USE_EXISTING,
 
   // Indicates a new ViewTreeClient is obtained and the View provided to
   // OnEmbed() should be used.
   USE_NEW
@@ skipping 36 matching lines @@
   // Additionally it overlaps with the client properties.
   OnWillNavigate(string origin) => ();
 
   // Called to notify that |frame_id|'s loading state has changed. This is only
   // called on the FrameClient rendering the parent of |frame_id|.
   OnFrameLoadingStateChanged(uint32 frame_id, bool loading);
 
   // Called to dispatch a load event of |frame_id| in its parent. This is only
   // called on the FrameClient rendering the parent of |frame_id|.
   OnDispatchFrameLoadEvent(uint32 frame_id);
+
+  // TODO(erg): Several of these take a WebFindOptions struct; we probably need
+  // to build a Frame version of that struct.
+
+  // Searches for a given string. If a match is found, it will be
+  // selected. Find() will only return true if it found a match, and will return
+  // the result in the future through OnFindInPageSelectionUpdated().
+  //
+  // |request_id| should be a monotonically increasing number which should only
+  // be reused between Find() and the HighlightFindResults() calls that are
+  // searching for the same string. |search_text| may be empty.
+  Find(int32 request_id, string search_text) => (bool found);

[sky, 2015/10/05 23:38:27]

Be aware that there are race conditions with using a callback, and invoking a
client function. By that I mean there is no guarantee that the callback will be
received before OnFindInFrame...

+
+  // Stop finding the single find result on the page. If |clear_selection| is
+  // set, it will also clear the selected find text.
+  StopFinding(bool clear_selection);
+
+  // Match every instance of a string in a document asynchronously, highlighting
+  // them and putting a tick mark in the scroll bar. This differs from Find() as
+  // Find() is about finding the one selected instance of the text.
+  // HighlightFindResults() is about highlighting all the instances of the text.
+  //
+  // HighlightFindResults() will asynchronously call
+  // OnFindInFrameCountUpdated() multiple times to report its progress.
+  HighlightFindResults(int32 request_id, string search_test, bool reset);
+
+  // Removes the tick marks and highlighting done by HighlightFindResults() in
+  // this frame.
+  StopHighlightingFindResults();
 };