chrome/common/favicon/favicon_url_parser.h

   1 // Copyright 2013 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_COMMON_FAVICON_FAVICON_URL_PARSER_H_
   6 #define CHROME_COMMON_FAVICON_FAVICON_URL_PARSER_H_
   7
   8 #include <string>
   9
  10 #include "ui/base/layout.h"
  11
  12 namespace chrome {
  13
  14 struct ParsedFaviconPath {
  15   // Whether the URL has the "iconurl" parameter.
  16   bool is_icon_url;
  17
  18   // The URL from which the favicon is being requested.
  19   std::string url;
  20
  21   // The size of the requested favicon in dip.
  22   int size_in_dip;
  23
  24   // The scale factor of the requested favicon.
  25   ui::ScaleFactor scale_factor;
  26
  27   // The index of the first character (relative to the path) where the the URL
  28   // from which the favicon is being requested is located.
  29   size_t path_index;
  30 };
  31
  32 // Parses |path|, which should be in the format described at the top of the
  33 // file "chrome/browser/ui/webui/favicon_source.h". |icon_types| indicates
  34 // which icon types are supported. Returns true if |path| could be parsed.
  35 // The result of the parsing will be stored in a ParsedFaviconPath struct.
  36 bool ParseFaviconPath(const std::string& path,
  37                       int icon_types,
  38                       ParsedFaviconPath* parsed);
  39
  40 }  // namespace chrome
  41
  42 #endif  // CHROME_COMMON_FAVICON_FAVICON_URL_PARSER_H_