using NStack;
using System;
using System.Collections.Generic;
using System.Data;
using System.Linq;
namespace Terminal.Gui.Views {
///
/// Defines rendering options that affect how the table is displayed
///
public class TableStyle {
///
/// When scrolling down always lock the column headers in place as the first row of the table
///
public bool AlwaysShowHeaders {get;set;} = false;
///
/// True to render a solid line above the headers
///
public bool ShowHorizontalHeaderOverline {get;set;} = true;
///
/// True to render a solid line under the headers
///
public bool ShowHorizontalHeaderUnderline {get;set;} = true;
///
/// True to render a solid line vertical line between cells
///
public bool ShowVerticalCellLines {get;set;} = true;
///
/// True to render a solid line vertical line between headers
///
public bool ShowVerticalHeaderLines {get;set;} = true;
}
///
/// View for tabular data based on a
///
public class TableView : View {
private int columnOffset;
private int rowOffset;
private int selectedRow;
private int selectedColumn;
private DataTable table;
private TableStyle style = new TableStyle();
///
/// The data table to render in the view. Setting this property automatically updates and redraws the control.
///
public DataTable Table { get => table; set {table = value; Update(); } }
///
/// Contains options for changing how the table is rendered
///
public TableStyle Style { get => style; set {style = value; Update(); } }
///
/// Zero indexed offset for the upper left to display in .
///
/// This property allows very wide tables to be rendered with horizontal scrolling
public int ColumnOffset {
get => columnOffset;
//try to prevent this being set to an out of bounds column
set => columnOffset = Table == null ? 0 : Math.Min (Table.Columns.Count - 1, Math.Max (0, value));
}
///
/// Zero indexed offset for the to display in on line 2 of the control (first line being headers)
///
/// This property allows very wide tables to be rendered with horizontal scrolling
public int RowOffset {
get => rowOffset;
set => rowOffset = Table == null ? 0 : Math.Min (Table.Rows.Count - 1, Math.Max (0, value));
}
///
/// The index of in that the user has currently selected
///
public int SelectedColumn {
get => selectedColumn;
//try to prevent this being set to an out of bounds column
set => selectedColumn = Table == null ? 0 : Math.Min (Table.Columns.Count - 1, Math.Max (0, value));
}
///
/// The index of in that the user has currently selected
///
public int SelectedRow {
get => selectedRow;
set => selectedRow = Table == null ? 0 : Math.Min (Table.Rows.Count - 1, Math.Max (0, value));
}
///
/// The maximum number of characters to render in any given column. This prevents one long column from pushing out all the others
///
public int MaximumCellWidth { get; set; } = 100;
///
/// The text representation that should be rendered for cells with the value
///
public string NullSymbol { get; set; } = "-";
///
/// The symbol to add after each cell value and header value to visually seperate values (if not using vertical gridlines)
///
public char SeparatorSymbol { get; set; } = ' ';
///
/// Initialzies a class using layout.
///
/// The table to display in the control
public TableView (DataTable table) : this ()
{
this.Table = table;
}
///
/// Initialzies a class using layout. Set the property to begin editing
///
public TableView () : base ()
{
CanFocus = true;
}
///
public override void Redraw (Rect bounds)
{
Move (0, 0);
var frame = Frame;
// What columns to render at what X offset in viewport
Dictionary columnsToRender = CalculateViewport (bounds);
Driver.SetAttribute (ColorScheme.Normal);
//invalidate current row (prevents scrolling around leaving old characters in the frame
Driver.AddStr (new string (' ', bounds.Width));
int line = 0;
if(ShouldRenderHeaders()){
// Render something like:
/*
┌────────────────────┬──────────┬───────────┬──────────────┬─────────┐
│ArithmeticComparator│chi │Healthboard│Interpretation│Labnumber│
└────────────────────┴──────────┴───────────┴──────────────┴─────────┘
*/
if(Style.ShowHorizontalHeaderOverline){
RenderHeaderOverline(line,bounds.Width,columnsToRender);
line++;
}
RenderHeaderMidline(line,bounds.Width,columnsToRender);
line++;
if(Style.ShowHorizontalHeaderUnderline){
RenderHeaderUnderline(line,bounds.Width,columnsToRender);
line++;
}
}
//render the cells
for (; line < frame.Height; line++) {
ClearLine(line,bounds.Width);
//work out what Row to render
var rowToRender = RowOffset + (line - GetHeaderHeight());
//if we have run off the end of the table
if ( Table == null || rowToRender >= Table.Rows.Count || rowToRender < 0)
continue;
RenderRow(line,bounds.Width,rowToRender,columnsToRender);
}
}
///
/// Clears a line of the console by filling it with spaces
///
///
///
private void ClearLine(int row, int width)
{
Move (0, row);
Driver.SetAttribute (ColorScheme.Normal);
Driver.AddStr (new string (' ', width));
}
///
/// Returns the amount of vertical space required to display the header
///
///
private int GetHeaderHeight()
{
int heightRequired = 1;
if(Style.ShowHorizontalHeaderOverline)
heightRequired++;
if(Style.ShowHorizontalHeaderUnderline)
heightRequired++;
return heightRequired;
}
private void RenderHeaderOverline(int row,int availableWidth, Dictionary columnsToRender)
{
// Renders a line above table headers (when visible) like:
// ┌────────────────────┬──────────┬───────────┬──────────────┬─────────┐
for(int c = 0;c< availableWidth;c++) {
var rune = Driver.HLine;
if (Style.ShowVerticalHeaderLines){
if(c == 0){
rune = Driver.ULCorner;
}
// if the next column is the start of a header
else if(columnsToRender.Values.Contains(c+1)){
rune = Driver.TopTee;
}
else if(c == availableWidth -1){
rune = Driver.URCorner;
}
}
AddRuneAt(Driver,c,row,rune);
}
}
private void RenderHeaderMidline(int row,int availableWidth, Dictionary columnsToRender)
{
// Renders something like:
// │ArithmeticComparator│chi │Healthboard│Interpretation│Labnumber│
ClearLine(row,availableWidth);
//render start of line
if(style.ShowVerticalHeaderLines)
AddRune(0,row,Driver.VLine);
foreach (var kvp in columnsToRender) {
//where the header should start
var col = kvp.Value;
RenderSeparator(col-1,row,true);
Move (col, row);
Driver.AddStr(Truncate (kvp.Key.ColumnName, availableWidth - kvp.Value));
}
//render end of line
if(style.ShowVerticalHeaderLines)
AddRune(availableWidth-1,row,Driver.VLine);
}
private void RenderHeaderUnderline(int row,int availableWidth, Dictionary columnsToRender)
{
// Renders a line below the table headers (when visible) like:
// ├──────────┼───────────┼───────────────────┼──────────┼────────┼─────────────┤
for(int c = 0;c< availableWidth;c++) {
var rune = Driver.HLine;
if (Style.ShowVerticalHeaderLines){
if(c == 0){
rune = Style.ShowVerticalCellLines ? Driver.LeftTee : Driver.LLCorner;
}
// if the next column is the start of a header
else if(columnsToRender.Values.Contains(c+1)){
/*TODO: is ┼ symbol in Driver?*/
rune = Style.ShowVerticalCellLines ? '┼' :Driver.BottomTee;
}
else if(c == availableWidth -1){
rune = Style.ShowVerticalCellLines ? Driver.RightTee : Driver.LRCorner;
}
}
AddRuneAt(Driver,c,row,rune);
}
}
private void RenderRow(int row, int availableWidth, int rowToRender, Dictionary columnsToRender)
{
//render start of line
if(style.ShowVerticalCellLines)
AddRune(0,row,Driver.VLine);
// Render cells for each visible header for the current row
foreach (var kvp in columnsToRender) {
// move to start of cell (in line with header positions)
Move (kvp.Value, row);
// Set color scheme based on whether the current cell is the selected one
bool isSelectedCell = rowToRender == SelectedRow && kvp.Key.Ordinal == SelectedColumn;
Driver.SetAttribute (isSelectedCell ? ColorScheme.HotFocus : ColorScheme.Normal);
// Render the (possibly truncated) cell value
var valueToRender = GetRenderedVal (Table.Rows [rowToRender] [kvp.Key]);
Driver.AddStr (Truncate (valueToRender, availableWidth - kvp.Value));
// Reset color scheme to normal and render the vertical line (or space) at the end of the cell
Driver.SetAttribute (ColorScheme.Normal);
RenderSeparator(kvp.Value-1,row,false);
}
//render end of line
if(style.ShowVerticalCellLines)
AddRune(availableWidth-1,row,Driver.VLine);
}
private void RenderSeparator(int col, int row,bool isHeader)
{
if(col<0)
return;
var renderLines = isHeader ? style.ShowVerticalHeaderLines : style.ShowVerticalCellLines;
Rune symbol = renderLines ? Driver.VLine : SeparatorSymbol;
AddRune(col,row,symbol);
}
void AddRuneAt (ConsoleDriver d,int col, int row, Rune ch)
{
Move (col, row);
d.AddRune (ch);
}
///
/// Truncates so that it occupies a maximum of
///
///
///
///
private ustring Truncate (string valueToRender, int availableHorizontalSpace)
{
if (string.IsNullOrEmpty (valueToRender) || valueToRender.Length < availableHorizontalSpace)
return valueToRender;
return valueToRender.Substring (0, availableHorizontalSpace);
}
///
public override bool ProcessKey (KeyEvent keyEvent)
{
switch (keyEvent.Key) {
case Key.CursorLeft:
SelectedColumn--;
Update ();
break;
case Key.CursorRight:
SelectedColumn++;
Update ();
break;
case Key.CursorDown:
SelectedRow++;
Update ();
break;
case Key.CursorUp:
SelectedRow--;
Update ();
break;
case Key.PageUp:
SelectedRow -= Frame.Height;
Update ();
break;
case Key.PageDown:
SelectedRow += Frame.Height;
Update ();
break;
case Key.Home | Key.CtrlMask:
SelectedRow = 0;
SelectedColumn = 0;
Update ();
break;
case Key.Home:
SelectedColumn = 0;
Update ();
break;
case Key.End | Key.CtrlMask:
//jump to end of table
SelectedRow = Table == null ? 0 : Table.Rows.Count - 1;
SelectedColumn = Table == null ? 0 : Table.Columns.Count - 1;
Update ();
break;
case Key.End:
//jump to end of row
SelectedColumn = Table == null ? 0 : Table.Columns.Count - 1;
Update ();
break;
default:
// Not a keystroke we care about
return false;
}
PositionCursor ();
return true;
}
///
/// Updates the view to reflect changes to and to ( / ) etc
///
/// This always calls
public void Update()
{
if(Table == null) {
SetNeedsDisplay ();
return;
}
//if user opened a large table scrolled down a lot then opened a smaller table (or API deleted a bunch of columns without telling anyone)
ColumnOffset = Math.Max(Math.Min(ColumnOffset,Table.Columns.Count -1),0);
RowOffset = Math.Max(Math.Min(RowOffset,Table.Rows.Count -1),0);
SelectedColumn = Math.Max(Math.Min(SelectedColumn,Table.Columns.Count -1),0);
SelectedRow = Math.Max(Math.Min(SelectedRow,Table.Rows.Count -1),0);
Dictionary columnsToRender = CalculateViewport (Bounds);
var headerHeight = GetHeaderHeight();
//if we have scrolled too far to the left
if (SelectedColumn < columnsToRender.Keys.Min (col => col.Ordinal)) {
ColumnOffset = SelectedColumn;
}
//if we have scrolled too far to the right
if (SelectedColumn > columnsToRender.Keys.Max (col => col.Ordinal)) {
ColumnOffset = SelectedColumn;
}
//if we have scrolled too far down
if (SelectedRow >= RowOffset + (Bounds.Height - headerHeight)) {
RowOffset = SelectedRow;
}
//if we have scrolled too far up
if (SelectedRow < RowOffset) {
RowOffset = SelectedRow;
}
SetNeedsDisplay ();
}
///
/// Calculates which columns should be rendered given the in which to display and the
///
///
///
///
private Dictionary CalculateViewport (Rect bounds, int padding = 1)
{
Dictionary toReturn = new Dictionary ();
if(Table == null)
return toReturn;
int usedSpace = 0;
//if horizontal space is required at the start of the line (before the first header)
if(Style.ShowVerticalHeaderLines || Style.ShowVerticalCellLines)
usedSpace+=1;
int availableHorizontalSpace = bounds.Width;
int rowsToRender = bounds.Height;
// reserved for the headers row
if(ShouldRenderHeaders())
rowsToRender -= GetHeaderHeight();
bool first = true;
foreach (var col in Table.Columns.Cast().Skip (ColumnOffset)) {
int startingIdxForCurrentHeader = usedSpace;
// is there enough space for this column (and it's data)?
usedSpace += CalculateMaxRowSize (col, rowsToRender) + padding;
// no (don't render it) unless its the only column we are render (that must be one massively wide column!)
if (!first && usedSpace > availableHorizontalSpace)
return toReturn;
// there is space
toReturn.Add (col, startingIdxForCurrentHeader);
first=false;
}
return toReturn;
}
private bool ShouldRenderHeaders()
{
if(Table == null || Table.Columns.Count == 0)
return false;
return Style.AlwaysShowHeaders || rowOffset == 0;
}
///
/// Returns the maximum of the name and the maximum length of data that will be rendered starting at and rendering
///
///
///
///
private int CalculateMaxRowSize (DataColumn col, int rowsToRender)
{
int spaceRequired = col.ColumnName.Length;
// if table has no rows
if(RowOffset < 0)
return spaceRequired;
for (int i = RowOffset; i < RowOffset + rowsToRender && i < Table.Rows.Count; i++) {
//expand required space if cell is bigger than the last biggest cell or header
spaceRequired = Math.Max (spaceRequired, GetRenderedVal (Table.Rows [i] [col]).Length);
}
return spaceRequired;
}
///
/// Returns the value that should be rendered to best represent a strongly typed read from
///
///
///
private string GetRenderedVal (object value)
{
if (value == null || value == DBNull.Value) {
return NullSymbol;
}
var representation = value.ToString ();
//if it is too long to fit
if (representation.Length > MaximumCellWidth)
return representation.Substring (0, MaximumCellWidth);
return representation;
}
}
}