// Copyright (c) Six Labors.
// Licensed under the Six Labors Split License.

using SixLabors.Fonts.Tables.AdvancedTypographic;

namespace SixLabors.Fonts {
  /// <summary>
  /// Defines the contract for glyph shaping collections.
  /// </summary>
  internal interface IGlyphShapingCollection
  {
      /// <summary>
      /// Gets the collection count.
      /// </summary>
      public int Count { get; }

      /// <summary>
      /// Gets the text options used by this collection.
      /// </summary>
      public TextOptions TextOptions { get; }

      /// <summary>
      /// Gets the glyph shaping data at the specified index.
      /// </summary>
      /// <param name="index">The zero-based index of the elements to get.</param>
      /// <returns>The <see cref="GlyphShapingData"/>.</returns>
      public GlyphShapingData this[int index] { get; }

      /// <summary>
      /// Adds the shaping feature to the collection which should be applied to the glyph at a specified index.
      /// </summary>
      /// <param name="index">The zero-based index of the element.</param>
      /// <param name="feature">The feature to apply.</param>
      public void AddShapingFeature(int index, TagEntry feature);

      /// <summary>
      /// Enables a previously added shaping feature.
      /// </summary>
      /// <param name="index">The zero-based index of the element.</param>
      /// <param name="feature">The feature to enable.</param>
      public void EnableShapingFeature(int index, Tag feature);

      /// <summary>
      /// Disables a previously added shaping feature.
      /// </summary>
      /// <param name="index">The zero-based index of the element.</param>
      /// <param name="feature">The feature to disable.</param>
      public void DisableShapingFeature(int index, Tag feature);
  }
}