| // Copyright 2014 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. |
| // |
| // This file defines utility functions for eliding URLs. |
| |
| #ifndef COMPONENTS_URL_FORMATTER_ELIDE_URL_H_ |
| #define COMPONENTS_URL_FORMATTER_ELIDE_URL_H_ |
| |
| #include <string> |
| |
| #include "base/strings/string16.h" |
| #include "build/build_config.h" |
| #include "ui/gfx/text_constants.h" |
| |
| class GURL; |
| |
| namespace gfx { |
| class FontList; |
| } |
| |
| namespace url { |
| class Origin; |
| } |
| |
| namespace url_formatter { |
| |
| // ElideUrl and Elide host require |
| // gfx::GetStringWidthF which is not implemented in Android |
| #if !defined(OS_ANDROID) |
| // This function takes a GURL object and elides it. It returns a string |
| // composed of parts from subdomain, domain, path, filename and query. |
| // A "..." is added automatically at the end if the elided string is bigger |
| // than the |available_pixel_width|. For |available_pixel_width| == 0, a |
| // formatted, but un-elided, string is returned. |
| // |
| // Note: in RTL locales, if the URL returned by this function is going to be |
| // displayed in the UI, then it is likely that the string needs to be marked |
| // as an LTR string (using base::i18n::WrapStringWithLTRFormatting()) so that it |
| // is displayed properly in an RTL context. Please refer to |
| // http://crbug.com/6487 for more information. |
| base::string16 ElideUrl(const GURL& url, |
| const gfx::FontList& font_list, |
| float available_pixel_width); |
| |
| // This function takes a GURL object and elides the host to fit within |
| // the given width. The function will never elide past the TLD+1 point, |
| // but after that, will leading-elide the domain name to fit the width. |
| // Example: http://sub.domain.com ---> "...domain.com", or "...b.domain.com" |
| // depending on the width. |
| base::string16 ElideHost(const GURL& host_url, |
| const gfx::FontList& font_list, |
| float available_pixel_width); |
| #endif // !defined(OS_ANDROID) |
| |
| enum class SchemeDisplay { |
| SHOW, |
| OMIT_HTTP_AND_HTTPS, |
| // Omit cryptographic (i.e. https and wss). |
| OMIT_CRYPTOGRAPHIC, |
| }; |
| |
| // This is a convenience function for formatting a URL in a concise and |
| // human-friendly way, to help users make security-related decisions (or in |
| // other circumstances when people need to distinguish sites, origins, or |
| // otherwise-simplified URLs from each other). |
| // |
| // Internationalized domain names (IDN) will be presented in Unicode if |
| // they're regarded safe except that domain names with RTL characters |
| // will still be in ACE/punycode for now (http://crbug.com/650760). |
| // See http://dev.chromium.org/developers/design-documents/idn-in-google-chrome |
| // for details on the algorithm. |
| // |
| // - Omits the path for standard schemes, excepting file and filesystem. |
| // - Omits the port if it is the default for the scheme. |
| // |
| // Do not use this for URLs which will be parsed or sent to other applications. |
| // |
| // Generally, prefer SchemeDisplay::SHOW to omitting the scheme unless there is |
| // plenty of indication as to whether the origin is secure elsewhere in the UX. |
| // For example, in Chrome's Page Info Bubble, there are icons and strings |
| // indicating origin (non-)security. But in the HTTP Basic Auth prompt (for |
| // example), the scheme may be the only indicator. |
| base::string16 FormatUrlForSecurityDisplay( |
| const GURL& origin, |
| const SchemeDisplay scheme_display = SchemeDisplay::SHOW); |
| |
| // This is a convenience function for formatting a url::Origin in a concise and |
| // human-friendly way, to help users make security-related decisions. |
| // |
| // - Omits the port if it is 0 or the default for the scheme. |
| // |
| // Do not use this for origins which will be parsed or sent to other |
| // applications. |
| // |
| // Generally, prefer SchemeDisplay::SHOW to omitting the scheme unless there is |
| // plenty of indication as to whether the origin is secure elsewhere in the UX. |
| base::string16 FormatOriginForSecurityDisplay( |
| const url::Origin& origin, |
| const SchemeDisplay scheme_display = SchemeDisplay::SHOW); |
| |
| } // namespace url_formatter |
| |
| #endif // COMPONENTS_URL_FORMATTER_ELIDE_URL_H_ |