tk/spectre.console
1
0
Fork 0
mirror of https://github.com/nsnail/spectre.console.git synced 2025-06-19 13:28:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add rule widget

Browse Source 
Adds a new rule widget.
Also fixes some bugs I encountered while testing
some unrelated things in an extremely small console.
This commit is contained in:
Patrik Svensson
2020-10-20 01:07:58 +02:00
committed by Patrik Svensson
parent 1410cba6c5
commit 5a1b8a1710
16 changed files with 610 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
src/Spectre.Console/Rendering/RenderContext.cs
View File

@ -27,6 +27,12 @@ namespace Spectre.Console.Rendering
/// </summary>
public Justify? Justification { get; }
/// <summary>
/// Gets a value indicating whether the context want items to render without
/// line breaks and return a single line where applicable.
/// </summary>
internal bool SingleLine { get; }
/// <summary>
/// Initializes a new instance of the <see cref="RenderContext"/> class.
/// </summary>
@ -34,21 +40,42 @@ namespace Spectre.Console.Rendering
/// <param name="legacyConsole">A value indicating whether or not this a legacy console (i.e. cmd.exe).</param>
/// <param name="justification">The justification to use when rendering.</param>
public RenderContext(Encoding encoding, bool legacyConsole, Justify? justification = null)
: this(encoding, legacyConsole, justification, false)
{
}
private RenderContext(Encoding encoding, bool legacyConsole, Justify? justification = null, bool singleLine = false)
{
Encoding = encoding ?? throw new System.ArgumentNullException(nameof(encoding));
LegacyConsole = legacyConsole;
Justification = justification;
Unicode = Encoding == Encoding.UTF8 || Encoding == Encoding.Unicode;
SingleLine = singleLine;
}
/// <summary>
/// Creates a new context with the specified justification.
/// </summary>
/// <param name="justification">The justification.</param>
/// <returns>A new <see cref="RenderContext"/> instance with the specified justification.</returns>
/// <returns>A new <see cref="RenderContext"/> instance.</returns>
public RenderContext WithJustification(Justify? justification)
{
return new RenderContext(Encoding, LegacyConsole, justification);
}
/// <summary>
/// Creates a new context that tell <see cref="IRenderable"/> instances
/// to not care about splitting things in new lines. Whether or not to
/// comply to the request is up to the item being rendered.
/// </summary>
/// <remarks>
/// Use with care since this has the potential to mess things up.
/// Only use this kind of context with items that you know about.
/// </remarks>
/// <returns>A new <see cref="RenderContext"/> instance.</returns>
internal RenderContext WithSingleLine()
{
return new RenderContext(Encoding, LegacyConsole, Justification, true);
}
}
}

165
src/Spectre.Console/Rendering/Segment.cs
View File

@ -1,7 +1,9 @@
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Text;
using Spectre.Console.Internal;
namespace Spectre.Console.Rendering
@ -125,48 +127,11 @@ namespace Spectre.Console.Rendering
/// <param name="context">The render context.</param>
/// <param name="segments">The segments to measure.</param>
/// <returns>The number of cells that the segments occupies in the console.</returns>
public static int CellLength(RenderContext context, List<Segment> segments)
public static int CellLength(RenderContext context, IEnumerable<Segment> segments)
{
return segments.Sum(segment => segment.CellLength(context));
}
/// <summary>
/// Truncates the segments to the specified width.
/// </summary>
/// <param name="context">The render context.</param>
/// <param name="segments">The segments to truncate.</param>
/// <param name="maxWidth">The maximum width that the segments may occupy.</param>
/// <returns>A list of segments that has been truncated.</returns>
public static List<Segment> Truncate(RenderContext context, IEnumerable<Segment> segments, int maxWidth)
{
if (context is null)
{
throw new ArgumentNullException(nameof(context));
}
if (segments is null)
{
throw new ArgumentNullException(nameof(segments));
}
var result = new List<Segment>();
var totalWidth = 0;
foreach (var segment in segments)
{
var segmentWidth = segment.CellLength(context);
if (totalWidth + segmentWidth > maxWidth)
{
break;
}
result.Add(segment);
totalWidth += segmentWidth;
}
return result;
}
/// <summary>
/// Splits the provided segments into lines.
/// </summary>
@ -387,6 +352,90 @@ namespace Spectre.Console.Rendering
return result;
}
/// <summary>
/// Truncates the segments to the specified width.
/// </summary>
/// <param name="context">The render context.</param>
/// <param name="segments">The segments to truncate.</param>
/// <param name="maxWidth">The maximum width that the segments may occupy.</param>
/// <returns>A list of segments that has been truncated.</returns>
public static List<Segment> Truncate(RenderContext context, IEnumerable<Segment> segments, int maxWidth)
{
if (context is null)
{
throw new ArgumentNullException(nameof(context));
}
if (segments is null)
{
throw new ArgumentNullException(nameof(segments));
}
var result = new List<Segment>();
var totalWidth = 0;
foreach (var segment in segments)
{
var segmentWidth = segment.CellLength(context);
if (totalWidth + segmentWidth > maxWidth)
{
break;
}
result.Add(segment);
totalWidth += segmentWidth;
}
if (result.Count == 0 && segments.Any())
{
var segment = Truncate(context, segments.First(), maxWidth);
if (segment != null)
{
result.Add(segment);
}
}
return result;
}
/// <summary>
/// Truncates the segment to the specified width.
/// </summary>
/// <param name="context">The render context.</param>
/// <param name="segment">The segment to truncate.</param>
/// <param name="maxWidth">The maximum width that the segment may occupy.</param>
/// <returns>A new truncated segment, or <c>null</c>.</returns>
public static Segment? Truncate(RenderContext context, Segment segment, int maxWidth)
{
if (segment is null)
{
return null;
}
if (segment.CellLength(context) <= maxWidth)
{
return segment;
}
var builder = new StringBuilder();
foreach (var character in segment.Text)
{
if (Cell.GetCellLength(context, builder.ToString()) >= maxWidth)
{
break;
}
builder.Append(character);
}
if (builder.Length == 0)
{
return null;
}
return new Segment(builder.ToString(), segment.Style);
}
internal static Segment TruncateWithEllipsis(string text, Style style, RenderContext context, int maxWidth)
{
return SplitOverflow(
@ -396,6 +445,46 @@ namespace Spectre.Console.Rendering
maxWidth)[0];
}
internal static List<Segment> TruncateWithEllipsis(IEnumerable<Segment> segments, RenderContext context, int maxWidth)
{
if (CellLength(context, segments) <= maxWidth)
{
return new List<Segment>(segments);
}
segments = TrimEnd(Truncate(context, segments, maxWidth - 1));
if (!segments.Any())
{
return new List<Segment>(1);
}
var result = new List<Segment>(segments);
result.Add(new Segment("…", result.Last().Style));
return result;
}
internal static List<Segment> TrimEnd(IEnumerable<Segment> segments)
{
var stack = new Stack<Segment>();
var checkForWhitespace = true;
foreach (var segment in segments.Reverse())
{
if (checkForWhitespace)
{
if (segment.IsWhiteSpace)
{
continue;
}
checkForWhitespace = false;
}
stack.Push(segment);
}
return stack.ToList();
}
internal static List<List<SegmentLine>> MakeSameHeight(int cellHeight, List<List<SegmentLine>> cells)
{
foreach (var cell in cells)