Avalonia/src/Avalonia.Base/Media/TextFormatting/TextLine.cs

using System;
using System.Collections.Generic;

namespace Avalonia.Media.TextFormatting
{
    /// <summary>
    /// Represents a line of text that is used for text rendering.
    /// </summary>
    public abstract class TextLine : IDisposable
    {
        /// <summary>
        /// Gets the text runs that are contained within a line.
        /// </summary>
        /// <value>
        /// The contained text runs.
        /// </value>
        public abstract IReadOnlyList<TextRun> TextRuns { get; }

        /// <summary>
        /// Gets the first TextSource position of the current line.
        /// </summary>
        public abstract int FirstTextSourceIndex { get; }

        /// <summary>
        /// Gets the total number of TextSource positions of the current line.
        /// </summary>
        public abstract int Length { get; }

        /// <summary>
        /// Gets the state of the line when broken by line breaking process.
        /// </summary>
        /// <returns>
        /// A <see cref="TextLineBreak"/> value that represents the line break.
        /// </returns>
        public abstract TextLineBreak? TextLineBreak { get; }

        /// <summary>
        /// Gets the distance from the top to the baseline of the current TextLine object.
        /// </summary>
        /// <returns>
        /// A <see cref="double"/> that represents the baseline distance.
        /// </returns>
        public abstract double Baseline { get; }

        /// <summary>
        /// Gets the distance from the top-most to bottom-most black pixel in a line.
        /// </summary>
        /// <returns>
        /// A value that represents the extent distance.
        /// </returns>
        public abstract double Extent { get; }

        /// <summary>
        /// Gets a value that indicates whether the line is collapsed.
        /// </summary>
        /// <returns>
        /// <c>true</c>, if the line is collapsed; otherwise, <c>false</c>.
        /// </returns>
        public abstract bool HasCollapsed { get; }

        /// <summary>
        /// Gets a value that indicates whether content of the line overflows the specified paragraph width.
        /// </summary>
        /// <returns>
        /// <c>true</c>, the line overflows the specified paragraph width; otherwise, <c>false</c>.
        /// </returns>
        public abstract bool HasOverflowed { get; }

        /// <summary>
        /// Gets the height of a line of text.
        /// </summary>
        /// <returns>
        /// The text line height.
        /// </returns>
        public abstract double Height { get; }

        /// <summary>
        /// Gets the number of newline characters at the end of a line.
        /// </summary>
        /// <returns>
        /// The number of newline characters.
        /// </returns>
        public abstract int NewLineLength { get; }

        /// <summary>
        /// Gets the distance that black pixels extend beyond the bottom alignment edge of a line.
        /// </summary>
        /// <returns>
        /// The overhang after distance.
        /// </returns>
        public abstract double OverhangAfter { get; }

        /// <summary>
        /// Gets the distance that black pixels extend prior to the left leading alignment edge of the line.
        /// </summary>
        /// <returns>
        /// The overhang leading distance.
        /// </returns>
        public abstract double OverhangLeading { get; }

        /// <summary>
        /// Gets the distance that black pixels extend following the right trailing alignment edge of the line.
        /// </summary>
        /// <returns>
        /// The overhang trailing distance.
        /// </returns>
        public abstract double OverhangTrailing { get; }

        /// <summary>
        /// Gets the distance from the start of a paragraph to the starting point of a line.
        /// </summary>
        /// <returns>
        /// The distance from the start of a paragraph to the starting point of a line.
        /// </returns>
        public abstract double Start { get; }

        /// <summary>
        /// Gets the number of whitespace code points beyond the last non-blank character in a line.
        /// </summary>
        /// <returns>
        /// The number of whitespace code points beyond the last non-blank character in a line.
        /// </returns>
        public abstract int TrailingWhitespaceLength { get; }

        /// <summary>
        /// Gets the width of a line of text, excluding trailing whitespace characters.
        /// </summary>
        /// <returns>
        /// The text line width, excluding trailing whitespace characters.
        /// </returns>
        public abstract double Width { get; }

        /// <summary>
        /// Gets the width of a line of text, including trailing whitespace characters.
        /// </summary>
        /// <returns>
        /// The text line width, including trailing whitespace characters.
        /// </returns>
        public abstract double WidthIncludingTrailingWhitespace { get; }

        /// <summary>
        /// Draws the <see cref="TextLine"/> at the given origin.
        /// </summary>
        /// <param name="drawingContext">The drawing context.</param>
        /// <param name="lineOrigin"></param>
        public abstract void Draw(DrawingContext drawingContext, Point lineOrigin);

        /// <summary>
        /// Create a collapsed line based on collapsed text properties.
        /// </summary>
        /// <param name="collapsingPropertiesList">A list of <see cref="TextCollapsingProperties"/>
        /// objects that represent the collapsed text properties.</param>
        /// <returns>
        /// A <see cref="TextLine"/> value that represents a collapsed line that can be displayed.
        /// </returns>
        public abstract TextLine Collapse(params TextCollapsingProperties?[] collapsingPropertiesList);

        /// <summary>
        /// Create a justified line based on justification text properties.
        /// </summary>
        /// <param name="justificationProperties">An object that represent the justification text properties.</param>
        /// <returns>
        /// A <see cref="TextLine"/> value that represents a justified line that can be displayed.
        /// </returns>
        public abstract void Justify(JustificationProperties justificationProperties);

        /// <summary>
        /// Gets the character hit corresponding to the specified distance from the beginning of the line.
        /// </summary>
        /// <param name="distance">A <see cref="double"/> value that represents the distance from the beginning of the line.</param>
        /// <returns>The <see cref="CharacterHit"/> object at the specified distance from the beginning of the line.</returns>
        public abstract CharacterHit GetCharacterHitFromDistance(double distance);

        /// <summary>
        /// Gets the distance from the beginning of the line to the specified character hit.
        /// <see cref="CharacterHit"/>.
        /// </summary>
        /// <param name="characterHit">The <see cref="CharacterHit"/> object whose distance you want to query.</param>
        /// <returns>A <see cref="double"/> that represents the distance from the beginning of the line.</returns>
        public abstract double GetDistanceFromCharacterHit(CharacterHit characterHit);

        /// <summary>
        /// Gets the next character hit for caret navigation.
        /// </summary>
        /// <param name="characterHit">The current <see cref="CharacterHit"/>.</param>
        /// <returns>The next <see cref="CharacterHit"/>.</returns>
        public abstract CharacterHit GetNextCaretCharacterHit(CharacterHit characterHit);

        /// <summary>
        /// Gets the previous character hit for caret navigation.
        /// </summary>
        /// <param name="characterHit">The current <see cref="CharacterHit"/>.</param>
        /// <returns>The previous <see cref="CharacterHit"/>.</returns>
        public abstract CharacterHit GetPreviousCaretCharacterHit(CharacterHit characterHit);

        /// <summary>
        /// Gets the previous character hit after backspacing.
        /// </summary>
        /// <param name="characterHit">The current <see cref="CharacterHit"/>.</param>
        /// <returns>The <see cref="CharacterHit"/> after backspacing.</returns>
        public abstract CharacterHit GetBackspaceCaretCharacterHit(CharacterHit characterHit);

        /// <summary>
        /// Get an array of bounding rectangles of a range of characters within a text line.
        /// </summary>
        /// <param name="firstTextSourceCharacterIndex">index of first character of specified range</param>
        /// <param name="textLength">number of characters of the specified range</param>
        /// <returns>an array of bounding rectangles.</returns>
        public abstract IReadOnlyList<TextBounds> GetTextBounds(int firstTextSourceCharacterIndex, int textLength);

        public abstract void Dispose();
    }
}