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
3 // found in the LICENSE file.
5 // For WinDDK ATL compatibility, these ATL headers must come first.
6 #include "build/build_config.h"
8 #include <atlbase.h> // NOLINT
9 #include <atlwin.h> // NOLINT
12 #include "chrome/browser/ui/views/omnibox/omnibox_result_view.h"
14 #include <algorithm> // NOLINT
16 #include "base/i18n/bidi_line_iterator.h"
17 #include "base/memory/scoped_vector.h"
18 #include "chrome/browser/ui/omnibox/omnibox_popup_model.h"
19 #include "chrome/browser/ui/views/location_bar/location_bar_view.h"
20 #include "chrome/browser/ui/views/omnibox/omnibox_result_view_model.h"
21 #include "grit/generated_resources.h"
22 #include "grit/theme_resources.h"
23 #include "ui/base/l10n/l10n_util.h"
24 #include "ui/base/theme_provider.h"
25 #include "ui/gfx/canvas.h"
26 #include "ui/gfx/color_utils.h"
27 #include "ui/gfx/image/image.h"
28 #include "ui/gfx/render_text.h"
29 #include "ui/gfx/text_elider.h"
30 #include "ui/native_theme/native_theme.h"
33 #include "ui/native_theme/native_theme_win.h"
37 #include "ui/native_theme/native_theme_aura.h"
42 const char16 kEllipsis[] = { 0x2026, 0x0 };
44 // The minimum distance between the top and bottom of the {icon|text} and the
45 // top or bottom of the row.
46 const int kMinimumIconVerticalPadding = 2;
47 const int kMinimumTextVerticalPadding = 3;
51 ////////////////////////////////////////////////////////////////////////////////
52 // OmniboxResultView, public:
54 // Precalculated data used to draw a complete visual run within the match.
55 // This will include all or part of at least one, and possibly several,
57 struct OmniboxResultView::RunData {
58 RunData() : run_start(0), visual_order(0), is_rtl(false), pixel_width(0) {}
60 size_t run_start; // Offset within the match text where this run begins.
61 int visual_order; // Where this run occurs in visual order. The earliest
62 // run drawn is run 0.
66 // Styled text classification pieces within this run, in logical order.
67 Classifications classifications;
70 // This class is a utility class for calculations affected by whether the result
71 // view is horizontally mirrored. The drawing functions can be written as if
72 // all drawing occurs left-to-right, and then use this class to get the actual
73 // coordinates to begin drawing onscreen.
74 class OmniboxResultView::MirroringContext {
76 MirroringContext() : center_(0), right_(0) {}
78 // Tells the mirroring context to use the provided range as the physical
79 // bounds of the drawing region. When coordinate mirroring is needed, the
80 // mirror point will be the center of this range.
81 void Initialize(int x, int width) {
82 center_ = x + width / 2;
86 // Given a logical range within the drawing region, returns the coordinate of
87 // the possibly-mirrored "left" side. (This functions exactly like
88 // View::MirroredLeftPointForRect().)
89 int mirrored_left_coord(int left, int right) const {
90 return base::i18n::IsRTL() ? (center_ + (center_ - right)) : left;
93 // Given a logical coordinate within the drawing region, returns the remaining
95 int remaining_width(int x) const {
103 DISALLOW_COPY_AND_ASSIGN(MirroringContext);
106 OmniboxResultView::OmniboxResultView(
107 OmniboxResultViewModel* model,
109 LocationBarView* location_bar_view,
110 const gfx::FontList& font_list)
111 : edge_item_padding_(LocationBarView::GetItemPadding()),
112 item_padding_(LocationBarView::GetItemPadding()),
113 minimum_text_vertical_padding_(kMinimumTextVerticalPadding),
115 model_index_(model_index),
116 location_bar_view_(location_bar_view),
117 font_list_(font_list),
118 font_height_(std::max(font_list.GetHeight(),
119 font_list.DeriveFontList(gfx::BOLD).GetHeight())),
120 ellipsis_width_(font_list.GetPrimaryFont().GetStringWidth(
121 string16(kEllipsis))),
122 mirroring_context_(new MirroringContext()),
123 keyword_icon_(new views::ImageView()),
124 animation_(new gfx::SlideAnimation(this)) {
125 CHECK_GE(model_index, 0);
126 if (default_icon_size_ == 0) {
128 location_bar_view_->GetThemeProvider()->GetImageSkiaNamed(
129 AutocompleteMatch::TypeToIcon(
130 AutocompleteMatchType::URL_WHAT_YOU_TYPED))->width();
132 keyword_icon_->set_owned_by_client();
133 keyword_icon_->EnableCanvasFlippingForRTLUI(true);
134 keyword_icon_->SetImage(GetKeywordIcon());
135 keyword_icon_->SizeToPreferredSize();
138 OmniboxResultView::~OmniboxResultView() {
141 SkColor OmniboxResultView::GetColor(
142 ResultViewState state,
143 ColorKind kind) const {
144 const ui::NativeTheme* theme = GetNativeTheme();
146 if (theme == ui::NativeThemeWin::instance()) {
147 static bool win_initialized = false;
148 static SkColor win_colors[NUM_STATES][NUM_KINDS];
149 if (!win_initialized) {
150 win_colors[NORMAL][BACKGROUND] = color_utils::GetSysSkColor(COLOR_WINDOW);
151 win_colors[SELECTED][BACKGROUND] =
152 color_utils::GetSysSkColor(COLOR_HIGHLIGHT);
153 win_colors[NORMAL][TEXT] = color_utils::GetSysSkColor(COLOR_WINDOWTEXT);
154 win_colors[SELECTED][TEXT] =
155 color_utils::GetSysSkColor(COLOR_HIGHLIGHTTEXT);
156 CommonInitColors(theme, win_colors);
157 win_initialized = true;
159 return win_colors[state][kind];
162 static bool initialized = false;
163 static SkColor colors[NUM_STATES][NUM_KINDS];
165 colors[NORMAL][BACKGROUND] = theme->GetSystemColor(
166 ui::NativeTheme::kColorId_TextfieldDefaultBackground);
167 colors[NORMAL][TEXT] = theme->GetSystemColor(
168 ui::NativeTheme::kColorId_TextfieldDefaultColor);
169 colors[NORMAL][URL] = SkColorSetARGB(0xff, 0x00, 0x99, 0x33);
170 colors[SELECTED][BACKGROUND] = theme->GetSystemColor(
171 ui::NativeTheme::kColorId_TextfieldSelectionBackgroundFocused);
172 colors[SELECTED][TEXT] = theme->GetSystemColor(
173 ui::NativeTheme::kColorId_TextfieldSelectionColor);
174 colors[SELECTED][URL] = SkColorSetARGB(0xff, 0x00, 0x66, 0x22);
175 colors[HOVERED][URL] = SkColorSetARGB(0xff, 0x00, 0x66, 0x22);
176 CommonInitColors(theme, colors);
179 return colors[state][kind];
182 void OmniboxResultView::SetMatch(const AutocompleteMatch& match) {
186 if (match.associated_keyword.get()) {
187 keyword_icon_->SetImage(GetKeywordIcon());
189 if (!keyword_icon_->parent())
190 AddChildView(keyword_icon_.get());
191 } else if (keyword_icon_->parent()) {
192 RemoveChildView(keyword_icon_.get());
198 void OmniboxResultView::ShowKeyword(bool show_keyword) {
205 void OmniboxResultView::Invalidate() {
206 keyword_icon_->SetImage(GetKeywordIcon());
210 gfx::Size OmniboxResultView::GetPreferredSize() {
211 return gfx::Size(0, std::max(
212 default_icon_size_ + (kMinimumIconVerticalPadding * 2),
213 GetTextHeight() + (minimum_text_vertical_padding_ * 2)));
216 ////////////////////////////////////////////////////////////////////////////////
217 // OmniboxResultView, protected:
219 OmniboxResultView::ResultViewState OmniboxResultView::GetState() const {
220 if (model_->IsSelectedIndex(model_index_))
222 return model_->IsHoveredIndex(model_index_) ? HOVERED : NORMAL;
225 int OmniboxResultView::GetTextHeight() const {
229 void OmniboxResultView::PaintMatch(gfx::Canvas* canvas,
230 const AutocompleteMatch& match,
232 x = DrawString(canvas, match.contents, match.contents_class, false, x,
235 // Paint the description.
236 // TODO(pkasting): Because we paint in multiple separate pieces, we can wind
237 // up with no space even for an ellipsis for one or both of these pieces.
238 // Instead, we should paint the entire match as a single long string. This
239 // would also let us use a more properly-localizable string than we get with
240 // just the IDS_AUTOCOMPLETE_MATCH_DESCRIPTION_SEPARATOR.
241 if (!match.description.empty()) {
243 l10n_util::GetStringUTF16(IDS_AUTOCOMPLETE_MATCH_DESCRIPTION_SEPARATOR);
244 ACMatchClassifications classifications;
245 classifications.push_back(
246 ACMatchClassification(0, ACMatchClassification::NONE));
247 x = DrawString(canvas, separator, classifications, true, x,
250 DrawString(canvas, match.description, match.description_class, true, x,
256 void OmniboxResultView::CommonInitColors(const ui::NativeTheme* theme,
257 SkColor colors[][NUM_KINDS]) {
258 colors[HOVERED][BACKGROUND] =
259 color_utils::AlphaBlend(colors[SELECTED][BACKGROUND],
260 colors[NORMAL][BACKGROUND], 64);
261 colors[HOVERED][TEXT] = colors[NORMAL][TEXT];
262 #if defined(USE_AURA)
263 const bool is_aura = theme == ui::NativeThemeAura::instance();
265 const bool is_aura = false;
267 for (int i = 0; i < NUM_STATES; ++i) {
270 color_utils::AlphaBlend(SK_ColorBLACK, colors[i][BACKGROUND], 0xdd);
271 colors[i][DIMMED_TEXT] =
272 color_utils::AlphaBlend(SK_ColorBLACK, colors[i][BACKGROUND], 0xbb);
274 colors[i][DIMMED_TEXT] =
275 color_utils::AlphaBlend(colors[i][TEXT], colors[i][BACKGROUND], 128);
276 colors[i][URL] = color_utils::GetReadableColor(SkColorSetRGB(0, 128, 0),
277 colors[i][BACKGROUND]);
280 // TODO(joi): Programmatically draw the dropdown border using
281 // this color as well. (Right now it's drawn as black with 25%
284 color_utils::AlphaBlend(colors[i][TEXT], colors[i][BACKGROUND], 0x34);
289 bool OmniboxResultView::SortRunsLogically(const RunData& lhs,
290 const RunData& rhs) {
291 return lhs.run_start < rhs.run_start;
295 bool OmniboxResultView::SortRunsVisually(const RunData& lhs,
296 const RunData& rhs) {
297 return lhs.visual_order < rhs.visual_order;
301 int OmniboxResultView::default_icon_size_ = 0;
303 gfx::ImageSkia OmniboxResultView::GetIcon() const {
304 const gfx::Image image = model_->GetIconIfExtensionMatch(model_index_);
305 if (!image.IsEmpty())
306 return image.AsImageSkia();
308 int icon = match_.starred ?
309 IDR_OMNIBOX_STAR : AutocompleteMatch::TypeToIcon(match_.type);
310 if (GetState() == SELECTED) {
312 case IDR_OMNIBOX_EXTENSION_APP:
313 icon = IDR_OMNIBOX_EXTENSION_APP_SELECTED;
315 case IDR_OMNIBOX_HTTP:
316 icon = IDR_OMNIBOX_HTTP_SELECTED;
318 case IDR_OMNIBOX_SEARCH:
319 icon = IDR_OMNIBOX_SEARCH_SELECTED;
321 case IDR_OMNIBOX_STAR:
322 icon = IDR_OMNIBOX_STAR_SELECTED;
329 return *(location_bar_view_->GetThemeProvider()->GetImageSkiaNamed(icon));
332 const gfx::ImageSkia* OmniboxResultView::GetKeywordIcon() const {
333 // NOTE: If we ever begin returning icons of varying size, then callers need
334 // to ensure that |keyword_icon_| is resized each time its image is reset.
335 return location_bar_view_->GetThemeProvider()->GetImageSkiaNamed(
336 (GetState() == SELECTED) ? IDR_OMNIBOX_TTS_SELECTED : IDR_OMNIBOX_TTS);
339 int OmniboxResultView::DrawString(
341 const string16& text,
342 const ACMatchClassifications& classifications,
349 // Check whether or not this text is a URL. URLs are always displayed LTR
350 // regardless of locale.
352 for (ACMatchClassifications::const_iterator i(classifications.begin());
353 i != classifications.end(); ++i) {
354 if (!(i->style & ACMatchClassification::URL)) {
360 // Split the text into visual runs. We do this first so that we don't need to
361 // worry about whether our eliding might change the visual display in
362 // unintended ways, e.g. by removing directional markings or by adding an
363 // ellipsis that's not enclosed in appropriate markings.
364 base::i18n::BiDiLineIterator bidi_line;
365 if (!bidi_line.Open(text, base::i18n::IsRTL(), is_url))
367 const int num_runs = bidi_line.CountRuns();
368 ScopedVector<gfx::RenderText> render_texts;
370 for (int run = 0; run < num_runs; ++run) {
371 int run_start_int = 0, run_length_int = 0;
372 // The index we pass to GetVisualRun corresponds to the position of the run
373 // in the displayed text. For example, the string "Google in HEBREW" (where
374 // HEBREW is text in the Hebrew language) has two runs: "Google in " which
375 // is an LTR run, and "HEBREW" which is an RTL run. In an LTR context, the
376 // run "Google in " has the index 0 (since it is the leftmost run
377 // displayed). In an RTL context, the same run has the index 1 because it
378 // is the rightmost run. This is why the order in which we traverse the
379 // runs is different depending on the locale direction.
380 const UBiDiDirection run_direction = bidi_line.GetVisualRun(
381 (base::i18n::IsRTL() && !is_url) ? (num_runs - run - 1) : run,
382 &run_start_int, &run_length_int);
383 DCHECK_GT(run_length_int, 0);
384 runs.push_back(RunData());
385 RunData* current_run = &runs.back();
386 current_run->run_start = run_start_int;
387 const size_t run_end = current_run->run_start + run_length_int;
388 current_run->visual_order = run;
389 current_run->is_rtl = !is_url && (run_direction == UBIDI_RTL);
391 // Compute classifications for this run.
392 for (size_t i = 0; i < classifications.size(); ++i) {
393 const size_t text_start =
394 std::max(classifications[i].offset, current_run->run_start);
395 if (text_start >= run_end)
396 break; // We're past the last classification in the run.
398 const size_t text_end = (i < (classifications.size() - 1)) ?
399 std::min(classifications[i + 1].offset, run_end) : run_end;
400 if (text_end <= current_run->run_start)
401 continue; // We haven't reached the first classification in the run.
403 render_texts.push_back(gfx::RenderText::CreateInstance());
404 gfx::RenderText* render_text = render_texts.back();
405 current_run->classifications.push_back(render_text);
406 render_text->SetText(text.substr(text_start, text_end - text_start));
407 render_text->SetFontList(font_list_);
409 // Calculate style-related data.
410 if (classifications[i].style & ACMatchClassification::MATCH)
411 render_text->SetStyle(gfx::BOLD, true);
412 const ResultViewState state = GetState();
413 if (classifications[i].style & ACMatchClassification::URL)
414 render_text->SetColor(GetColor(state, URL));
415 else if (classifications[i].style & ACMatchClassification::DIM)
416 render_text->SetColor(GetColor(state, DIMMED_TEXT));
418 render_text->SetColor(GetColor(state, force_dim ? DIMMED_TEXT : TEXT));
420 current_run->pixel_width += render_text->GetStringSize().width();
422 DCHECK(!current_run->classifications.empty());
424 DCHECK(!runs.empty());
426 // Sort into logical order so we can elide logically.
427 std::sort(runs.begin(), runs.end(), &SortRunsLogically);
429 // Now determine what to elide, if anything. Several subtle points:
430 // * Because we have the run data, we can get edge cases correct, like
431 // whether to place an ellipsis before or after the end of a run when the
432 // text needs to be elided at the run boundary.
433 // * The "or one before it" comments below refer to cases where an earlier
434 // classification fits completely, but leaves too little space for an
435 // ellipsis that turns out to be needed later. These cases are commented
436 // more completely in Elide().
437 int remaining_width = mirroring_context_->remaining_width(x);
438 for (Runs::iterator i(runs.begin()); i != runs.end(); ++i) {
439 if (i->pixel_width > remaining_width) {
440 // This run or one before it needs to be elided.
441 for (Classifications::iterator j(i->classifications.begin());
442 j != i->classifications.end(); ++j) {
443 const int width = (*j)->GetStringSize().width();
444 if (width > remaining_width) {
445 // This classification or one before it needs to be elided. Erase all
446 // further classifications and runs so Elide() can simply reverse-
447 // iterate over everything to find the specific classification to
449 i->classifications.erase(++j, i->classifications.end());
450 runs.erase(++i, runs.end());
451 Elide(&runs, remaining_width);
454 remaining_width -= width;
458 remaining_width -= i->pixel_width;
461 // Sort back into visual order so we can display the runs correctly.
462 std::sort(runs.begin(), runs.end(), &SortRunsVisually);
465 for (Runs::iterator i(runs.begin()); i != runs.end(); ++i) {
466 const bool reverse_visible_order = (i->is_rtl != base::i18n::IsRTL());
467 if (reverse_visible_order)
468 std::reverse(i->classifications.begin(), i->classifications.end());
469 for (Classifications::const_iterator j(i->classifications.begin());
470 j != i->classifications.end(); ++j) {
471 const gfx::Size size = (*j)->GetStringSize();
472 // Align the text runs to a common baseline.
473 const gfx::Rect rect(
474 mirroring_context_->mirrored_left_coord(x, x + size.width()), y,
475 size.width(), height());
476 (*j)->SetDisplayRect(rect);
485 void OmniboxResultView::Elide(Runs* runs, int remaining_width) const {
486 // The complexity of this function is due to edge cases like the following:
487 // We have 100 px of available space, an initial classification that takes 86
488 // px, and a font that has a 15 px wide ellipsis character. Now if the first
489 // classification is followed by several very narrow classifications (e.g. 3
490 // px wide each), we don't know whether we need to elide or not at the time we
491 // see the first classification -- it depends on how many subsequent
492 // classifications follow, and some of those may be in the next run (or
493 // several runs!). This is why instead we let our caller move forward until
494 // we know we definitely need to elide, and then in this function we move
495 // backward again until we find a string that we can successfully do the
497 bool on_trailing_classification = true;
498 for (Runs::reverse_iterator i(runs->rbegin()); i != runs->rend(); ++i) {
499 for (Classifications::reverse_iterator j(i->classifications.rbegin());
500 j != i->classifications.rend(); ++j) {
501 if (!on_trailing_classification) {
502 // We also add this classification's width (sans ellipsis) back to the
503 // available width since we want to consider the available space we'll
504 // have when we draw this classification.
505 remaining_width += (*j)->GetStringSize().width();
507 // If we reached here, we couldn't fit an ellipsis in the space taken by
508 // the previous classifications we looped over (see comments at bottom
509 // of loop). Append one here to represent those elided portions.
510 (*j)->SetText((*j)->text() + kEllipsis);
512 on_trailing_classification = false;
514 // Can we fit at least an ellipsis?
515 gfx::Font font((*j)->GetStyle(gfx::BOLD) ?
516 (*j)->GetPrimaryFont().DeriveFont(0, gfx::Font::BOLD) :
517 (*j)->GetPrimaryFont());
518 string16 elided_text(
519 gfx::ElideText((*j)->text(), font, remaining_width,
521 Classifications::reverse_iterator prior(j + 1);
522 const bool on_leading_classification =
523 (prior == i->classifications.rend());
524 if (elided_text.empty() && (remaining_width >= ellipsis_width_) &&
525 on_leading_classification) {
526 // Edge case: This classification is bold, we can't fit a bold ellipsis
527 // but we can fit a normal one, and this is the first classification in
528 // the run. We should display a lone normal ellipsis, because appending
529 // one to the end of the previous run might put it in the wrong visual
530 // location (if the previous run is reversed from the normal visual
532 // NOTE: If this isn't the first classification in the run, we don't
533 // need to bother with this; see note below.
534 elided_text = kEllipsis;
536 if (!elided_text.empty()) {
537 // Success. Elide this classification and stop.
538 (*j)->SetText(elided_text);
540 // If we could only fit an ellipsis, then only make it bold if there was
541 // an immediate prior classification in this run that was also bold, or
542 // it will look orphaned.
543 if ((*j)->GetStyle(gfx::BOLD) && (elided_text.length() == 1) &&
544 (on_leading_classification || !(*prior)->GetStyle(gfx::BOLD)))
545 (*j)->SetStyle(gfx::BOLD, false);
547 // Erase any other classifications that come after the elided one.
548 i->classifications.erase(j.base(), i->classifications.end());
549 runs->erase(i.base(), runs->end());
553 // We couldn't fit an ellipsis. Move back one classification,
554 // append an ellipsis, and try again.
555 // NOTE: In the edge case that a bold ellipsis doesn't fit but a
556 // normal one would, and we reach here, then there is a previous
557 // classification in this run, and so either:
558 // * It's normal, and will be able to draw successfully with the
559 // ellipsis we'll append to it, or
560 // * It is also bold, in which case we don't want to fall back
561 // to a normal ellipsis anyway (see comment above).
565 // We couldn't draw anything.
569 void OmniboxResultView::Layout() {
570 const gfx::ImageSkia icon = GetIcon();
572 icon_bounds_.SetRect(edge_item_padding_ +
573 ((icon.width() == default_icon_size_) ?
574 0 : LocationBarView::kIconInternalPadding),
575 (height() - icon.height()) / 2, icon.width(), icon.height());
577 int text_x = edge_item_padding_ + default_icon_size_ + item_padding_;
578 int text_width = width() - text_x - edge_item_padding_;
580 if (match_.associated_keyword.get()) {
581 const int kw_collapsed_size =
582 keyword_icon_->width() + edge_item_padding_;
583 const int max_kw_x = width() - kw_collapsed_size;
585 animation_->CurrentValueBetween(max_kw_x, edge_item_padding_);
586 const int kw_text_x = kw_x + keyword_icon_->width() + item_padding_;
588 text_width = kw_x - text_x - item_padding_;
589 keyword_text_bounds_.SetRect(
591 std::max(width() - kw_text_x - edge_item_padding_, 0), height());
592 keyword_icon_->SetPosition(
593 gfx::Point(kw_x, (height() - keyword_icon_->height()) / 2));
596 text_bounds_.SetRect(text_x, 0, std::max(text_width, 0), height());
599 void OmniboxResultView::OnBoundsChanged(const gfx::Rect& previous_bounds) {
600 animation_->SetSlideDuration(width() / 4);
603 void OmniboxResultView::OnPaint(gfx::Canvas* canvas) {
604 const ResultViewState state = GetState();
606 canvas->DrawColor(GetColor(state, BACKGROUND));
608 if (!match_.associated_keyword.get() ||
609 keyword_icon_->x() > icon_bounds_.right()) {
611 canvas->DrawImageInt(GetIcon(), GetMirroredXForRect(icon_bounds_),
615 int x = GetMirroredXForRect(text_bounds_);
616 mirroring_context_->Initialize(x, text_bounds_.width());
617 PaintMatch(canvas, match_, x);
620 if (match_.associated_keyword.get()) {
621 // Paint the keyword text.
622 int x = GetMirroredXForRect(keyword_text_bounds_);
623 mirroring_context_->Initialize(x, keyword_text_bounds_.width());
624 PaintMatch(canvas, *match_.associated_keyword.get(), x);
628 void OmniboxResultView::AnimationProgressed(const gfx::Animation* animation) {