Remove the "autogenerate keyword" bit on TemplateURL.

chrome/browser/search_engines/template_url.h

 // Copyright (c) 2012 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_H_
 #define CHROME_BROWSER_SEARCH_ENGINES_TEMPLATE_URL_H_
 #pragma once
 
 #include <string>
 #include <vector>
@@ skipping 220 matching lines @@
 // whatever fields are desired, then create an immutable TemplateURL from it.
 struct TemplateURLData {
   TemplateURLData();
   ~TemplateURLData();
 
   // A short description of the template. This is the name we show to the user
   // in various places that use TemplateURLs. For example, the location bar
   // shows this when the user selects a substituting match.
   string16 short_name;
 
-  // The shortcut for this TemplateURL.  May be empty.
+  // The shortcut for this TemplateURL.  |keyword| must be non-empty.
   void SetKeyword(const string16& keyword);
-  const string16& keyword(TemplateURL* t_url) const;
-  // TODO(pkasting): This should only be necessary until we eliminate keyword
-  // autogeneration.
-  const string16& raw_keyword() const { return keyword_; }
-
-  // Whether to autogenerate a keyword in TemplateURL::GetKeyword().  Most
-  // consumers should not need this.
-  // NOTE: Calling SetKeyword() turns this back off.  Manual and automatic
-  // keywords are mutually exclusive.
-  void SetAutogenerateKeyword(bool autogenerate_keyword);
-  bool autogenerate_keyword() const { return autogenerate_keyword_; }
-
-  // Ensures that the keyword is generated.  Most consumers should not need this
-  // because it is done automatically.  Use this method on the UI thread, so
-  // the keyword may be accessed on another thread.
-  void EnsureKeyword(TemplateURL* t_url) const;
+  const string16& keyword() const { return keyword_; }
 
   // The raw URL for the TemplateURL, which may not be valid as-is (e.g. because
   // it requires substitutions first).  This must be non-empty.
   void SetURL(const std::string& url);
   const std::string& url() const { return url_; }
 
   // Optional additional raw URLs.
   std::string suggestions_url;
   std::string instant_url;
 
@@ skipping 49 matching lines @@
   // If this TemplateURL comes from prepopulated data the prepopulate_id is > 0.
   int prepopulate_id;
 
   // The primary unique identifier for Sync. This set on all TemplateURLs
   // regardless of whether they have been associated with Sync.
   std::string sync_guid;
 
  private:
   // Private so we can enforce using the setters and thus enforce that these
   // fields are never empty.
-  // TODO(pkasting): |keyword_| is temporarily still allowed to be empty.
-  mutable string16 keyword_;
+  string16 keyword_;
   std::string url_;
-
-  // TODO(pkasting): These fields will go away soon.
-  bool autogenerate_keyword_;
-  // True if the keyword was generated. This is used to avoid multiple attempts
-  // if generating a keyword failed.
-  mutable bool keyword_generated_;
 };
 
 
 // TemplateURL ----------------------------------------------------------------
 
 // A TemplateURL represents a single "search engine", defined primarily as a
 // subset of the Open Search Description Document
 // (http://www.opensearch.org/Specifications/OpenSearch) plus some extensions.
 // One TemplateURL contains several TemplateURLRefs, which correspond to various
 // different capabilities (e.g. doing searches or getting suggestions), as well
@@ skipping 18 matching lines @@
   static GURL GenerateFaviconURL(const GURL& url);
 
   Profile* profile() { return profile_; }
   const TemplateURLData& data() const { return data_; }
 
   const string16& short_name() const { return data_.short_name; }
   // An accessor for the short_name, but adjusted so it can be appropriately
   // displayed even if it is LTR and the UI is RTL.
   string16 AdjustedShortNameForLocaleDirection() const;
 
-  const string16& keyword() const {
-    // TODO(pkasting): See comment on EnsureKeyword() below.
-    return data_.keyword(const_cast<TemplateURL*>(this));
-  }
-  bool autogenerate_keyword() const {
-    return data_.autogenerate_keyword();
-  }
-  void EnsureKeyword() const {
-    // TODO(pkasting): EnsureKeyword() will die soon so it's not worth jumping
-    // through hoops to fix this const_cast<>().
-    data_.EnsureKeyword(const_cast<TemplateURL*>(this));
-  }
+  const string16& keyword() const { return data_.keyword(); }
 
   const std::string& url() const { return data_.url(); }
   const std::string& suggestions_url() const { return data_.suggestions_url; }
   const std::string& instant_url() const { return data_.instant_url; }
   const GURL& favicon_url() const { return data_.favicon_url; }
 
   const GURL& originating_url() const { return data_.originating_url; }
 
   bool show_in_default_list() const { return data_.show_in_default_list; }
   // Returns true if show_in_default_list() is true and this TemplateURL has a
@@ skipping 25 matching lines @@
   }
   const TemplateURLRef& instant_url_ref() const { return instant_url_ref_; }
 
   // Returns true if |url| supports replacement.
   bool SupportsReplacement() const;
 
   // Like SupportsReplacement but usable on threads other than the UI thread.
   bool SupportsReplacementUsingTermsData(
       const SearchTermsData& search_terms_data) const;
 
+  // Returns true if this TemplateURL uses Google base URLs and has a keyword
+  // of "google.TLD".  We use this to decide whether we can automatically
+  // update the keyword to reflect the current Google base URL TLD.
+  bool IsGoogleSearchURLWithReplaceableKeyword() const;
+
   std::string GetExtensionId() const;
   bool IsExtensionKeyword() const;
 
  private:
   friend class TemplateURLService;
 
   void SetURL(const std::string& url);
   void SetPrepopulateId(int id);
 
+  // Resets the keyword if IsGoogleSearchURLWithReplaceableKeyword() or |force|.

[SteveT, 2012/05/07 18:17:47]

Would it be more clear here to state that "resetting" the keyword actually means
re-generating it?

[Peter Kasting, 2012/05/07 19:39:14]

Added some comments.

+  // The |force| parameter is useful when the existing keyword is known to be
+  // a placeholder.
+  void ResetKeywordIfNecessary(bool force);
+
   // Invalidates cached values on this object and its child TemplateURLRefs.
   void InvalidateCachedValues();
 
   Profile* profile_;
   TemplateURLData data_;
   TemplateURLRef url_ref_;
   TemplateURLRef suggestions_url_ref_;
   TemplateURLRef instant_url_ref_;
 
   // TODO(sky): Add date last parsed OSD file.
 };
 
 #endif  // CHROME_BROWSER_SEARCH_ENGINES_TEMPLATE_URL_H_