ios/chrome/browser/translate/chrome_ios_translate_client.h

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

#ifndef IOS_CHROME_BROWSER_TRANSLATE_CHROME_IOS_TRANSLATE_CLIENT_H_
#define IOS_CHROME_BROWSER_TRANSLATE_CHROME_IOS_TRANSLATE_CLIENT_H_

#import <Foundation/Foundation.h>

#include <memory>
#include <string>

#include "base/macros.h"
#include "components/translate/core/browser/translate_client.h"
#include "components/translate/core/browser/translate_step.h"
#include "components/translate/core/common/translate_errors.h"
#include "components/translate/ios/browser/ios_translate_driver.h"
#include "ios/web/public/web_state/web_state_observer.h"
#import "ios/web/public/web_state/web_state_user_data.h"

class PrefService;

namespace metrics {
class TranslateEventProto;
}  // namespace metrics

namespace translate {
class TranslateAcceptLanguages;
class TranslatePrefs;
class TranslateManager;

struct LanguageDetectionDetails;
}  // namespace translate

namespace web {
class WebState;
}  // namespace web

@protocol LanguageSelectionHandler;
@protocol TranslateNotificationHandler;
@protocol TranslateOptionSelectionHandler;

class ChromeIOSTranslateClient
    : public translate::TranslateClient,
      public web::WebStateObserver,
      public web::WebStateUserData<ChromeIOSTranslateClient> {
 public:
  ~ChromeIOSTranslateClient() override;

  // Creates a translation client tab helper and attaches it to |web_state|
  static void CreateForWebState(web::WebState* web_state);

  // Helper method to return a new TranslatePrefs instance.
  static std::unique_ptr<translate::TranslatePrefs> CreateTranslatePrefs(
      PrefService* prefs);

  // Gets the associated TranslateManager.
  translate::TranslateManager* GetTranslateManager();

  // TranslateClient implementation.
  translate::IOSTranslateDriver* GetTranslateDriver() override;
  PrefService* GetPrefs() override;
  std::unique_ptr<translate::TranslatePrefs> GetTranslatePrefs() override;
  translate::TranslateAcceptLanguages* GetTranslateAcceptLanguages() override;
  int GetInfobarIconID() const override;
  // Record language detection event.
  void RecordLanguageDetectionEvent(
      const translate::LanguageDetectionDetails& details) const override;
  void RecordTranslateEvent(const metrics::TranslateEventProto&) override;
  std::unique_ptr<infobars::InfoBar> CreateInfoBar(
      std::unique_ptr<translate::TranslateInfoBarDelegate> delegate)
      const override;
  bool ShowTranslateUI(translate::TranslateStep step,
                       const std::string& source_language,
                       const std::string& target_language,
                       translate::TranslateErrors::Type error_type,
                       bool triggered_from_menu) override;
  bool IsTranslatableURL(const GURL& url) override;
  void ShowReportLanguageDetectionErrorUI(const GURL& report_url) override;

  id<LanguageSelectionHandler> language_selection_handler() {
    return language_selection_handler_;
  }

  void set_language_selection_handler(id<LanguageSelectionHandler> handler) {
    language_selection_handler_ = handler;
  }

  id<TranslateOptionSelectionHandler> translate_option_selection_handler() {
    return translate_option_selection_handler_;
  }

  void set_translate_option_selection_handler(
      id<TranslateOptionSelectionHandler> handler) {
    translate_option_selection_handler_ = handler;
  }

  id<TranslateNotificationHandler> translate_notification_handler() {
    return translate_notification_handler_;
  }

  void set_translate_notification_handler(
      id<TranslateNotificationHandler> handler) {
    translate_notification_handler_ = handler;
  }

 private:
  ChromeIOSTranslateClient(web::WebState* web_state);
  friend class web::WebStateUserData<ChromeIOSTranslateClient>;

  // web::WebStateObserver implementation.
  void DidStartLoading(web::WebState* web_state) override;
  void WebStateDestroyed(web::WebState* web_state) override;

  // The WebState this instance is observing. Will be null after
  // WebStateDestroyed has been called.
  web::WebState* web_state_ = nullptr;

  std::unique_ptr<translate::TranslateManager> translate_manager_;
  translate::IOSTranslateDriver translate_driver_;
  __weak id<LanguageSelectionHandler> language_selection_handler_;
  __weak id<TranslateOptionSelectionHandler>
      translate_option_selection_handler_;
  __weak id<TranslateNotificationHandler> translate_notification_handler_;

  DISALLOW_COPY_AND_ASSIGN(ChromeIOSTranslateClient);
};

#endif  // IOS_CHROME_BROWSER_TRANSLATE_CHROME_IOS_TRANSLATE_CLIENT_H_