github/Discord.Net
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Cleaned up several classes

Browse Source
This commit is contained in:
RogueException
2016-01-01 01:06:34 -04:00
parent 321093e0f8
commit c1bee10523
60 changed files with 411 additions and 722 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
src/Discord.Net.Commands/Command.cs
View File

@@ -5,48 +5,24 @@ using System.Threading.Tasks;
namespace Discord.Commands
{
public enum ParameterType
{
/// <summary> Catches a single required parameter. </summary>
Required,
/// <summary> Catches a single optional parameter. </summary>
Optional,
/// <summary> Catches a zero or more optional parameters. </summary>
Multiple,
/// <summary> Catches all remaining text as a single optional parameter. </summary>
Unparsed
}
public sealed class CommandParameter
{
public string Name { get; }
public int Id { get; internal set; }
public ParameterType Type { get; }
public CommandParameter(string name, ParameterType type)
{
Name = name;
Type = type;
}
}
public sealed class Command
{
public string Text { get; }
{
private string[] _aliases;
internal CommandParameter[] _parameters;
private IPermissionChecker[] _checks;
private Func<CommandEventArgs, Task> _runFunc;
internal readonly Dictionary<string, CommandParameter> _parametersByName;
public string Text { get; }
public string Category { get; internal set; }
public bool IsHidden { get; internal set; }
public string Description { get; internal set; }
public IEnumerable<string> Aliases => _aliases;
private string[] _aliases;
public IEnumerable<CommandParameter> Parameters => _parameters;
internal CommandParameter[] _parameters;
private IPermissionChecker[] _checks;
private Func<CommandEventArgs, Task> _runFunc;
internal readonly Dictionary<string, CommandParameter> _parametersByName;
public CommandParameter this[string name] => _parametersByName[name];
internal Command(string text)
internal Command(string text)
{
Text = text;
IsHidden = false;
@@ -55,7 +31,6 @@ namespace Discord.Commands
_parametersByName = new Dictionary<string, CommandParameter>();
}
public CommandParameter this[string name] => _parametersByName[name];
internal void SetAliases(string[] aliases)
{

18
src/Discord.Net.Commands/CommandErrorEventArgs.cs Normal file
View File

@@ -0,0 +1,18 @@
using System;
namespace Discord.Commands
{
public enum CommandErrorType { Exception, UnknownCommand, BadPermissions, BadArgCount, InvalidInput }
public class CommandErrorEventArgs : CommandEventArgs
{
public CommandErrorType ErrorType { get; }
public Exception Exception { get; }
public CommandErrorEventArgs(CommandErrorType errorType, CommandEventArgs baseArgs, Exception ex)
: base(baseArgs.Message, baseArgs.Command, baseArgs.Args)
{
Exception = ex;
ErrorType = errorType;
}
}
}

27
src/Discord.Net.Commands/CommandEventArgs.cs Normal file
View File

@@ -0,0 +1,27 @@
using System;
namespace Discord.Commands
{
public class CommandEventArgs : EventArgs
{
private readonly string[] _args;
public Message Message { get; }
public Command Command { get; }
public User User => Message.User;
public Channel Channel => Message.Channel;
public Server Server => Message.Channel.Server;
public CommandEventArgs(Message message, Command command, string[] args)
{
Message = message;
Command = command;
_args = args;
}
public string[] Args => _args;
public string GetArg(int index) => _args[index];
public string GetArg(string name) => _args[Command[name].Id];
}
}

26
src/Discord.Net.Commands/CommandParameter.cs Normal file
View File

@@ -0,0 +1,26 @@
namespace Discord.Commands
{
public enum ParameterType
{
/// <summary> Catches a single required parameter. </summary>
Required,
/// <summary> Catches a single optional parameter. </summary>
Optional,
/// <summary> Catches a zero or more optional parameters. </summary>
Multiple,
/// <summary> Catches all remaining text as a single optional parameter. </summary>
Unparsed
}
public sealed class CommandParameter
{
public string Name { get; }
public int Id { get; internal set; }
public ParameterType Type { get; }
public CommandParameter(string name, ParameterType type)
{
Name = name;
Type = type;
}
}
}

57
src/Discord.Net.Commands/CommandService.Events.cs
View File

@@ -1,57 +0,0 @@
using System;
namespace Discord.Commands
{
public class CommandEventArgs : EventArgs
{
private readonly string[] _args;
public Message Message { get; }
public Command Command { get; }
public User User => Message.User;
public Channel Channel => Message.Channel;
public Server Server => Message.Channel.Server;
public CommandEventArgs(Message message, Command command, string[] args)
{
Message = message;
Command = command;
_args = args;
}
public string[] Args => _args;
public string GetArg(int index) => _args[index];
public string GetArg(string name) => _args[Command[name].Id];
}
public enum CommandErrorType { Exception, UnknownCommand, BadPermissions, BadArgCount, InvalidInput }
public class CommandErrorEventArgs : CommandEventArgs
{
public CommandErrorType ErrorType { get; }
public Exception Exception { get; }
public CommandErrorEventArgs(CommandErrorType errorType, CommandEventArgs baseArgs, Exception ex)
: base(baseArgs.Message, baseArgs.Command, baseArgs.Args)
{
Exception = ex;
ErrorType = errorType;
}
}
public partial class CommandService
{
public event EventHandler<CommandEventArgs> RanCommand;
private void RaiseRanCommand(CommandEventArgs args)
{
if (RanCommand != null)
RanCommand(this, args);
}
public event EventHandler<CommandErrorEventArgs> CommandError;
private void RaiseCommandError(CommandErrorType errorType, CommandEventArgs args, Exception ex = null)
{
if (CommandError != null)
CommandError(this, new CommandErrorEventArgs(errorType, args, ex));
}
}
}

69
src/Discord.Net.Commands/CommandService.cs
View File

@@ -6,42 +6,45 @@ using System.Threading.Tasks;
namespace Discord.Commands
{
/// <summary> A Discord.Net client with extensions for handling common bot operations like text commands. </summary>
public sealed partial class CommandService : IService
public partial class CommandService : IService
{
private readonly CommandServiceConfig _config;
private readonly CommandGroupBuilder _root;
private DiscordClient _client;
public DiscordClient Client => _client;
public CommandGroupBuilder Root => _root;
private readonly List<Command> _allCommands;
private readonly Dictionary<string, CommandMap> _categories;
private readonly CommandMap _map; //Command map stores all commands by their input text, used for fast resolving and parsing
public CommandServiceConfig Config { get; }
public CommandGroupBuilder Root { get; }
public DiscordClient Client { get; private set; }
//AllCommands store a flattened collection of all commands
public IEnumerable<Command> AllCommands => _allCommands;
private readonly List<Command> _allCommands;
//Command map stores all commands by their input text, used for fast resolving and parsing
private readonly CommandMap _map;
public IEnumerable<Command> AllCommands => _allCommands;
//Groups store all commands by their module, used for more informative help
internal IEnumerable<CommandMap> Categories => _categories.Values;
private readonly Dictionary<string, CommandMap> _categories;
public CommandService(CommandServiceConfig config)
public event EventHandler<CommandEventArgs> Command = delegate { };
public event EventHandler<CommandErrorEventArgs> CommandError = delegate { };
private void OnCommand(CommandEventArgs args)
=> Command(this, args);
private void OnCommandError(CommandErrorType errorType, CommandEventArgs args, Exception ex = null)
=> CommandError(this, new CommandErrorEventArgs(errorType, args, ex));
public CommandService(CommandServiceConfig config)
{
_config = config;
Config = config;
_allCommands = new List<Command>();
_map = new CommandMap(null, "", "");
_categories = new Dictionary<string, CommandMap>();
_root = new CommandGroupBuilder(this, "", null);
Root = new CommandGroupBuilder(this, "", null);
}
void IService.Install(DiscordClient client)
{
_client = client;
_config.Lock();
Client = client;
Config.Lock();
if (_config.HelpMode != HelpMode.Disable)
if (Config.HelpMode != HelpMode.Disable)
{
CreateCommand("help")
.Parameter("command", ParameterType.Multiple)
@@ -49,7 +52,7 @@ namespace Discord.Commands
.Description("Returns information about commands.")
.Do(async e =>
{
Channel replyChannel = _config.HelpMode == HelpMode.Public ? e.Channel : await e.User.CreatePMChannel().ConfigureAwait(false);
Channel replyChannel = Config.HelpMode == HelpMode.Public ? e.Channel : await e.User.CreatePMChannel().ConfigureAwait(false);
if (e.Args.Length > 0) //Show command help
{
var map = _map.GetItem(string.Join(" ", e.Args));
@@ -66,13 +69,13 @@ namespace Discord.Commands
client.MessageReceived += async (s, e) =>
{
if (_allCommands.Count == 0) return;
if (e.Message.User == null || e.Message.User.Id == _client.CurrentUser.Id) return;
if (e.Message.User == null || e.Message.User.Id == Client.CurrentUser.Id) return;
string msg = e.Message.RawText;
if (msg.Length == 0) return;
//Check for command char if one is provided
var chars = _config.CommandChars;
var chars = Config.CommandChars;
if (chars.Length > 0)
{
if (!chars.Contains(msg[0]))
@@ -87,7 +90,7 @@ namespace Discord.Commands
if (commands == null)
{
CommandEventArgs errorArgs = new CommandEventArgs(e.Message, null, null);
RaiseCommandError(CommandErrorType.UnknownCommand, errorArgs);
OnCommandError(CommandErrorType.UnknownCommand, errorArgs);
return;
}
else
@@ -104,7 +107,7 @@ namespace Discord.Commands
else
{
var errorArgs = new CommandEventArgs(e.Message, command, null);
RaiseCommandError(error.Value, errorArgs);
OnCommandError(error.Value, errorArgs);
return;
}
}
@@ -115,24 +118,24 @@ namespace Discord.Commands
string errorText;
if (!command.CanRun(eventArgs.User, eventArgs.Channel, out errorText))
{
RaiseCommandError(CommandErrorType.BadPermissions, eventArgs, errorText != null ? new Exception(errorText) : null);
OnCommandError(CommandErrorType.BadPermissions, eventArgs, errorText != null ? new Exception(errorText) : null);
return;
}
// Run the command
try
{
RaiseRanCommand(eventArgs);
OnCommand(eventArgs);
await command.Run(eventArgs).ConfigureAwait(false);
}
catch (Exception ex)
{
RaiseCommandError(CommandErrorType.Exception, eventArgs, ex);
OnCommandError(CommandErrorType.Exception, eventArgs, ex);
}
return;
}
var errorArgs2 = new CommandEventArgs(e.Message, null, null);
RaiseCommandError(CommandErrorType.BadArgCount, errorArgs2);
OnCommandError(CommandErrorType.BadArgCount, errorArgs2);
}
};
}
@@ -184,7 +187,7 @@ namespace Discord.Commands
{
output.Append("\n\n");
var chars = _config.CommandChars;
var chars = Config.CommandChars;
if (chars.Length > 0)
{
if (chars.Length == 1)
@@ -294,8 +297,8 @@ namespace Discord.Commands
output.AppendLine($"Aliases: `" + string.Join("`, `", command.Aliases) + '`');
}
public void CreateGroup(string cmd, Action<CommandGroupBuilder> config = null) => _root.CreateGroup(cmd, config);
public CommandBuilder CreateCommand(string cmd) => _root.CreateCommand(cmd);
public void CreateGroup(string cmd, Action<CommandGroupBuilder> config = null) => Root.CreateGroup(cmd, config);
public CommandBuilder CreateCommand(string cmd) => Root.CreateCommand(cmd);
internal void AddCommand(Command command)
{