Add chrome to the repository.

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@15 0039d316-1c4b-4281-b951-d872f2087c98

1 files changed, 132 insertions, 0 deletions

diff --git a/chrome/browser/autocomplete/keyword_provider.h b/chrome/browser/autocomplete/keyword_provider.h
new file mode 100644
index 0000000..1964006
--- /dev/null
+++ b/chrome/browser/autocomplete/keyword_provider.h
@@ -0,0 +1,132 @@
+// Copyright 2008, Google Inc.
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//    * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//    * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//    * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+//
+// This file contains the keyword autocomplete provider. The keyword provider is
+// responsible for remembering/suggesting user "search keyword queries" (e.g.
+// "imdb Godzilla") and then fixing them up into valid URLs.  An instance of it
+// gets created and managed by the autocomplete controller.  KeywordProvider
+// uses a TemplateURLModel to find the set of keywords.
+//
+// For more information on the autocomplete system in general, including how
+// the autocomplete controller and autocomplete providers work, see
+// chrome/browser/autocomplete.h.
+
+#ifndef CHROME_BROWSER_AUTOCOMPLETE_KEYWORD_PROVIDER_H__
+#define CHROME_BROWSER_AUTOCOMPLETE_KEYWORD_PROVIDER_H__
+
+#include <map>
+#include <string>
+#include <vector>
+#include "chrome/browser/autocomplete/autocomplete.h"
+
+class Profile;
+class TemplateURL;
+class TemplateURLModel;
+
+/****************************** KeywordProvider ******************************/
+
+// Autocomplete provider for keyword input.
+//
+// After construction, the autocomplete controller repeatedly calls Start()
+// with some user input, each time expecting to receive a small set of the best
+// matches (either synchronously or asynchronously).
+//
+// To construct these matches, the provider treats user input as a series of
+// whitespace-delimited tokens and tries to match the first token as the prefix
+// of a known "keyword".  A keyword is some string that maps to a search query
+// URL; the rest of the user's input is taken as the input to the query.  For
+// example, the keyword "bug" might map to the URL "http://b/issue?id=%s", so
+// input like "bug 123" would become "http://b/issue?id=123".
+//
+// Because we do prefix matching, user input could match more than one keyword
+// at once.  (Example: the input "f jazz" matches all keywords starting with
+// "f".)  We return the best matches, up to three.
+//
+// The resulting matches are shown with content specified by the keyword
+// (usually "Search [name] for %s"), description "(Keyword: [keyword])", and
+// action "[keyword] %s".  If the user has typed a (possibly partial) keyword
+// but no search terms, the suggested result is shown greyed out, with
+// "<enter term(s)>" as the substituted input, and does nothing when selected.
+class KeywordProvider : public AutocompleteProvider {
+ public:
+  KeywordProvider(ACProviderListener* listener, Profile* profile);
+  // For testing.
+  KeywordProvider(ACProviderListener* listener, TemplateURLModel* model);
+
+  // Returns the replacement string from the user input. The replacement
+  // string is the portion of the input that does not contain the keyword.
+  // For example, the replacement string for "b blah" is blah.
+  static std::wstring SplitReplacementStringFromInput(
+      const std::wstring& input);
+
+  // AutocompleteProvider
+  virtual void Start(const AutocompleteInput& input,
+                     bool minimal_changes,
+                     bool synchronous_only);
+
+ private:
+  // Helper functor for Start(), for sorting keyword matches by quality.
+  class CompareQuality;
+
+  // Extracts the next whitespace-delimited token from input and returns it.
+  // Sets |remaining_input| to everything after the first token (skipping over
+  // intervening whitespace).
+  static std::wstring SplitKeywordFromInput(const std::wstring& input,
+                                            std::wstring* remaining_input);
+
+  // Fills in the "destination_url" and "contents" fields of |match| with the
+  // provided user input and keyword data.
+  static void FillInURLAndContents(
+      const std::wstring& remaining_input,
+      const TemplateURL* element,
+      AutocompleteMatch* match);
+
+  // Determines the relevance for some input, given its type, whether the user
+  // typed the complete keyword, and whether the keyword is a bookmark keyword
+  // (i.e. one that does not support replacement).
+  static int CalculateRelevance(AutocompleteInput::Type type,
+                                bool complete,
+                                bool is_bookmark_keyword);
+
+  // Creates a fully marked-up AutocompleteMatch from the user's input.
+  AutocompleteMatch CreateAutocompleteMatch(
+      TemplateURLModel* model,
+      const std::wstring keyword,
+      const AutocompleteInput& input,
+      size_t prefix_length,
+      const std::wstring& remaining_input);
+
+  // Model for the keywords.  This is only non-null when testing, otherwise the
+  // TemplateURLModel from the Profile is used.
+  TemplateURLModel* model_;
+
+  DISALLOW_EVIL_CONSTRUCTORS(KeywordProvider);
+};
+
+#endif  // CHROME_BROWSER_AUTOCOMPLETE_KEYWORD_PROVIDER_H__