[Android] Allow setting recently visited search engines as default search engine

chrome/browser/search_engines/template_url_service_android.h

 // Copyright (c) 2013 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_SEARCH_ENGINES_TEMPLATE_URL_SERVICE_ANDROID_H_
 #define CHROME_BROWSER_SEARCH_ENGINES_TEMPLATE_URL_SERVICE_ANDROID_H_
 
 #include <memory>
 
 #include "base/android/jni_weak_ref.h"
 #include "base/android/scoped_java_ref.h"
 #include "base/macros.h"
 #include "components/search_engines/template_url_service.h"
 #include "components/search_engines/template_url_service_observer.h"
 
 class TemplateURL;
 
 
 // Android wrapper of the TemplateUrlService which provides access from the Java
 // layer. Note that on Android, there's only a single profile, and therefore
 // a single instance of this wrapper.
 class TemplateUrlServiceAndroid : public TemplateURLServiceObserver {
  public:
   TemplateUrlServiceAndroid(JNIEnv* env, jobject obj);
 
   void Load(JNIEnv* env, const base::android::JavaParamRef<jobject>& obj);
   void SetUserSelectedDefaultSearchProvider(
       JNIEnv* env,
       const base::android::JavaParamRef<jobject>& obj,
-      jint selected_index);
-  jint GetDefaultSearchProvider(
+      const base::android::JavaParamRef<jstring>& jkeyword);
+
+  jint GetDefaultSearchProviderIndex(
       JNIEnv* env,
-      const base::android::JavaParamRef<jobject>& obj);
-  jint GetTemplateUrlCount(JNIEnv* env,
-                           const base::android::JavaParamRef<jobject>& obj);
-  jboolean IsLoaded(JNIEnv* env,
-                    const base::android::JavaParamRef<jobject>& obj);
+      const base::android::JavaParamRef<jobject>& obj) const;
+
+  jint GetTemplateUrlCount(
+      JNIEnv* env,
+      const base::android::JavaParamRef<jobject>& obj) const;
+  jboolean IsLoaded(
+      JNIEnv* env,
+      const base::android::JavaParamRef<jobject>& obj) const;
   base::android::ScopedJavaLocalRef<jobject> GetTemplateUrlAt(
       JNIEnv* env,
       const base::android::JavaParamRef<jobject>& obj,
-      jint index);
+      jint index) const;
   jboolean IsSearchProviderManaged(
       JNIEnv* env,
       const base::android::JavaParamRef<jobject>& obj);
   jboolean IsSearchByImageAvailable(
       JNIEnv* env,
       const base::android::JavaParamRef<jobject>& obj);
   jboolean IsDefaultSearchEngineGoogle(
       JNIEnv* env,
       const base::android::JavaParamRef<jobject>& obj);
   base::android::ScopedJavaLocalRef<jstring> GetUrlForSearchQuery(
@@ skipping 12 matching lines @@
   base::android::ScopedJavaLocalRef<jstring> GetUrlForContextualSearchQuery(
       JNIEnv* env,
       const base::android::JavaParamRef<jobject>& obj,
       const base::android::JavaParamRef<jstring>& jquery,
       const base::android::JavaParamRef<jstring>& jalternate_term,
       jboolean jshould_prefetch,
       const base::android::JavaParamRef<jstring>& jprotocol_version);
   base::android::ScopedJavaLocalRef<jstring> GetSearchEngineUrlFromTemplateUrl(
       JNIEnv* env,
       const base::android::JavaParamRef<jobject>& obj,
-      jint index);
+      const base::android::JavaParamRef<jstring>& jkeyword);
 
   static bool Register(JNIEnv* env);
 
  private:
   ~TemplateUrlServiceAndroid() override;
 
-  bool IsPrepopulatedTemplate(TemplateURL* url);
-
   void OnTemplateURLServiceLoaded();
 
   // TemplateUrlServiceObserver:
   void OnTemplateURLServiceChanged() override;
 
+  // Retrieves and sorts TemplateURL list and calculates the index of the
+  // default search provider with it.

[Peter Kasting, 2016/11/29 03:32:18]

This comment is incorrect, since the function does not calculate a default
search provider index.

There have been several cases in this CL where comments haven't been updated
correctly from one patch set to another.  Please be careful to keep your
comments up to date.  Reviewers now and readers later will treat your comments
as more important than the code itself.

I don't know whether you should clarify the "sorts" bit at all.  Perhaps a
comment like this:

Updates |template_urls_| to contain everything for which
TemplateURLService::ShowInDefaultList() returns true.  Sorts this list with
prepopulated engines first, then any default non-prepopulated engine, then other
non-prepopulated engines.

[ltian, 2016/11/30 06:36:17]

Sorry for forgetting update the comment up to date. And the |template_urls_|
actually not only holds urls for which TemplateURLService::ShowInDefaultList()
returns true, but also all the other Template URLs.

+  void LoadTemplateURLs();
+
   JavaObjectWeakGlobalRef weak_java_obj_;
 
   // Pointer to the TemplateUrlService for the main profile.
   TemplateURLService* template_url_service_;
 
   std::unique_ptr<TemplateURLService::Subscription> template_url_subscription_;
 
+  // Caches the up-to-date TemplateURL list so that calls from Android could
+  // directly get data from it.
+  std::vector<TemplateURL*> template_urls_;
+
   DISALLOW_COPY_AND_ASSIGN(TemplateUrlServiceAndroid);
 };
 
 #endif  // CHROME_BROWSER_SEARCH_ENGINES_TEMPLATE_URL_SERVICE_ANDROID_H_