Cleanup AutocompleteInput and AutocompleteProvider Functions

chrome/browser/autocomplete/autocomplete_provider.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_AUTOCOMPLETE_AUTOCOMPLETE_PROVIDER_H_
 #define CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_PROVIDER_H_
 
 #include <string>
 
 #include "base/basictypes.h"
@@ skipping 223 matching lines @@
   // A suggested upper bound for how many matches a provider should return.
   // TODO(pkasting): http://b/1111299 , http://b/933133 This should go away once
   // we have good relevance heuristics; the controller should handle all
   // culling.
   static const size_t kMaxMatches;
 
  protected:
   friend class base::RefCountedThreadSafe<AutocompleteProvider>;
   FRIEND_TEST_ALL_PREFIXES(BookmarkProviderTest, InlineAutocompletion);
 
+  typedef std::pair<bool, base::string16> FixupReturn;
+
   virtual ~AutocompleteProvider();
 
   // Updates the starred state of each of the matches in matches_ from the
   // profile's bookmark bar model.
   void UpdateStarredStateOfMatches();
 
   // Fixes up user URL input to make it more possible to match against.  Among
   // many other things, this takes care of the following:
   // * Prepending file:// to file URLs
   // * Converting drive letters in file URLs to uppercase
   // * Converting case-insensitive parts of URLs (like the scheme and domain)
   //   to lowercase
   // * Convert spaces to %20s
   // Note that we don't do this in AutocompleteInput's constructor, because if
   // e.g. we convert a Unicode hostname to punycode, other providers will show
   // output that surprises the user ("Search Google for xn--6ca.com").
-  // Returns false if the fixup attempt resulted in an empty string (which
-  // providers generally can't do anything with).
-  static bool FixupUserInput(AutocompleteInput* input);
+  // Returns a bool indicating whether fixup succeeded, as well as the fixed-up
+  // input text.  The returned string will be the same as the input string if
+  // fixup failed; this lets callers who don't care about failure simply use the
+  // string unconditionally.
+  static FixupReturn FixupUserInput(const AutocompleteInput& input);
 
   // Trims "http:" and up to two subsequent slashes from |url|.  Returns the
   // number of characters that were trimmed.
   // NOTE: For a view-source: URL, this will trim from after "view-source:" and
   // return 0.
   static size_t TrimHttpPrefix(base::string16* url);
 
   // The profile associated with the AutocompleteProvider.  Reference is not
   // owned by us.
   Profile* profile_;
 
   AutocompleteProviderListener* listener_;
   ACMatches matches_;
   bool done_;
 
   Type type_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(AutocompleteProvider);
 };
 
 typedef std::vector<AutocompleteProvider*> ACProviders;
 
 #endif  // CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_PROVIDER_H_