Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1122)

Side by Side Diff: ui/gfx/text_elider.h

Issue 100303003: Move more uses of string16 to specify base:: (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 7 years ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « ui/gfx/render_text.cc ('k') | ui/gfx/text_elider.cc » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. 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 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 and formatting UI text. 5 // This file defines utility functions for eliding and formatting UI text.
6 6
7 #ifndef UI_GFX_TEXT_ELIDER_H_ 7 #ifndef UI_GFX_TEXT_ELIDER_H_
8 #define UI_GFX_TEXT_ELIDER_H_ 8 #define UI_GFX_TEXT_ELIDER_H_
9 9
10 #include <string> 10 #include <string>
11 #include <vector> 11 #include <vector>
12 12
13 #include "base/basictypes.h" 13 #include "base/basictypes.h"
14 #include "base/strings/string16.h" 14 #include "base/strings/string16.h"
15 #include "third_party/icu/source/common/unicode/uchar.h" 15 #include "third_party/icu/source/common/unicode/uchar.h"
16 #include "third_party/icu/source/i18n/unicode/coll.h" 16 #include "third_party/icu/source/i18n/unicode/coll.h"
17 #include "ui/gfx/gfx_export.h" 17 #include "ui/gfx/gfx_export.h"
18 18
19 class GURL; 19 class GURL;
20 20
21 namespace base { 21 namespace base {
22 class FilePath; 22 class FilePath;
23 } 23 }
24 24
25 namespace gfx { 25 namespace gfx {
26 class Font; 26 class Font;
27 class FontList; 27 class FontList;
28 28
29 GFX_EXPORT extern const char kEllipsis[]; 29 GFX_EXPORT extern const char kEllipsis[];
30 GFX_EXPORT extern const char16 kEllipsisUTF16[]; 30 GFX_EXPORT extern const base::char16 kEllipsisUTF16[];
31 31
32 // Elides a well-formed email address (e.g. username@domain.com) to fit into 32 // Elides a well-formed email address (e.g. username@domain.com) to fit into
33 // |available_pixel_width| using the specified |font_list|. 33 // |available_pixel_width| using the specified |font_list|.
34 // This function guarantees that the string returned will contain at least one 34 // This function guarantees that the string returned will contain at least one
35 // character, other than the ellipses, on either side of the '@'. If it is 35 // character, other than the ellipses, on either side of the '@'. If it is
36 // impossible to achieve these requirements: only an ellipsis will be returned. 36 // impossible to achieve these requirements: only an ellipsis will be returned.
37 // If possible: this elides only the username portion of the |email|. Otherwise, 37 // If possible: this elides only the username portion of the |email|. Otherwise,
38 // the domain is elided in the middle so that it splits the available width 38 // the domain is elided in the middle so that it splits the available width
39 // equally with the elided username (should the username be short enough that it 39 // equally with the elided username (should the username be short enough that it
40 // doesn't need half the available width: the elided domain will occupy that 40 // doesn't need half the available width: the elided domain will occupy that
41 // extra width). 41 // extra width).
42 GFX_EXPORT string16 ElideEmail(const string16& email, 42 GFX_EXPORT base::string16 ElideEmail(const base::string16& email,
43 const gfx::FontList& font_list, 43 const gfx::FontList& font_list,
44 float available_pixel_width); 44 float available_pixel_width);
45 45
46 // This function takes a GURL object and elides it. It returns a string 46 // This function takes a GURL object and elides it. It returns a string
47 // which composed of parts from subdomain, domain, path, filename and query. 47 // which composed of parts from subdomain, domain, path, filename and query.
48 // A "..." is added automatically at the end if the elided string is bigger 48 // A "..." is added automatically at the end if the elided string is bigger
49 // than the |available_pixel_width|. For |available_pixel_width| == 0, a 49 // than the |available_pixel_width|. For |available_pixel_width| == 0, a
50 // formatted, but un-elided, string is returned. |languages| is a comma 50 // formatted, but un-elided, string is returned. |languages| is a comma
51 // separated list of ISO 639 language codes and is used to determine what 51 // separated list of ISO 639 language codes and is used to determine what
52 // characters are understood by a user. It should come from 52 // characters are understood by a user. It should come from
53 // |prefs::kAcceptLanguages|. 53 // |prefs::kAcceptLanguages|.
54 // 54 //
55 // Note: in RTL locales, if the URL returned by this function is going to be 55 // Note: in RTL locales, if the URL returned by this function is going to be
56 // displayed in the UI, then it is likely that the string needs to be marked 56 // displayed in the UI, then it is likely that the string needs to be marked
57 // as an LTR string (using base::i18n::WrapStringWithLTRFormatting()) so that it 57 // as an LTR string (using base::i18n::WrapStringWithLTRFormatting()) so that it
58 // is displayed properly in an RTL context. Please refer to 58 // is displayed properly in an RTL context. Please refer to
59 // http://crbug.com/6487 for more information. 59 // http://crbug.com/6487 for more information.
60 GFX_EXPORT string16 ElideUrl(const GURL& url, 60 GFX_EXPORT base::string16 ElideUrl(const GURL& url,
61 const gfx::FontList& font_list, 61 const gfx::FontList& font_list,
62 float available_pixel_width, 62 float available_pixel_width,
63 const std::string& languages); 63 const std::string& languages);
64 64
65 enum ElideBehavior { 65 enum ElideBehavior {
66 // Add ellipsis at the end of the string. 66 // Add ellipsis at the end of the string.
67 ELIDE_AT_END, 67 ELIDE_AT_END,
68 // Add ellipsis in the middle of the string. 68 // Add ellipsis in the middle of the string.
69 ELIDE_IN_MIDDLE, 69 ELIDE_IN_MIDDLE,
70 // Truncate the end of the string. 70 // Truncate the end of the string.
71 TRUNCATE_AT_END 71 TRUNCATE_AT_END
72 }; 72 };
73 73
74 // Elides |text| to fit in |available_pixel_width| according to the specified 74 // Elides |text| to fit in |available_pixel_width| according to the specified
75 // |elide_behavior|. 75 // |elide_behavior|.
76 GFX_EXPORT string16 ElideText(const string16& text, 76 GFX_EXPORT base::string16 ElideText(const base::string16& text,
77 const gfx::FontList& font_list, 77 const gfx::FontList& font_list,
78 float available_pixel_width, 78 float available_pixel_width,
79 ElideBehavior elide_behavior); 79 ElideBehavior elide_behavior);
80 // Obsolete version. Use the above version which takes gfx::FontList. 80 // Obsolete version. Use the above version which takes gfx::FontList.
81 GFX_EXPORT string16 ElideText(const string16& text, 81 GFX_EXPORT base::string16 ElideText(const base::string16& text,
82 const gfx::Font& font, 82 const gfx::Font& font,
83 float available_pixel_width, 83 float available_pixel_width,
84 ElideBehavior elide_behavior); 84 ElideBehavior elide_behavior);
85 85
86 // Elide a filename to fit a given pixel width, with an emphasis on not hiding 86 // Elide a filename to fit a given pixel width, with an emphasis on not hiding
87 // the extension unless we have to. If filename contains a path, the path will 87 // the extension unless we have to. If filename contains a path, the path will
88 // be removed if filename doesn't fit into available_pixel_width. The elided 88 // be removed if filename doesn't fit into available_pixel_width. The elided
89 // filename is forced to have LTR directionality, which means that in RTL UI 89 // filename is forced to have LTR directionality, which means that in RTL UI
90 // the elided filename is wrapped with LRE (Left-To-Right Embedding) mark and 90 // the elided filename is wrapped with LRE (Left-To-Right Embedding) mark and
91 // PDF (Pop Directional Formatting) mark. 91 // PDF (Pop Directional Formatting) mark.
92 GFX_EXPORT string16 ElideFilename(const base::FilePath& filename, 92 GFX_EXPORT base::string16 ElideFilename(const base::FilePath& filename,
93 const gfx::FontList& font_list, 93 const gfx::FontList& font_list,
94 float available_pixel_width); 94 float available_pixel_width);
95 95
96 // SortedDisplayURL maintains a string from a URL suitable for display to the 96 // SortedDisplayURL maintains a string from a URL suitable for display to the
97 // use. SortedDisplayURL also provides a function used for comparing two 97 // use. SortedDisplayURL also provides a function used for comparing two
98 // SortedDisplayURLs for use in visually ordering the SortedDisplayURLs. 98 // SortedDisplayURLs for use in visually ordering the SortedDisplayURLs.
99 // 99 //
100 // SortedDisplayURL is relatively cheap and supports value semantics. 100 // SortedDisplayURL is relatively cheap and supports value semantics.
101 class GFX_EXPORT SortedDisplayURL { 101 class GFX_EXPORT SortedDisplayURL {
102 public: 102 public:
103 SortedDisplayURL(const GURL& url, const std::string& languages); 103 SortedDisplayURL(const GURL& url, const std::string& languages);
104 SortedDisplayURL(); 104 SortedDisplayURL();
105 ~SortedDisplayURL(); 105 ~SortedDisplayURL();
106 106
107 // Compares this SortedDisplayURL to |url| using |collator|. Returns a value 107 // Compares this SortedDisplayURL to |url| using |collator|. Returns a value
108 // < 0, = 1 or > 0 as to whether this url is less then, equal to or greater 108 // < 0, = 1 or > 0 as to whether this url is less then, equal to or greater
109 // than the supplied url. 109 // than the supplied url.
110 int Compare(const SortedDisplayURL& other, icu::Collator* collator) const; 110 int Compare(const SortedDisplayURL& other, icu::Collator* collator) const;
111 111
112 // Returns the display string for the URL. 112 // Returns the display string for the URL.
113 const string16& display_url() const { return display_url_; } 113 const base::string16& display_url() const { return display_url_; }
114 114
115 private: 115 private:
116 // Returns everything after the host. This is used by Compare if the hosts 116 // Returns everything after the host. This is used by Compare if the hosts
117 // match. 117 // match.
118 string16 AfterHost() const; 118 base::string16 AfterHost() const;
119 119
120 // Host name minus 'www.'. Used by Compare. 120 // Host name minus 'www.'. Used by Compare.
121 string16 sort_host_; 121 base::string16 sort_host_;
122 122
123 // End of the prefix (spec and separator) in display_url_. 123 // End of the prefix (spec and separator) in display_url_.
124 size_t prefix_end_; 124 size_t prefix_end_;
125 125
126 string16 display_url_; 126 base::string16 display_url_;
127 127
128 DISALLOW_COPY_AND_ASSIGN(SortedDisplayURL); 128 DISALLOW_COPY_AND_ASSIGN(SortedDisplayURL);
129 }; 129 };
130 130
131 // Functions to elide strings when the font information is unknown. As 131 // Functions to elide strings when the font information is unknown. As
132 // opposed to the above functions, the ElideString() and 132 // opposed to the above functions, the ElideString() and
133 // ElideRectangleString() functions operate in terms of character units, 133 // ElideRectangleString() functions operate in terms of character units,
134 // not pixels. 134 // not pixels.
135 135
136 // If the size of |input| is more than |max_len|, this function returns 136 // If the size of |input| is more than |max_len|, this function returns
137 // true and |input| is shortened into |output| by removing chars in the 137 // true and |input| is shortened into |output| by removing chars in the
138 // middle (they are replaced with up to 3 dots, as size permits). 138 // middle (they are replaced with up to 3 dots, as size permits).
139 // Ex: ElideString(ASCIIToUTF16("Hello"), 10, &str) puts Hello in str and 139 // Ex: ElideString(ASCIIToUTF16("Hello"), 10, &str) puts Hello in str and
140 // returns false. ElideString(ASCIIToUTF16("Hello my name is Tom"), 10, &str) 140 // returns false. ElideString(ASCIIToUTF16("Hello my name is Tom"), 10, &str)
141 // puts "Hell...Tom" in str and returns true. 141 // puts "Hell...Tom" in str and returns true.
142 // TODO(tsepez): Doesn't handle UTF-16 surrogate pairs properly. 142 // TODO(tsepez): Doesn't handle UTF-16 surrogate pairs properly.
143 // TODO(tsepez): Doesn't handle bidi properly. 143 // TODO(tsepez): Doesn't handle bidi properly.
144 GFX_EXPORT bool ElideString(const string16& input, int max_len, 144 GFX_EXPORT bool ElideString(const base::string16& input, int max_len,
145 string16* output); 145 base::string16* output);
146 146
147 // Reformat |input| into |output| so that it fits into a |max_rows| by 147 // Reformat |input| into |output| so that it fits into a |max_rows| by
148 // |max_cols| rectangle of characters. Input newlines are respected, but 148 // |max_cols| rectangle of characters. Input newlines are respected, but
149 // lines that are too long are broken into pieces. If |strict| is true, 149 // lines that are too long are broken into pieces. If |strict| is true,
150 // we break first at naturally occuring whitespace boundaries, otherwise 150 // we break first at naturally occuring whitespace boundaries, otherwise
151 // we assume some other mechanism will do this in approximately the same 151 // we assume some other mechanism will do this in approximately the same
152 // spot after the fact. If the word itself is too long, we always break 152 // spot after the fact. If the word itself is too long, we always break
153 // intra-word (respecting UTF-16 surrogate pairs) as necssary. Truncation 153 // intra-word (respecting UTF-16 surrogate pairs) as necssary. Truncation
154 // (indicated by an added 3 dots) occurs if the result is still too long. 154 // (indicated by an added 3 dots) occurs if the result is still too long.
155 // Returns true if the input had to be truncated (and not just reformatted). 155 // Returns true if the input had to be truncated (and not just reformatted).
156 GFX_EXPORT bool ElideRectangleString(const string16& input, size_t max_rows, 156 GFX_EXPORT bool ElideRectangleString(const base::string16& input,
157 size_t max_cols, bool strict, 157 size_t max_rows,
158 string16* output); 158 size_t max_cols,
159 bool strict,
160 base::string16* output);
159 161
160 // Specifies the word wrapping behavior of |ElideRectangleText()| when a word 162 // Specifies the word wrapping behavior of |ElideRectangleText()| when a word
161 // would exceed the available width. 163 // would exceed the available width.
162 enum WordWrapBehavior { 164 enum WordWrapBehavior {
163 // Words that are too wide will be put on a new line, but will not be 165 // Words that are too wide will be put on a new line, but will not be
164 // truncated or elided. 166 // truncated or elided.
165 IGNORE_LONG_WORDS, 167 IGNORE_LONG_WORDS,
166 168
167 // Words that are too wide will be put on a new line and will be truncated to 169 // Words that are too wide will be put on a new line and will be truncated to
168 // the available width. 170 // the available width.
(...skipping 17 matching lines...) Expand all
186 }; 188 };
187 189
188 // Reformats |text| into output vector |lines| so that the resulting text fits 190 // Reformats |text| into output vector |lines| so that the resulting text fits
189 // into an |available_pixel_width| by |available_pixel_height| rectangle with 191 // into an |available_pixel_width| by |available_pixel_height| rectangle with
190 // the specified |font_list|. Input newlines are respected, but lines that are 192 // the specified |font_list|. Input newlines are respected, but lines that are
191 // too long are broken into pieces. For words that are too wide to fit on a 193 // too long are broken into pieces. For words that are too wide to fit on a
192 // single line, the wrapping behavior can be specified with the |wrap_behavior| 194 // single line, the wrapping behavior can be specified with the |wrap_behavior|
193 // param. Returns a combination of |ReformattingResultFlags| that indicate 195 // param. Returns a combination of |ReformattingResultFlags| that indicate
194 // whether the given rectangle had insufficient space to accommodate |texŧ|, 196 // whether the given rectangle had insufficient space to accommodate |texŧ|,
195 // leading to elision or truncation (and not just reformatting). 197 // leading to elision or truncation (and not just reformatting).
196 GFX_EXPORT int ElideRectangleText(const string16& text, 198 GFX_EXPORT int ElideRectangleText(const base::string16& text,
197 const gfx::FontList& font_list, 199 const gfx::FontList& font_list,
198 float available_pixel_width, 200 float available_pixel_width,
199 int available_pixel_height, 201 int available_pixel_height,
200 WordWrapBehavior wrap_behavior, 202 WordWrapBehavior wrap_behavior,
201 std::vector<string16>* lines); 203 std::vector<base::string16>* lines);
202 204
203 // Truncates the string to length characters. This breaks the string at 205 // Truncates the string to length characters. This breaks the string at
204 // the first word break before length, adding the horizontal ellipsis 206 // the first word break before length, adding the horizontal ellipsis
205 // character (unicode character 0x2026) to render ... 207 // character (unicode character 0x2026) to render ...
206 // The supplied string is returned if the string has length characters or 208 // The supplied string is returned if the string has length characters or
207 // less. 209 // less.
208 GFX_EXPORT string16 TruncateString(const string16& string, size_t length); 210 GFX_EXPORT base::string16 TruncateString(const base::string16& string,
211 size_t length);
209 212
210 } // namespace gfx 213 } // namespace gfx
211 214
212 #endif // UI_GFX_TEXT_ELIDER_H_ 215 #endif // UI_GFX_TEXT_ELIDER_H_
OLDNEW
« no previous file with comments | « ui/gfx/render_text.cc ('k') | ui/gfx/text_elider.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698