[gtk] Add fade-commit to instant suggestion for predictive instant.

chrome/browser/autocomplete/autocomplete_edit_view_gtk.cc

 // 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 "chrome/browser/autocomplete/autocomplete_edit_view_gtk.h"
 
 #include <gtk/gtk.h>
 #include <gdk/gdkkeysyms.h>
 
 #include <algorithm>
 
 #include "app/l10n_util.h"
+#include "app/multi_animation.h"
 #include "base/logging.h"
 #include "base/string_util.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/app/chrome_command_ids.h"
 #include "chrome/browser/autocomplete/autocomplete_edit.h"
 #include "chrome/browser/autocomplete/autocomplete_match.h"
 #include "chrome/browser/autocomplete/autocomplete_popup_model.h"
 #include "chrome/browser/bookmarks/bookmark_node_data.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/command_updater.h"
 #include "chrome/browser/defaults.h"
 #include "chrome/browser/gtk/gtk_util.h"
 #include "chrome/browser/gtk/view_id_util.h"
+#include "chrome/browser/instant/instant_controller.h"
 #include "chrome/browser/platform_util.h"
 #include "chrome/browser/tab_contents/tab_contents.h"
 #include "chrome/browser/ui/toolbar/toolbar_model.h"
 #include "chrome/common/notification_service.h"
+#include "gfx/color_utils.h"
 #include "gfx/font.h"
 #include "gfx/gtk_util.h"
 #include "gfx/skia_utils_gtk.h"
 #include "googleurl/src/gurl.h"
 #include "grit/generated_resources.h"
 #include "net/base/escape.h"
 #include "third_party/undoview/undo_view.h"
 
 #if defined(TOOLKIT_VIEWS)
 #include "chrome/browser/views/autocomplete/autocomplete_popup_contents_view.h"
 #include "chrome/browser/views/location_bar/location_bar_view.h"
 #else
 #include "chrome/browser/autocomplete/autocomplete_popup_view_gtk.h"
 #include "chrome/browser/gtk/gtk_theme_provider.h"
 #include "chrome/browser/gtk/location_bar_view_gtk.h"
 #endif
 
 namespace {
 
 const gchar* kAutocompleteEditViewGtkKey = "__ACE_VIEW_GTK__";
 
 const char kTextBaseColor[] = "#808080";
 const char kSecureSchemeColor[] = "#079500";
 const char kSecurityErrorSchemeColor[] = "#a20000";
 
 const double kStrikethroughStrokeRed = 162.0 / 256.0;
 const double kStrikethroughStrokeWidth = 2.0;
 
+// Amount of time to wait before starting the instant animation.
+const int kPauseTimeMS = 1000;
+// Duration of the instant animation in which the colors change.
+const int kFadeInTimeMS = 300;

[James Su, 2010/12/04 03:43:38]

Is it possible or necessary to share these constants with other ports?

[sky, 2010/12/06 17:38:12]

Maybe move them to browser/defaults?

[Evan Stade, 2010/12/06 22:15:48]

moved to instant_controller. defaults.h doesn't seem to be a place for stuffing
generic constants.

+
 size_t GetUTF8Offset(const std::wstring& wide_text, size_t wide_text_offset) {
   return WideToUTF8(wide_text.substr(0, wide_text_offset)).size();
 }
 
 // Stores GTK+-specific state so it can be restored after switching tabs.
 struct ViewState {
   explicit ViewState(const AutocompleteEditViewGtk::CharRange& selection_range)
       : selection_range(selection_range) {
   }
 
@@ skipping 262 matching lines @@
   g_signal_connect(text_view_, "redo", G_CALLBACK(&HandleUndoRedoThunk), this);
   g_signal_connect_after(text_view_, "undo",
                          G_CALLBACK(&HandleUndoRedoAfterThunk), this);
   g_signal_connect_after(text_view_, "redo",
                          G_CALLBACK(&HandleUndoRedoAfterThunk), this);
 
   // Setup for the Instant suggestion text view.
   // GtkLabel is used instead of GtkTextView to get transparent background.
   instant_view_ = gtk_label_new(NULL);
   gtk_widget_set_no_show_all(instant_view_, TRUE);
+  gtk_label_set_selectable(GTK_LABEL(instant_view_), TRUE);
 
   GtkTextIter end_iter;
   gtk_text_buffer_get_end_iter(text_buffer_, &end_iter);
 
   // Insert a Zero Width Space character just before the instant anchor.
   // It's a hack to workaround a bug of GtkTextView which can not align the
   // preedit string and a child anchor correctly when there is no other content
   // around the preedit string.
   gtk_text_buffer_insert(text_buffer_, &end_iter, "\342\200\213", -1);
   GtkTextChildAnchor* instant_anchor =
@@ skipping 16 matching lines @@
   instant_mark_ =
       gtk_text_buffer_create_mark(text_buffer_, NULL, &start_iter, FALSE);
 
   // Hooking up this handler after setting up above hacks for Instant view, so
   // that we won't filter out the special ZWP mark itself.
   g_signal_connect(text_buffer_, "insert-text",
                    G_CALLBACK(&HandleInsertTextThunk), this);
 
   AdjustVerticalAlignmentOfInstantView();
 
+  MultiAnimation::Parts parts;
+  parts.push_back(MultiAnimation::Part(kPauseTimeMS, Tween::ZERO));
+  parts.push_back(MultiAnimation::Part(kFadeInTimeMS, Tween::EASE_IN));
+  instant_animation_.reset(new MultiAnimation(parts));
+  instant_animation_->set_continuous(false);
+
 #if !defined(TOOLKIT_VIEWS)
   registrar_.Add(this,
                  NotificationType::BROWSER_THEME_CHANGED,
                  NotificationService::AllSources());
   theme_provider_->InitThemesFor(this);
 #else
   // Manually invoke SetBaseColor() because TOOLKIT_VIEWS doesn't observe
   // themes.
   SetBaseColor();
 #endif
@@ skipping 348 matching lines @@
 }
 
 void AutocompleteEditViewGtk::Observe(NotificationType type,
                                       const NotificationSource& source,
                                       const NotificationDetails& details) {
   DCHECK(type == NotificationType::BROWSER_THEME_CHANGED);
 
   SetBaseColor();
 }
 
+void AutocompleteEditViewGtk::AnimationEnded(const Animation* animation) {
+  controller_->OnCommitSuggestedText(GetText());
+}
+
+void AutocompleteEditViewGtk::AnimationProgressed(const Animation* animation) {
+  UpdateInstantViewColors();
+}
+
+void AutocompleteEditViewGtk::AnimationCanceled(const Animation* animation) {
+  UpdateInstantViewColors();
+}
+
 void AutocompleteEditViewGtk::SetBaseColor() {
 #if defined(TOOLKIT_VIEWS)
   bool use_gtk = false;
 #else
   bool use_gtk = theme_provider_->UseGtkTheme();
 #endif
 
   if (use_gtk) {
     gtk_widget_modify_cursor(text_view_, NULL, NULL);
     gtk_widget_modify_base(text_view_, GTK_STATE_NORMAL, NULL);
     gtk_widget_modify_base(text_view_, GTK_STATE_SELECTED, NULL);
     gtk_widget_modify_text(text_view_, GTK_STATE_SELECTED, NULL);
     gtk_widget_modify_base(text_view_, GTK_STATE_ACTIVE, NULL);
     gtk_widget_modify_text(text_view_, GTK_STATE_ACTIVE, NULL);
 
     gtk_util::UndoForceFontSize(text_view_);
     gtk_util::UndoForceFontSize(instant_view_);
 
     // Grab the text colors out of the style and set our tags to use them.
     GtkStyle* style = gtk_rc_get_style(text_view_);
 
     // style may be unrealized at this point, so calculate the halfway point
     // between text[] and base[] manually instead of just using text_aa[].
     GdkColor average_color = gtk_util::AverageColors(
         style->text[GTK_STATE_NORMAL], style->base[GTK_STATE_NORMAL]);
 
     g_object_set(faded_text_tag_, "foreground-gdk", &average_color, NULL);
     g_object_set(normal_text_tag_, "foreground-gdk",
                  &style->text[GTK_STATE_NORMAL], NULL);
-
-    // GtkLabel uses fg color instead of text color.
-    gtk_widget_modify_fg(instant_view_, GTK_STATE_NORMAL, &average_color);
   } else {
     const GdkColor* background_color_ptr;
 #if defined(TOOLKIT_VIEWS)
     const GdkColor background_color = gfx::SkColorToGdkColor(
         LocationBarView::GetColor(ToolbarModel::NONE,
                                   LocationBarView::BACKGROUND));
     background_color_ptr = &background_color;
 #else
     background_color_ptr = &LocationBarViewGtk::kBackgroundColor;
 #endif
     gtk_widget_modify_cursor(
         text_view_, &gtk_util::kGdkBlack, &gtk_util::kGdkGray);
     gtk_widget_modify_base(text_view_, GTK_STATE_NORMAL, background_color_ptr);
 
     GdkColor c;

[James Su, 2010/12/04 03:43:38]

It's not used in views port.

[Evan Stade, 2010/12/06 22:15:48]

Done.

 #if !defined(TOOLKIT_VIEWS)
     // Override the selected colors so we don't leak colors from the current
     // gtk theme into the chrome-theme.
     c = gfx::SkColorToGdkColor(
         theme_provider_->get_active_selection_bg_color());
     gtk_widget_modify_base(text_view_, GTK_STATE_SELECTED, &c);
 
     c = gfx::SkColorToGdkColor(
         theme_provider_->get_active_selection_fg_color());
     gtk_widget_modify_text(text_view_, GTK_STATE_SELECTED, &c);
 
     c = gfx::SkColorToGdkColor(
         theme_provider_->get_inactive_selection_bg_color());
     gtk_widget_modify_base(text_view_, GTK_STATE_ACTIVE, &c);
 
     c = gfx::SkColorToGdkColor(
         theme_provider_->get_inactive_selection_fg_color());
     gtk_widget_modify_text(text_view_, GTK_STATE_ACTIVE, &c);
 #endif
 
-    gdk_color_parse(kTextBaseColor, &c);
-    gtk_widget_modify_fg(instant_view_, GTK_STATE_NORMAL, &c);
-
     // Until we switch to vector graphics, force the font size.
     gtk_util::ForceFontSizePixels(text_view_,
         popup_window_mode_ ?
         browser_defaults::kAutocompleteEditFontPixelSizeInPopup :
         browser_defaults::kAutocompleteEditFontPixelSize);
 
     gtk_util::ForceFontSizePixels(instant_view_,
         popup_window_mode_ ?
         browser_defaults::kAutocompleteEditFontPixelSizeInPopup :
         browser_defaults::kAutocompleteEditFontPixelSize);
 
     g_object_set(faded_text_tag_, "foreground", kTextBaseColor, NULL);
     g_object_set(normal_text_tag_, "foreground", "#000000", NULL);
   }
 
   AdjustVerticalAlignmentOfInstantView();
+  UpdateInstantViewColors();
+}
+
+void AutocompleteEditViewGtk::UpdateInstantViewColors() {

[James Su, 2010/12/04 03:43:38]

Please fix compilation failure for views port.

[Evan Stade, 2010/12/06 22:15:48]

Done.

+  SkColor selection_text, selection_bg;
+  GdkColor faded_text, normal_bg;
+
+  // We don't worry about views because it doesn't use the instant view.
+  if (theme_provider_->UseGtkTheme()) {
+    GtkStyle* style = gtk_rc_get_style(text_view_);
+
+    faded_text = gtk_util::AverageColors(
+        style->text[GTK_STATE_NORMAL], style->base[GTK_STATE_NORMAL]);
+    normal_bg = style->base[GTK_STATE_NORMAL];
+
+    selection_text = gfx::GdkColorToSkColor(style->text[GTK_STATE_SELECTED]);
+    selection_bg = gfx::GdkColorToSkColor(style->base[GTK_STATE_SELECTED]);
+  } else {
+    gdk_color_parse(kTextBaseColor, &faded_text);
+    normal_bg = LocationBarViewGtk::kBackgroundColor;
+
+    selection_text =
+        theme_provider_->get_active_selection_fg_color();
+    selection_bg =
+        theme_provider_->get_active_selection_bg_color();
+  }
+
+  double alpha = instant_animation_->GetCurrentValue();
+  GdkColor text = gfx::SkColorToGdkColor(color_utils::AlphaBlend(
+      selection_text,
+      gfx::GdkColorToSkColor(faded_text),
+      alpha * 0xff));
+  GdkColor bg = gfx::SkColorToGdkColor(color_utils::AlphaBlend(
+      selection_bg,
+      gfx::GdkColorToSkColor(normal_bg),
+      alpha * 0xff));
+
+  // ACTIVE is the state for text that is selected, but not focused (the
+  // instant view is always fully selected and never has focus).
+  gtk_widget_modify_text(instant_view_, GTK_STATE_ACTIVE, &text);
+  gtk_widget_modify_base(instant_view_, GTK_STATE_ACTIVE, &bg);
 }
 
 void AutocompleteEditViewGtk::HandleBeginUserAction(GtkTextBuffer* sender) {
   OnBeforePossibleChange();
 }
 
 void AutocompleteEditViewGtk::HandleEndUserAction(GtkTextBuffer* sender) {
   OnAfterPossibleChange();
 }
 
@@ skipping 851 matching lines @@
       gtk_text_buffer_apply_tag(text_buffer_, faded_text_tag_, &start, &end);
     } else {
       gtk_text_buffer_apply_tag(text_buffer_, secure_scheme_tag_, &start, &end);
     }
   }
 }
 
 void AutocompleteEditViewGtk::SetInstantSuggestion(
     const std::string& suggestion) {
   gtk_label_set_text(GTK_LABEL(instant_view_), suggestion.c_str());
+  // Select the whole thing.
+  gtk_label_select_region(GTK_LABEL(instant_view_), 0, -1);
+
+  // Clear the animation delegate so we don't get an AnimationEnded() callback.
+  instant_animation_->set_delegate(NULL);
+  instant_animation_->Reset();
+
   if (suggestion.empty()) {
     gtk_widget_hide(instant_view_);
   } else {
+    if (InstantController::IsEnabled(model_->profile(),
+                                     InstantController::PREDICTIVE_TYPE)) {
+      instant_animation_->set_delegate(this);
+      instant_animation_->Start();
+    }
+
     gtk_widget_show(instant_view_);
     AdjustVerticalAlignmentOfInstantView();
+    UpdateInstantViewColors();
   }
 }
 
 bool AutocompleteEditViewGtk::CommitInstantSuggestion() {
   const gchar* suggestion = gtk_label_get_text(GTK_LABEL(instant_view_));
   if (!suggestion || !*suggestion)
     return false;
 
   model()->FinalizeInstantQuery(GetText() + UTF8ToWide(suggestion));
   return true;
@@ skipping 260 matching lines @@
   // baseline, so we need to move the |instant_view_| down to make sure it
   // has the same baseline as the |text_view_|.
   PangoLayout* layout = gtk_label_get_layout(GTK_LABEL(instant_view_));
   int height;
   pango_layout_get_size(layout, NULL, &height);
   PangoLayoutIter* iter = pango_layout_get_iter(layout);
   int baseline = pango_layout_iter_get_baseline(iter);
   pango_layout_iter_free(iter);
   g_object_set(instant_anchor_tag_, "rise", baseline - height, NULL);
 }