External autofill delegates.

chrome/browser/autofill/autofill_manager.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_MANAGER_H_
 #define CHROME_BROWSER_AUTOFILL_AUTOFILL_MANAGER_H_
 #pragma once
 
 #include <list>
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/gtest_prod_util.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/scoped_vector.h"
 #include "base/string16.h"
 #include "base/time.h"
 #include "chrome/browser/autofill/autofill_download.h"
 #include "chrome/browser/autofill/field_types.h"
 #include "chrome/browser/autofill/form_structure.h"
 #include "content/browser/tab_contents/tab_contents_observer.h"
 
+class AutofillExternalDelegate;
 class AutofillField;
 class AutofillProfile;
 class AutofillMetrics;
 class CreditCard;
 class PersonalDataManager;
 class PrefService;
 class RenderViewHost;
 class TabContentsWrapper;
 
 struct ViewHostMsg_FrameNavigate_Params;
@@ skipping 37 matching lines @@
 
   // Imports the form data, submitted by the user, into |personal_data_|.
   void ImportFormData(const FormStructure& submitted_form);
 
   // Uploads the form data to the Autofill server.
   virtual void UploadFormData(const FormStructure& submitted_form);
 
   // Reset cache.
   void Reset();
 
+  // Set our external delegate.
+  void SetExternalDelegate(AutofillExternalDelegate* delegate) {
+    external_delegate_ = delegate;
+  }

[Ilya Sherman, 2011/10/27 11:01:55]

nit: Can this be passed into the constructor rather than being initialized
separately, or might a single AutofillManager be associated with multiple
AutofillExternalDelegates over its lifetime?

[John Grabowski, 2011/10/27 17:42:21]

One platform's likely implementation of the external delegate has a weak pointer
to the manager, so no.  That may change in the future.  Would you like a TODO?

[Ilya Sherman, 2011/10/27 21:17:24]

Sure, let's add a TODO just to keep this in the back of our minds as this code
evolves.

+
  protected:
   // For tests:
 
   // The string/int pair is composed of the guid string and variant index
   // respectively.  The variant index is an index into the multi-valued item
   // (where applicable).
   typedef std::pair<std::string, size_t> GUIDPair;
 
   AutofillManager(TabContentsWrapper* tab_contents,
                   PersonalDataManager* personal_data);
@@ skipping 10 matching lines @@
   // Maps GUIDs to and from IDs that are used to identify profiles and credit
   // cards sent to and from the renderer process.
   virtual int GUIDToID(const GUIDPair& guid) const;
   virtual const GUIDPair IDToGUID(int id) const;
 
   // Methods for packing and unpacking credit card and profile IDs for sending
   // and receiving to and from the renderer process.
   int PackGUIDs(const GUIDPair& cc_guid, const GUIDPair& profile_guid) const;
   void UnpackGUIDs(int id, GUIDPair* cc_guid, GUIDPair* profile_guid) const;
 
+ // Called from our external delegate so it cannot be private.
+  void OnFillAutoFillFormData(int query_id,
+                              const webkit_glue::FormData& form,
+                              const webkit_glue::FormField& field,
+                              int unique_id);
+
+  // Exposed for testing.
+  AutofillExternalDelegate* external_delegate() {
+    return external_delegate_;
+  }
+
  private:
   void OnFormSubmitted(const webkit_glue::FormData& form,
                        const base::TimeTicks& timestamp);
   void OnFormsSeen(const std::vector<webkit_glue::FormData>& forms,
                    const base::TimeTicks& timestamp);
   void OnTextFieldDidChange(const webkit_glue::FormData& form,
                             const webkit_glue::FormField& field,
                             const base::TimeTicks& timestamp);
   void OnQueryFormFieldAutofill(int query_id,
                                 const webkit_glue::FormData& form,
@@ skipping 145 matching lines @@
   // page.
   base::TimeTicks initial_interaction_timestamp_;
 
   // Our copy of the form data.
   ScopedVector<FormStructure> form_structures_;
 
   // GUID to ID mapping.  We keep two maps to convert back and forth.
   mutable std::map<GUIDPair, int> guid_id_map_;
   mutable std::map<int, GUIDPair> id_guid_map_;
 
+  // Delegate to perform external processing (display, selection) on
+  // our behalf.  Weak.
+  AutofillExternalDelegate* external_delegate_;
+
   friend class AutofillManagerTest;
   friend class FormStructureBrowserTest;
   FRIEND_TEST_ALL_PREFIXES(AutofillManagerTest,
                            DeterminePossibleFieldTypesForUpload);
   FRIEND_TEST_ALL_PREFIXES(AutofillManagerTest,
                            DeterminePossibleFieldTypesForUploadStressTest);
   FRIEND_TEST_ALL_PREFIXES(AutofillMetricsTest, AddressSuggestionsCount);
   FRIEND_TEST_ALL_PREFIXES(AutofillMetricsTest, AutofillIsEnabledAtPageLoad);
   FRIEND_TEST_ALL_PREFIXES(AutofillMetricsTest,
                            NoQualityMetricsForNonAutofillableForms);
   FRIEND_TEST_ALL_PREFIXES(AutofillMetricsTest, QualityMetrics);
   FRIEND_TEST_ALL_PREFIXES(AutofillMetricsTest, QualityMetricsForFailure);
   FRIEND_TEST_ALL_PREFIXES(AutofillMetricsTest, QualityMetricsWithExperimentId);
   FRIEND_TEST_ALL_PREFIXES(AutofillMetricsTest, SaneMetricsWithCacheMismatch);
+  FRIEND_TEST_ALL_PREFIXES(AutofillManagerTest, TestExternalDelegate);
+  FRIEND_TEST_ALL_PREFIXES(AutofillManagerTest,
+                           TestTabContentsWithExternalDelegate);
   FRIEND_TEST_ALL_PREFIXES(AutofillMetricsTest,
                            UserHappinessFormLoadAndSubmission);
   FRIEND_TEST_ALL_PREFIXES(AutofillMetricsTest, UserHappinessFormInteraction);
   FRIEND_TEST_ALL_PREFIXES(AutofillMetricsTest, FormFillDuration);
 
   DISALLOW_COPY_AND_ASSIGN(AutofillManager);
 };
 
 #endif  // CHROME_BROWSER_AUTOFILL_AUTOFILL_MANAGER_H_