ios/chrome/browser/autofill/form_suggestion_controller.h

// Copyright 2014 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 IOS_CHROME_BROWSER_AUTOFILL_FORM_SUGGESTION_CONTROLLER_H_
#define IOS_CHROME_BROWSER_AUTOFILL_FORM_SUGGESTION_CONTROLLER_H_

#import <UIKit/UIKit.h>

#include <string>

#import "components/autofill/ios/browser/js_suggestion_manager.h"
#import "ios/chrome/browser/autofill/form_input_suggestions_provider.h"
#import "ios/chrome/browser/autofill/form_suggestion_client.h"
#import "ios/chrome/browser/autofill/form_suggestion_view.h"
#import "ios/web/public/web_state_observer_bridge.h"

namespace autofill {
struct FormActivityParams;
}

namespace web {
class WebState;
}

@protocol CRWWebViewProxy;

// Handles form focus events and presents input suggestions.
@interface FormSuggestionController : NSObject<CRWWebStateObserver,
                                               FormSuggestionClient,
                                               FormInputSuggestionsProvider>

// Initializes a new FormSuggestionController with the specified WebState and a
// list of FormSuggestionProviders.
// When suggestions are required for an input field, the |providers| will be
// asked (in order) if they can handle the field; the first provider to return
// YES from [FormSuggestionProvider canProviderSuggestionsForForm:field:] will
// be expected to provide those suggestions using [FormSuggestionProvider
// retrieveSuggestionsForForm:field:withCompletion:].
- (instancetype)initWithWebState:(web::WebState*)webState
                       providers:(NSArray*)providers;

// Finds a FormSuggestionProvider that can supply suggestions for the specified
// form, requests them, and updates the view accordingly.
- (void)retrieveSuggestionsForForm:(const autofill::FormActivityParams&)params
                          webState:(web::WebState*)webState;

// Instructs the controller to detach itself from the WebState.
- (void)detachFromWebState;

@end

@interface FormSuggestionController (ForTesting)

// Overrides the web view proxy.
- (void)setWebViewProxy:(id<CRWWebViewProxy>)webViewProxy;

// Invoked when an attempt to retrieve suggestions yields no results.
- (void)onNoSuggestionsAvailable;

@end

#endif  // IOS_CHROME_BROWSER_AUTOFILL_FORM_SUGGESTION_CONTROLLER_H_