1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
#nullable disable
using System;
using System.Collections.Generic;
using System.Linq;
namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands
{
/// <summary>The base implementation for a console command.</summary>
internal abstract class ConsoleCommand : IConsoleCommand
{
/*********
** Accessors
*********/
/// <summary>The command name the user must type.</summary>
public string Name { get; }
/// <summary>The command description.</summary>
public string Description { get; }
/// <summary>Whether the command may need to perform logic when the player presses a button. This value shouldn't change.</summary>
public bool MayNeedInput { get; }
/// <summary>Whether the command may need to perform logic when the game updates. This value shouldn't change.</summary>
public bool MayNeedUpdate { get; }
/*********
** Public methods
*********/
/// <summary>Handle the command.</summary>
/// <param name="monitor">Writes messages to the console and log file.</param>
/// <param name="command">The command name.</param>
/// <param name="args">The command arguments.</param>
public abstract void Handle(IMonitor monitor, string command, ArgumentParser args);
/// <summary>Perform any logic needed on update tick.</summary>
/// <param name="monitor">Writes messages to the console and log file.</param>
public virtual void OnUpdated(IMonitor monitor) { }
/// <summary>Perform any logic when input is received.</summary>
/// <param name="monitor">Writes messages to the console and log file.</param>
/// <param name="button">The button that was pressed.</param>
public virtual void OnButtonPressed(IMonitor monitor, SButton button) { }
/*********
** Protected methods
*********/
/// <summary>Construct an instance.</summary>
/// <param name="name">The command name the user must type.</param>
/// <param name="description">The command description.</param>
/// <param name="mayNeedInput">Whether the command may need to perform logic when the player presses a button.</param>
/// <param name="mayNeedUpdate">Whether the command may need to perform logic when the game updates.</param>
protected ConsoleCommand(string name, string description, bool mayNeedInput = false, bool mayNeedUpdate = false)
{
this.Name = name;
this.Description = description;
this.MayNeedInput = mayNeedInput;
this.MayNeedUpdate = mayNeedUpdate;
}
/// <summary>Log an error indicating incorrect usage.</summary>
/// <param name="monitor">Writes messages to the console and log file.</param>
/// <param name="error">A sentence explaining the problem.</param>
protected void LogUsageError(IMonitor monitor, string error)
{
monitor.Log($"{error} Type 'help {this.Name}' for usage.", LogLevel.Error);
}
/// <summary>Log an error indicating a value must be an integer.</summary>
/// <param name="monitor">Writes messages to the console and log file.</param>
protected void LogArgumentNotInt(IMonitor monitor)
{
this.LogUsageError(monitor, "The value must be a whole number.");
}
/// <summary>Get an ASCII table to show tabular data in the console.</summary>
/// <typeparam name="T">The data type.</typeparam>
/// <param name="data">The data to display.</param>
/// <param name="header">The table header.</param>
/// <param name="getRow">Returns a set of fields for a data value.</param>
protected string GetTableString<T>(IEnumerable<T> data, string[] header, Func<T, string[]> getRow)
{
// get table data
int[] widths = header.Select(p => p.Length).ToArray();
string[][] rows = data
.Select(item =>
{
string[] fields = getRow(item);
if (fields.Length != widths.Length)
throw new InvalidOperationException($"Expected {widths.Length} columns, but found {fields.Length}: {string.Join(", ", fields)}");
for (int i = 0; i < fields.Length; i++)
widths[i] = Math.Max(widths[i], fields[i].Length);
return fields;
})
.ToArray();
// render fields
List<string[]> lines = new List<string[]>(rows.Length + 2)
{
header,
header.Select((_, i) => "".PadRight(widths[i], '-')).ToArray()
};
lines.AddRange(rows);
return string.Join(
Environment.NewLine,
lines.Select(line => string.Join(" | ",
line.Select((field, i) => field.PadLeft(widths[i], ' '))
))
);
}
}
}
|
