[TTS] Add a Java Context linked to existing native

chrome/browser/android/contextualsearch/contextual_search_delegate.h

 // 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.
 
 #ifndef CHROME_BROWSER_ANDROID_CONTEXTUALSEARCH_CONTEXTUAL_SEARCH_DELEGATE_H_
 #define CHROME_BROWSER_ANDROID_CONTEXTUALSEARCH_CONTEXTUAL_SEARCH_DELEGATE_H_
 
 #include <stddef.h>
 
 #include <memory>
@@ skipping 25 matching lines @@
 // way, without the complication of being connected to a Java object.
 class ContextualSearchDelegate
     : public net::URLFetcherDelegate,
       public base::SupportsWeakPtr<ContextualSearchDelegate> {
  public:
   // Callback that provides the surrounding text past the selection for the UX.
   typedef base::Callback<void(const std::string&)> SurroundingTextCallback;
   // Provides the Resolved Search Term, called when the Resolve Request returns.
   typedef base::Callback<void(const ResolvedSearchTerm&)>
       SearchTermResolutionCallback;
-  // Provides the surrounding text and selection start/end when Blink gathers
-  // surrounding text for the Context.
-  typedef base::Callback<
-      void(const base::string16&, int, int)>
-      HandleSurroundingsCallback;
   // Provides limited surrounding text for icing.
   typedef base::Callback<
       void(const std::string&, const base::string16&, size_t, size_t)>
       IcingCallback;
 
   // ID used in creating URLFetcher for Contextual Search results.
   static const int kContextualSearchURLFetcherID;
 
   // Constructs a delegate that will always call back to the given callbacks
   // when search term resolution or surrounding text responses are available.
   ContextualSearchDelegate(
       net::URLRequestContextGetter* url_request_context,
       TemplateURLService* template_url_service,
       const SearchTermResolutionCallback& search_term_callback,
       const SurroundingTextCallback& surrounding_callback,
       const IcingCallback& icing_callback);
   ~ContextualSearchDelegate() override;
 
-  // Gathers surrounding text and starts an asynchronous search term resolution
-  // request. The "search term" is the best query to issue for a section of text
-  // in the context of a web page. When the response is available the callback
-  // specified in the constructor is run.
-  void StartSearchTermResolutionRequest(const std::string& selection,
-                                        const std::string& home_country,
-                                        content::WebContents* web_contents,
-                                        bool may_send_base_page_url);
+  // Gathers surrounding text and saves it locally in the given context.
+  void GatherAndSaveSurroundingText(
+      ContextualSearchContext* contextual_search_context,
+      content::WebContents* web_contents);
 
-  // Gathers surrounding text and saves it locally for a future query.
-  void GatherAndSaveSurroundingText(const std::string& selection,
-                                    const std::string& home_country,
-                                    content::WebContents* web_contents,
-                                    bool may_send_base_page_url);
-
-  // Continues making a Search Term Resolution request, once the surrounding
-  // text has been gathered.
-  void ContinueSearchTermResolutionRequest();
+  // Starts an asynchronous search term resolution request.
+  // The given context includes some content from a web page and must be able
+  // to resolve.
+  // When the response is available the callback specified in the constructor
+  // is run.
+  void StartSearchTermResolutionRequest(
+      ContextualSearchContext* contextual_search_context,
+      content::WebContents* web_contents);
 
   // Gets the target language for translation purposes for this user.
   std::string GetTargetLanguage();
 
   // Returns the accept languages preference string.
   std::string GetAcceptLanguages();
 
   // For testing.
   void set_context_for_testing(ContextualSearchContext* context) {
-    context_.reset(context);
+    context_ = context;
   }
 
  private:
+  // Friend our test which allows our private methods to be used in helper
+  // functions.  FRIEND_TEST_ALL_PREFIXES just friends individual prefixes.
+  // Needed for |ResolveSearchTermFromContext|.
+  friend class ContextualSearchDelegateTest;
+  // TODO(donnd): consider removing the following since the above covers this.
   FRIEND_TEST_ALL_PREFIXES(ContextualSearchDelegateTest,
                            SurroundingTextHighMaximum);
   FRIEND_TEST_ALL_PREFIXES(ContextualSearchDelegateTest,
                            SurroundingTextLowMaximum);
   FRIEND_TEST_ALL_PREFIXES(ContextualSearchDelegateTest,
                            SurroundingTextNoBeforeText);
   FRIEND_TEST_ALL_PREFIXES(ContextualSearchDelegateTest,
                            SurroundingTextNoAfterText);
   FRIEND_TEST_ALL_PREFIXES(ContextualSearchDelegateTest,
                            ExtractMentionsStartEnd);
   FRIEND_TEST_ALL_PREFIXES(ContextualSearchDelegateTest,
                            SurroundingTextForIcing);
   FRIEND_TEST_ALL_PREFIXES(ContextualSearchDelegateTest,
                            SurroundingTextForIcingNegativeLimit);
   FRIEND_TEST_ALL_PREFIXES(ContextualSearchDelegateTest,
                            DecodeSearchTermFromJsonResponse);
   FRIEND_TEST_ALL_PREFIXES(ContextualSearchDelegateTest, DecodeStringMentions);
 
   // net::URLFetcherDelegate:
   void OnURLFetchComplete(const net::URLFetcher* source) override;
 
-  // Builds the ContextualSearchContext in the current context from
-  // the given parameters.
-  void BuildContext(const std::string& selection,
-                    const std::string& home_country,
-                    content::WebContents* web_contents,
-                    bool may_send_base_page_url);
+  // Resolves the search term specified by the current context.
+  // Only needed for tests.  TODO(donnd): make private and friend?
+  void ResolveSearchTermFromContext();
 
   // Builds and returns the search term resolution request URL.
   // |selection| is used as the default query.
   std::string BuildRequestUrl(std::string selection);
 
   // Uses the TemplateURL service to construct a search term resolution URL from
   // the given parameters.
   std::string GetSearchTermResolutionUrlString(
       const std::string& selected_text,
       const std::string& base_page_url,
       const bool may_send_base_page_url);
 
-  // Will gather the surrounding text from the |content_view_core| and call the
-  // |callback|.
-  void GatherSurroundingTextWithCallback(const std::string& selection,
-                                         const std::string& home_country,
-                                         content::WebContents* web_contents,
-                                         bool may_send_base_page_url,
-                                         HandleSurroundingsCallback callback);
-
-  // Callback for GatherSurroundingTextWithCallback(). Will start the search
-  // term resolution request.
-  void StartSearchTermRequestFromSelection(
+  // Callback for GatherAndSaveSurroundingText, called when surrounding text is
+  // available.
+  void OnTextSurroundingSelectionAvailable(
       const base::string16& surrounding_text,
       int start_offset,
       int end_offset);
 
   void SaveSurroundingText(
     const base::string16& surrounding_text,
     int start_offset,
     int end_offset);
 
   // Will call back to the manager with the proper surrounding text to be shown
@@ skipping 76 matching lines @@
   // The callback for notifications of completed URL fetches.
   SearchTermResolutionCallback search_term_callback_;
 
   // The callback for notifications of surrounding text being available.
   SurroundingTextCallback surrounding_callback_;
 
   // The callback for notifications of Icing selection being available.
   IcingCallback icing_callback_;
 
   // Used to hold the context until an upcoming search term request is started.
-  std::unique_ptr<ContextualSearchContext> context_;
+  // Owned by the Java ContextualSearchContext.
+  ContextualSearchContext* context_;
 
   DISALLOW_COPY_AND_ASSIGN(ContextualSearchDelegate);
 };
 
 #endif  // CHROME_BROWSER_ANDROID_CONTEXTUALSEARCH_CONTEXTUAL_SEARCH_DELEGATE_H_