Add Datalist Support to New Autofill UI

chrome/browser/autofill/autofill_external_delegate.cc

 // Copyright (c) 2012 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 "base/utf_string_conversions.h"
 #include "chrome/browser/autocomplete_history_manager.h"
 #include "chrome/browser/autofill/autofill_external_delegate.h"
 #include "chrome/browser/autofill/autofill_manager.h"
 #include "chrome/common/autofill_messages.h"
 #include "chrome/common/chrome_constants.h"
@@ skipping 19 matching lines @@
           tab_contents_wrapper ? tab_contents_wrapper->web_contents() : NULL),
       autofill_query_id_(0),
       display_warning_if_disabled_(false),
       has_shown_autofill_popup_for_current_edit_(false) {
 }
 
 void AutofillExternalDelegate::SelectAutofillSuggestionAtIndex(int unique_id) {
   if (unique_id == WebAutofillClient::MenuItemIDAutofillOptions ||
       unique_id == WebAutofillClient::MenuItemIDClearForm ||
       unique_id == WebAutofillClient::MenuItemIDSeparator ||
       unique_id == WebAutofillClient::MenuItemIDWarningMessage)

[Ilya Sherman, 2012/05/30 21:55:43]

Hmm, I would have expected this if-stmt to be updated as part of this CL.

[csharp, 2012/05/31 14:20:26]

If the datalist element was added to this list then if the user hovered over a
profile entry before moving over a data list entry, the profile data would still
be previewed.

This current logic clears the preview from anything a suggestion that could fill
in the input field is selected (which seems to be the cleanest way to me), but I
could also remove this if statement and the password one so that the preview
form is cleared as soon as you move off the item, no matter what you move onto.

[Ilya Sherman, 2012/06/01 06:28:16]

Ah, I see.  Yeah, I think the preview should vanish as soon as you're no longer
hovering over the row that is being previewed, even if you hover over a
separator or a menu item or whatever.

[csharp, 2012/06/04 15:02:03]

Done.

     return;
 
   ClearPreviewedForm();
 
   if (unique_id == WebAutofillClient::MenuItemIDPasswordEntry)
     return;
 
-  FillAutofillFormData(unique_id, true);
+  // Only preview the data if it is a profile.
+  if (unique_id > 0)
+    FillAutofillFormData(unique_id, true);
 }
 
 void AutofillExternalDelegate::OnQuery(int query_id,
                                        const webkit::forms::FormData& form,
                                        const webkit::forms::FormField& field,
                                        const gfx::Rect& bounds,
                                        bool display_warning_if_disabled) {
   autofill_query_form_ = form;
   autofill_query_field_ = field;
   display_warning_if_disabled_ = display_warning_if_disabled;
   autofill_query_id_ = query_id;
 
   OnQueryPlatformSpecific(query_id, form, field, bounds);
 }
 
 void AutofillExternalDelegate::OnSuggestionsReturned(
     int query_id,
     const std::vector<string16>& values,
     const std::vector<string16>& labels,
     const std::vector<string16>& icons,
     const std::vector<int>& unique_ids) {
   if (query_id != autofill_query_id_)
     return;
 
-  if (values.empty()) {
+  // List any data list values at the start.
+  std::vector<string16> v(data_list_values_);
+  std::vector<string16> l(data_list_labels_);
+  std::vector<string16> i(data_list_icons_);
+  std::vector<int> ids(data_list_unique_ids_);
+
+  // If there are both <datalist> items and Autofill suggestions, add a
+  // separator between them.
+  if (!values.empty() && !v.empty()) {
+    v.push_back(string16());
+    l.push_back(string16());
+    i.push_back(string16());
+    ids.push_back(WebAutofillClient::MenuItemIDSeparator);
+  }
+
+  // Append the Autofill suggestions.
+  v.insert(v.end(), values.begin(), values.end());
+  l.insert(l.end(), labels.begin(), labels.end());
+  i.insert(i.end(), icons.begin(), icons.end());
+  ids.insert(ids.end(), unique_ids.begin(), unique_ids.end());
+
+  if (v.empty()) {
     // No suggestions, any popup currently showing is obsolete.
     HideAutofillPopup();
     return;
   }
 
-  std::vector<string16> v(values);
-  std::vector<string16> l(labels);
-  std::vector<string16> i(icons);
-  std::vector<int> ids(unique_ids);
-
   // Add a separator to go between the values and menu items.
   v.push_back(string16());
   l.push_back(string16());
   i.push_back(string16());
   ids.push_back(WebAutofillClient::MenuItemIDSeparator);
 
   DCHECK_GT(ids.size(), 0U);
   if (!autofill_query_field_.should_autocomplete) {
     // If autofill is disabled and we had suggestions, show a warning instead.
     v.assign(1, l10n_util::GetStringUTF16(IDS_AUTOFILL_WARNING_FORM_DISABLED));
     l.assign(1, string16());
     i.assign(1, string16());
     ids.assign(1, WebAutofillClient::MenuItemIDWarningMessage);
-  } else if (ids[0] < 0 && ids.size() > 1) {
+  } else if (ids[0] == WebAutofillClient::MenuItemIDWarningMessage &&

[Ilya Sherman, 2012/05/30 21:55:43]

ids[0] is no longer guaranteed to be the first Autofill item, so this if-stmt
logic will need to be updated to accomodate for that.

[csharp, 2012/05/31 14:20:26]

Done.

+             ids.size() > 1) {
     // If we received a warning instead of suggestions from autofill but regular
     // suggestions from autocomplete, don't show the autofill warning.
     v.erase(v.begin());
     l.erase(l.begin());
     i.erase(i.begin());
     ids.erase(ids.begin());
   }
 
   // If we were about to show a warning and we shouldn't, don't.
-  if (ids[0] < 0 && !display_warning_if_disabled_)
+  if (ids[0] == WebAutofillClient::MenuItemIDWarningMessage &&
+      !display_warning_if_disabled_)
     return;
 
   // Only include "Autofill Options" special menu item if we have Autofill
   // items, identified by |unique_ids| having at least one valid value.
   bool has_autofill_item = false;
   for (size_t i = 0; i < ids.size(); ++i) {
     if (ids[i] > 0) {
       has_autofill_item = true;
       break;
     }
@@ skipping 45 matching lines @@
   }
 
   SetBounds(bounds);
 
   std::vector<string16> empty(suggestions.size());
   std::vector<int> password_ids(suggestions.size(),
                                 WebAutofillClient::MenuItemIDPasswordEntry);
   ApplyAutofillSuggestions(suggestions, empty, empty, password_ids);
 }
 
+void AutofillExternalDelegate::SetCurrentDataListValues(
+    const std::vector<string16>& data_list_values,
+    const std::vector<string16>& data_list_labels,
+    const std::vector<string16>& data_list_icons,
+    const std::vector<int>& data_list_unique_ids) {
+  data_list_values_ = data_list_values;
+  data_list_labels_ = data_list_labels;
+  data_list_icons_ = data_list_icons;
+  data_list_unique_ids_ = data_list_unique_ids;
+}

[Ilya Sherman, 2012/05/30 21:55:43]

Shouldn't this method also update the popup contents, if there is already a
popup showing?

[csharp, 2012/05/31 14:20:26]

This method shouldn't ever get called when the popup is visible. The datalist
values are set once the input field is selected (which is before before the
popup appears) and they shouldn't change until we selected a new input field.

I've add a DCHECK to ensure this holds.

[Ilya Sherman, 2012/06/01 06:28:16]

Ok.  The DCHECK is probably good enough for now; but eventually we will likely
want to be able to update the <datalist> suggestions in response to JavaScript
changes even while the popup is open.  Maybe worth adding a TODO or filing a bug
to tackle that case someday.

[csharp, 2012/06/04 15:02:03]

Had to replace the DCHECK with an if, since if you double clicked on an input
element twice the DCHECK would fail (I had thought the first popup would get
hidden before the second one appears).

Add a bug.

+
 void AutofillExternalDelegate::RemoveAutocompleteEntry(const string16& value) {
   if (tab_contents_wrapper_) {
     tab_contents_wrapper_->autocomplete_history_manager()->
         OnRemoveAutocompleteEntry(autofill_query_field_.name, value);
   }
 }
 
 void AutofillExternalDelegate::RemoveAutofillProfileOrCreditCard(
     int unique_id) {
   autofill_manager_->RemoveAutofillProfileOrCreditCard(unique_id);
 }
 
 
 void AutofillExternalDelegate::DidEndTextFieldEditing() {
   HideAutofillPopup();
 
   has_shown_autofill_popup_for_current_edit_ = false;
 }
 
 bool AutofillExternalDelegate::DidAcceptAutofillSuggestions(
     const string16& value,
     int unique_id,
     unsigned index) {
   // If the selected element is a warning we don't want to do anything.
   if (unique_id == WebAutofillClient::MenuItemIDWarningMessage)
     return false;
 
+  RenderViewHost* host =
+      tab_contents_wrapper_->web_contents()->GetRenderViewHost();
+
   if (unique_id == WebAutofillClient::MenuItemIDAutofillOptions) {
     // User selected 'Autofill Options'.
     autofill_manager_->OnShowAutofillDialog();
   } else if (unique_id == WebAutofillClient::MenuItemIDClearForm) {
     // User selected 'Clear form'.
-    RenderViewHost* host =
-        tab_contents_wrapper_->web_contents()->GetRenderViewHost();
     host->Send(new AutofillMsg_ClearForm(host->GetRoutingID()));
   } else if (unique_id == WebAutofillClient::MenuItemIDPasswordEntry &&
              password_autofill_manager_.DidAcceptAutofillSuggestion(
                  autofill_query_field_, value)) {
     // DidAcceptAutofillSuggestion has already handled the work to fill in
     // the page as required.
+  } else if (unique_id == WebAutofillClient::MenuItemIDDataListEntry) {
+    host->Send(new AutofillMsg_AcceptDataListSuggestion(host->GetRoutingID(),
+                                                        value));
   } else if (unique_id == WebAutofillClient::MenuItemIDAutocompleteEntry) {
     // User selected an Autocomplete, so we fill directly.
-    RenderViewHost* host =
-        tab_contents_wrapper_->web_contents()->GetRenderViewHost();
     host->Send(new AutofillMsg_SetNodeText(
         host->GetRoutingID(),
         value));
   } else {
     FillAutofillFormData(unique_id, false);
   }
 
   HideAutofillPopup();
 
   return true;
@@ skipping 46 matching lines @@
 // none, so all platforms use the default.
 
 #if !defined(OS_ANDROID) && !defined(TOOLKIT_GTK)
 
 AutofillExternalDelegate* AutofillExternalDelegate::Create(
     TabContentsWrapper*, AutofillManager*) {
   return NULL;
 }
 
 #endif