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

#ifndef IOS_CHROME_BROWSER_CONTEXT_MENU_UI_BUNDLED_CONTEXT_MENU_CONFIGURATION_PROVIDER_H_
#define IOS_CHROME_BROWSER_CONTEXT_MENU_UI_BUNDLED_CONTEXT_MENU_CONFIGURATION_PROVIDER_H_

#import <UIKit/UIKit.h>

#import "ios/chrome/browser/menu/ui_bundled/menu_histograms.h"

namespace web {
struct ContextMenuParams;
class WebState;
}  // namespace web

class Browser;
@protocol ContextMenuConfigurationProviderDelegate;
class GURL;

// Object creating the configuration (action items...) for the context menu.
@interface ContextMenuConfigurationProvider : NSObject

// Instantiates with a `browser`. The context menu will be presented for the
// active webState.
// TODO(crbug.com/365698103): Remove the browser dependency.
- (instancetype)initWithBrowser:(Browser*)browser
             baseViewController:(UIViewController*)baseViewController;

// Instantiates with a `browser` and a base `webState`. The context menu will
// only be presented for this webState.
// `isLensOverlay`: Whether the context menu is presented in the LensOverlay.
// LensOverlay presents the webState in a modal sheet.
// TODO(crbug.com/365698103): Remove the browser dependency.
- (instancetype)initWithBrowser:(Browser*)browser
             baseViewController:(UIViewController*)baseViewController
                   baseWebState:(web::WebState*)webState
                  isLensOverlay:(BOOL)isLensOverlay;

// Returns a configuration for a context menu, based on its associated
// `webState`, `params` and `baseViewController`.
// `params` is copied in order to be used in blocks.
- (UIContextMenuConfiguration*)
    contextMenuConfigurationForWebState:(web::WebState*)webState
                                 params:(web::ContextMenuParams)params;

// Returns a menu for a context menu, based on its associated `webState` and
// `params`.
- (UIMenu*)contextMenuForWebState:(web::WebState*)webState
                           params:(web::ContextMenuParams)params
                         scenario:(MenuScenarioHistogram)scenario;

// Record the fact that the menu was shown.
- (void)recordMenuShown:(MenuScenarioHistogram)scenario;

// Stops the provider.
- (void)stop;

// The URL to be loaded when the user taps on the preview. Empty URL if there is
// nothing to load.
@property(nonatomic, assign, readonly) GURL URLToLoad;

// Delegate for events in this class.
@property(nonatomic, weak) id<ContextMenuConfigurationProviderDelegate>
    delegate;

@end

#endif  // IOS_CHROME_BROWSER_CONTEXT_MENU_UI_BUNDLED_CONTEXT_MENU_CONFIGURATION_PROVIDER_H_