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

#ifndef THIRD_PARTY_BLINK_RENDERER_CORE_HIGHLIGHT_HIGHLIGHT_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_HIGHLIGHT_HIGHLIGHT_H_

#include "third_party/blink/renderer/bindings/core/v8/iterable.h"
#include "third_party/blink/renderer/bindings/core/v8/v8_highlight_type.h"
#include "third_party/blink/renderer/bindings/core/v8/v8_sync_iterator_highlight.h"
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/core/dom/abstract_range.h"
#include "third_party/blink/renderer/core/dom/live_collection_iterator.h"
#include "third_party/blink/renderer/platform/bindings/script_wrappable.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_hash_map.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_hash_set.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_linked_hash_set.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_vector.h"
#include "third_party/blink/renderer/platform/wtf/forward.h"

namespace blink {

using HighlightSetIterable = ValueSyncIterable<Highlight>;
class HighlightRegistry;

class CORE_EXPORT Highlight : public ScriptWrappable,
                              public HighlightSetIterable {
  DEFINE_WRAPPERTYPEINFO();

 public:
  static Highlight* Create(const HeapVector<Member<AbstractRange>>&);

  explicit Highlight(const HeapVector<Member<AbstractRange>>&);
  ~Highlight() override;

  void Trace(blink::Visitor*) const override;

  Highlight* addForBinding(ScriptState*, AbstractRange*, ExceptionState&);
  void clearForBinding(ScriptState*, ExceptionState&);
  bool deleteForBinding(ScriptState*, AbstractRange*, ExceptionState&);
  bool hasForBinding(ScriptState*, AbstractRange*, ExceptionState&) const;
  wtf_size_t size() const;

  const int32_t& priority() const { return priority_; }
  void setPriority(const int32_t&);

  V8HighlightType type() const { return type_; }
  void setType(const V8HighlightType& type) { type_ = type; }

  bool Contains(AbstractRange*) const;

  // HighlightSetIterable implements live iteration following Set semantics.
  using HighlightLiveIterator = LiveCollectionIterator<AbstractRange>;

  class CORE_EXPORT IterationSource final
      : public HighlightSetIterable::IterationSource,
        public HighlightLiveIterator {
   public:
    explicit IterationSource(Highlight& highlight);

    bool FetchNextItem(ScriptState*, AbstractRange*&) override;

    void Trace(blink::Visitor*) const override;

   private:
    Member<Highlight> highlight_;
  };

  const HeapLinkedHashSet<Member<AbstractRange>>& GetRanges() const {
    return highlight_ranges_;
  }

  void RegisterIn(HighlightRegistry* highlight_registry);
  void DeregisterFrom(HighlightRegistry* highlight_registry);

 private:
  HighlightSetIterable::IterationSource* CreateIterationSource(
      ScriptState*) override;

  HeapLinkedHashSet<Member<AbstractRange>> highlight_ranges_;
  // Active iteration sources that need to be notified of mutations.
  HeapHashSet<WeakMember<HighlightLiveIterator>> active_iterators_;
  void NotifyIteratorsWillRemoveItem(AbstractRange* range);
  void NotifyIteratorsWillClear();

  int32_t priority_ = 0;
  V8HighlightType type_ = V8HighlightType{V8HighlightType::Enum::kHighlight};
  // Since a Highlight can be registered many times under different names in
  // many HighlightRegistries, we need to keep track of the number of times
  // it's present in each registry. If the Highlight is not registered anywhere,
  // then we avoid scheduling repaints in case of modifications to it.
  HeapHashMap<Member<HighlightRegistry>, unsigned>
      containing_highlight_registries_;
  void ScheduleRepaintsInContainingHighlightRegistries() const;
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_CORE_HIGHLIGHT_HIGHLIGHT_H_