1 // Copyright 2013 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef COMPONENTS_AUTOFILL_CORE_BROWSER_AUTOFILL_DRIVER_H_
6 #define COMPONENTS_AUTOFILL_CORE_BROWSER_AUTOFILL_DRIVER_H_
10 #include "components/autofill/core/common/form_data.h"
13 class SequencedWorkerPool;
17 class URLRequestContextGetter;
24 // Interface that allows Autofill core code to interact with its driver (i.e.,
25 // obtain information from it and give information to it). A concrete
26 // implementation must be provided by the driver.
27 class AutofillDriver {
29 // The possible actions that the renderer can take on receiving form data.
30 enum RendererFormDataAction {
31 // The renderer should fill the form data.
32 FORM_DATA_ACTION_FILL,
33 // The renderer should preview the form data.
34 FORM_DATA_ACTION_PREVIEW
37 virtual ~AutofillDriver() {}
39 // Returns whether the user is currently operating in an off-the-record
40 // (i.e., incognito) context.
41 virtual bool IsOffTheRecord() const = 0;
43 // Returns the URL request context information associated with this driver.
44 virtual net::URLRequestContextGetter* GetURLRequestContext() = 0;
46 // Returns the SequencedWorkerPool on which core Autofill code should run
47 // tasks that may block. This pool must live at least as long as the driver.
48 virtual base::SequencedWorkerPool* GetBlockingPool() = 0;
50 // Returns true iff the renderer is available for communication.
51 virtual bool RendererIsAvailable() = 0;
53 // Informs the renderer what action to take with the next form data that it
54 // receives. Must be called before each call to |SendFormDataToRenderer|.
55 virtual void SetRendererActionOnFormDataReception(
56 RendererFormDataAction action) = 0;
58 // Forwards |data| to the renderer. |query_id| is the id of the renderer's
59 // original request for the data. This method is a no-op if the renderer is
60 // not currently available.
61 virtual void SendFormDataToRenderer(int query_id, const FormData& data) = 0;
63 // Sends the field type predictions specified in |forms| to the renderer. This
64 // method is a no-op if the renderer is not available or the appropriate
65 // command-line flag is not set.
66 virtual void SendAutofillTypePredictionsToRenderer(
67 const std::vector<FormStructure*>& forms) = 0;
69 // Tells the renderer to accept data list suggestions for |value|.
70 virtual void RendererShouldAcceptDataListSuggestion(
71 const base::string16& value) = 0;
73 // Tells the renderer to accept the password autofill suggestion for
75 virtual void RendererShouldAcceptPasswordAutofillSuggestion(
76 const base::string16& username) = 0;
78 // Tells the renderer to clear the currently filled Autofill results.
79 virtual void RendererShouldClearFilledForm() = 0;
81 // Tells the renderer to clear the currently previewed Autofill results.
82 virtual void RendererShouldClearPreviewedForm() = 0;
84 // Tells the renderer to set the node text.
85 virtual void RendererShouldSetNodeText(const base::string16& value) = 0;
88 } // namespace autofill
90 #endif // COMPONENTS_AUTOFILL_CORE_BROWSER_AUTOFILL_DRIVER_H_