src/chrome/browser/autocomplete/url_prefix.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_AUTOCOMPLETE_URL_PREFIX_H_
   6 #define CHROME_BROWSER_AUTOCOMPLETE_URL_PREFIX_H_
   7
   8 #include <vector>
   9
  10 #include "base/strings/string16.h"
  11 #include "chrome/browser/autocomplete/autocomplete_input.h"
  12
  13 struct URLPrefix;
  14 typedef std::vector<URLPrefix> URLPrefixes;
  15
  16 // A URL prefix; combinations of schemes and (least significant) domain labels
  17 // that may be inferred from certain URL-like input strings.
  18 struct URLPrefix {
  19   URLPrefix(const base::string16& prefix, size_t num_components);
  20
  21   // Returns a vector of URL prefixes sorted by descending number of components.
  22   static const URLPrefixes& GetURLPrefixes();
  23
  24   // Returns if the argument is a valid URL prefix.
  25   static bool IsURLPrefix(const base::string16& prefix);
  26
  27   // Returns the URL prefix of |text| with the most components, or NULL.
  28   // |prefix_suffix| (which may be empty) is appended to every attempted prefix,
  29   // which is useful for finding the innermost match of user input in a URL.
  30   // Performs case insensitive string comparison.
  31   static const URLPrefix* BestURLPrefix(const base::string16& text,
  32                                         const base::string16& prefix_suffix);
  33
  34   // A helper function for BestURLPrefix().  Returns true if |text| starts
  35   // with |prefix| which is then followed by |prefix_suffix|.
  36   // Performs case insensitive string comparison.
  37   static bool PrefixMatch(const URLPrefix& prefix,
  38                           const base::string16& text,
  39                           const base::string16& prefix_suffix);
  40
  41   // Sees if |text| is inlineable against either |input| or |fixed_up_input|,
  42   // returning the appropriate inline autocomplete offset or
  43   // base::string16::npos if |text| is not inlineable.
  44   // |allow_www_prefix_without_scheme| says whether to consider an input such
  45   // as "foo" to be allowed to match against text "www.foo.com".  This is
  46   // needed because sometimes the string we're matching against here can come
  47   // from a match's fill_into_edit, which can start with "www." without having
  48   // a protocol at the beginning, and we want to allow these matches to be
  49   // inlineable.  ("www." is not otherwise on the default prefix list.)
  50   static size_t GetInlineAutocompleteOffset(
  51       const AutocompleteInput& input,
  52       const AutocompleteInput& fixed_up_input,
  53       const bool allow_www_prefix_without_scheme,
  54       const base::string16& text);
  55
  56   base::string16 prefix;
  57
  58   // The number of URL components (scheme, domain label, etc.) in the prefix.
  59   // For example, "http://foo.com" and "www.bar.com" each have one component,
  60   // while "ftp://ftp.ftp.com" has two, and "mysite.com" has none.
  61   size_t num_components;
  62 };
  63
  64 #endif  // CHROME_BROWSER_AUTOCOMPLETE_URL_PREFIX_H_