// TO COMPLETE
// Copyright (c) 2014 AlphaSierraPapa for the SharpDevelop Team
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
// software and associated documentation files (the "Software"), to deal in the Software
// without restriction, including without limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
// to whom the Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all copies or
// substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
using System;
using System.Collections.Generic;
using Unity.CodeEditor.Document;
using Unity.CodeEditor.Text;
namespace Unity.CodeEditor.Rendering
{
///
/// VisualLineElement that represents a piece of text.
///
internal class VisualLineText : VisualLineElement
{
///
/// Gets the parent visual line.
///
internal VisualLine ParentVisualLine { get; }
///
/// Creates a visual line text element with the specified length.
/// It uses the and its
/// to find the actual text string.
///
internal VisualLineText(VisualLine parentVisualLine, int length) : base(length, length)
{
ParentVisualLine = parentVisualLine ?? throw new ArgumentNullException(nameof(parentVisualLine));
}
///
/// Override this method to control the type of new VisualLineText instances when
/// the visual line is split due to syntax highlighting.
///
protected virtual VisualLineText CreateInstance(int length)
{
return new VisualLineText(ParentVisualLine, length);
}
///
internal override TextRun CreateTextRun(int startVisualColumn, ITextRunConstructionContext context)
{
if (context == null)
throw new ArgumentNullException(nameof(context));
var relativeOffset = startVisualColumn - VisualColumn;
var offset = context.VisualLine.FirstDocumentLine.Offset + RelativeTextOffset + relativeOffset;
var text = context.GetText(
offset,
DocumentLength - relativeOffset);
return new StringSegmentTextRun(text, TextParagraphProperties);
}
///
internal override bool IsWhitespace(int visualColumn)
{
var offset = visualColumn - VisualColumn + ParentVisualLine.FirstDocumentLine.Offset + RelativeTextOffset;
return char.IsWhiteSpace(ParentVisualLine.Document.GetCharAt(offset));
}
internal override ReadOnlyMemory GetPrecedingText(int visualColumnLimit, ITextRunConstructionContext context)
{
if (context == null)
throw new ArgumentNullException(nameof(context));
var relativeOffset = visualColumnLimit - VisualColumn;
var text = context.GetText(context.VisualLine.FirstDocumentLine.Offset + RelativeTextOffset, relativeOffset);
return text.Text.AsMemory().Slice(text.Offset, text.Count);
}
///
internal override bool CanSplit => true;
///
internal override void Split(int splitVisualColumn, IList elements, int elementIndex)
{
if (splitVisualColumn <= VisualColumn || splitVisualColumn >= VisualColumn + VisualLength)
throw new ArgumentOutOfRangeException(nameof(splitVisualColumn), splitVisualColumn, "Value must be between " + (VisualColumn + 1) + " and " + (VisualColumn + VisualLength - 1));
if (elements == null)
throw new ArgumentNullException(nameof(elements));
if (elements[elementIndex] != this)
throw new ArgumentException("Invalid elementIndex - couldn't find this element at the index");
var relativeSplitPos = splitVisualColumn - VisualColumn;
var splitPart = CreateInstance(DocumentLength - relativeSplitPos);
SplitHelper(this, splitPart, splitVisualColumn, relativeSplitPos + RelativeTextOffset);
elements.Insert(elementIndex + 1, splitPart);
}
///
internal override int GetRelativeOffset(int visualColumn)
{
return RelativeTextOffset + visualColumn - VisualColumn;
}
///
internal override int GetVisualColumn(int relativeTextOffset)
{
return VisualColumn + relativeTextOffset - RelativeTextOffset;
}
///
internal override int GetNextCaretPosition(int visualColumn, LogicalDirection direction, CaretPositioningMode mode)
{
var textOffset = ParentVisualLine.StartOffset + RelativeTextOffset;
var pos = TextUtilities.GetNextCaretPosition(ParentVisualLine.Document, textOffset + visualColumn - VisualColumn, direction, mode);
if (pos < textOffset || pos > textOffset + DocumentLength)
return -1;
return VisualColumn + pos - textOffset;
}
}
}