#nullable enable
namespace Terminal.Gui;
/// Facilitates box drawing and line intersection detection and rendering. Does not support diagonal lines.
public class LineCanvas : IDisposable
{
///
/// Optional which when present overrides the
/// (colors) of lines in the canvas. This can be used e.g. to apply a global
/// across all lines.
///
public FillPair? Fill { get; set; }
private readonly List _lines = [];
private readonly Dictionary _runeResolvers = new ()
{
{
IntersectionRuneType.ULCorner,
new ULIntersectionRuneResolver ()
},
{
IntersectionRuneType.URCorner,
new URIntersectionRuneResolver ()
},
{
IntersectionRuneType.LLCorner,
new LLIntersectionRuneResolver ()
},
{
IntersectionRuneType.LRCorner,
new LRIntersectionRuneResolver ()
},
{
IntersectionRuneType.TopTee,
new TopTeeIntersectionRuneResolver ()
},
{
IntersectionRuneType.LeftTee,
new LeftTeeIntersectionRuneResolver ()
},
{
IntersectionRuneType.RightTee,
new RightTeeIntersectionRuneResolver ()
},
{
IntersectionRuneType.BottomTee,
new BottomTeeIntersectionRuneResolver ()
},
{
IntersectionRuneType.Cross,
new CrossIntersectionRuneResolver ()
}
// TODO: Add other resolvers
};
private Rectangle _cachedViewport;
/// Creates a new instance.
public LineCanvas ()
{
// TODO: Refactor ConfigurationManager to not use an event handler for this.
// Instead, have it call a method on any class appropriately attributed
// to update the cached values. See Issue #2871
Applied += ConfigurationManager_Applied;
}
/// Creates a new instance with the given .
/// Initial lines for the canvas.
public LineCanvas (IEnumerable lines) : this () { _lines = lines.ToList (); }
///
/// Gets the rectangle that describes the bounds of the canvas. Location is the coordinates of the line that is
/// furthest left/top and Size is defined by the line that extends the furthest right/bottom.
///
public Rectangle Viewport
{
get
{
if (_cachedViewport.IsEmpty)
{
if (_lines.Count == 0)
{
return _cachedViewport;
}
Rectangle viewport = _lines [0].Viewport;
for (var i = 1; i < _lines.Count; i++)
{
viewport = Rectangle.Union (viewport, _lines [i].Viewport);
}
if (viewport is { Width: 0 } or { Height: 0 })
{
viewport = viewport with
{
Width = Math.Clamp (viewport.Width, 1, short.MaxValue),
Height = Math.Clamp (viewport.Height, 1, short.MaxValue)
};
}
_cachedViewport = viewport;
}
return _cachedViewport;
}
}
/// Gets the lines in the canvas.
public IReadOnlyCollection Lines => _lines.AsReadOnly ();
///
public void Dispose () { Applied -= ConfigurationManager_Applied; }
///
/// Adds a new long line to the canvas starting at .
///
/// Use positive for the line to extend Right and negative for Left when
/// is .
///
///
/// Use positive for the line to extend Down and negative for Up when
/// is .
///
///
/// Starting point.
///
/// The length of line. 0 for an intersection (cross or T). Positive for Down/Right. Negative for
/// Up/Left.
///
/// The direction of the line.
/// The style of line to use
///
public void AddLine (
Point start,
int length,
Orientation orientation,
LineStyle style,
Attribute? attribute = default
)
{
_cachedViewport = Rectangle.Empty;
_lines.Add (new (start, length, orientation, style, attribute));
}
/// Adds a new line to the canvas
///
public void AddLine (StraightLine line)
{
_cachedViewport = Rectangle.Empty;
_lines.Add (line);
}
/// Clears all lines from the LineCanvas.
public void Clear ()
{
_cachedViewport = Rectangle.Empty;
_lines.Clear ();
}
///
/// Clears any cached states from the canvas Call this method if you make changes to lines that have already been
/// added.
///
public void ClearCache () { _cachedViewport = Rectangle.Empty; }
///
/// Evaluates the lines that have been added to the canvas and returns a map containing the glyphs and their
/// locations. The glyphs are the characters that should be rendered so that all lines connect up with the appropriate
/// intersection symbols.
///
/// A map of all the points within the canvas.
public Dictionary GetCellMap ()
{
Dictionary map = new ();
// walk through each pixel of the bitmap
for (int y = Viewport.Y; y < Viewport.Y + Viewport.Height; y++)
{
for (int x = Viewport.X; x < Viewport.X + Viewport.Width; x++)
{
IntersectionDefinition? [] intersects = _lines
.Select (l => l.Intersects (x, y))
.Where (i => i is { })
.ToArray ();
Cell? cell = GetCellForIntersects (Application.Driver, intersects);
if (cell is { })
{
map.Add (new (x, y), cell);
}
}
}
return map;
}
// TODO: Unless there's an obvious use case for this API we should delete it in favor of the
// simpler version that doesn't take an area.
///
/// Evaluates the lines that have been added to the canvas and returns a map containing the glyphs and their
/// locations. The glyphs are the characters that should be rendered so that all lines connect up with the appropriate
/// intersection symbols.
///
/// A rectangle to constrain the search by.
/// A map of the points within the canvas that intersect with .
public Dictionary GetMap (Rectangle inArea)
{
Dictionary map = new ();
// walk through each pixel of the bitmap
for (int y = inArea.Y; y < inArea.Y + inArea.Height; y++)
{
for (int x = inArea.X; x < inArea.X + inArea.Width; x++)
{
IntersectionDefinition? [] intersects = _lines
.Select (l => l.Intersects (x, y))
.Where (i => i is { })
.ToArray ();
Rune? rune = GetRuneForIntersects (Application.Driver, intersects);
if (rune is { })
{
map.Add (new (x, y), rune.Value);
}
}
}
return map;
}
///
/// Evaluates the lines that have been added to the canvas and returns a map containing the glyphs and their
/// locations. The glyphs are the characters that should be rendered so that all lines connect up with the appropriate
/// intersection symbols.
///
/// A map of all the points within the canvas.
public Dictionary GetMap () { return GetMap (Viewport); }
/// Merges one line canvas into this one.
///
public void Merge (LineCanvas lineCanvas)
{
foreach (StraightLine line in lineCanvas._lines)
{
AddLine (line);
}
}
/// Removes the last line added to the canvas
///
public StraightLine RemoveLastLine ()
{
StraightLine? l = _lines.LastOrDefault ();
if (l is { })
{
_lines.Remove (l);
}
return l!;
}
///
/// Returns the contents of the line canvas rendered to a string. The string will include all columns and rows,
/// even if has negative coordinates. For example, if the canvas contains a single line that
/// starts at (-1,-1) with a length of 2, the rendered string will have a length of 2.
///
/// The canvas rendered to a string.
public override string ToString ()
{
if (Viewport.IsEmpty)
{
return string.Empty;
}
// Generate the rune map for the entire canvas
Dictionary runeMap = GetMap ();
// Create the rune canvas
Rune [,] canvas = new Rune [Viewport.Height, Viewport.Width];
// Copy the rune map to the canvas, adjusting for any negative coordinates
foreach (KeyValuePair kvp in runeMap)
{
int x = kvp.Key.X - Viewport.X;
int y = kvp.Key.Y - Viewport.Y;
canvas [y, x] = kvp.Value;
}
// Convert the canvas to a string
var sb = new StringBuilder ();
for (var y = 0; y < canvas.GetLength (0); y++)
{
for (var x = 0; x < canvas.GetLength (1); x++)
{
Rune r = canvas [y, x];
sb.Append (r.Value == 0 ? ' ' : r.ToString ());
}
if (y < canvas.GetLength (0) - 1)
{
sb.AppendLine ();
}
}
return sb.ToString ();
}
private bool All (IntersectionDefinition? [] intersects, Orientation orientation) { return intersects.All (i => i!.Line.Orientation == orientation); }
private void ConfigurationManager_Applied (object? sender, ConfigurationManagerEventArgs e)
{
foreach (KeyValuePair irr in _runeResolvers)
{
irr.Value.SetGlyphs ();
}
}
///
/// Returns true if all requested appear in and there are
/// no additional
///
///
///
///
private bool Exactly (HashSet intersects, params IntersectionType [] types) { return intersects.SetEquals (types); }
private Attribute? GetAttributeForIntersects (IntersectionDefinition? [] intersects)
{
return Fill != null ? Fill.GetAttribute (intersects [0]!.Point) : intersects [0]!.Line.Attribute;
}
private Cell? GetCellForIntersects (ConsoleDriver? driver, IntersectionDefinition? [] intersects)
{
if (!intersects.Any ())
{
return null;
}
var cell = new Cell ();
Rune? rune = GetRuneForIntersects (driver, intersects);
if (rune.HasValue)
{
cell.Rune = rune.Value;
}
cell.Attribute = GetAttributeForIntersects (intersects);
return cell;
}
private Rune? GetRuneForIntersects (ConsoleDriver? driver, IntersectionDefinition? [] intersects)
{
if (!intersects.Any ())
{
return null;
}
IntersectionRuneType runeType = GetRuneTypeForIntersects (intersects);
if (_runeResolvers.TryGetValue (runeType, out IntersectionRuneResolver? resolver))
{
return resolver.GetRuneForIntersects (driver, intersects);
}
// TODO: Remove these once we have all of the below ported to IntersectionRuneResolvers
bool useDouble = intersects.Any (i => i?.Line.Style == LineStyle.Double);
bool useDashed = intersects.Any (
i => i?.Line.Style == LineStyle.Dashed
|| i?.Line.Style == LineStyle.RoundedDashed
);
bool useDotted = intersects.Any (
i => i?.Line.Style == LineStyle.Dotted
|| i?.Line.Style == LineStyle.RoundedDotted
);
// horiz and vert lines same as Single for Rounded
bool useThick = intersects.Any (i => i?.Line.Style == LineStyle.Heavy);
bool useThickDashed = intersects.Any (i => i?.Line.Style == LineStyle.HeavyDashed);
bool useThickDotted = intersects.Any (i => i?.Line.Style == LineStyle.HeavyDotted);
// TODO: Support ruler
//var useRuler = intersects.Any (i => i.Line.Style == LineStyle.Ruler && i.Line.Length != 0);
// TODO: maybe make these resolvers too for simplicity?
switch (runeType)
{
case IntersectionRuneType.None:
return null;
case IntersectionRuneType.Dot:
return Glyphs.Dot;
case IntersectionRuneType.HLine:
if (useDouble)
{
return Glyphs.HLineDbl;
}
if (useDashed)
{
return Glyphs.HLineDa2;
}
if (useDotted)
{
return Glyphs.HLineDa3;
}
return useThick ? Glyphs.HLineHv :
useThickDashed ? Glyphs.HLineHvDa2 :
useThickDotted ? Glyphs.HLineHvDa3 : Glyphs.HLine;
case IntersectionRuneType.VLine:
if (useDouble)
{
return Glyphs.VLineDbl;
}
if (useDashed)
{
return Glyphs.VLineDa3;
}
if (useDotted)
{
return Glyphs.VLineDa4;
}
return useThick ? Glyphs.VLineHv :
useThickDashed ? Glyphs.VLineHvDa3 :
useThickDotted ? Glyphs.VLineHvDa4 : Glyphs.VLine;
default:
throw new (
"Could not find resolver or switch case for "
+ nameof (runeType)
+ ":"
+ runeType
);
}
}
private IntersectionRuneType GetRuneTypeForIntersects (IntersectionDefinition? [] intersects)
{
HashSet set = new (intersects.Select (i => i!.Type));
#region Cross Conditions
if (Has (
set,
IntersectionType.PassOverHorizontal,
IntersectionType.PassOverVertical
))
{
return IntersectionRuneType.Cross;
}
if (Has (
set,
IntersectionType.PassOverVertical,
IntersectionType.StartLeft,
IntersectionType.StartRight
))
{
return IntersectionRuneType.Cross;
}
if (Has (
set,
IntersectionType.PassOverHorizontal,
IntersectionType.StartUp,
IntersectionType.StartDown
))
{
return IntersectionRuneType.Cross;
}
if (Has (
set,
IntersectionType.StartLeft,
IntersectionType.StartRight,
IntersectionType.StartUp,
IntersectionType.StartDown
))
{
return IntersectionRuneType.Cross;
}
#endregion
#region Corner Conditions
if (Exactly (
set,
IntersectionType.StartRight,
IntersectionType.StartDown
))
{
return IntersectionRuneType.ULCorner;
}
if (Exactly (
set,
IntersectionType.StartLeft,
IntersectionType.StartDown
))
{
return IntersectionRuneType.URCorner;
}
if (Exactly (
set,
IntersectionType.StartUp,
IntersectionType.StartLeft
))
{
return IntersectionRuneType.LRCorner;
}
if (Exactly (
set,
IntersectionType.StartUp,
IntersectionType.StartRight
))
{
return IntersectionRuneType.LLCorner;
}
#endregion Corner Conditions
#region T Conditions
if (Has (
set,
IntersectionType.PassOverHorizontal,
IntersectionType.StartDown
))
{
return IntersectionRuneType.TopTee;
}
if (Has (
set,
IntersectionType.StartRight,
IntersectionType.StartLeft,
IntersectionType.StartDown
))
{
return IntersectionRuneType.TopTee;
}
if (Has (
set,
IntersectionType.PassOverHorizontal,
IntersectionType.StartUp
))
{
return IntersectionRuneType.BottomTee;
}
if (Has (
set,
IntersectionType.StartRight,
IntersectionType.StartLeft,
IntersectionType.StartUp
))
{
return IntersectionRuneType.BottomTee;
}
if (Has (
set,
IntersectionType.PassOverVertical,
IntersectionType.StartRight
))
{
return IntersectionRuneType.LeftTee;
}
if (Has (
set,
IntersectionType.StartRight,
IntersectionType.StartDown,
IntersectionType.StartUp
))
{
return IntersectionRuneType.LeftTee;
}
if (Has (
set,
IntersectionType.PassOverVertical,
IntersectionType.StartLeft
))
{
return IntersectionRuneType.RightTee;
}
if (Has (
set,
IntersectionType.StartLeft,
IntersectionType.StartDown,
IntersectionType.StartUp
))
{
return IntersectionRuneType.RightTee;
}
#endregion
if (All (intersects, Orientation.Horizontal))
{
return IntersectionRuneType.HLine;
}
if (All (intersects, Orientation.Vertical))
{
return IntersectionRuneType.VLine;
}
return IntersectionRuneType.Dot;
}
///
/// Returns true if the collection has all the specified
/// (i.e. AND).
///
///
///
///
private bool Has (HashSet intersects, params IntersectionType [] types) { return types.All (t => intersects.Contains (t)); }
private class BottomTeeIntersectionRuneResolver : IntersectionRuneResolver
{
public override void SetGlyphs ()
{
_round = Glyphs.BottomTee;
_doubleH = Glyphs.BottomTeeDblH;
_doubleV = Glyphs.BottomTeeDblV;
_doubleBoth = Glyphs.BottomTeeDbl;
_thickH = Glyphs.BottomTeeHvH;
_thickV = Glyphs.BottomTeeHvV;
_thickBoth = Glyphs.BottomTeeHvDblH;
_normal = Glyphs.BottomTee;
}
}
private class CrossIntersectionRuneResolver : IntersectionRuneResolver
{
public override void SetGlyphs ()
{
_round = Glyphs.Cross;
_doubleH = Glyphs.CrossDblH;
_doubleV = Glyphs.CrossDblV;
_doubleBoth = Glyphs.CrossDbl;
_thickH = Glyphs.CrossHvH;
_thickV = Glyphs.CrossHvV;
_thickBoth = Glyphs.CrossHv;
_normal = Glyphs.Cross;
}
}
private abstract class IntersectionRuneResolver
{
internal Rune _doubleBoth;
internal Rune _doubleH;
internal Rune _doubleV;
internal Rune _normal;
internal Rune _round;
internal Rune _thickBoth;
internal Rune _thickH;
internal Rune _thickV;
public IntersectionRuneResolver () { SetGlyphs (); }
public Rune? GetRuneForIntersects (ConsoleDriver? driver, IntersectionDefinition? [] intersects)
{
bool useRounded = intersects.Any (
i => i?.Line.Length != 0
&& (
i?.Line.Style == LineStyle.Rounded
|| i?.Line.Style
== LineStyle.RoundedDashed
|| i?.Line.Style
== LineStyle.RoundedDotted)
);
// Note that there aren't any glyphs for intersections of double lines with heavy lines
bool doubleHorizontal = intersects.Any (
l => l?.Line.Orientation == Orientation.Horizontal
&& l.Line.Style == LineStyle.Double
);
bool doubleVertical = intersects.Any (
l => l?.Line.Orientation == Orientation.Vertical
&& l.Line.Style == LineStyle.Double
);
bool thickHorizontal = intersects.Any (
l => l?.Line.Orientation == Orientation.Horizontal
&& (
l.Line.Style == LineStyle.Heavy
|| l.Line.Style == LineStyle.HeavyDashed
|| l.Line.Style == LineStyle.HeavyDotted)
);
bool thickVertical = intersects.Any (
l => l?.Line.Orientation == Orientation.Vertical
&& (
l.Line.Style == LineStyle.Heavy
|| l.Line.Style == LineStyle.HeavyDashed
|| l.Line.Style == LineStyle.HeavyDotted)
);
if (doubleHorizontal)
{
return doubleVertical ? _doubleBoth : _doubleH;
}
if (doubleVertical)
{
return _doubleV;
}
if (thickHorizontal)
{
return thickVertical ? _thickBoth : _thickH;
}
if (thickVertical)
{
return _thickV;
}
return useRounded ? _round : _normal;
}
///
/// Sets the glyphs used. Call this method after construction and any time ConfigurationManager has updated the
/// settings.
///
public abstract void SetGlyphs ();
}
private class LeftTeeIntersectionRuneResolver : IntersectionRuneResolver
{
public override void SetGlyphs ()
{
_round = Glyphs.LeftTee;
_doubleH = Glyphs.LeftTeeDblH;
_doubleV = Glyphs.LeftTeeDblV;
_doubleBoth = Glyphs.LeftTeeDbl;
_thickH = Glyphs.LeftTeeHvH;
_thickV = Glyphs.LeftTeeHvV;
_thickBoth = Glyphs.LeftTeeHvDblH;
_normal = Glyphs.LeftTee;
}
}
private class LLIntersectionRuneResolver : IntersectionRuneResolver
{
public override void SetGlyphs ()
{
_round = Glyphs.LLCornerR;
_doubleH = Glyphs.LLCornerSingleDbl;
_doubleV = Glyphs.LLCornerDblSingle;
_doubleBoth = Glyphs.LLCornerDbl;
_thickH = Glyphs.LLCornerLtHv;
_thickV = Glyphs.LLCornerHvLt;
_thickBoth = Glyphs.LLCornerHv;
_normal = Glyphs.LLCorner;
}
}
private class LRIntersectionRuneResolver : IntersectionRuneResolver
{
public override void SetGlyphs ()
{
_round = Glyphs.LRCornerR;
_doubleH = Glyphs.LRCornerSingleDbl;
_doubleV = Glyphs.LRCornerDblSingle;
_doubleBoth = Glyphs.LRCornerDbl;
_thickH = Glyphs.LRCornerLtHv;
_thickV = Glyphs.LRCornerHvLt;
_thickBoth = Glyphs.LRCornerHv;
_normal = Glyphs.LRCorner;
}
}
private class RightTeeIntersectionRuneResolver : IntersectionRuneResolver
{
public override void SetGlyphs ()
{
_round = Glyphs.RightTee;
_doubleH = Glyphs.RightTeeDblH;
_doubleV = Glyphs.RightTeeDblV;
_doubleBoth = Glyphs.RightTeeDbl;
_thickH = Glyphs.RightTeeHvH;
_thickV = Glyphs.RightTeeHvV;
_thickBoth = Glyphs.RightTeeHvDblH;
_normal = Glyphs.RightTee;
}
}
private class TopTeeIntersectionRuneResolver : IntersectionRuneResolver
{
public override void SetGlyphs ()
{
_round = Glyphs.TopTee;
_doubleH = Glyphs.TopTeeDblH;
_doubleV = Glyphs.TopTeeDblV;
_doubleBoth = Glyphs.TopTeeDbl;
_thickH = Glyphs.TopTeeHvH;
_thickV = Glyphs.TopTeeHvV;
_thickBoth = Glyphs.TopTeeHvDblH;
_normal = Glyphs.TopTee;
}
}
private class ULIntersectionRuneResolver : IntersectionRuneResolver
{
public override void SetGlyphs ()
{
_round = Glyphs.ULCornerR;
_doubleH = Glyphs.ULCornerSingleDbl;
_doubleV = Glyphs.ULCornerDblSingle;
_doubleBoth = Glyphs.ULCornerDbl;
_thickH = Glyphs.ULCornerLtHv;
_thickV = Glyphs.ULCornerHvLt;
_thickBoth = Glyphs.ULCornerHv;
_normal = Glyphs.ULCorner;
}
}
private class URIntersectionRuneResolver : IntersectionRuneResolver
{
public override void SetGlyphs ()
{
_round = Glyphs.URCornerR;
_doubleH = Glyphs.URCornerSingleDbl;
_doubleV = Glyphs.URCornerDblSingle;
_doubleBoth = Glyphs.URCornerDbl;
_thickH = Glyphs.URCornerHvLt;
_thickV = Glyphs.URCornerLtHv;
_thickBoth = Glyphs.URCornerHv;
_normal = Glyphs.URCorner;
}
}
}