Moving AutofillAgent Logic into Browser

chrome/browser/autofill/autofill_external_delegate.h

 // 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.
 
 #ifndef CHROME_BROWSER_AUTOFILL_AUTOFILL_EXTERNAL_DELEGATE_H_
 #define CHROME_BROWSER_AUTOFILL_AUTOFILL_EXTERNAL_DELEGATE_H_
 #pragma once
 
 #include <vector>
 
 #include "base/string16.h"
+#include "webkit/glue/form_field.h"
 
 class AutofillManager;
 class TabContentsWrapper;
 
 namespace gfx {
 class Rect;
 }
 
 namespace webkit_glue {
 struct FormData;
-struct FormField;
 }  // namespace webkit_glue
 
+// TODO(csharp): A lot of the logic in this class is copied from autofillagent.
+// Once Autofill is moved out of WebKit this class should be the only home for
+// this logic. See http://crbug.com/51644
+
 // Delegate for external processing of Autocomplete and Autofill
 // display and selection.
 class AutofillExternalDelegate {
  public:
   virtual ~AutofillExternalDelegate();
 
   // When using an external Autofill delegate.  Allows Chrome to tell
   // WebKit which Autofill selection has been chosen.
   // TODO(jrg): add feedback mechanism for hover on relevant platforms.
   void SelectAutofillSuggestionAtIndex(int listIndex);
 
   // Records and associates a query_id with web form data.  Called
   // when the renderer posts an Autofill query to the browser. |bounds|
-  // is window relative.
+  // is window relative. |display_warning_if_disabled| tells us if we should
+  // display warnings (such as autofill is disabled, but had suggestions).
+  // We might not want to display the warning if a website has disabled
+  // Autocomplete because they have their own popup, and showing our popup
+  // on to of theirs would be a poor user experience.
   virtual void OnQuery(int query_id,
                        const webkit_glue::FormData& form,
                        const webkit_glue::FormField& field,
-                       const gfx::Rect& bounds) = 0;
+                       const gfx::Rect& bounds,
+                       bool display_warning_if_disabled);
 
-  // Records query results.  Displays them to the user with an external
-  // Autofill popup that lives completely in the browser.  Called when
-  // an Autofill query result is available.
-  // TODO(csharp): This should contain the logic found in
-  // AutofillAgent::OnSuggestionsReturned.
-  // See http://crbug.com/51644
+  // Records query results and correctly formats them before sending them off
+  // to be displayed.  Called when an Autofill query result is available.
   virtual void OnSuggestionsReturned(
       int query_id,
       const std::vector<string16>& autofill_values,
       const std::vector<string16>& autofill_labels,
       const std::vector<string16>& autofill_icons,
-      const std::vector<int>& autofill_unique_ids) = 0;
+      const std::vector<int>& autofill_unique_ids);
 
   // Hide the Autofill poup.
   virtual void HideAutofillPopup() = 0;
 
   // Platforms that wish to implement an external Autofill delegate
   // MUST implement this.  The 1st arg is the tab contents that owns
   // this delegate; the second is the Autofill manager owned by the
   // tab contents.
   static AutofillExternalDelegate* Create(TabContentsWrapper*,
                                           AutofillManager*);
 
+  // Inform the delegate that the text field editing has ended, this is
+  // used to help record the metrics of when a new popup is shown.
+  void DidEndTextFieldEditing();
+
  protected:
   explicit AutofillExternalDelegate(TabContentsWrapper* tab_contents_wrapper);
 
+  // Displays the the Autofill results to the user with an external
+  // Autofill popup that lives completely in the browser.  The suggestions
+  // have be correctly formatted by this point.
+  virtual void ApplyAutofillSuggestions(
+      const std::vector<string16>& autofill_values,
+      const std::vector<string16>& autofill_labels,
+      const std::vector<string16>& autofill_icons,
+      const std::vector<int>& autofill_unique_ids,
+      int separator_index) = 0;
+
+  // Handle instance specific OnQueryCode.
+  virtual void OnQueryPlatformSpecific(int query_id,
+                                       const webkit_glue::FormData& form,
+                                       const webkit_glue::FormField& field) = 0;
+
  private:
   TabContentsWrapper* tab_contents_wrapper_;  // weak; owns me.
 
+  // The ID of the last request sent for form field Autofill.  Used to ignore
+  // out of date responses.
+  int autofill_query_id_;
+
+  // The current field selected by Autofill.
+  webkit_glue::FormField autofill_query_field_;
+
+  // Should we display a warning if Autofill is disabled?
+  bool display_warning_if_disabled_;
+
+  // Have we already shown Autofill suggestions for the field the user is
+  // currently editing?  Used to keep track of state for metrics logging.
+  bool has_shown_autofill_popup_for_current_edit_;
+
   DISALLOW_COPY_AND_ASSIGN(AutofillExternalDelegate);
 };
 
 #endif  // CHROME_BROWSER_AUTOFILL_AUTOFILL_EXTERNAL_DELEGATE_H_