ios/chrome/browser/intelligence/bwg/model/bwg_browser_agent.h

// Copyright 2025 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_INTELLIGENCE_BWG_MODEL_BWG_BROWSER_AGENT_H_
#define IOS_CHROME_BROWSER_INTELLIGENCE_BWG_MODEL_BWG_BROWSER_AGENT_H_

#import <UIKit/UIKit.h>

#import "base/memory/raw_ptr.h"
#import "base/types/expected.h"
#import "ios/chrome/browser/shared/model/browser/browser_user_data.h"

class Browser;

enum class PageContextWrapperError;

namespace optimization_guide::proto {
class PageContext;
}  // namespace optimization_guide::proto

@class BWGLinkOpeningHandler;
@class BWGPageStateChangeHandler;
@class BWGSessionHandler;

@protocol BWGGatewayProtocol;

// A browser agent responsible for presenting the BWG overlay and managing
// its protocol handlers.
class BwgBrowserAgent : public BrowserUserData<BwgBrowserAgent> {
 public:
  BwgBrowserAgent(const BwgBrowserAgent&) = delete;
  BwgBrowserAgent& operator=(const BwgBrowserAgent&) = delete;

  ~BwgBrowserAgent() override;

  // Presents the BWG overlay on a given view controller with a given expected
  // PageContext.
  void PresentBwgOverlay(
      UIViewController* base_view_controller,
      base::expected<std::unique_ptr<optimization_guide::proto::PageContext>,
                     PageContextWrapperError> expected_page_context);

 private:
  explicit BwgBrowserAgent(Browser* browser);
  friend class BrowserUserData<BwgBrowserAgent>;

  // Sets the UI command handlers on the session handler. This cannot be called
  // in the constructor because some objects fail the protocol conformance test
  // at that time.
  void SetSessionCommandHandlers();

  // The gateway for bridging internal protocols.
  __strong id<BWGGatewayProtocol> bwg_gateway_ = nullptr;

  // Handler for opening links from BWG.
  __strong BWGLinkOpeningHandler* bwg_link_opening_handler_ = nullptr;

  // Handler for PageState changes.
  __strong BWGPageStateChangeHandler* bwg_page_state_change_handler_ = nullptr;

  // Handler for the BWG sessions.
  __strong BWGSessionHandler* bwg_session_handler_ = nullptr;
};

#endif  // IOS_CHROME_BROWSER_INTELLIGENCE_BWG_MODEL_BWG_BROWSER_AGENT_H_