OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 // | 4 // |
5 // This file defines utility functions for eliding URLs. | 5 // This file defines utility functions for eliding URLs. |
6 | 6 |
7 #ifndef COMPONENTS_URL_FORMATTER_ELIDE_URL_H_ | 7 #ifndef COMPONENTS_URL_FORMATTER_ELIDE_URL_H_ |
8 #define COMPONENTS_URL_FORMATTER_ELIDE_URL_H_ | 8 #define COMPONENTS_URL_FORMATTER_ELIDE_URL_H_ |
9 | 9 |
10 #include <string> | 10 #include <string> |
11 | 11 |
12 #include "base/strings/string16.h" | 12 #include "base/strings/string16.h" |
13 | 13 |
14 class GURL; | 14 class GURL; |
15 | 15 |
16 namespace gfx { | 16 namespace gfx { |
17 class FontList; | 17 class FontList; |
18 } | 18 } |
19 | 19 |
20 namespace url_formatter { | 20 namespace url_formatter { |
21 | 21 |
22 // ElideUrl and Elide host require | 22 // ElideUrl and Elide host require |
23 // gfx::GetStringWidthF which is not implemented in Android | 23 // gfx::GetStringWidthF which is not implemented in Android |
24 #if !defined(OS_ANDROID) || defined(USE_AURA) | 24 #if !defined(OS_ANDROID) |
25 // This function takes a GURL object and elides it. It returns a string | 25 // This function takes a GURL object and elides it. It returns a string |
26 // which composed of parts from subdomain, domain, path, filename and query. | 26 // which composed of parts from subdomain, domain, path, filename and query. |
27 // A "..." is added automatically at the end if the elided string is bigger | 27 // A "..." is added automatically at the end if the elided string is bigger |
28 // than the |available_pixel_width|. For |available_pixel_width| == 0, a | 28 // than the |available_pixel_width|. For |available_pixel_width| == 0, a |
29 // formatted, but un-elided, string is returned. |languages| is a comma | 29 // formatted, but un-elided, string is returned. |languages| is a comma |
30 // separated list of ISO 639 language codes and is used to determine what | 30 // separated list of ISO 639 language codes and is used to determine what |
31 // characters are understood by a user. It should come from | 31 // characters are understood by a user. It should come from |
32 // |prefs::kAcceptLanguages|. | 32 // |prefs::kAcceptLanguages|. |
33 // | 33 // |
34 // Note: in RTL locales, if the URL returned by this function is going to be | 34 // Note: in RTL locales, if the URL returned by this function is going to be |
35 // displayed in the UI, then it is likely that the string needs to be marked | 35 // displayed in the UI, then it is likely that the string needs to be marked |
36 // as an LTR string (using base::i18n::WrapStringWithLTRFormatting()) so that it | 36 // as an LTR string (using base::i18n::WrapStringWithLTRFormatting()) so that it |
37 // is displayed properly in an RTL context. Please refer to | 37 // is displayed properly in an RTL context. Please refer to |
38 // http://crbug.com/6487 for more information. | 38 // http://crbug.com/6487 for more information. |
39 base::string16 ElideUrl(const GURL& url, | 39 base::string16 ElideUrl(const GURL& url, |
40 const gfx::FontList& font_list, | 40 const gfx::FontList& font_list, |
41 float available_pixel_width, | 41 float available_pixel_width, |
42 const std::string& languages); | 42 const std::string& languages); |
43 | 43 |
44 // This function takes a GURL object and elides the host to fit within | 44 // This function takes a GURL object and elides the host to fit within |
45 // the given width. The function will never elide past the TLD+1 point, | 45 // the given width. The function will never elide past the TLD+1 point, |
46 // but after that, will leading-elide the domain name to fit the width. | 46 // but after that, will leading-elide the domain name to fit the width. |
47 // Example: http://sub.domain.com ---> "...domain.com", or "...b.domain.com" | 47 // Example: http://sub.domain.com ---> "...domain.com", or "...b.domain.com" |
48 // depending on the width. | 48 // depending on the width. |
49 base::string16 ElideHost(const GURL& host_url, | 49 base::string16 ElideHost(const GURL& host_url, |
50 const gfx::FontList& font_list, | 50 const gfx::FontList& font_list, |
51 float available_pixel_width); | 51 float available_pixel_width); |
52 #endif // !defined(OS_ANDROID) || defined(USE_AURA) | 52 #endif // !defined(OS_ANDROID) |
53 | 53 |
54 // This is a convenience function for formatting a URL in a concise and | 54 // This is a convenience function for formatting a URL in a concise and |
55 // human-friendly way, to help users make security-related decisions (or in | 55 // human-friendly way, to help users make security-related decisions (or in |
56 // other circumstances when people need to distinguish sites, origins, or | 56 // other circumstances when people need to distinguish sites, origins, or |
57 // otherwise-simplified URLs from each other). | 57 // otherwise-simplified URLs from each other). |
58 // | 58 // |
59 // Internationalized domain names (IDN) may be presented in Unicode if | 59 // Internationalized domain names (IDN) may be presented in Unicode if |
60 // |languages| accepts the Unicode representation (see | 60 // |languages| accepts the Unicode representation (see |
61 // |url_formatter::FormatUrl| for more details on the algorithm). | 61 // |url_formatter::FormatUrl| for more details on the algorithm). |
62 // | 62 // |
(...skipping 14 matching lines...) Expand all Loading... |
77 // Just like |FormatUrlForSecurityDisplay|, but also: | 77 // Just like |FormatUrlForSecurityDisplay|, but also: |
78 // | 78 // |
79 // - Omits the scheme if SchemeIsHTTPOrHTTPS(). | 79 // - Omits the scheme if SchemeIsHTTPOrHTTPS(). |
80 base::string16 FormatUrlForSecurityDisplayOmitScheme( | 80 base::string16 FormatUrlForSecurityDisplayOmitScheme( |
81 const GURL& origin, | 81 const GURL& origin, |
82 const std::string& languages); | 82 const std::string& languages); |
83 | 83 |
84 } // namespace url_formatter | 84 } // namespace url_formatter |
85 | 85 |
86 #endif // COMPONENTS_URL_FORMATTER_ELIDE_URL_H_ | 86 #endif // COMPONENTS_URL_FORMATTER_ELIDE_URL_H_ |
OLD | NEW |