ios/chrome/browser/web/model/annotations/annotations_tab_helper.h

// Copyright 2022 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_WEB_MODEL_ANNOTATIONS_ANNOTATIONS_TAB_HELPER_H_
#define IOS_CHROME_BROWSER_WEB_MODEL_ANNOTATIONS_ANNOTATIONS_TAB_HELPER_H_

#import <UIKit/UIKit.h>

#import <optional>

#import "base/memory/raw_ptr.h"
#import "base/memory/weak_ptr.h"
#import "base/sequence_checker.h"
#import "base/values.h"
#import "ios/public/provider/chrome/browser/context_menu/context_menu_api.h"
#import "ios/web/public/annotations/annotations_text_observer.h"
#import "ios/web/public/annotations/custom_text_checking_result.h"
#import "ios/web/public/web_state_observer.h"
#import "ios/web/public/web_state_user_data.h"

@protocol CRWWebViewHandlerDelegate;
@protocol MiniMapCommands;
@protocol UnitConversionCommands;
@class UIViewController;

namespace web {
class WebState;
}  // namespace web

/**
 * Class in charge of annotations in text.
 */
class AnnotationsTabHelper : public web::AnnotationsTextObserver,
                             public web::WebStateUserData<AnnotationsTabHelper>,
                             public web::WebStateObserver {
 public:
  ~AnnotationsTabHelper() override;

  // Sets the BaseViewController from which to present UI.
  void SetBaseViewController(UIViewController* base_view_controller);

  // Sets the MiniMapCommands that can display mini maps.
  void SetMiniMapCommands(id<MiniMapCommands> mini_map_handler);

  // Sets the UnitConversionCommands that can display unit conversion.
  void SetUnitConversionCommands(
      id<UnitConversionCommands> unit_conversion_handler);

  // Returns pointer to latest metadata extracted or `nullptr`. See
  // i/w/p/a/annotations_text_observer.h for metadata key/pair values.
  base::Value::Dict* GetMetadata() { return metadata_.get(); }

  // AnnotationsTextObserver methods:
  void OnTextExtracted(web::WebState* web_state,
                       const std::string& text,
                       int seq_id,
                       const base::Value::Dict& metadata) override;
  void OnDecorated(web::WebState* web_state,
                   int annotations,
                   int successes,
                   int failures,
                   const base::Value::List& cancelled) override;
  void OnClick(web::WebState* web_state,
               const std::string& text,
               CGRect rect,
               const std::string& data) override;

  // WebStateObserver methods:
  void WebStateDestroyed(web::WebState* web_state) override;
  void PageLoaded(
      web::WebState* web_state,
      web::PageLoadCompletionStatus load_completion_status) override;

 private:
  friend class WebStateUserData<AnnotationsTabHelper>;

  explicit AnnotationsTabHelper(web::WebState* web_state);

  // Receiver for text classifier extracted intents. Must run on main thread.
  // `seq_id` comes from `OnTextExtracted` and is meant to be passed on to
  // `AnnotationsTextManager::DecorateAnnotations` to validate decorations
  // against the text extracted.
  void ApplyDeferredProcessing(
      int seq_id,
      std::optional<std::vector<web::TextAnnotation>> deferred);

  // Records the measurement detection from the input `annotations_list`.c
  void ProcessAnnotations(std::vector<web::TextAnnotation>& annotations_list);

  // Puts annotations data in `match_cache_` and replaces it with a uuid key
  // to be passed to JS and expect back in `OnClick`. Builds `decorations`
  // from annotations.
  void BuildCacheAndDecorations(
      std::vector<web::TextAnnotation>& annotations_list,
      base::Value::List& decorations);

  UIViewController* base_view_controller_ = nil;

  id<MiniMapCommands> mini_map_handler_ = nil;

  id<UnitConversionCommands> unit_conversion_handler_ = nil;

  raw_ptr<web::WebState> web_state_ = nullptr;

  std::unique_ptr<base::Value::Dict> metadata_;

  std::map<std::string, NSTextCheckingResult*> match_cache_;

  SEQUENCE_CHECKER(sequence_checker_);

  // Must be last member to ensure it is destroyed last.
  base::WeakPtrFactory<AnnotationsTabHelper> weak_factory_{this};
};

#endif  // IOS_CHROME_BROWSER_WEB_MODEL_ANNOTATIONS_ANNOTATIONS_TAB_HELPER_H_