| // Copyright (c) 2010 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. |
| |
| #include <vector> |
| |
| #include "app/text_elider.h" |
| #include "app/l10n_util.h" |
| #include "base/file_path.h" |
| #include "base/i18n/rtl.h" |
| #include "base/string_util.h" |
| #include "base/sys_string_conversions.h" |
| #include "base/utf_string_conversions.h" |
| #include "gfx/font.h" |
| #include "googleurl/src/gurl.h" |
| #include "net/base/escape.h" |
| #include "net/base/net_util.h" |
| #include "net/base/registry_controlled_domain.h" |
| |
| namespace { |
| |
| const wchar_t kEllipsis[] = L"\x2026"; |
| |
| // Cuts |text| to be |length| characters long. If |cut_in_middle| is true, the |
| // middle of the string is removed to leave equal-length pieces from the |
| // beginning and end of the string; otherwise, the end of the string is removed |
| // and only the beginning remains. If |insert_ellipsis| is true, then an |
| // ellipsis character will by inserted at the cut point. |
| std::wstring CutString(const std::wstring& text, |
| size_t length, |
| bool cut_in_middle, |
| bool insert_ellipsis) { |
| const std::wstring insert(insert_ellipsis ? kEllipsis : L""); |
| if (!cut_in_middle) |
| return text.substr(0, length) + insert; |
| // We put the extra character, if any, before the cut. |
| const size_t half_length = length / 2; |
| return text.substr(0, length - half_length) + insert + |
| text.substr(text.length() - half_length, half_length); |
| } |
| |
| } // namespace |
| |
| namespace gfx { |
| |
| // This function takes a GURL object and elides it. It returns a string |
| // which 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. |
| // |
| // TODO(pkasting): http://b/119635 This whole function gets |
| // kerning/ligatures/etc. issues potentially wrong by assuming that the width of |
| // a rendered string is always the sum of the widths of its substrings. Also I |
| // suspect it could be made simpler. |
| std::wstring ElideUrl(const GURL& url, |
| const gfx::Font& font, |
| int available_pixel_width, |
| const std::wstring& languages) { |
| // Get a formatted string and corresponding parsing of the url. |
| url_parse::Parsed parsed; |
| std::wstring url_string = net::FormatUrl(url, languages, |
| net::kFormatUrlOmitAll, UnescapeRule::SPACES, &parsed, NULL, NULL); |
| if (available_pixel_width <= 0) |
| return url_string; |
| |
| // If non-standard or not file type, return plain eliding. |
| if (!(url.SchemeIsFile() || url.IsStandard())) |
| return ElideText(url_string, font, available_pixel_width, false); |
| |
| // Now start eliding url_string to fit within available pixel width. |
| // Fist pass - check to see whether entire url_string fits. |
| int pixel_width_url_string = font.GetStringWidth(url_string); |
| if (available_pixel_width >= pixel_width_url_string) |
| return url_string; |
| |
| // Get the path substring, including query and reference. |
| size_t path_start_index = parsed.path.begin; |
| size_t path_len = parsed.path.len; |
| std::wstring url_path_query_etc = url_string.substr(path_start_index); |
| std::wstring url_path = url_string.substr(path_start_index, path_len); |
| |
| // Return general elided text if url minus the query fits. |
| std::wstring url_minus_query = url_string.substr(0, path_start_index + |
| path_len); |
| if (available_pixel_width >= font.GetStringWidth(url_minus_query)) |
| return ElideText(url_string, font, available_pixel_width, false); |
| |
| // Get Host. |
| std::wstring url_host = UTF8ToWide(url.host()); |
| |
| // Get domain and registry information from the URL. |
| std::wstring url_domain = UTF8ToWide( |
| net::RegistryControlledDomainService::GetDomainAndRegistry(url)); |
| if (url_domain.empty()) |
| url_domain = url_host; |
| |
| // Add port if required. |
| if (!url.port().empty()) { |
| url_host += L":" + UTF8ToWide(url.port()); |
| url_domain += L":" + UTF8ToWide(url.port()); |
| } |
| |
| // Get sub domain. |
| std::wstring url_subdomain; |
| size_t domain_start_index = url_host.find(url_domain); |
| if (domain_start_index > 0) |
| url_subdomain = url_host.substr(0, domain_start_index); |
| if ((url_subdomain == L"www." || url_subdomain.empty() || |
| url.SchemeIsFile())) { |
| url_subdomain.clear(); |
| } |
| |
| // If this is a file type, the path is now defined as everything after ":". |
| // For example, "C:/aa/aa/bb", the path is "/aa/bb/cc". Interesting, the |
| // domain is now C: - this is a nice hack for eliding to work pleasantly. |
| if (url.SchemeIsFile()) { |
| // Split the path string using ":" |
| std::vector<std::wstring> file_path_split; |
| SplitString(url_path, L':', &file_path_split); |
| if (file_path_split.size() > 1) { // File is of type "file:///C:/.." |
| url_host.clear(); |
| url_domain.clear(); |
| url_subdomain.clear(); |
| |
| url_host = url_domain = file_path_split.at(0).substr(1) + L":"; |
| url_path_query_etc = url_path = file_path_split.at(1); |
| } |
| } |
| |
| // Second Pass - remove scheme - the rest fits. |
| int pixel_width_url_host = font.GetStringWidth(url_host); |
| int pixel_width_url_path = font.GetStringWidth(url_path_query_etc); |
| if (available_pixel_width >= |
| pixel_width_url_host + pixel_width_url_path) |
| return url_host + url_path_query_etc; |
| |
| // Third Pass: Subdomain, domain and entire path fits. |
| int pixel_width_url_domain = font.GetStringWidth(url_domain); |
| int pixel_width_url_subdomain = font.GetStringWidth(url_subdomain); |
| if (available_pixel_width >= |
| pixel_width_url_subdomain + pixel_width_url_domain + |
| pixel_width_url_path) |
| return url_subdomain + url_domain + url_path_query_etc; |
| |
| // Query element. |
| std::wstring url_query; |
| const int pixel_width_dots_trailer = font.GetStringWidth(kEllipsis); |
| if (parsed.query.is_nonempty()) { |
| url_query = std::wstring(L"?") + url_string.substr(parsed.query.begin); |
| if (available_pixel_width >= (pixel_width_url_subdomain + |
| pixel_width_url_domain + pixel_width_url_path - |
| font.GetStringWidth(url_query))) { |
| return ElideText(url_subdomain + url_domain + url_path_query_etc, font, |
| available_pixel_width, false); |
| } |
| } |
| |
| // Parse url_path using '/'. |
| std::vector<std::wstring> url_path_elements; |
| SplitString(url_path, L'/', &url_path_elements); |
| |
| // Get filename - note that for a path ending with / |
| // such as www.google.com/intl/ads/, the file name is ads/. |
| int url_path_number_of_elements = static_cast<int> (url_path_elements. |
| size()); |
| std::wstring url_filename; |
| if ((url_path_elements.at(url_path_number_of_elements - 1)).length() > 0) { |
| url_filename = *(url_path_elements.end()-1); |
| } else if (url_path_number_of_elements > 1) { // Path ends with a '/'. |
| url_filename = url_path_elements.at(url_path_number_of_elements - 2) + |
| L'/'; |
| url_path_number_of_elements--; |
| } |
| |
| const int kMaxNumberOfUrlPathElementsAllowed = 1024; |
| if (url_path_number_of_elements <= 1 || |
| url_path_number_of_elements > kMaxNumberOfUrlPathElementsAllowed) { |
| // No path to elide, or too long of a path (could overflow in loop below) |
| // Just elide this as a text string. |
| return ElideText(url_subdomain + url_domain + url_path_query_etc, font, |
| available_pixel_width, false); |
| } |
| |
| // Start eliding the path and replacing elements by "../". |
| std::wstring an_ellipsis_and_a_slash(kEllipsis); |
| an_ellipsis_and_a_slash += L'/'; |
| int pixel_width_url_filename = font.GetStringWidth(url_filename); |
| int pixel_width_dot_dot_slash = font.GetStringWidth(an_ellipsis_and_a_slash); |
| int pixel_width_slash = font.GetStringWidth(L"/"); |
| int pixel_width_url_path_elements[kMaxNumberOfUrlPathElementsAllowed]; |
| for (int i = 0; i < url_path_number_of_elements; ++i) { |
| pixel_width_url_path_elements[i] = |
| font.GetStringWidth(url_path_elements.at(i)); |
| } |
| |
| // Check with both subdomain and domain. |
| std::wstring elided_path; |
| int pixel_width_elided_path; |
| for (int i = url_path_number_of_elements - 1; i >= 1; --i) { |
| // Add the initial elements of the path. |
| elided_path.clear(); |
| pixel_width_elided_path = 0; |
| for (int j = 0; j < i; ++j) { |
| elided_path += url_path_elements.at(j) + L'/'; |
| pixel_width_elided_path += pixel_width_url_path_elements[j] + |
| pixel_width_slash; |
| } |
| |
| // Add url_file_name. |
| if (i == (url_path_number_of_elements - 1)) { |
| elided_path += url_filename; |
| pixel_width_elided_path += pixel_width_url_filename; |
| } else { |
| elided_path += an_ellipsis_and_a_slash + url_filename; |
| pixel_width_elided_path += pixel_width_dot_dot_slash + |
| pixel_width_url_filename; |
| } |
| |
| if (available_pixel_width >= |
| pixel_width_url_subdomain + pixel_width_url_domain + |
| pixel_width_elided_path) { |
| return ElideText(url_subdomain + url_domain + elided_path + url_query, |
| font, available_pixel_width, false); |
| } |
| } |
| |
| // Check with only domain. |
| // If a subdomain is present, add an ellipsis before domain. |
| // This is added only if the subdomain pixel width is larger than |
| // the pixel width of kEllipsis. Otherwise, subdomain remains, |
| // which means that this case has been resolved earlier. |
| std::wstring url_elided_domain = url_subdomain + url_domain; |
| int pixel_width_url_elided_domain = pixel_width_url_domain; |
| if (pixel_width_url_subdomain > pixel_width_dots_trailer) { |
| if (!url_subdomain.empty()) { |
| url_elided_domain = kEllipsis + url_domain; |
| pixel_width_url_elided_domain += pixel_width_dots_trailer; |
| } else { |
| url_elided_domain = url_domain; |
| } |
| |
| for (int i = url_path_number_of_elements - 1; i >= 1; --i) { |
| // Add the initial elements of the path. |
| elided_path.clear(); |
| pixel_width_elided_path = 0; |
| for (int j = 0; j < i; ++j) { |
| elided_path += url_path_elements.at(j) + L'/'; |
| pixel_width_elided_path += pixel_width_url_path_elements[j] + |
| pixel_width_slash; |
| } |
| |
| // Add url_file_name. |
| if (i == (url_path_number_of_elements - 1)) { |
| elided_path += url_filename; |
| pixel_width_elided_path += pixel_width_url_filename; |
| } else { |
| elided_path += an_ellipsis_and_a_slash + url_filename; |
| pixel_width_elided_path += pixel_width_dot_dot_slash + |
| pixel_width_url_filename; |
| } |
| |
| if (available_pixel_width >= |
| pixel_width_url_elided_domain + pixel_width_elided_path) { |
| return ElideText(url_elided_domain + elided_path + url_query, font, |
| available_pixel_width, false); |
| } |
| } |
| } |
| |
| // Return elided domain/../filename anyway. |
| std::wstring final_elided_url_string(url_elided_domain); |
| if ((available_pixel_width - font.GetStringWidth(url_elided_domain)) > |
| pixel_width_dot_dot_slash + pixel_width_dots_trailer + |
| font.GetStringWidth(L"UV")) // A hack to prevent trailing "../...". |
| final_elided_url_string += elided_path; |
| else |
| final_elided_url_string += url_path; |
| |
| return ElideText(final_elided_url_string, font, available_pixel_width, false); |
| } |
| |
| std::wstring ElideFilename(const FilePath& filename, |
| const gfx::Font& font, |
| int available_pixel_width) { |
| int full_width = font.GetStringWidth(filename.ToWStringHack()); |
| if (full_width <= available_pixel_width) { |
| std::wstring elided_name = filename.ToWStringHack(); |
| return base::i18n::GetDisplayStringInLTRDirectionality(&elided_name); |
| } |
| |
| #if defined(OS_WIN) |
| std::wstring extension = filename.Extension(); |
| #elif defined(OS_POSIX) |
| std::wstring extension = base::SysNativeMBToWide(filename.Extension()); |
| #endif |
| std::wstring rootname = |
| filename.BaseName().RemoveExtension().ToWStringHack(); |
| |
| if (rootname.empty() || extension.empty()) { |
| std::wstring elided_name = ElideText(filename.ToWStringHack(), font, |
| available_pixel_width, false); |
| return base::i18n::GetDisplayStringInLTRDirectionality(&elided_name); |
| } |
| |
| int ext_width = font.GetStringWidth(extension); |
| int root_width = font.GetStringWidth(rootname); |
| |
| // We may have trimmed the path. |
| if (root_width + ext_width <= available_pixel_width) { |
| std::wstring elided_name = rootname + extension; |
| return base::i18n::GetDisplayStringInLTRDirectionality(&elided_name); |
| } |
| |
| int available_root_width = available_pixel_width - ext_width; |
| std::wstring elided_name = |
| ElideText(rootname, font, available_root_width, false); |
| elided_name += extension; |
| return base::i18n::GetDisplayStringInLTRDirectionality(&elided_name); |
| } |
| |
| // This function adds an ellipsis at the end of the text if the text |
| // does not fit the given pixel width. |
| std::wstring ElideText(const std::wstring& text, |
| const gfx::Font& font, |
| int available_pixel_width, |
| bool elide_in_middle) { |
| if (text.empty()) |
| return text; |
| |
| int current_text_pixel_width = font.GetStringWidth(text); |
| |
| // Pango will return 0 width for absurdly long strings. Cut the string in |
| // half and try again. |
| // This is caused by an int overflow in Pango (specifically, in |
| // pango_glyph_string_extents_range). It's actually more subtle than just |
| // returning 0, since on super absurdly long strings, the int can wrap and |
| // return positive numbers again. Detecting that is probably not worth it |
| // (eliding way too much from a ridiculous string is probably still |
| // ridiculous), but we should check other widths for bogus values as well. |
| if (current_text_pixel_width <= 0 && !text.empty()) { |
| return ElideText(CutString(text, text.length() / 2, elide_in_middle, false), |
| font, available_pixel_width, false); |
| } |
| |
| if (current_text_pixel_width <= available_pixel_width) |
| return text; |
| |
| if (font.GetStringWidth(kEllipsis) > available_pixel_width) |
| return std::wstring(); |
| |
| // Use binary search to compute the elided text. |
| size_t lo = 0; |
| size_t hi = text.length() - 1; |
| for (size_t guess = (lo + hi) / 2; guess != lo; guess = (lo + hi) / 2) { |
| // We check the length of the whole desired string at once to ensure we |
| // handle kerning/ligatures/etc. correctly. |
| int guess_length = |
| font.GetStringWidth(CutString(text, guess, elide_in_middle, true)); |
| // Check again that we didn't hit a Pango width overflow. If so, cut the |
| // current string in half and start over. |
| if (guess_length <= 0) { |
| return ElideText(CutString(text, guess / 2, elide_in_middle, false), |
| font, available_pixel_width, elide_in_middle); |
| } |
| if (guess_length > available_pixel_width) |
| hi = guess; |
| else |
| lo = guess; |
| } |
| |
| return CutString(text, lo, elide_in_middle, true); |
| } |
| |
| SortedDisplayURL::SortedDisplayURL(const GURL& url, |
| const std::wstring& languages) { |
| std::wstring host; |
| net::AppendFormattedHost(url, languages, &host, NULL, NULL); |
| sort_host_ = WideToUTF16Hack(host); |
| string16 host_minus_www = WideToUTF16Hack(net::StripWWW(host)); |
| url_parse::Parsed parsed; |
| display_url_ = WideToUTF16Hack(net::FormatUrl(url, languages, |
| net::kFormatUrlOmitAll, UnescapeRule::SPACES, &parsed, &prefix_end_, |
| NULL)); |
| if (sort_host_.length() > host_minus_www.length()) { |
| prefix_end_ += sort_host_.length() - host_minus_www.length(); |
| sort_host_.swap(host_minus_www); |
| } |
| } |
| |
| int SortedDisplayURL::Compare(const SortedDisplayURL& other, |
| icu::Collator* collator) const { |
| // Compare on hosts first. The host won't contain 'www.'. |
| UErrorCode compare_status = U_ZERO_ERROR; |
| UCollationResult host_compare_result = collator->compare( |
| static_cast<const UChar*>(sort_host_.c_str()), |
| static_cast<int>(sort_host_.length()), |
| static_cast<const UChar*>(other.sort_host_.c_str()), |
| static_cast<int>(other.sort_host_.length()), |
| compare_status); |
| DCHECK(U_SUCCESS(compare_status)); |
| if (host_compare_result != 0) |
| return host_compare_result; |
| |
| // Hosts match, compare on the portion of the url after the host. |
| string16 path = this->AfterHost(); |
| string16 o_path = other.AfterHost(); |
| compare_status = U_ZERO_ERROR; |
| UCollationResult path_compare_result = collator->compare( |
| static_cast<const UChar*>(path.c_str()), |
| static_cast<int>(path.length()), |
| static_cast<const UChar*>(o_path.c_str()), |
| static_cast<int>(o_path.length()), |
| compare_status); |
| DCHECK(U_SUCCESS(compare_status)); |
| if (path_compare_result != 0) |
| return path_compare_result; |
| |
| // Hosts and paths match, compare on the complete url. This'll push the www. |
| // ones to the end. |
| compare_status = U_ZERO_ERROR; |
| UCollationResult display_url_compare_result = collator->compare( |
| static_cast<const UChar*>(display_url_.c_str()), |
| static_cast<int>(display_url_.length()), |
| static_cast<const UChar*>(other.display_url_.c_str()), |
| static_cast<int>(other.display_url_.length()), |
| compare_status); |
| DCHECK(U_SUCCESS(compare_status)); |
| return display_url_compare_result; |
| } |
| |
| string16 SortedDisplayURL::AfterHost() const { |
| size_t slash_index = display_url_.find(sort_host_, prefix_end_); |
| if (slash_index == string16::npos) { |
| NOTREACHED(); |
| return string16(); |
| } |
| return display_url_.substr(slash_index + sort_host_.length()); |
| } |
| |
| } // namespace gfx |