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.
+  OnReportFindInFrameMatchCount(int32 request_id, int32 count,
+                                bool final_update);
+
+  // Reports which match is currently highlighted.
+  OnReportFindInPageSelection(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 synchronously. If a match is found, it will be
+  // selected. Returns true if the search string was found, false otherwise.
+  Find(int32 request_id, string search_text) =>
+     (int32 request_id, string search_text, bool found);

[sky, 2015/10/02 16:03:40]

Does the callback really need a request_id too? Can't the source that invokes
Find() track the request_id if they care about?
Also, document what the expectations of this are. It isn't readily obvious why
there is both a callback and OnReportXX.

[Elliot Glaysher, 2015/10/02 21:42:33]

I put that data in a Bind() on the mojo::WebView side of things, instead of
passing back the data in the response. Also greatly expanded documentation in
this file.

+
+  // Stop highlighting the find results on the page.
+  StopFinding(bool clear_selection);
+
+  // Counts how many times a particular string occurs within a frame.
+  ScopeStringMatches(int32 request_id, string search_test, bool reset);

[sky, 2015/10/02 16:03:40]

What does 'Scope' mean in this context?

Could this function be merged with Find and Find gets arguments indicating the
type of find to do?

[Elliot Glaysher, 2015/10/02 21:42:33]

It's an opaque name from blink. I totally agree with you that this name is
terrible.

I don't like it, but I think it's better to use consistent naming than to
diverge. (That's why the ReportFindIn... methods above are named such; they are
aping the blink names to make people from blink and content feel more at home.)
Sadly, no. Find and ScopeStringMatches do different things. Find is synchronous
while ScopeStringMatches is asynchronous. Find is about the currently matched
instance of the string while ScopeStringMatches is about all instances of the
string in the document.

+
+  CancelPendingScopingEffort();
 };