[WIP] Add CommandHelpService

Remora.Commands/Attributes/HiddenFromHelpAttribute.cs

@@ -0,0 +1,51 @@
+//
+//  HiddenFromHelpAttribute.cs
+//
+//  Author:
+//       Jarl Gullberg <[email protected]>
+//
+//  Copyright (c) 2017 Jarl Gullberg
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU Lesser General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using System;
+
+namespace Remora.Commands.Attributes
+{
+    /// <summary>
+    /// Marks a command or group as being hidden from the help service.
+    /// </summary>
+    /// <remarks>
+    /// This attribute represents a request to be hidden. The implementing
+    /// service may or may not respect this request.
+    /// </remarks>
+    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
+    public sealed class HiddenFromHelpAttribute : Attribute
+    {
+        /// <summary>
+        /// Gets a comment provided by the developer, if any.
+        /// </summary>
+        public string? Comment { get; }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="HiddenFromHelpAttribute"/> class.
+        /// </summary>
+        /// <param name="comment">A comment describing why this is hidden or any relevant notes. May be displayed by the help service.</param>
+        public HiddenFromHelpAttribute(string? comment = null)
+        {
+            Comment = comment;
+        }
+    }
+}

Remora.Commands/CommandInformation/CommandBranch.cs

@@ -0,0 +1,33 @@
+//
+//  CommandBranch.cs
+//
+//  Author:
+//       Jarl Gullberg <[email protected]>
+//
+//  Copyright (c) 2017 Jarl Gullberg
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU Lesser General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using OneOf;
+
+namespace Remora.Commands.CommandInformation
+{
+    /// <inheritdoc />
+    public sealed record CommandBranch
+    (
+        IGroupInfo GroupInfo,
+        OneOf<ICommandInfo, ICommandInfo[]> Commands
+    ) : ICommandBranch;
+}

Remora.Commands/CommandInformation/CommandInfo.cs

@@ -0,0 +1,39 @@
+//
+//  CommandInfo.cs
+//
+//  Author:
+//       Jarl Gullberg <[email protected]>
+//
+//  Copyright (c) 2017 Jarl Gullberg
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU Lesser General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using System.Collections.Generic;
+using System.Reflection;
+
+namespace Remora.Commands.CommandInformation
+{
+    /// <inheritdoc />
+    public sealed record CommandInfo
+    (
+        string Name,
+        string? Description,
+        IReadOnlyList<string> Aliases,
+        bool Hidden,
+        string? HiddenFromHelpComment,
+        IReadOnlyList<IConditionInfo> Conditions,
+        IReadOnlyList<ParameterInfo> Arguments
+    ) : ICommandInfo;
+}

Remora.Commands/CommandInformation/ConditionInfo.cs

@@ -0,0 +1,29 @@
+//
+//  ConditionInfo.cs
+//
+//  Author:
+//       Jarl Gullberg <[email protected]>
+//
+//  Copyright (c) 2017 Jarl Gullberg
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU Lesser General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using System.Collections.Generic;
+
+namespace Remora.Commands.CommandInformation
+{
+    /// <inheritdoc />
+    public sealed record ConditionInfo(string Name, string? Description, IReadOnlyList<IConditionPropertyInfo> ConditionProperties) : IConditionInfo;
+}

Remora.Commands/CommandInformation/ConditionPropertyInfo.cs

@@ -0,0 +1,31 @@
+//
+//  ConditionPropertyInfo.cs
+//
+//  Author:
+//       Jarl Gullberg <[email protected]>
+//
+//  Copyright (c) 2017 Jarl Gullberg
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU Lesser General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using System;
+using JetBrains.Annotations;
+
+namespace Remora.Commands.CommandInformation
+{
+    /// <inheritdoc />
+    [PublicAPI]
+    public sealed record ConditionPropertyInfo(string Name, bool CanRead, bool CanWrite, Type PropertyType, object? Value) : IConditionPropertyInfo;
+}

Remora.Commands/CommandInformation/GroupInfo.cs

@@ -0,0 +1,38 @@
+//
+//  GroupInfo.cs
+//
+//  Author:
+//       Jarl Gullberg <[email protected]>
+//
+//  Copyright (c) 2017 Jarl Gullberg
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU Lesser General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using System.Collections.Generic;
+
+namespace Remora.Commands.CommandInformation
+{
+    /// <inheritdoc />
+    public sealed record GroupInfo
+    (
+        string Name,
+        string? Description,
+        IReadOnlyList<string> Aliases,
+        bool Hidden,
+        string? HiddenFromHelpComment,
+        IReadOnlyList<ICommandInfo> Commands,
+        IReadOnlyList<IGroupInfo> ChildGroups
+    ) : IGroupInfo;
+}

Remora.Commands/CommandInformation/ICommandBranch.cs

@@ -0,0 +1,42 @@
+//
+//  ICommandBranch.cs
+//
+//  Author:
+//       Jarl Gullberg <[email protected]>
+//
+//  Copyright (c) 2017 Jarl Gullberg
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU Lesser General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using OneOf;
+
+namespace Remora.Commands.CommandInformation
+{
+    /// <summary>
+    /// Represents a branch within the command system.
+    /// </summary>
+    public interface ICommandBranch
+    {
+        /// <summary>
+        /// Gets the command group which was found at the level searched.
+        /// </summary>
+        IGroupInfo GroupInfo { get; }
+
+        /// <summary>
+        /// Gets the command or all overloaded commands found at the level searched.
+        /// </summary>
+        OneOf<ICommandInfo, ICommandInfo[]> Commands { get; }
+    }
+}

Remora.Commands/CommandInformation/ICommandInfo.cs

@@ -0,0 +1,68 @@
+//
+//  ICommandInfo.cs
+//
+//  Author:
+//       Jarl Gullberg <[email protected]>
+//
+//  Copyright (c) 2017 Jarl Gullberg
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU Lesser General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using System.Collections.Generic;
+using System.Reflection;
+
+namespace Remora.Commands.CommandInformation
+{
+    /// <summary>
+    /// Contains information about a specific command.
+    /// </summary>
+    public interface ICommandInfo
+    {
+        /// <summary>
+        /// Gets the name of the command.
+        /// </summary>
+        string Name { get; }
+
+        /// <summary>
+        /// Gets the command's description, if any.
+        /// </summary>
+        string? Description { get; }
+
+        /// <summary>
+        /// Gets a read-only list of the command's aliases.
+        /// </summary>
+        IReadOnlyList<string> Aliases { get; }
+
+        /// <summary>
+        /// Gets a value indicating whether the command was requested to be hidden from help commands.
+        /// </summary>
+        bool Hidden { get; }
+
+        /// <summary>
+        /// Gets a comment describing why the command is hidden.
+        /// </summary>
+        string? HiddenFromHelpComment { get; }
+
+        /// <summary>
+        /// Gets a read-only list of any command conditions.
+        /// </summary>
+        IReadOnlyList<IConditionInfo> Conditions { get; }
+
+        /// <summary>
+        /// Gets a read-only list of any command arguments.
+        /// </summary>
+        IReadOnlyList<ParameterInfo> Arguments { get; }
+    }
+}

Remora.Commands/CommandInformation/IConditionInfo.cs

@@ -0,0 +1,47 @@
+//
+//  IConditionInfo.cs
+//
+//  Author:
+//       Jarl Gullberg <[email protected]>
+//
+//  Copyright (c) 2017 Jarl Gullberg
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU Lesser General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using System.Collections.Generic;
+
+namespace Remora.Commands.CommandInformation
+{
+    /// <summary>
+    /// Contains information about a specific command condition.
+    /// </summary>
+    public interface IConditionInfo
+    {
+        /// <summary>
+        /// Gets the display name of the condition.
+        /// </summary>
+        string Name { get; }
+
+        /// <summary>
+        /// Gets the description of the condition, if any.
+        /// </summary>
+        string? Description { get; }
+
+        /// <summary>
+        /// Gets a list of properties belonging to the condition this type represents.
+        /// </summary>
+        IReadOnlyList<IConditionPropertyInfo> ConditionProperties { get; }
+    }
+}