From e7f497050cc558cbf0f4b79e1a9dd71394131fa4 Mon Sep 17 00:00:00 2001 From: Patrik Svensson Date: Mon, 26 Oct 2020 11:51:35 +0100 Subject: [PATCH] Add row and column accessors for tables and grids --- docs/input/_layout.cshtml | 7 +- docs/input/widgets/calendar.md | 4 +- docs/input/widgets/table.md | 22 ++-- examples/Borders/Program.cs | 1 - src/Spectre.Console.Tests/Unit/GridTests.cs | 2 +- src/Spectre.Console.Tests/Unit/TableTests.cs | 2 +- .../Extensions/CalendarExtensions.cs | 32 ++++++ .../Extensions/ColumnExtensions.cs | 19 ++++ .../Extensions/GridExtensions.cs | 4 +- .../Extensions/PaddableExtensions.cs | 8 +- .../Extensions/PaddingExtensions.cs | 48 +++++++++ .../Extensions/TableExtensions.cs | 20 +++- src/Spectre.Console/IColumn.cs | 5 + src/Spectre.Console/IPaddable.cs | 2 +- .../Internal/Collections/ListWithCallback.cs | 2 +- .../Extensions/EnumerableExtensions.cs | 15 +++ .../Borders/Tables/MarkdownTableBorder.cs | 8 +- .../Rendering/IHasDirtyState.cs | 13 +++ .../Rendering/JustInTimeRenderable.cs | 79 ++++++++++++++ src/Spectre.Console/TableBorder.cs | 2 +- src/Spectre.Console/Widgets/Calendar.cs | 44 +------- src/Spectre.Console/Widgets/Columns.cs | 6 +- src/Spectre.Console/Widgets/Grid.cs | 102 +++++++++++------- src/Spectre.Console/Widgets/GridColumn.cs | 50 ++++++--- src/Spectre.Console/Widgets/GridRow.cs | 56 ++++++++++ src/Spectre.Console/Widgets/Padder.cs | 20 ++-- src/Spectre.Console/Widgets/Panel.cs | 2 +- src/Spectre.Console/Widgets/Table.cs | 40 +++---- src/Spectre.Console/Widgets/TableColumn.cs | 2 +- src/Spectre.Console/Widgets/TableRow.cs | 56 ++++++++++ 30 files changed, 511 insertions(+), 162 deletions(-) create mode 100644 src/Spectre.Console/Extensions/PaddingExtensions.cs create mode 100644 src/Spectre.Console/Rendering/IHasDirtyState.cs create mode 100644 src/Spectre.Console/Rendering/JustInTimeRenderable.cs create mode 100644 src/Spectre.Console/Widgets/GridRow.cs create mode 100644 src/Spectre.Console/Widgets/TableRow.cs diff --git a/docs/input/_layout.cshtml b/docs/input/_layout.cshtml index f8df17b..f90ae5b 100644 --- a/docs/input/_layout.cshtml +++ b/docs/input/_layout.cshtml @@ -130,7 +130,7 @@
@if(root.ShowLink()) { - @Html.DocumentLink(root) + @Html.DocumentLink(root) } else { @@ -140,6 +140,11 @@ @foreach (IDocument document in OutputPages.GetChildrenOf(root).OnlyVisible()) { + if(string.IsNullOrWhiteSpace(document.GetTitle())) + { + continue; + } + DocumentList documentChildren = OutputPages.GetChildrenOf(document);
@if(document.ShowLink()) diff --git a/docs/input/widgets/calendar.md b/docs/input/widgets/calendar.md index c74ae49..c59c0b0 100644 --- a/docs/input/widgets/calendar.md +++ b/docs/input/widgets/calendar.md @@ -1,4 +1,4 @@ -Title: Calendar +Title: Calendar Order: 4 RedirectFrom: calendar --- @@ -58,7 +58,7 @@ You can hide the calendar header. ```csharp var calendar = new Calendar(2020,10); -calendar.ShowHeader = false; +calendar.ShowHeader(); AnsiConsole.Render(calendar); ``` diff --git a/docs/input/widgets/table.md b/docs/input/widgets/table.md index 4f9bfd6..58dc27f 100644 --- a/docs/input/widgets/table.md +++ b/docs/input/widgets/table.md @@ -91,33 +91,33 @@ table.Width(50); ## Alignment ```csharp -column.Alignment(Justify.Right); -column.LeftAligned(); -column.Centered(); -column.RightAligned(); +table.Columns[0].Alignment(Justify.Right); +table.Columns[0].LeftAligned(); +table.Columns[0].Centered(); +table.Columns[0].RightAligned(); ``` ## Padding ```csharp // Set left and right padding -column.Padding(left: 3, right: 5); +table.Columns[0].Padding(left: 3, right: 5); -// Set padding individually. -column.PadLeft(3); -column.PadRight(5); +// Set padding individually +table.Columns[0].PadLeft(3); +table.Columns[0].PadRight(5); ``` ## Disable column wrapping ```csharp // Disable column wrapping -column.NoWrap(); +table.Columns[0].NoWrap(); ``` ## Set column width ```csharp -// Set the column width (no fluent extension method for this yet) -column.Width = 15; +// Set the column width +table.Columns[0].Width(15); ``` \ No newline at end of file diff --git a/examples/Borders/Program.cs b/examples/Borders/Program.cs index e49b9d1..dd8412d 100644 --- a/examples/Borders/Program.cs +++ b/examples/Borders/Program.cs @@ -1,4 +1,3 @@ -using System.Diagnostics; using Spectre.Console; using Spectre.Console.Rendering; diff --git a/src/Spectre.Console.Tests/Unit/GridTests.cs b/src/Spectre.Console.Tests/Unit/GridTests.cs index e893eb6..9e06035 100644 --- a/src/Spectre.Console.Tests/Unit/GridTests.cs +++ b/src/Spectre.Console.Tests/Unit/GridTests.cs @@ -53,7 +53,7 @@ namespace Spectre.Console.Tests.Unit grid.AddRow("Foo"); // Then - grid.RowCount.ShouldBe(1); + grid.Rows.Count.ShouldBe(1); } [Fact] diff --git a/src/Spectre.Console.Tests/Unit/TableTests.cs b/src/Spectre.Console.Tests/Unit/TableTests.cs index ae324c2..384ba8f 100644 --- a/src/Spectre.Console.Tests/Unit/TableTests.cs +++ b/src/Spectre.Console.Tests/Unit/TableTests.cs @@ -98,7 +98,7 @@ namespace Spectre.Console.Tests.Unit table.AddRow("Foo"); // Then - table.RowCount.ShouldBe(1); + table.Rows.Count.ShouldBe(1); } [Fact] diff --git a/src/Spectre.Console/Extensions/CalendarExtensions.cs b/src/Spectre.Console/Extensions/CalendarExtensions.cs index 78a49eb..0265a89 100644 --- a/src/Spectre.Console/Extensions/CalendarExtensions.cs +++ b/src/Spectre.Console/Extensions/CalendarExtensions.cs @@ -96,5 +96,37 @@ namespace Spectre.Console calendar.HeaderStyle = style ?? Style.Plain; return calendar; } + + /// + /// Shows the calendar header. + /// + /// The calendar. + /// The same instance so that multiple calls can be chained. + public static Calendar ShowHeader(this Calendar calendar) + { + if (calendar is null) + { + throw new ArgumentNullException(nameof(calendar)); + } + + calendar.ShowHeader = true; + return calendar; + } + + /// + /// Hides the calendar header. + /// + /// The calendar. + /// The same instance so that multiple calls can be chained. + public static Calendar HideHeader(this Calendar calendar) + { + if (calendar is null) + { + throw new ArgumentNullException(nameof(calendar)); + } + + calendar.ShowHeader = false; + return calendar; + } } } diff --git a/src/Spectre.Console/Extensions/ColumnExtensions.cs b/src/Spectre.Console/Extensions/ColumnExtensions.cs index 0ac41a9..3240a85 100644 --- a/src/Spectre.Console/Extensions/ColumnExtensions.cs +++ b/src/Spectre.Console/Extensions/ColumnExtensions.cs @@ -24,5 +24,24 @@ namespace Spectre.Console obj.NoWrap = true; return obj; } + + /// + /// Sets the width of the column. + /// + /// An object implementing . + /// The column. + /// The column width. + /// The same instance so that multiple calls can be chained. + public static T Width(this T obj, int? width) + where T : class, IColumn + { + if (obj is null) + { + throw new ArgumentNullException(nameof(obj)); + } + + obj.Width = width; + return obj; + } } } diff --git a/src/Spectre.Console/Extensions/GridExtensions.cs b/src/Spectre.Console/Extensions/GridExtensions.cs index 710d585..078edd1 100644 --- a/src/Spectre.Console/Extensions/GridExtensions.cs +++ b/src/Spectre.Console/Extensions/GridExtensions.cs @@ -69,8 +69,8 @@ namespace Spectre.Console throw new ArgumentNullException(nameof(grid)); } - var columns = new IRenderable[grid.ColumnCount]; - Enumerable.Range(0, grid.ColumnCount).ForEach(index => columns[index] = Text.Empty); + var columns = new IRenderable[grid.Columns.Count]; + Enumerable.Range(0, grid.Columns.Count).ForEach(index => columns[index] = Text.Empty); grid.AddRow(columns); return grid; diff --git a/src/Spectre.Console/Extensions/PaddableExtensions.cs b/src/Spectre.Console/Extensions/PaddableExtensions.cs index 131d51b..ad1ea73 100644 --- a/src/Spectre.Console/Extensions/PaddableExtensions.cs +++ b/src/Spectre.Console/Extensions/PaddableExtensions.cs @@ -22,7 +22,7 @@ namespace Spectre.Console throw new ArgumentNullException(nameof(obj)); } - return Padding(obj, new Padding(left, obj.Padding.Top, obj.Padding.Right, obj.Padding.Bottom)); + return Padding(obj, new Padding(left, obj.Padding.GetTopSafe(), obj.Padding.GetRightSafe(), obj.Padding.GetBottomSafe())); } /// @@ -40,7 +40,7 @@ namespace Spectre.Console throw new ArgumentNullException(nameof(obj)); } - return Padding(obj, new Padding(obj.Padding.Left, top, obj.Padding.Right, obj.Padding.Bottom)); + return Padding(obj, new Padding(obj.Padding.GetLeftSafe(), top, obj.Padding.GetRightSafe(), obj.Padding.GetBottomSafe())); } /// @@ -58,7 +58,7 @@ namespace Spectre.Console throw new ArgumentNullException(nameof(obj)); } - return Padding(obj, new Padding(obj.Padding.Left, obj.Padding.Top, right, obj.Padding.Bottom)); + return Padding(obj, new Padding(obj.Padding.GetLeftSafe(), obj.Padding.GetTopSafe(), right, obj.Padding.GetBottomSafe())); } /// @@ -76,7 +76,7 @@ namespace Spectre.Console throw new ArgumentNullException(nameof(obj)); } - return Padding(obj, new Padding(obj.Padding.Left, obj.Padding.Top, obj.Padding.Right, bottom)); + return Padding(obj, new Padding(obj.Padding.GetLeftSafe(), obj.Padding.GetTopSafe(), obj.Padding.GetRightSafe(), bottom)); } /// diff --git a/src/Spectre.Console/Extensions/PaddingExtensions.cs b/src/Spectre.Console/Extensions/PaddingExtensions.cs new file mode 100644 index 0000000..beccd8e --- /dev/null +++ b/src/Spectre.Console/Extensions/PaddingExtensions.cs @@ -0,0 +1,48 @@ +namespace Spectre.Console +{ + /// + /// Contains extension methods for . + /// + public static class PaddingExtensions + { + /// + /// Gets the left padding. + /// + /// The padding. + /// The left padding or zero if padding is null. + public static int GetLeftSafe(this Padding? padding) + { + return padding?.Left ?? 0; + } + + /// + /// Gets the right padding. + /// + /// The padding. + /// The right padding or zero if padding is null. + public static int GetRightSafe(this Padding? padding) + { + return padding?.Right ?? 0; + } + + /// + /// Gets the top padding. + /// + /// The padding. + /// The top padding or zero if padding is null. + public static int GetTopSafe(this Padding? padding) + { + return padding?.Top ?? 0; + } + + /// + /// Gets the bottom padding. + /// + /// The padding. + /// The bottom padding or zero if padding is null. + public static int GetBottomSafe(this Padding? padding) + { + return padding?.Bottom ?? 0; + } + } +} diff --git a/src/Spectre.Console/Extensions/TableExtensions.cs b/src/Spectre.Console/Extensions/TableExtensions.cs index 3f93b06..9535b06 100644 --- a/src/Spectre.Console/Extensions/TableExtensions.cs +++ b/src/Spectre.Console/Extensions/TableExtensions.cs @@ -36,6 +36,22 @@ namespace Spectre.Console return table; } + /// + /// Adds a row to the table. + /// + /// The table to add the row to. + /// The row columns to add. + /// The same instance so that multiple calls can be chained. + public static Table AddRow(this Table table, params IRenderable[] columns) + { + if (table is null) + { + throw new ArgumentNullException(nameof(table)); + } + + return table.AddRow(columns); + } + /// /// Adds an empty row to the table. /// @@ -48,8 +64,8 @@ namespace Spectre.Console throw new ArgumentNullException(nameof(table)); } - var columns = new IRenderable[table.ColumnCount]; - Enumerable.Range(0, table.ColumnCount).ForEach(index => columns[index] = Text.Empty); + var columns = new IRenderable[table.Columns.Count]; + Enumerable.Range(0, table.Columns.Count).ForEach(index => columns[index] = Text.Empty); table.AddRow(columns); return table; } diff --git a/src/Spectre.Console/IColumn.cs b/src/Spectre.Console/IColumn.cs index 60ed9d0..824bf21 100644 --- a/src/Spectre.Console/IColumn.cs +++ b/src/Spectre.Console/IColumn.cs @@ -10,5 +10,10 @@ namespace Spectre.Console /// or not wrapping should be prevented. /// bool NoWrap { get; set; } + + /// + /// Gets or sets the width of the column. + /// + int? Width { get; set; } } } diff --git a/src/Spectre.Console/IPaddable.cs b/src/Spectre.Console/IPaddable.cs index b9b56ea..4476f3f 100644 --- a/src/Spectre.Console/IPaddable.cs +++ b/src/Spectre.Console/IPaddable.cs @@ -8,6 +8,6 @@ namespace Spectre.Console /// /// Gets or sets the padding. /// - public Padding Padding { get; set; } + public Padding? Padding { get; set; } } } diff --git a/src/Spectre.Console/Internal/Collections/ListWithCallback.cs b/src/Spectre.Console/Internal/Collections/ListWithCallback.cs index 50dfe41..180899f 100644 --- a/src/Spectre.Console/Internal/Collections/ListWithCallback.cs +++ b/src/Spectre.Console/Internal/Collections/ListWithCallback.cs @@ -4,7 +4,7 @@ using System.Collections.Generic; namespace Spectre.Console.Internal.Collections { - internal sealed class ListWithCallback : IList + internal sealed class ListWithCallback : IList, IReadOnlyList { private readonly List _list; private readonly Action _callback; diff --git a/src/Spectre.Console/Internal/Extensions/EnumerableExtensions.cs b/src/Spectre.Console/Internal/Extensions/EnumerableExtensions.cs index 0529de4..c1028a8 100644 --- a/src/Spectre.Console/Internal/Extensions/EnumerableExtensions.cs +++ b/src/Spectre.Console/Internal/Extensions/EnumerableExtensions.cs @@ -6,6 +6,21 @@ namespace Spectre.Console.Internal { internal static class EnumerableExtensions { + public static int GetCount(this IEnumerable source) + { + if (source is IList list) + { + return list.Count; + } + + if (source is T[] array) + { + return array.Length; + } + + return source.Count(); + } + public static void ForEach(this IEnumerable source, Action action) { foreach (var item in source) diff --git a/src/Spectre.Console/Rendering/Borders/Tables/MarkdownTableBorder.cs b/src/Spectre.Console/Rendering/Borders/Tables/MarkdownTableBorder.cs index 6654f68..3420ec9 100644 --- a/src/Spectre.Console/Rendering/Borders/Tables/MarkdownTableBorder.cs +++ b/src/Spectre.Console/Rendering/Borders/Tables/MarkdownTableBorder.cs @@ -63,10 +63,10 @@ namespace Spectre.Console.Rendering { var padding = columns[columnIndex].Padding; - if (padding.Left > 0) + if (padding != null && padding.Value.Left > 0) { // Left padding - builder.Append(" ".Repeat(padding.Left)); + builder.Append(" ".Repeat(padding.Value.Left)); } var justification = columns[columnIndex].Alignment; @@ -96,9 +96,9 @@ namespace Spectre.Console.Rendering } // Right padding - if (padding.Right > 0) + if (padding != null && padding.Value.Right > 0) { - builder.Append(" ".Repeat(padding.Right)); + builder.Append(" ".Repeat(padding.Value.Right)); } if (!lastColumn) diff --git a/src/Spectre.Console/Rendering/IHasDirtyState.cs b/src/Spectre.Console/Rendering/IHasDirtyState.cs new file mode 100644 index 0000000..76660f7 --- /dev/null +++ b/src/Spectre.Console/Rendering/IHasDirtyState.cs @@ -0,0 +1,13 @@ +namespace Spectre.Console.Rendering +{ + /// + /// Represents something that can be dirty. + /// + public interface IHasDirtyState + { + /// + /// Gets a value indicating whether the object is dirty. + /// + bool IsDirty { get; } + } +} diff --git a/src/Spectre.Console/Rendering/JustInTimeRenderable.cs b/src/Spectre.Console/Rendering/JustInTimeRenderable.cs new file mode 100644 index 0000000..5d223b6 --- /dev/null +++ b/src/Spectre.Console/Rendering/JustInTimeRenderable.cs @@ -0,0 +1,79 @@ +using System; +using System.Collections.Generic; + +namespace Spectre.Console.Rendering +{ + /// + /// Represents something renderable that's reconstructed + /// when it's state change in any way. + /// + public abstract class JustInTimeRenderable : Renderable + { + private bool _dirty; + private IRenderable? _rendered; + + /// + protected sealed override Measurement Measure(RenderContext context, int maxWidth) + { + return GetInner().Measure(context, maxWidth); + } + + /// + protected sealed override IEnumerable Render(RenderContext context, int width) + { + return GetInner().Render(context, width); + } + + /// + /// Builds the inner renderable. + /// + /// A new inner renderable. + protected abstract IRenderable Build(); + + /// + /// Checks if there are any children that has changed. + /// If so, the underlying renderable needs rebuilding. + /// + /// true if the object needs rebuilding, otherwise false. + protected virtual bool HasDirtyChildren() + { + return false; + } + + /// + /// Marks this instance as dirty. + /// + protected void MarkAsDirty() + { + _dirty = true; + } + + /// + /// Marks this instance as dirty. + /// + /// + /// The action to execute before marking the instance as dirty. + /// + protected void MarkAsDirty(Action action) + { + if (action is null) + { + throw new ArgumentNullException(nameof(action)); + } + + action(); + _dirty = true; + } + + private IRenderable GetInner() + { + if (_dirty || HasDirtyChildren() || _rendered == null) + { + _rendered = Build(); + _dirty = false; + } + + return _rendered; + } + } +} diff --git a/src/Spectre.Console/TableBorder.cs b/src/Spectre.Console/TableBorder.cs index 544d7b9..531bc75 100644 --- a/src/Spectre.Console/TableBorder.cs +++ b/src/Spectre.Console/TableBorder.cs @@ -55,7 +55,7 @@ namespace Spectre.Console foreach (var (columnIndex, _, lastColumn, columnWidth) in widths.Enumerate()) { var padding = columns[columnIndex].Padding; - var centerWidth = padding.Left + columnWidth + padding.Right; + var centerWidth = padding.GetLeftSafe() + columnWidth + padding.GetRightSafe(); builder.Append(center.Repeat(centerWidth)); if (!lastColumn) diff --git a/src/Spectre.Console/Widgets/Calendar.cs b/src/Spectre.Console/Widgets/Calendar.cs index 57eede5..059b1a7 100644 --- a/src/Spectre.Console/Widgets/Calendar.cs +++ b/src/Spectre.Console/Widgets/Calendar.cs @@ -11,7 +11,7 @@ namespace Spectre.Console /// /// A renderable calendar. /// - public sealed class Calendar : Renderable, IHasCulture, IHasTableBorder, IAlignable + public sealed class Calendar : JustInTimeRenderable, IHasCulture, IHasTableBorder, IAlignable { private const int NumberOfWeekDays = 7; private const int ExpectedRowCount = 6; @@ -21,11 +21,9 @@ namespace Spectre.Console private int _year; private int _month; private int _day; - private IRenderable? _table; private TableBorder _border; private bool _useSafeBorder; private Style? _borderStyle; - private bool _dirty; private CultureInfo _culture; private Style _highlightStyle; private bool _showHeader; @@ -158,43 +156,17 @@ namespace Spectre.Console _year = year; _month = month; _day = day; - _table = null; _border = TableBorder.Square; _useSafeBorder = true; _borderStyle = null; - _dirty = true; _culture = CultureInfo.InvariantCulture; _highlightStyle = new Style(foreground: Color.Blue); _showHeader = true; - _calendarEvents = new ListWithCallback(() => _dirty = true); + _calendarEvents = new ListWithCallback(() => MarkAsDirty()); } /// - protected override Measurement Measure(RenderContext context, int maxWidth) - { - var table = GetTable(); - return table.Measure(context, maxWidth); - } - - /// - protected override IEnumerable Render(RenderContext context, int maxWidth) - { - return GetTable().Render(context, maxWidth); - } - - private IRenderable GetTable() - { - // Table needs to be built? - if (_dirty || _table == null) - { - _table = BuildTable(); - _dirty = false; - } - - return _table; - } - - private IRenderable BuildTable() + protected override IRenderable Build() { var culture = Culture ?? CultureInfo.InvariantCulture; @@ -264,9 +236,9 @@ namespace Spectre.Console } // We want all calendars to have the same height. - if (table.RowCount < ExpectedRowCount) + if (table.Rows.Count < ExpectedRowCount) { - var diff = Math.Max(0, ExpectedRowCount - table.RowCount); + var diff = Math.Max(0, ExpectedRowCount - table.Rows.Count); for (var i = 0; i < diff; i++) { table.AddEmptyRow(); @@ -276,12 +248,6 @@ namespace Spectre.Console return table; } - private void MarkAsDirty(Action action) - { - action(); - _dirty = true; - } - private DayOfWeek[] GetWeekdays() { var culture = Culture ?? CultureInfo.InvariantCulture; diff --git a/src/Spectre.Console/Widgets/Columns.cs b/src/Spectre.Console/Widgets/Columns.cs index ff1e60f..013278c 100644 --- a/src/Spectre.Console/Widgets/Columns.cs +++ b/src/Spectre.Console/Widgets/Columns.cs @@ -13,7 +13,7 @@ namespace Spectre.Console private readonly List _items; /// - public Padding Padding { get; set; } = new Padding(0, 0, 1, 0); + public Padding? Padding { get; set; } = new Padding(0, 0, 1, 0); /// /// Gets or sets a value indicating whether or not the columns should @@ -62,7 +62,7 @@ namespace Spectre.Console /// protected override Measurement Measure(RenderContext context, int maxWidth) { - var maxPadding = Math.Max(Padding.Left, Padding.Right); + var maxPadding = Math.Max(Padding.GetLeftSafe(), Padding.GetRightSafe()); var itemWidths = _items.Select(item => item.Measure(context, maxWidth).Max).ToArray(); var columnCount = CalculateColumnCount(maxWidth, itemWidths, _items.Count, maxPadding); @@ -90,7 +90,7 @@ namespace Spectre.Console /// protected override IEnumerable Render(RenderContext context, int maxWidth) { - var maxPadding = Math.Max(Padding.Left, Padding.Right); + var maxPadding = Math.Max(Padding.GetLeftSafe(), Padding.GetRightSafe()); var itemWidths = _items.Select(item => item.Measure(context, maxWidth).Max).ToArray(); var columnCount = CalculateColumnCount(maxWidth, itemWidths, _items.Count, maxPadding); diff --git a/src/Spectre.Console/Widgets/Grid.cs b/src/Spectre.Console/Widgets/Grid.cs index b11b3de..0403e72 100644 --- a/src/Spectre.Console/Widgets/Grid.cs +++ b/src/Spectre.Console/Widgets/Grid.cs @@ -1,5 +1,7 @@ using System; using System.Collections.Generic; +using System.Linq; +using Spectre.Console.Internal.Collections; using Spectre.Console.Rendering; namespace Spectre.Console @@ -7,32 +9,37 @@ namespace Spectre.Console /// /// A renderable grid. /// - public sealed class Grid : Renderable, IExpandable, IAlignable + public sealed class Grid : JustInTimeRenderable, IExpandable, IAlignable { - private readonly Table _table; + private readonly ListWithCallback _columns; + private readonly ListWithCallback _rows; + + private bool _expand; + private Justify? _alignment; + private bool _padRightCell; /// - /// Gets the number of columns in the table. + /// Gets the grid columns. /// - public int ColumnCount => _table.ColumnCount; + public IReadOnlyList Columns => _columns; /// - /// Gets the number of rows in the table. + /// Gets the grid rows. /// - public int RowCount => _table.RowCount; + public IReadOnlyList Rows => _rows; /// public bool Expand { - get => _table.Expand; - set => _table.Expand = value; + get => _expand; + set => MarkAsDirty(() => _expand = value); } /// public Justify? Alignment { - get => _table.Alignment; - set => _table.Alignment = value; + get => _alignment; + set => MarkAsDirty(() => _alignment = value); } /// @@ -40,25 +47,10 @@ namespace Spectre.Console /// public Grid() { - _table = new Table - { - Border = TableBorder.None, - ShowHeaders = false, - IsGrid = true, - PadRightCell = false, - }; - } - - /// - protected override Measurement Measure(RenderContext context, int maxWidth) - { - return ((IRenderable)_table).Measure(context, maxWidth); - } - - /// - protected override IEnumerable Render(RenderContext context, int width) - { - return ((IRenderable)_table).Render(context, width); + _expand = false; + _alignment = null; + _columns = new ListWithCallback(() => MarkAsDirty()); + _rows = new ListWithCallback(() => MarkAsDirty()); } /// @@ -83,21 +75,15 @@ namespace Spectre.Console throw new ArgumentNullException(nameof(column)); } - if (_table.RowCount > 0) + if (_rows.Count > 0) { throw new InvalidOperationException("Cannot add new columns to grid with existing rows."); } // Only pad the most right cell if we've explicitly set a padding. - _table.PadRightCell = column.HasExplicitPadding; + _padRightCell = column.HasExplicitPadding; - _table.AddColumn(new TableColumn(string.Empty) - { - Width = column.Width, - NoWrap = column.NoWrap, - Padding = column.Padding, - Alignment = column.Alignment, - }); + _columns.Add(column); return this; } @@ -114,13 +100,49 @@ namespace Spectre.Console throw new ArgumentNullException(nameof(columns)); } - if (columns.Length > _table.ColumnCount) + if (columns.Length > _columns.Count) { throw new InvalidOperationException("The number of row columns are greater than the number of grid columns."); } - _table.AddRow(columns); + _rows.Add(new GridRow(columns)); return this; } + + /// + protected override bool HasDirtyChildren() + { + return _columns.Any(c => ((IHasDirtyState)c).IsDirty); + } + + /// + protected override IRenderable Build() + { + var table = new Table + { + Border = TableBorder.None, + ShowHeaders = false, + IsGrid = true, + PadRightCell = _padRightCell, + }; + + foreach (var column in _columns) + { + table.AddColumn(new TableColumn(string.Empty) + { + Width = column.Width, + NoWrap = column.NoWrap, + Padding = column.Padding ?? new Padding(0, 0, 2, 0), + Alignment = column.Alignment, + }); + } + + foreach (var row in _rows) + { + table.AddRow(row); + } + + return table; + } } } diff --git a/src/Spectre.Console/Widgets/GridColumn.cs b/src/Spectre.Console/Widgets/GridColumn.cs index e16cd6e..5418832 100644 --- a/src/Spectre.Console/Widgets/GridColumn.cs +++ b/src/Spectre.Console/Widgets/GridColumn.cs @@ -1,55 +1,71 @@ +using System; +using Spectre.Console.Rendering; + namespace Spectre.Console { /// /// Represents a grid column. /// - public sealed class GridColumn : IColumn + public sealed class GridColumn : IColumn, IHasDirtyState { - private Padding _padding; + private bool _isDirty; + private int? _width; + private bool _noWrap; + private Padding? _padding; + private Justify? _alignment; + + /// + bool IHasDirtyState.IsDirty => _isDirty; /// /// Gets or sets the width of the column. /// If null, the column will adapt to it's contents. /// - public int? Width { get; set; } + public int? Width + { + get => _width; + set => MarkAsDirty(() => _width = value); + } /// /// Gets or sets a value indicating whether wrapping of /// text within the column should be prevented. /// - public bool NoWrap { get; set; } + public bool NoWrap + { + get => _noWrap; + set => MarkAsDirty(() => _noWrap = value); + } /// /// Gets or sets the padding of the column. /// Vertical padding (top and bottom) is ignored. /// - public Padding Padding + public Padding? Padding { get => _padding; - set - { - HasExplicitPadding = true; - _padding = value; - } + set => MarkAsDirty(() => _padding = value); } /// /// Gets or sets the alignment of the column. /// - public Justify? Alignment { get; set; } + public Justify? Alignment + { + get => _alignment; + set => MarkAsDirty(() => _alignment = value); + } /// /// Gets a value indicating whether the user /// has set an explicit padding for this column. /// - internal bool HasExplicitPadding { get; private set; } + internal bool HasExplicitPadding => Padding != null; - /// - /// Initializes a new instance of the class. - /// - public GridColumn() + private void MarkAsDirty(Action action) { - _padding = new Padding(0, 0, 2, 0); + action(); + _isDirty = true; } } } diff --git a/src/Spectre.Console/Widgets/GridRow.cs b/src/Spectre.Console/Widgets/GridRow.cs new file mode 100644 index 0000000..860de80 --- /dev/null +++ b/src/Spectre.Console/Widgets/GridRow.cs @@ -0,0 +1,56 @@ +using System; +using System.Collections; +using System.Collections.Generic; +using Spectre.Console.Rendering; + +namespace Spectre.Console +{ + /// + /// Represents a grid row. + /// + public sealed class GridRow : IEnumerable + { + private readonly List _items; + + /// + /// Gets a row item at the specified grid column index. + /// + /// The grid column index. + /// The row item at the specified grid column index. + public IRenderable this[int index] + { + get => _items[index]; + } + + /// + /// Initializes a new instance of the class. + /// + /// The row items. + public GridRow(IEnumerable items) + { + _items = new List(items ?? Array.Empty()); + } + + internal void Add(IRenderable item) + { + if (item is null) + { + throw new ArgumentNullException(nameof(item)); + } + + _items.Add(item); + } + + /// + public IEnumerator GetEnumerator() + { + return _items.GetEnumerator(); + } + + /// + IEnumerator IEnumerable.GetEnumerator() + { + return GetEnumerator(); + } + } +} diff --git a/src/Spectre.Console/Widgets/Padder.cs b/src/Spectre.Console/Widgets/Padder.cs index bba0a4b..e34e992 100644 --- a/src/Spectre.Console/Widgets/Padder.cs +++ b/src/Spectre.Console/Widgets/Padder.cs @@ -12,7 +12,7 @@ namespace Spectre.Console private readonly IRenderable _child; /// - public Padding Padding { get; set; } = new Padding(1, 1, 1, 1); + public Padding? Padding { get; set; } = new Padding(1, 1, 1, 1); /// /// Gets or sets a value indicating whether or not the padding should @@ -35,7 +35,7 @@ namespace Spectre.Console /// protected override Measurement Measure(RenderContext context, int maxWidth) { - var paddingWidth = Padding.GetWidth(); + var paddingWidth = Padding?.GetWidth() ?? 0; var measurement = _child.Measure(context, maxWidth - paddingWidth); return new Measurement( @@ -46,7 +46,7 @@ namespace Spectre.Console /// protected override IEnumerable Render(RenderContext context, int maxWidth) { - var paddingWidth = Padding.GetWidth(); + var paddingWidth = Padding?.GetWidth() ?? 0; var childWidth = maxWidth - paddingWidth; if (!Expand) @@ -59,7 +59,7 @@ namespace Spectre.Console var result = new List(); // Top padding - for (var i = 0; i < Padding.Top; i++) + for (var i = 0; i < Padding.GetTopSafe(); i++) { result.Add(new Segment(new string(' ', width))); result.Add(Segment.LineBreak); @@ -69,22 +69,22 @@ namespace Spectre.Console foreach (var (_, _, _, line) in Segment.SplitLines(context, child).Enumerate()) { // Left padding - if (Padding.Left != 0) + if (Padding.GetLeftSafe() != 0) { - result.Add(new Segment(new string(' ', Padding.Left))); + result.Add(new Segment(new string(' ', Padding.GetLeftSafe()))); } result.AddRange(line); // Right padding - if (Padding.Right != 0) + if (Padding.GetRightSafe() != 0) { - result.Add(new Segment(new string(' ', Padding.Right))); + result.Add(new Segment(new string(' ', Padding.GetRightSafe()))); } // Missing space on right side? var lineWidth = line.CellCount(context); - var diff = width - lineWidth - Padding.Left - Padding.Right; + var diff = width - lineWidth - Padding.GetLeftSafe() - Padding.GetRightSafe(); if (diff > 0) { result.Add(new Segment(new string(' ', diff))); @@ -94,7 +94,7 @@ namespace Spectre.Console } // Bottom padding - for (var i = 0; i < Padding.Bottom; i++) + for (var i = 0; i < Padding.GetBottomSafe(); i++) { result.Add(new Segment(new string(' ', width))); result.Add(Segment.LineBreak); diff --git a/src/Spectre.Console/Widgets/Panel.cs b/src/Spectre.Console/Widgets/Panel.cs index 1755085..e429176 100644 --- a/src/Spectre.Console/Widgets/Panel.cs +++ b/src/Spectre.Console/Widgets/Panel.cs @@ -34,7 +34,7 @@ namespace Spectre.Console /// /// Gets or sets the padding. /// - public Padding Padding { get; set; } = new Padding(1, 0, 1, 0); + public Padding? Padding { get; set; } = new Padding(1, 0, 1, 0); /// /// Gets or sets the header. diff --git a/src/Spectre.Console/Widgets/Table.cs b/src/Spectre.Console/Widgets/Table.cs index 0208dce..673cb78 100644 --- a/src/Spectre.Console/Widgets/Table.cs +++ b/src/Spectre.Console/Widgets/Table.cs @@ -3,6 +3,7 @@ using System.Collections.Generic; using System.Linq; using Spectre.Console.Internal; using Spectre.Console.Rendering; +using Spectre.Console.Widgets; namespace Spectre.Console { @@ -14,20 +15,20 @@ namespace Spectre.Console private const int EdgeCount = 2; private readonly List _columns; - private readonly List> _rows; + private readonly List _rows; private static Style _defaultHeadingStyle = new Style(Color.Silver); private static Style _defaultCaptionStyle = new Style(Color.Grey); /// - /// Gets the number of columns in the table. + /// Gets the table columns. /// - public int ColumnCount => _columns.Count; + public IReadOnlyList Columns => _columns; /// - /// Gets the number of rows in the table. + /// Gets the table rows. /// - public int RowCount => _rows.Count; + public IReadOnlyList Rows => _rows; /// public TableBorder Border { get; set; } = TableBorder.Square; @@ -87,7 +88,7 @@ namespace Spectre.Console public Table() { _columns = new List(); - _rows = new List>(); + _rows = new List(); } /// @@ -116,24 +117,25 @@ namespace Spectre.Console /// /// The row columns to add. /// The same instance so that multiple calls can be chained. - public Table AddRow(params IRenderable[] columns) + public Table AddRow(IEnumerable columns) { if (columns is null) { throw new ArgumentNullException(nameof(columns)); } - if (columns.Length > _columns.Count) + var rowColumnCount = columns.GetCount(); + if (rowColumnCount > _columns.Count) { throw new InvalidOperationException("The number of row columns are greater than the number of table columns."); } - _rows.Add(columns.ToList()); + _rows.Add(new TableRow(columns)); // Need to add missing columns? - if (columns.Length < _columns.Count) + if (rowColumnCount < _columns.Count) { - var diff = _columns.Count - columns.Length; + var diff = _columns.Count - rowColumnCount; Enumerable.Range(0, diff).ForEach(_ => _rows.Last().Add(Text.Empty)); } @@ -198,11 +200,11 @@ namespace Spectre.Console return new List(new[] { new Segment("…", BorderStyle ?? Style.Plain) }); } - var rows = new List>(); + var rows = new List(); if (ShowHeaders) { // Add columns to top of rows - rows.Add(new List(_columns.Select(c => c.Header))); + rows.Add(new TableRow(new List(_columns.Select(c => c.Header)))); } // Add rows. @@ -210,7 +212,7 @@ namespace Spectre.Console if (hasFooters) { - rows.Add(new List(_columns.Select(c => c.Footer ?? Text.Empty))); + rows.Add(new TableRow(new List(_columns.Select(c => c.Footer ?? Text.Empty)))); } var result = new List(); @@ -273,7 +275,7 @@ namespace Spectre.Console // Pad column on left side. if (showBorder || IsGrid) { - var leftPadding = _columns[cellIndex].Padding.Left; + var leftPadding = _columns[cellIndex].Padding.GetLeftSafe(); if (leftPadding > 0) { rowResult.Add(new Segment(new string(' ', leftPadding))); @@ -293,7 +295,7 @@ namespace Spectre.Console // Pad column on the right side if (showBorder || (hideBorder && !lastCell) || (hideBorder && lastCell && IsGrid && PadRightCell)) { - var rightPadding = _columns[cellIndex].Padding.Right; + var rightPadding = _columns[cellIndex].Padding.GetRightSafe(); if (rightPadding > 0) { rowResult.Add(new Segment(new string(' ', rightPadding))); @@ -446,7 +448,7 @@ namespace Spectre.Console private (int Min, int Max) MeasureColumn(TableColumn column, RenderContext options, int maxWidth) { - var padding = column.Padding.GetWidth(); + var padding = column.Padding?.GetWidth() ?? 0; // Predetermined width? if (column.Width != null) @@ -482,11 +484,11 @@ namespace Spectre.Console var hideBorder = !Border.Visible; var separators = hideBorder ? 0 : _columns.Count - 1; var edges = hideBorder ? 0 : EdgeCount; - var padding = includePadding ? _columns.Select(x => x.Padding.GetWidth()).Sum() : 0; + var padding = includePadding ? _columns.Select(x => x.Padding?.GetWidth() ?? 0).Sum() : 0; if (!PadRightCell) { - padding -= _columns.Last().Padding.Right; + padding -= _columns.Last().Padding.GetRightSafe(); } return separators + edges + padding; diff --git a/src/Spectre.Console/Widgets/TableColumn.cs b/src/Spectre.Console/Widgets/TableColumn.cs index 91bba5a..6f4d938 100644 --- a/src/Spectre.Console/Widgets/TableColumn.cs +++ b/src/Spectre.Console/Widgets/TableColumn.cs @@ -28,7 +28,7 @@ namespace Spectre.Console /// Gets or sets the padding of the column. /// Vertical padding (top and bottom) is ignored. /// - public Padding Padding { get; set; } + public Padding? Padding { get; set; } /// /// Gets or sets a value indicating whether wrapping of diff --git a/src/Spectre.Console/Widgets/TableRow.cs b/src/Spectre.Console/Widgets/TableRow.cs new file mode 100644 index 0000000..a491148 --- /dev/null +++ b/src/Spectre.Console/Widgets/TableRow.cs @@ -0,0 +1,56 @@ +using System; +using System.Collections; +using System.Collections.Generic; +using Spectre.Console.Rendering; + +namespace Spectre.Console.Widgets +{ + /// + /// Represents a table row. + /// + public sealed class TableRow : IEnumerable + { + private readonly List _items; + + /// + /// Gets a row item at the specified table column index. + /// + /// The table column index. + /// The row item at the specified table column index. + public IRenderable this[int index] + { + get => _items[index]; + } + + /// + /// Initializes a new instance of the class. + /// + /// The row items. + public TableRow(IEnumerable items) + { + _items = new List(items ?? Array.Empty()); + } + + internal void Add(IRenderable item) + { + if (item is null) + { + throw new ArgumentNullException(nameof(item)); + } + + _items.Add(item); + } + + /// + public IEnumerator GetEnumerator() + { + return _items.GetEnumerator(); + } + + /// + IEnumerator IEnumerable.GetEnumerator() + { + return GetEnumerator(); + } + } +}