themaster1970sf/TShock
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Modified PaginationTools to have colored console output.

Browse source
This commit is contained in:
MarioE 2013-07-10 23:14:42 -04:00
parent 7c3ffee48c
commit 7509204c4c
1 changed files with 299 additions and 254 deletions
Download patch file Download diff file Expand all files Collapse all files

469
TShockAPI/PaginationTools.cs
View file

@ -21,251 +21,296 @@ using System.Collections.Generic;
using System.Linq; using System.Linq;
using System.Text; using System.Text;
namespace TShockAPI { namespace TShockAPI
public static class PaginationTools { {
public delegate Tuple<string, Color> LineFormatterDelegate(object lineData, int lineIndex, int pageNumber); public static class PaginationTools
{
public delegate Tuple<string, Color> LineFormatterDelegate(object lineData, int lineIndex, int pageNumber);
#region [Nested: Settings Class] #region [Nested: Settings Class]
public class Settings { public class Settings
public bool IncludeHeader { get; set; } {
public bool IncludeHeader { get; set; }
private string headerFormat; private string headerFormat;
public string HeaderFormat public string HeaderFormat
{ {
get { return this.headerFormat; } get { return this.headerFormat; }
set set
{ {
if (value == null) if (value == null)
throw new ArgumentNullException(); throw new ArgumentNullException();
this.headerFormat = value; this.headerFormat = value;
} }
} }
public Color HeaderTextColor { get; set; } public Color HeaderTextColor { get; set; }
public bool IncludeFooter { get; set; } public bool IncludeFooter { get; set; }
private string footerFormat; private string footerFormat;
public string FooterFormat public string FooterFormat
{ {
get { return this.footerFormat; } get { return this.footerFormat; }
set set
{ {
if (value == null) if (value == null)
throw new ArgumentNullException(); throw new ArgumentNullException();
this.footerFormat = value; this.footerFormat = value;
} }
} }
public Color FooterTextColor { get; set; } public Color FooterTextColor { get; set; }
public string NothingToDisplayString { get; set; } public string NothingToDisplayString { get; set; }
public LineFormatterDelegate LineFormatter { get; set; } public LineFormatterDelegate LineFormatter { get; set; }
public Color LineTextColor { get; set; } public Color LineTextColor { get; set; }
private int maxLinesPerPage; private int maxLinesPerPage;
public int MaxLinesPerPage public int MaxLinesPerPage
{ {
get { return this.maxLinesPerPage; } get { return this.maxLinesPerPage; }
set set
{ {
if (value <= 0) if (value <= 0)
throw new ArgumentException("The value has to be greater than zero."); throw new ArgumentException("The value has to be greater than zero.");
this.maxLinesPerPage = value; this.maxLinesPerPage = value;
} }
} }
private int pageLimit; private int pageLimit;
public int PageLimit public int PageLimit
{ {
get { return this.pageLimit; } get { return this.pageLimit; }
set set
{ {
if (value < 0) if (value < 0)
throw new ArgumentException("The value has to be greater than or equal to zero."); throw new ArgumentException("The value has to be greater than or equal to zero.");
this.pageLimit = value; this.pageLimit = value;
} }
} }
public Settings() public Settings()
{ {
this.IncludeHeader = true; this.IncludeHeader = true;
this.headerFormat = "Page {0} of {1}"; this.headerFormat = "Page {0} of {1}";
this.HeaderTextColor = Color.Green; this.HeaderTextColor = Color.Green;
this.IncludeFooter = true; this.IncludeFooter = true;
this.footerFormat = "Type /<command> {0} for more."; this.footerFormat = "Type /<command> {0} for more.";
this.FooterTextColor = Color.Yellow; this.FooterTextColor = Color.Yellow;
this.NothingToDisplayString = null; this.NothingToDisplayString = null;
this.LineFormatter = null; this.LineFormatter = null;
this.LineTextColor = Color.White; this.LineTextColor = Color.White;
this.maxLinesPerPage = 4; this.maxLinesPerPage = 4;
this.pageLimit = 0; this.pageLimit = 0;
} }
} }
#endregion #endregion
public static void SendPage( public static void SendPage(
TSPlayer player, int pageNumber, IEnumerable dataToPaginate, int dataToPaginateCount, Settings settings = null) TSPlayer player, int pageNumber, IEnumerable dataToPaginate, int dataToPaginateCount, Settings settings = null)
{ {
if (settings == null) if (settings == null)
settings = new Settings(); settings = new Settings();
if (dataToPaginateCount == 0) if (dataToPaginateCount == 0)
{ {
if (settings.NothingToDisplayString != null) if (settings.NothingToDisplayString != null)
player.SendMessage(settings.NothingToDisplayString, settings.HeaderTextColor); {
if (player is TSServerPlayer)
{
player.SendSuccessMessage(settings.NothingToDisplayString);
}
else
{
player.SendMessage(settings.NothingToDisplayString, settings.HeaderTextColor);
}
}
return;
}
return; int pageCount = ((dataToPaginateCount - 1) / settings.MaxLinesPerPage) + 1;
} if (settings.PageLimit > 0 && pageCount > settings.PageLimit)
pageCount = settings.PageLimit;
if (pageNumber > pageCount)
pageNumber = pageCount;
int pageCount = ((dataToPaginateCount - 1) / settings.MaxLinesPerPage) + 1; if (settings.IncludeHeader)
if (settings.PageLimit > 0 && pageCount > settings.PageLimit) {
pageCount = settings.PageLimit; if (player is TSServerPlayer)
if (pageNumber > pageCount) {
pageNumber = pageCount; player.SendSuccessMessage(string.Format(settings.HeaderFormat, pageNumber, pageCount));
}
else
{
player.SendMessage(string.Format(settings.HeaderFormat, pageNumber, pageCount), settings.HeaderTextColor);
}
}
if (settings.IncludeHeader) int listOffset = (pageNumber - 1) * settings.MaxLinesPerPage;
player.SendMessage(string.Format(settings.HeaderFormat, pageNumber, pageCount), settings.HeaderTextColor); int offsetCounter = 0;
int lineCounter = 0;
foreach (object lineData in dataToPaginate)
{
if (lineData == null)
continue;
if (offsetCounter++ < listOffset)
continue;
if (lineCounter++ == settings.MaxLinesPerPage)
break;
int listOffset = (pageNumber - 1) * settings.MaxLinesPerPage; string lineMessage;
int offsetCounter = 0; Color lineColor = settings.LineTextColor;
int lineCounter = 0; if (lineData is Tuple<string, Color>)
foreach (object lineData in dataToPaginate) {
{ var lineFormat = (Tuple<string, Color>)lineData;
if (lineData == null) lineMessage = lineFormat.Item1;
continue; lineColor = lineFormat.Item2;
if (offsetCounter++ < listOffset) }
continue; else if (settings.LineFormatter != null)
if (lineCounter++ == settings.MaxLinesPerPage) {
break; try
{
Tuple<string, Color> lineFormat = settings.LineFormatter(lineData, offsetCounter, pageNumber);
if (lineFormat == null)
continue;
string lineMessage; lineMessage = lineFormat.Item1;
Color lineColor = settings.LineTextColor; lineColor = lineFormat.Item2;
if (lineData is Tuple<string, Color>) }
{ catch (Exception ex)
var lineFormat = (Tuple<string, Color>)lineData; {
lineMessage = lineFormat.Item1; throw new InvalidOperationException(
lineColor = lineFormat.Item2; "The method referenced by LineFormatter has thrown an exception. See inner exception for details.", ex);
} }
else if (settings.LineFormatter != null) }
{ else
try {
{ lineMessage = lineData.ToString();
Tuple<string, Color> lineFormat = settings.LineFormatter(lineData, offsetCounter, pageNumber); }
if (lineFormat == null)
continue;
lineMessage = lineFormat.Item1; if (lineMessage != null)
lineColor = lineFormat.Item2; {
} if (player is TSServerPlayer)
catch (Exception ex) {
{ Console.WriteLine(lineMessage);
throw new InvalidOperationException( }
"The method referenced by LineFormatter has thrown an exception. See inner exception for details.", ex); else
} {
} player.SendMessage(lineMessage, lineColor);
else }
{ }
lineMessage = lineData.ToString(); }
}
if (lineMessage != null) if (lineCounter == 0)
player.SendMessage(lineMessage, lineColor); {
} if (settings.NothingToDisplayString != null)
{
if (player is TSServerPlayer)
{
player.SendSuccessMessage(settings.NothingToDisplayString);
}
else
{
player.SendMessage(settings.NothingToDisplayString, settings.HeaderTextColor);
}
}
}
else if (settings.IncludeFooter && pageNumber + 1 <= pageCount)
{
if (player is TSServerPlayer)
{
player.SendInfoMessage(string.Format(settings.FooterFormat, pageNumber + 1, pageNumber, pageCount));
}
else
{
player.SendMessage(string.Format(settings.FooterFormat, pageNumber + 1, pageNumber, pageCount), settings.FooterTextColor);
}
}
}
if (lineCounter == 0) public static void SendPage(TSPlayer player, int pageNumber, IList dataToPaginate, Settings settings = null)
{ {
if (settings.NothingToDisplayString != null) PaginationTools.SendPage(player, pageNumber, dataToPaginate, dataToPaginate.Count, settings);
player.SendMessage(settings.NothingToDisplayString, settings.HeaderTextColor); }
}
else if (settings.IncludeFooter && pageNumber + 1 <= pageCount)
{
player.SendMessage(string.Format(settings.FooterFormat, pageNumber + 1, pageNumber, pageCount), settings.FooterTextColor);
}
}
public static void SendPage(TSPlayer player, int pageNumber, IList dataToPaginate, Settings settings = null) public static List<string> BuildLinesFromTerms(
{ IEnumerable terms, Func<object, string> termFormatter = null, string separator = ", ", int maxCharsPerLine = 80)
PaginationTools.SendPage(player, pageNumber, dataToPaginate, dataToPaginate.Count, settings); {
} List<string> lines = new List<string>();
StringBuilder lineBuilder = new StringBuilder();
foreach (object term in terms)
{
if (term == null && termFormatter == null)
continue;
public static List<string> BuildLinesFromTerms( string termString;
IEnumerable terms, Func<object, string> termFormatter = null, string separator = ", ", int maxCharsPerLine = 80) if (termFormatter != null)
{ {
List<string> lines = new List<string>(); try
StringBuilder lineBuilder = new StringBuilder(); {
foreach (object term in terms) termString = termFormatter(term);
{
if (term == null && termFormatter == null)
continue;
string termString; if (termString == null)
if (termFormatter != null) continue;
{ }
try catch (Exception ex)
{ {
termString = termFormatter(term); throw new ArgumentException(
"The method represented by termFormatter has thrown an exception. See inner exception for details.", ex);
}
}
else
{
termString = term.ToString();
}
if (termString == null) bool goesOnNextLine = (lineBuilder.Length + termString.Length > maxCharsPerLine);
continue; if (!goesOnNextLine)
} {
catch (Exception ex) if (lineBuilder.Length > 0)
{ lineBuilder.Append(separator);
throw new ArgumentException( lineBuilder.Append(termString);
"The method represented by termFormatter has thrown an exception. See inner exception for details.", ex); }
} else
} {
else // A separator should always be at the end of a line as we know it is followed by another line.
{ lineBuilder.Append(separator);
termString = term.ToString(); lines.Add(lineBuilder.ToString());
} lineBuilder.Clear();
bool goesOnNextLine = (lineBuilder.Length + termString.Length > maxCharsPerLine); lineBuilder.Append(termString);
if (!goesOnNextLine) }
{ }
if (lineBuilder.Length > 0) if (lineBuilder.Length > 0)
lineBuilder.Append(separator); lines.Add(lineBuilder.ToString());
lineBuilder.Append(termString);
}
else
{
// A separator should always be at the end of a line as we know it is followed by another line.
lineBuilder.Append(separator);
lines.Add(lineBuilder.ToString());
lineBuilder.Clear();
lineBuilder.Append(termString); return lines;
} }
}
if (lineBuilder.Length > 0)
lines.Add(lineBuilder.ToString());
return lines; public static bool TryParsePageNumber(
} List<string> commandParameters, int expectedParamterIndex, TSPlayer errorMessageReceiver, out int pageNumber)
{
pageNumber = 1;
if (commandParameters.Count <= expectedParamterIndex)
return true;
public static bool TryParsePageNumber( string pageNumberRaw = commandParameters[expectedParamterIndex];
List<string> commandParameters, int expectedParamterIndex, TSPlayer errorMessageReceiver, out int pageNumber) if (!int.TryParse(pageNumberRaw, out pageNumber) || pageNumber < 1)
{ {
pageNumber = 1; if (errorMessageReceiver != null)
if (commandParameters.Count <= expectedParamterIndex) errorMessageReceiver.SendErrorMessage(string.Format("\"{0}\" is not a valid page number.", pageNumberRaw));
return true;
string pageNumberRaw = commandParameters[expectedParamterIndex]; pageNumber = 1;
if (!int.TryParse(pageNumberRaw, out pageNumber) || pageNumber < 1) return false;
{ }
if (errorMessageReceiver != null)
errorMessageReceiver.SendErrorMessage(string.Format("\"{0}\" is not a valid page number.", pageNumberRaw));
pageNumber = 1; return true;
return false; }
} }
return true;
}
}
} }