// 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_FIND_IN_PAGE_MODEL_FIND_TAB_HELPER_H_
#define IOS_CHROME_BROWSER_FIND_IN_PAGE_MODEL_FIND_TAB_HELPER_H_

#import <memory>

#import "base/scoped_observation.h"
#import "ios/chrome/browser/find_in_page/model/find_in_page_response_delegate.h"
#import "ios/web/public/web_state_observer.h"
#import "ios/web/public/web_state_user_data.h"

@class FindInPageController;
class FullscreenController;
@protocol FullscreenCommands;
class ScopedForceFullscreen;

// Adds support for the Native Find in Page feature. Instantiates a
// FindInPageController when the web state is realized which itself attaches and
// interacts with a web-layer FindInPageManager.
class FindTabHelper final : public web::WebStateObserver,
                            public web::WebStateUserData<FindTabHelper> {
 public:
  enum FindDirection {
    FORWARD,
    REVERSE,
  };

  FindTabHelper(const FindTabHelper&) = delete;
  FindTabHelper& operator=(const FindTabHelper&) = delete;

  ~FindTabHelper() final;

  void DismissFindNavigator();

  // Sets the full screen controller that will passed to the
  // `FindInPageController`.
  void SetFullscreenController(FullscreenController* fullscreen_controller);

  // Sets the fullscreen handler that will be passed to the
  // `FindInPageController` (refactored).
  void SetFullscreenHandler(id<FullscreenCommands> fullscreen_handler);

  void SetResponseDelegate(id<FindInPageResponseDelegate> response_delegate);
  void StartFinding(NSString* search_string);
  void ContinueFinding(FindDirection direction);
  void StopFinding();
  FindInPageModel* GetFindResult() const;
  bool CurrentPageSupportsFindInPage() const;
  // Returns true if the Find UI is active in this WebState. If `this` is a
  // tab inside a WebStateList, see `IsFindNavigatorVisibleInTab` instead.
  bool IsFindUIActive() const;
  void SetFindUIActive(bool active);
  void PersistSearchTerm();
  void RestoreSearchTerm();

 private:
  friend class web::WebStateUserData<FindTabHelper>;

  // Private constructor used by CreateForWebState().
  FindTabHelper(web::WebState* web_state);

  // web::WebStateObserver.
  void WebStateDestroyed(web::WebState* web_state) final;
  void DidFinishNavigation(web::WebState* web_state,
                           web::NavigationContext* navigation_context) final;

  // The ObjC find in page controller (nil if the WebState is not realized).
  FindInPageController* controller_ = nil;

  // Fullscreen commands handler for forcing fullscreen.
  __weak id<FullscreenCommands> fullscreen_handler_ = nil;

  // Scoped object that forces fullscreen mode while Find UI is active.
  std::unique_ptr<ScopedForceFullscreen> scoped_force_fullscreen_;

  // The delegate to register with JavaScriptFindInPageController when it is
  // created.
  __weak id<FindInPageResponseDelegate> response_delegate_ = nil;

  // Manage the registration of this instance as a WebStateObserver.
  base::ScopedObservation<web::WebState, web::WebStateObserver> observation_{
      this};
};

#endif  // IOS_CHROME_BROWSER_FIND_IN_PAGE_MODEL_FIND_TAB_HELPER_H_