components/android_autofill/browser/autofill_provider.h

// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_ANDROID_AUTOFILL_BROWSER_AUTOFILL_PROVIDER_H_
#define COMPONENTS_ANDROID_AUTOFILL_BROWSER_AUTOFILL_PROVIDER_H_

#include "base/memory/raw_ptr.h"
#include "base/time/time.h"
#include "components/autofill/core/browser/field_types.h"
#include "components/autofill/core/browser/foundations/autofill_manager.h"
#include "components/autofill/core/common/form_data.h"
#include "components/autofill/core/common/mojom/autofill_types.mojom.h"
#include "components/autofill/core/common/signatures.h"
#include "content/public/browser/web_contents_user_data.h"

namespace content {
class WebContents;
}  // namespace content

namespace autofill {

class AndroidAutofillManager;

// This class defines the interface for the autofill implementation other than
// default BrowserAutofillManager. Unlike BrowserAutofillManager, this class
// has one instance per WebContents.
class AutofillProvider : public content::WebContentsUserData<AutofillProvider> {
 public:
  ~AutofillProvider() override;

  // These events come from AutofillDriver.
  // See autofill_driver.mojom for documentation.
  virtual void OnAskForValuesToFill(
      AndroidAutofillManager* manager,
      const FormData& form,
      const FormFieldData& field,
      AutofillSuggestionTriggerSource trigger_source) = 0;
  virtual void OnTextFieldValueChanged(AndroidAutofillManager* manager,
                                       const FormData& form,
                                       const FormFieldData& field,
                                       const base::TimeTicks timestamp) = 0;
  virtual void OnTextFieldDidScroll(AndroidAutofillManager* manager,
                                    const FormData& form,
                                    const FormFieldData& field) = 0;
  virtual void OnSelectControlSelectionChanged(AndroidAutofillManager* manager,
                                               const FormData& form,
                                               const FormFieldData& field) = 0;
  virtual void OnFormSubmitted(AndroidAutofillManager* manager,
                               const FormData& form,
                               mojom::SubmissionSource source) = 0;
  virtual void OnFocusOnNonFormField(AndroidAutofillManager* manager) = 0;
  virtual void OnFocusOnFormField(AndroidAutofillManager* manager,
                                  const FormData& form,
                                  const FormFieldData& field) = 0;
  virtual void OnDidFillAutofillFormData(AndroidAutofillManager* manager,
                                         const FormData& form,
                                         base::TimeTicks timestamp) = 0;
  virtual void OnHidePopup(AndroidAutofillManager* manager) = 0;

  virtual void OnServerPredictionsAvailable(AndroidAutofillManager& manager,
                                            FormGlobalId form_id) = 0;

  // Reacts to a reset or destruction of `manager`, e.g., by submitting forms
  // for suspected navigations.
  virtual void OnManagerResetOrDestroyed(AndroidAutofillManager* manager) = 0;

  // Returns autofilled state from AutofillProvider's cache.
  virtual bool GetCachedIsAutofilled(const FormFieldData& field) const = 0;

  virtual void MaybeInitKeyboardSuppressor() = 0;

  void FillOrPreviewForm(AndroidAutofillManager* manager,
                         const FormData& form_data,
                         FieldTypeGroup field_type_group,
                         const url::Origin& triggered_origin);

  // Notifies the renderer should accept the datalist suggestion given by
  // |value| and fill the input field indified by |field_id|.
  void RendererShouldAcceptDataListSuggestion(AndroidAutofillManager* manager,
                                              const FieldGlobalId& field_id,
                                              const std::u16string& value);

 protected:
  // WebContents takes the ownership of AutofillProvider.
  explicit AutofillProvider(content::WebContents* web_contents);
  friend class content::WebContentsUserData<AutofillProvider>;

 private:
  WEB_CONTENTS_USER_DATA_KEY_DECL();
};

}  // namespace autofill

#endif  // COMPONENTS_ANDROID_AUTOFILL_BROWSER_AUTOFILL_PROVIDER_H_