spectre.console/src/Spectre.Console/Widgets/Table/Table.cs

using System;
using System.Collections.Generic;
using System.Linq;
using Spectre.Console.Rendering;

namespace Spectre.Console
{
    /// <summary>
    /// A renderable table.
    /// </summary>
    public sealed class Table : Renderable, IHasTableBorder, IExpandable, IAlignable
    {
        private readonly List<TableColumn> _columns;

        /// <summary>
        /// Gets the table columns.
        /// </summary>
        public IReadOnlyList<TableColumn> Columns => _columns;

        /// <summary>
        /// Gets the table rows.
        /// </summary>
        public TableRowCollection Rows { get; }

        /// <inheritdoc/>
        public TableBorder Border { get; set; } = TableBorder.Square;

        /// <inheritdoc/>
        public Style? BorderStyle { get; set; }

        /// <inheritdoc/>
        public bool UseSafeBorder { get; set; } = true;

        /// <summary>
        /// Gets or sets a value indicating whether or not table headers should be shown.
        /// </summary>
        public bool ShowHeaders { get; set; } = true;

        /// <summary>
        /// Gets or sets a value indicating whether or not table footers should be shown.
        /// </summary>
        public bool ShowFooters { get; set; } = true;

        /// <summary>
        /// Gets or sets a value indicating whether or not the table should
        /// fit the available space. If <c>false</c>, the table width will be
        /// auto calculated. Defaults to <c>false</c>.
        /// </summary>
        public bool Expand { get; set; }

        /// <summary>
        /// Gets or sets the width of the table.
        /// </summary>
        public int? Width { get; set; }

        /// <summary>
        /// Gets or sets the table title.
        /// </summary>
        public TableTitle? Title { get; set; }

        /// <summary>
        /// Gets or sets the table footnote.
        /// </summary>
        public TableTitle? Caption { get; set; }

        /// <inheritdoc/>
        public Justify? Alignment { get; set; }

        // Whether this is a grid or not.
        internal bool IsGrid { get; set; }

        // Whether or not the most right cell should be padded.
        // This is almost always the case, unless we're rendering
        // a grid without explicit padding in the last cell.
        internal bool PadRightCell { get; set; } = true;

        /// <summary>
        /// Initializes a new instance of the <see cref="Table"/> class.
        /// </summary>
        public Table()
        {
            _columns = new List<TableColumn>();
            Rows = new TableRowCollection(this);
        }

        /// <summary>
        /// Adds a column to the table.
        /// </summary>
        /// <param name="column">The column to add.</param>
        /// <returns>The same instance so that multiple calls can be chained.</returns>
        public Table AddColumn(TableColumn column)
        {
            if (column is null)
            {
                throw new ArgumentNullException(nameof(column));
            }

            if (Rows.Count > 0)
            {
                throw new InvalidOperationException("Cannot add new columns to table with existing rows.");
            }

            _columns.Add(column);
            return this;
        }

        /// <inheritdoc/>
        protected override Measurement Measure(RenderContext context, int maxWidth)
        {
            if (context is null)
            {
                throw new ArgumentNullException(nameof(context));
            }

            var measurer = new TableMeasurer(this, context);

            // Calculate the total cell width
            var totalCellWidth = measurer.CalculateTotalCellWidth(maxWidth);

            // Calculate the minimum and maximum table width
            var measurements = _columns.Select(column => measurer.MeasureColumn(column, totalCellWidth));
            var minTableWidth = measurements.Sum(x => x.Min) + measurer.GetNonColumnWidth();
            var maxTableWidth = Width ?? measurements.Sum(x => x.Max) + measurer.GetNonColumnWidth();
            return new Measurement(minTableWidth, maxTableWidth);
        }

        /// <inheritdoc/>
        protected override IEnumerable<Segment> Render(RenderContext context, int maxWidth)
        {
            if (context is null)
            {
                throw new ArgumentNullException(nameof(context));
            }

            var measurer = new TableMeasurer(this, context);

            // Calculate the column and table width
            var totalCellWidth = measurer.CalculateTotalCellWidth(maxWidth);
            var columnWidths = measurer.CalculateColumnWidths(totalCellWidth);
            var tableWidth = columnWidths.Sum() + measurer.GetNonColumnWidth();

            // Get the rows to render
            var rows = GetRenderableRows();

            // Render the table
            return TableRenderer.Render(
                new TableRendererContext(this, context, rows, tableWidth, maxWidth),
                columnWidths);
        }

        private List<TableRow> GetRenderableRows()
        {
            var rows = new List<TableRow>();

            // Show headers?
            if (ShowHeaders)
            {
                rows.Add(TableRow.Header(_columns.Select(c => c.Header)));
            }

            // Add rows
            rows.AddRange(Rows);

            // Show footers?
            if (ShowFooters && _columns.Any(c => c.Footer != null))
            {
                rows.Add(TableRow.Footer(_columns.Select(c => c.Footer ?? Text.Empty)));
            }

            return rows;
        }
    }
}