base_grid_mediator.h | Explore in Territory

// Copyright 2023 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_UI_TAB_SWITCHER_TAB_GRID_GRID_BASE_GRID_MEDIATOR_H_
#define IOS_CHROME_BROWSER_UI_TAB_SWITCHER_TAB_GRID_GRID_BASE_GRID_MEDIATOR_H_

#import <Foundation/Foundation.h>

#import "ios/chrome/browser/shared/model/web_state_list/web_state_list_observer_bridge.h"
#import "ios/chrome/browser/ui/tab_switcher/tab_collection_drag_drop_handler.h"
#import "ios/chrome/browser/ui/tab_switcher/tab_grid/grid/base_grid_mediator_items_provider.h"
#import "ios/chrome/browser/ui/tab_switcher/tab_grid/grid/grid_commands.h"
#import "ios/chrome/browser/ui/tab_switcher/tab_grid/grid/grid_view_controller_mutator.h"
#import "ios/chrome/browser/ui/tab_switcher/tab_grid/suggested_actions/suggested_actions_delegate.h"
#import "ios/chrome/browser/ui/tab_switcher/tab_grid/tab_grid_page_mutator.h"
#import "ios/chrome/browser/ui/tab_switcher/tab_grid/tab_grid_paging.h"
#import "ios/chrome/browser/ui/tab_switcher/tab_grid/toolbars/tab_grid_toolbars_grid_delegate.h"

class Browser;
@protocol GridConsumer;
@protocol GridMediatorDelegate;
@protocol GridToolbarsConfigurationProvider;
@protocol GridToolbarsMutator;
@protocol TabCollectionConsumer;
@protocol TabGridCommands;
@protocol TabGridIdleStatusHandler;
@class TabGridModeHolder;
@class TabGridToolbarsConfiguration;
@protocol TabGridToolbarCommands;
@protocol TabGroupsCommands;
@class TabGroupInfo;
@protocol TabPresentationDelegate;
class WebStateList;

namespace web {
class WebState;
}

// Mediates between model layer and tab grid UI layer.
@interface BaseGridMediator : NSObject <BaseGridMediatorItemProvider,
                                        GridCommands,
                                        GridViewControllerMutator,
                                        SuggestedActionsDelegate,
                                        TabCollectionDragDropHandler,
                                        TabGridPageMutator,
                                        TabGridToolbarsGridDelegate>

// The source browser.
@property(nonatomic, assign) Browser* browser;
// The UI consumer to which updates are made.
@property(nonatomic, weak) id<TabCollectionConsumer> consumer;
// Delegate to handle presenting the action sheet.
@property(nonatomic, weak) id<GridMediatorDelegate> delegate;
// Mutator to handle toolbars modification.
@property(nonatomic, weak) id<GridToolbarsMutator> toolbarsMutator;
// The list from the browser.
@property(nonatomic, assign) WebStateList* webStateList;
// Contained grid which provides tab grid toolbar configuration.
@property(nonatomic, weak) id<GridToolbarsConfigurationProvider>
    containedGridToolbarsProvider;
// Grid consumer.
@property(nonatomic, weak) id<GridConsumer> gridConsumer;
// Delegate to handle presenting tab UI.
@property(nonatomic, weak) id<TabPresentationDelegate> tabPresentationDelegate;
// Tab Groups handler.
@property(nonatomic, weak) id<TabGroupsCommands> tabGroupsHandler;
// Tab Grid handler.
@property(nonatomic, weak) id<TabGridCommands> tabGridHandler;
// Handler for tab grid toolbar commands.
@property(nonatomic, weak) id<TabGridToolbarCommands> tabGridToolbarHandler;
// Tab grid idle status handler.
@property(nonatomic, weak) id<TabGridIdleStatusHandler>
    tabGridIdleStatusHandler;

- (instancetype)initWithModeHolder:(TabGridModeHolder*)modeHolder
    NS_DESIGNATED_INITIALIZER;
- (instancetype)init NS_UNAVAILABLE;

@end

@interface BaseGridMediator (Subclassing) <WebStateListObserving>

// The mode holder.
@property(nonatomic, readonly) TabGridModeHolder* modeHolder;

// Disconnects the mediator.
- (void)disconnect NS_REQUIRES_SUPER;

// Called when toolbars should be updated. This function should be implemented
// in a subclass.
- (void)configureToolbarsButtons;

// Called when the buttons needs to be updated for the selection mode.
- (void)configureButtonsInSelectionMode:
    (TabGridToolbarsConfiguration*)configuration;

// Display the current active tab. This function should be implemented in a
// subclass.
- (void)displayActiveTab;

// Calls `-populateItems:selectedItemID:` on the consumer.
- (void)populateConsumerItems;

// Returns the active grid item identifier.
- (GridItemIdentifier*)activeIdentifier;

// Called when a tab has been inserted, leaving an opportunity for the
// subclasses to update. Can be called during a batch update. Default
// implementation is no op.
- (void)updateForTabInserted;

// Adds an observation to every non-pinned WebState. Subclasses can override
// this to observe a different set of `WebState`s. It's not necessary to call
// the parent class implementation if not desired.
- (void)addWebStateObservations;

// Adds or removes observation to the given `webState`.
- (void)addObservationForWebState:(web::WebState*)webState;
- (void)removeObservationForWebState:(web::WebState*)webState;

// Inserts a new WebState at the given grid `index` with `newTabURL`. This is
// clamping the index to make sure it is in correct bounds.
- (void)insertNewWebStateAtGridIndex:(int)index withURL:(const GURL&)newTabURL;

// Inserts `item` before the WebState at `nextWebStateIndex`.
- (void)insertItem:(GridItemIdentifier*)item
    beforeWebStateIndex:(int)nextWebStateIndex;
// Moves `item` before the WebState at `nextWebStateIndex`.
- (void)moveItem:(GridItemIdentifier*)item
    beforeWebStateIndex:(int)nextWebStateIndex;

// Reconfigures the item containing the `webState`.
- (void)updateConsumerItemForWebState:(web::WebState*)webState;

// Closes all tabs in `group`, optionally deleting it from the sync service.
// If 'deleteGroup' is YES, the group is removed permanently.
// If 'deleteGroup' is NO, the group is closed locally but remains on the sync
// service.
- (void)closeTabGroup:(const TabGroup*)group andDeleteGroup:(BOOL)deleteGroup;

// Ungroups all tabs in `group`. The tabs in the group remain open.
- (void)ungroupTabGroup:(const TabGroup*)group;

// Returns whether this mediator can handle the drop of `tabGroupInfo`.
- (BOOL)canHandleTabGroupDrop:(TabGroupInfo*)tabGroupInfo;

// Records in UMA that a URL has been dropped from outside of the app.
- (void)recordExternalURLDropped;

// Shows the tab group snackbar or IPH.
// `closedGroups` represents the number of closed groups.
- (void)showTabGroupSnackbarOrIPH:(int)closedGroups;

@end

#endif  // IOS_CHROME_BROWSER_UI_TAB_SWITCHER_TAB_GRID_GRID_BASE_GRID_MEDIATOR_H_
chromium/ios/chrome/browser/ui/tab_switcher/tab_grid/grid/base_grid_mediator.h
