Setting up external delegate calls to allow a future delegate to handle autofill

chrome/renderer/autofill/autofill_agent.cc

 // Copyright (c) 2011 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/renderer/autofill/autofill_agent.h"
 
 #include "base/bind.h"
 #include "base/message_loop.h"
 #include "base/time.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/common/autofill_messages.h"
 #include "chrome/common/chrome_constants.h"
 #include "chrome/renderer/autofill/form_autofill_util.h"
 #include "chrome/renderer/autofill/password_autofill_manager.h"
 #include "content/public/renderer/render_view.h"
 #include "grit/generated_resources.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebDocument.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebFormControlElement.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebFrame.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebInputEvent.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebNode.h"
+#include "third_party/WebKit/Source/WebKit/chromium/public/WebRect.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebView.h"
 #include "ui/base/keycodes/keyboard_codes.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "webkit/glue/form_data.h"
 #include "webkit/glue/form_data_predictions.h"
 #include "webkit/glue/form_field.h"
 #include "webkit/glue/password_form.h"
 
 using WebKit::WebFormControlElement;
 using WebKit::WebFormElement;
@@ skipping 20 matching lines @@
     PasswordAutofillManager* password_autofill_manager)
     : content::RenderViewObserver(render_view),
       password_autofill_manager_(password_autofill_manager),
       autofill_query_id_(0),
       autofill_action_(AUTOFILL_NONE),
       display_warning_if_disabled_(false),
       was_query_node_autofilled_(false),
       suggestions_clear_index_(-1),
       suggestions_options_index_(-1),
       has_shown_autofill_popup_for_current_edit_(false),
+      has_external_delegate_(false),
       ALLOW_THIS_IN_INITIALIZER_LIST(weak_ptr_factory_(this)) {
   render_view->GetWebView()->setAutofillClient(this);
 }
 
 AutofillAgent::~AutofillAgent() {}
 
 bool AutofillAgent::OnMessageReceived(const IPC::Message& message) {
   bool handled = true;
   IPC_BEGIN_MESSAGE_MAP(AutofillAgent, message)
     IPC_MESSAGE_HANDLER(AutofillMsg_SuggestionsReturned, OnSuggestionsReturned)
     IPC_MESSAGE_HANDLER(AutofillMsg_FormDataFilled, OnFormDataFilled)
     IPC_MESSAGE_HANDLER(AutofillMsg_FieldTypePredictionsAvailable,
                         OnFieldTypePredictionsAvailable)
     IPC_MESSAGE_HANDLER(AutofillMsg_SelectAutofillSuggestionAtIndex,
                         OnSelectAutofillSuggestionAtIndex)
+    IPC_MESSAGE_HANDLER(AutofillMsg_SetHasExternalDelegate,
+                        OnSetHasExternalDelegate)
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
   return handled;
 }
 
 void AutofillAgent::DidFinishDocumentLoad(WebFrame* frame) {
   // The document has now been fully loaded.  Scan for forms to be sent up to
   // the browser.
   std::vector<webkit_glue::FormData> forms;
   form_cache_.ExtractForms(*frame, &forms);
@@ skipping 30 matching lines @@
 bool AutofillAgent::InputElementClicked(const WebInputElement& element,
                                         bool was_focused,
                                         bool is_focused) {
   if (was_focused)
     ShowSuggestions(element, true, false, true);
 
   return false;
 }
 
 bool AutofillAgent::InputElementLostFocus() {
+  if (has_external_delegate_)

[John Grabowski, 2011/11/08 20:46:02]

Can you confirm this is called when, for example, a page reload happens?
What happens to the autofill window if the element maintains focus but scrolls
off the page?

[csharp, 2011/11/09 16:18:37]

This function is not called in both of these cases, good catch.

I've added a bug to myself for the page refresh issue, since the input field
does lose focus. In the scrolling case the input field doesn't lost focus, so
this shouldn't get called, but the popup should hide so I've add another bug to
myself to fix that issue, but I'm not sure right now where the correct place to
fix that would be.

On 2011/11/08 20:46:02, John Grabowski wrote:

[Ilya Sherman, 2011/11/09 20:34:19]

My hunch is that we'll want to add something along the lines of OnFrameDidScroll
to the RenderView::Observer class to handle scrolling.

+    Send(new AutofillHostMsg_HideAutofillPopup(routing_id()));
+
   return false;
 }
 
 void AutofillAgent::didAcceptAutofillSuggestion(const WebNode& node,
                                                 const WebString& value,
                                                 const WebString& label,
                                                 int unique_id,
                                                 unsigned index) {
   if (password_autofill_manager_->DidAcceptAutofillSuggestion(node, value))
     return;
@@ skipping 171 matching lines @@
     // Append the 'Chrome Autofill options' menu item;
     v.push_back(l10n_util::GetStringFUTF16(IDS_AUTOFILL_OPTIONS_POPUP,
         WideToUTF16(chrome::kBrowserAppName)));
     l.push_back(string16());
     i.push_back(string16());
     ids.push_back(0);
     suggestions_options_index_ = v.size() - 1;
     separator_index = values.size();
   }
 
-  // Send to WebKit for display.
   if (!v.empty() && !autofill_query_element_.isNull() &&
       autofill_query_element_.isFocusable()) {
-    web_view->applyAutofillSuggestions(
-        autofill_query_element_, v, l, i, ids, separator_index);
+    if (has_external_delegate_) {
+      // Send to an external delegate for display.
+      WebKit::WebRect  autofill_element_rect =
+          autofill_query_element_.getRect();
+
+      Send(new AutofillHostMsg_AutofillElementBounds(
+          routing_id(),
+          autofill_element_rect.x,
+          autofill_element_rect.y,
+          autofill_element_rect.width,
+          autofill_element_rect.height));
+    } else {
+      // Send to WebKit for display.
+      web_view->applyAutofillSuggestions(
+          autofill_query_element_, v, l, i, ids, separator_index);
+    }
   }
 
   Send(new AutofillHostMsg_DidShowAutofillSuggestions(
       routing_id(),
       has_autofill_item && !has_shown_autofill_popup_for_current_edit_));
   has_shown_autofill_popup_for_current_edit_ |= has_autofill_item;
 }
 
 void AutofillAgent::OnFormDataFilled(int query_id,
                                      const webkit_glue::FormData& form) {
@@ skipping 22 matching lines @@
     form_cache_.ShowPredictions(forms[i]);
   }
 }
 
 void AutofillAgent::OnSelectAutofillSuggestionAtIndex(int listIndex) {
   NOTIMPLEMENTED();
   // TODO(jrg): enable once changes land in WebKit
   // render_view()->webview()->selectAutofillSuggestionAtIndex(listIndex);
 }
 
+void AutofillAgent::OnSetHasExternalDelegate(bool has_external_delegate) {
+  has_external_delegate_ = has_external_delegate;
+}
+
 void AutofillAgent::ShowSuggestions(const WebInputElement& element,
                                     bool autofill_on_empty_values,
                                     bool requires_caret_at_end,
                                     bool display_warning_if_disabled) {
   // If autocomplete is disabled at the form level, then we might want to show
   // a warning in place of suggestions. However, if autocomplete is disabled
   // specifically for this field, we never want to show a warning. Otherwise,
   // we might interfere with custom popups (e.g. search suggestions) used by
   // the website.
   const WebFormElement form = element.form();
@@ skipping 56 matching lines @@
     return;
   }
 
   autofill_action_ = action;
   was_query_node_autofilled_ = field.is_autofilled;
   Send(new AutofillHostMsg_FillAutofillFormData(
       routing_id(), autofill_query_id_, form, field, unique_id));
 }
 
 }  // namespace autofill