Upstreaming mechanism to add query refinement to omnibox searches.

chrome/browser/autocomplete/autocomplete_input.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_INPUT_H_
 #define CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_INPUT_H_
 
 #include <string>
 
 #include "base/basictypes.h"
@@ skipping 37 matching lines @@
   // |text| and |cursor_position| represent the input query and location of
   // the cursor with the query respectively.  |cursor_position| may be set to
   // string16::npos if the input |text| doesn't come directly from the user's
   // typing.
   //
   // |desired_tld| is the user's desired TLD, if one is not already present in
   // the text to autocomplete.  When this is non-empty, it also implies that
   // "www." should be prepended to the domain where possible. The |desired_tld|
   // should not contain a leading '.' (use "com" instead of ".com").
   //
+  // If |current_url| is set to a valid search result page URL, providers can
+  // use it to perform query refinement. For example, if it is set to an image
+  // search result page, the search provider may generate an image search URL.
+  // Query refinement is only used by mobile ports, so only these set
+  // |current_url| to a non-empty string.
+  //
   // |prevent_inline_autocomplete| is true if the generated result set should
   // not require inline autocomplete for the default match.  This is difficult
   // to explain in the abstract; the practical use case is that after the user
   // deletes text in the edit, the HistoryURLProvider should make sure not to
   // promote a match requiring inline autocomplete too highly.
   //
   // |prefer_keyword| should be true when the keyword UI is onscreen; this will
   // bias the autocomplete result set toward the keyword provider when the input
   // string is a bare keyword.
   //
   // |allow_exact_keyword_match| should be false when triggering keyword mode on
   // the input string would be surprising or wrong, e.g. when highlighting text
   // in a page and telling the browser to search for it or navigate to it. This
   // parameter only applies to substituting keywords.
 
   // If |matches_requested| is BEST_MATCH or SYNCHRONOUS_MATCHES the controller
   // asks the providers to only return matches which are synchronously
   // available, which should mean that all providers will be done immediately.
   AutocompleteInput(const string16& text,
                     size_t cursor_position,
                     const string16& desired_tld,
+                    const GURL& current_url,
                     bool prevent_inline_autocomplete,
                     bool prefer_keyword,
                     bool allow_exact_keyword_match,
                     MatchesRequested matches_requested);
   ~AutocompleteInput();
 
   // If type is |FORCED_QUERY| and |text| starts with '?', it is removed.
   // Returns number of leading characters removed.
   static size_t RemoveForcedQueryStringIfNecessary(Type type, string16* text);
 
@@ skipping 39 matching lines @@
   // used.
   size_t cursor_position() const { return cursor_position_; }
 
   // Use of this setter is risky, since no other internal state is updated
   // besides |text_|, |cursor_position_| and |parts_|.  Only callers who know
   // that they're not changing the type/scheme/etc. should use this.
   void UpdateText(const string16& text,
                   size_t cursor_position,
                   const url_parse::Parsed& parts);
 
+  // The current URL, or an invalid GURL if query refinement is not desired.
+  const GURL& current_url() const { return current_url_; }
+
   // The type of input supplied.
   Type type() const { return type_; }
 
   // Returns parsed URL components.
   const url_parse::Parsed& parts() const { return parts_; }
 
   // The scheme parsed from the provided text; only meaningful when type_ is
   // URL.
   const string16& scheme() const { return scheme_; }
 
@@ skipping 18 matching lines @@
   MatchesRequested matches_requested() const { return matches_requested_; }
 
   // Resets all internal variables to the null-constructed state.
   void Clear();
 
  private:
   // NOTE: Whenever adding a new field here, please make sure to update Clear()
   // method.
   string16 text_;
   size_t cursor_position_;
+  GURL current_url_;
   Type type_;
   url_parse::Parsed parts_;
   string16 scheme_;
   GURL canonicalized_url_;
   bool prevent_inline_autocomplete_;
   bool prefer_keyword_;
   bool allow_exact_keyword_match_;
   MatchesRequested matches_requested_;
 };
 
 #endif  // CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_INPUT_H_