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

#ifndef UI_BASE_CLIPBOARD_CLIPBOARD_MAC_H_
#define UI_BASE_CLIPBOARD_CLIPBOARD_MAC_H_

#include <stddef.h>
#include <stdint.h>

#include <string_view>

#include "base/apple/foundation_util.h"
#include "base/callback_list.h"
#include "base/component_export.h"
#include "ui/base/clipboard/clipboard.h"
#include "ui/base/clipboard/clipboard_change_notifier.h"

@class NSPasteboard;

namespace ui {

// Documentation on the underlying MacOS API this ultimately abstracts is
// available at https://developer.apple.com/documentation/appkit/nspasteboard
// and
// https://developer.apple.com/library/archive/documentation/General/Conceptual/Devpedia-CocoaApp/Pasteboard.html.
class COMPONENT_EXPORT(UI_BASE_CLIPBOARD) ClipboardMac
    : public Clipboard,
      public ClipboardChangeNotifier {
 public:
  ClipboardMac(const ClipboardMac&) = delete;
  ClipboardMac& operator=(const ClipboardMac&) = delete;

  // ClipboardChangeNotifier overrides:
  void StartNotifying() override;
  void StopNotifying() override;

 private:
  friend class Clipboard;
  friend class ClipboardMacTest;

  ClipboardMac();
  ~ClipboardMac() override;

  // Clipboard overrides:
  void OnPreShutdown() override;
  void GetSource(ClipboardBuffer buffer,
                 GetSourceCallback callback) const override;
  const ClipboardSequenceNumberToken& GetSequenceNumber(
      ClipboardBuffer buffer) const override;
  void GetStandardFormats(ClipboardBuffer buffer,
                          const std::optional<DataTransferEndpoint>& data_dst,
                          GetStandardFormatsCallback callback) const override;
  void GetAllAvailableFormats(
      ClipboardBuffer buffer,
      const std::optional<DataTransferEndpoint>& data_dst,
      base::OnceCallback<void(base::flat_set<ClipboardFormatType>)> callback)
      const override;
  bool IsMarkedByOriginatorAsConfidential() const override;
  void Clear(ClipboardBuffer buffer) override;
  void ReadAvailableTypes(ClipboardBuffer buffer,
                          const std::optional<DataTransferEndpoint>& data_dst,
                          ReadAvailableTypesCallback callback) const override;
  void ReadText(ClipboardBuffer buffer,
                const std::optional<DataTransferEndpoint>& data_dst,
                ReadTextCallback callback) const override;
  void ReadAsciiText(ClipboardBuffer buffer,
                     const std::optional<DataTransferEndpoint>& data_dst,
                     ReadAsciiTextCallback callback) const override;
  void ReadHTML(ClipboardBuffer buffer,
                const std::optional<DataTransferEndpoint>& data_dst,
                ReadHtmlCallback callback) const override;
  void ReadSvg(ClipboardBuffer buffer,
               const std::optional<DataTransferEndpoint>& data_dst,
               ReadSvgCallback callback) const override;
  void ReadRTF(ClipboardBuffer buffer,
               const std::optional<DataTransferEndpoint>& data_dst,
               ReadRTFCallback callback) const override;
  void ReadPng(ClipboardBuffer buffer,
               const std::optional<DataTransferEndpoint>& data_dst,
               ReadPngCallback callback) const override;
  void ReadDataTransferCustomData(
      ClipboardBuffer buffer,
      const std::u16string& type,
      const std::optional<DataTransferEndpoint>& data_dst,
      ReadDataTransferCustomDataCallback callback) const override;
  void ReadFilenames(ClipboardBuffer buffer,
                     const std::optional<DataTransferEndpoint>& data_dst,
                     ReadFilenamesCallback callback) const override;
  void ReadURL(const std::optional<DataTransferEndpoint>& data_dst,
               ReadUrlCallback callback) const override;
  void ReadData(const ClipboardFormatType& format,
                const std::optional<DataTransferEndpoint>& data_dst,
                ReadDataCallback callback) const override;
  void WritePortableAndPlatformRepresentations(
      ClipboardBuffer buffer,
      const ObjectMap& objects,
      const std::vector<RawData>& raw_objects,
      std::vector<Clipboard::PlatformRepresentation> platform_representations,
      std::unique_ptr<DataTransferEndpoint> data_src,
      uint32_t privacy_types) override;
  void WriteText(std::string_view text) override;
  void WriteHTML(std::string_view markup,
                 std::optional<std::string_view> source_url) override;
  void WriteSvg(std::string_view markup) override;
  void WriteRTF(std::string_view rtf) override;
  void WriteFilenames(std::vector<ui::FileInfo> filenames) override;
  void WriteURL(const ClipboardUrlInfo& url_info) override;
  void WriteWebSmartPaste() override;
  void WriteBitmap(const SkBitmap& bitmap) override;
  void WriteData(const ClipboardFormatType& format,
                 base::span<const uint8_t> data) override;

  void WriteBitmapInternal(const SkBitmap& bitmap, NSPasteboard* pasteboard);
  void ReadPngInternal(ClipboardBuffer buffer,
                       NSPasteboard* pasteboard,
                       ReadPngCallback callback) const;
  void GetSourceInternal(ClipboardBuffer buffer,
                         NSPasteboard* pasteboard,
                         GetSourceCallback callback) const;
  void ClearInternal(ClipboardBuffer buffer, NSPasteboard* pasteboard);
  void WritePortableAndPlatformRepresentationsInternal(
      ClipboardBuffer buffer,
      const ObjectMap& objects,
      const std::vector<RawData>& raw_objects,
      std::vector<Clipboard::PlatformRepresentation> platform_representations,
      std::unique_ptr<DataTransferEndpoint> data_src,
      NSPasteboard* pasteboard,
      uint32_t privacy_types);
  void ClipboardChanged();

  // Mapping of OS-provided sequence number to a unique token.
  mutable struct {
    NSInteger sequence_number;
    ClipboardSequenceNumberToken token;
  } clipboard_sequence_;

  base::CallbackListSubscription clipboard_change_subscription_;
  NSInteger last_known_sequence_number_ = 0;
};

}  // namespace ui

#endif  // UI_BASE_CLIPBOARD_CLIPBOARD_MAC_H_