You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

CommandParser.cs 8.1 kB

Documentation Overhaul (#1161) * Add XML docs * Clean up style switcher * Squash commits on branch docs/faq-n-patches * Fix broken theme selector * Add local image embed instruction * Add a bunch of XML docs * Add a bunch of XML docs * Fix broken search + DocFX by default ships with an older version of jQuery, switching to a newer version confuses parts of the DocFX Javascript. * Minor fixes for CONTRIBUTING.md and README.md * Clean up filterConfig.yml + New config exposes Discord.Net namespace since it has several common public exceptions that may be helpful to users * Add XML docs * Read token from Environment Variable instead of hardcode * Add XMLDocs * Compress some assets & add OAuth2 URL generator * Fix sample link & add missing pictures * Add tag examples * Fix embed docs consistency * Add details regarding userbot support * Add XML Docs * Add XML Docs * Add XML Docs * Minor fixes in documentations + Fix unescaped '<' + Fix typo * Fix seealso for preconditions and add missing descriptions * Add missing exceptions * Document exposed TypeReaders * Fix letter-casing for files * Add 'last modified' plugin Source: https://github.com/Still34/DocFx.Plugin.LastModified Licensed under MIT License * XML Docs * Fix minor consistencies & redundant impl * Add properties examples to overwrite * Fix missing Username prop * Add warning for bulk-delete endpoint * Replace note block * Add BaseSocketClient docs * Add XML docs * Replace langword null to code block null instead - Because DocFX sucks at rendering langword * Replace all langword placements with code block * Add more IGuild docs * Add details to SpotifyGame * Initial proofread of the articles * Add explanation for RunMode * Add event docs - MessageReceived - ChannelUpdated/Destroyed/Created * Fix light theme link color * Fix xml docs error * Add partial documentation for audit log impl * Add documentation for some REST-based objects * Add partial documentation for audit log objects * Add more XML comments to quotation mark alias map stuff, including an example * Add reference to CommandServiceConfig from the util docs' * Add explanation that if " is removed then it wont work * Fix missing service provider in example * Add documentation for new INestedChannel * Add documentation * Add documentation for new API version & few events * Revise guide paragraphs/samples + Fix various formatting. + Provide a more detailed walkthrough for dependency injection. + Add C# note at intro. * Fix typos & formatting * Improve group module example * Small amount to see if I'm doing it right * Remove/cleanup redundant variables * Fix EnterTypingState impl for doc inheritance * Fix Test to resolve changes made in 15b58e * Improve precondition documentation + Add precondition usage sample + Add precondition group usage sample + Move precondition samples to its own sample folder * Move samples to individual folders * Clarify token source * Cleanup styling of README.md for docs * Replace InvalidPathChars for NS1.3 * InvalidPathChars does not exist in NS1.3; replaced with GetInvalidPathChars instead. * Add a missing change for 2c7cc738 * Update LastModified to v1.1.0 & add license * Rewrite installation page for Core 2.1 * Fix anchor link * Bump post-processor to v1.1.1 * Add fixes to partial file & add license * Moved theme-switcher code to scripts partial file + Add author's MIT license to featherlight javascript * Remove unused bootstrap plugin * Bump LastModified plugin * Changed the path from 'lastmodified' to 'last-modified' for consistency * Cleanup README & Contribution guide * Changes to last pr * Fix GetCategoryAsync docs * Proofread and cleanup articles * Change passive voice in "Get Started" to active * Fix improper preposition in Commands Introduction page * Fix minor grammar mistakes in "Your First Bot" (future tense -> present tense/subjunctive mood -> indicative mood/proper noun casing/incorrect noun/add missing article) * Fix minor grammar mistakes in "Installation" (missing article) * no hablo ingles * Try try try again * I'm sure you're having as much fun as I am * Cleanup TOC & fix titles * Improve styling + Change title font to Noto Sans + Add materialized design for commit message box * Add DescriptionGenerator plugin * Add nightly section for clarification * Fix typos in Nightlies & Post-execution * Bump DescriptionGenerator to v1.1.0 + This build adds the functionality of generating managed references' summary into the description tag. * Initial emoji article draft * Add 'additional information' section for emoji article * Add cosmetic changes to the master css * Alter info box color + Add transition to article content * Add clarification in the emoji article * Emphasize that normal emoji string will not translate to its Unicode representation. * Clean up or add some of the samples featured in the article. + Add emoji/emote declaration section for clarification. + Add WebSocket emote sample. - Remove inconsistent styling ('wacky memes' proves to be too out of place). * Improve readability for nightlies article * Move 'Bundled Preconditions' section * Bump LastModified to fix UTC DateTime parsing * Add langwordMapping.yml * Add XML docs * Add VSC workspace rule * The root workspace limits the ruler to 120 characters for member documentations and excludes folders such as 'samples' and 'docs'. * The docs workspace limits the ruler to 70 characters for standard conceptual article to comply with documentation's CONTRIBUTING.md rule, and excludes temprorary folders created by DocFX. * Update CONTRIBUTING.md * Add documentation style rule * Fix styling of several member documentation * Fix ' />' caused by Agent Smith oddities * Fix styling to be more specific about the mention of IDs * Fix exception summary to comply with official Microsoft Docs style * References https://docs.microsoft.com/en-us/dotnet/api/system.argumentnullexception?view=netframework-4.7.2 https://docs.microsoft.com/en-us/dotnet/api/system.platformnotsupportedexception?view=netframework-4.7.2 https://docs.microsoft.com/en-us/dotnet/api/system.badimageformatexception?view=netframework-4.7.2 * Add XML documentations * Shift color return docs * Fix minor docs * Added documentation for SocketDMChannel, SocketGuildChannel, and SocketTextChannel * Add XML docs * Corrections to SocketGuildChannel * Corrections to SocketTextChannel * Corrections to SocketDMChannel * Swapped out 'id' for 'snowflake identifier * Swapped out 'id' for 'snowflake identifier' * SocketDMChannel amendments * SocketGuildChannel amendments * SocketTextChannel amendments * Add XML docs & patch return types + Starting from this commit, all return types for tasks will use style similar to most documentations featured on docs.microsoft.com References: https://docs.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.dbcontext.-ctor?view=efcore-2.1 https://docs.microsoft.com/en-us/dotnet/api/system.io.filestream.readasync?view=netcore-2.1 https://docs.microsoft.com/en-us/dotnet/api/system.io.textwriter.writelineasync?view=netcore-2.1#System_IO_TextWriter_WriteLineAsync_System_Char___ And many more other asynchronous method documentations featured in the latest BCL. * Added documentation for many audit log data types, fixed vowel indefinite articles * Change audit log data types to start with 'Contains' (verb) instead of an article * Fix some documentation issues and document some more audit log data types * Fix English posession * Add XML doc * Documented two more types * Documented RoleCreateAuditLogData * Document remaining audit log data types * Added RestDMChannel documentation * Added RestGuildChannel documentation * Added RestTextChannel documentation * Added RestVoiceChannel documentation * Added RestUser documentation * Added RestRole documentation * Added RestMessage documentation * Slightly better wording * Contains -> Contains a piece of (describe article) * [EN] Present perf. -> past perf. * Add XML docs * Fix arrow alignment * Clarify supported nullable type * Fixed a typo in ISnowflakeEntity * Added RestUser Documentation * Added RestInvite documentation * Add XML docs & minor optimizations * Minor optimization for doc rendering * Rollback font optimization changes * Amendments to RestUser * Added SocketDMChannel documentation * Added RestDMChannel documentation * Added RestGuild documentation * Adjustment to SocketDMChannel * Added minimal descriptions from the API documentation for Integration types * Added obsolete mention to the ReadMessages flag. * Added remarks about 2FA requirement for guild permissions * Added xmldoc for GuildPermission methods * Added xml doc for ToAllowList and ToDenyList * Added specification of how the bits of the color raw value are packed * Added discord API documentation to IConnection interface * I can spell :^) * Fix whitespace in ChannelPermission * fix spacing of values in guildpermission * Made changes to get field descriptions from feedback, added returns tag to IConnection * Added property get standard for IntegrationAccount * Added property get pattern to xml docs and identical returns tag. * Change all color class references to struct ...because it isn't a class. * Add XML docs * Rewrote the returns tags in IGuildIntegration, removed the ones I was unsure about. * Rewrote the rest of the returns tags * Amendments * Cleanup doc for c1d78189 * Added types to <returns> tags where missing * Added second sample for adding reactions * Added some class summaries * Missed a period * Amendments * restored the removed line break * Removed unnecessary see tag * Use consistent quotation marks around subscribers, the name for these users are dependant on the source of where they are integrated from (youtube or twitch), so we should not use a name that is specific to one platform * Add <remarks> tag to the IGuildIntegration xmldocs * Fix grammar issue * Update DescriptionGenerator * Cleanup of https://github.com/Still34/Discord.Net/pull/8 * Cleanup previous PR * Fix for misleading behaviour in the emoji guide + Original lines stated that sending a emoji wrapped in colon will not be parsed, but that was incorrect; replaced with reactions instead of sending messages as the example * Add strings for dictionary in DotSettings * Add XML docs * Fix lots of typos in comments + Geez, I didn't know there were so many. * Add XML docs & rewrite GetMessagesAsync docs This commit rewrites the remarks section of GetMessagesAsync, as well as adding examples to several methods. * Update 'Your First Bot' + This commit reflects the new changes made to the Discord Application Developer Portal after its major update * Initial optimization for DocFX render & add missing files * Add examples in message methods * Cleanup https://github.com/RogueException/Discord.Net/pull/1128 * Fix first bot note * Cleanup FAQ structure * Add XML docs * Update docfx plugins * Fix navbar collapsing issue * Fix broken xref * Cleanup FAQ section + Add introductory paragraphs to each FAQ section. + Add 'missing dependency' entry to commands FAQ. * Split commands FAQ to 'General' and 'DI' sections. * Cleanup https://github.com/RogueException/Discord.Net/pull/1139 * Fix missing namespace * Add missing highlighting css for the light theme * Add additional clarification for installing packages * Add indentation to example for clarity * Cleanup several articles to be more human-friendly and easier to read * Remove RPC-related notes * Cleanup slow-mode-related documentation strings * Add an additional note about cross-guild emote usage * Add CreateTextChannel sample * Add XMLDocs
7 years ago
9 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Collections.Immutable;
  4. using System.Text;
  5. using System.Threading.Tasks;
  6. namespace Discord.Commands
  7. {
  8. internal static class CommandParser
  9. {
  10. private enum ParserPart
  11. {
  12. None,
  13. Parameter,
  14. QuotedParameter
  15. }
  16. public static async Task<ParseResult> ParseArgsAsync(CommandInfo command, ICommandContext context, bool ignoreExtraArgs, IServiceProvider services, string input, int startPos, IReadOnlyDictionary<char, char> aliasMap)
  17. {
  18. ParameterInfo curParam = null;
  19. StringBuilder argBuilder = new StringBuilder(input.Length);
  20. int endPos = input.Length;
  21. var curPart = ParserPart.None;
  22. int lastArgEndPos = int.MinValue;
  23. var argList = ImmutableArray.CreateBuilder<TypeReaderResult>();
  24. var paramList = ImmutableArray.CreateBuilder<TypeReaderResult>();
  25. bool isEscaping = false;
  26. char c, matchQuote = '\0';
  27. // local helper functions
  28. bool IsOpenQuote(IReadOnlyDictionary<char, char> dict, char ch)
  29. {
  30. // return if the key is contained in the dictionary if it is populated
  31. if (dict.Count != 0)
  32. return dict.ContainsKey(ch);
  33. // or otherwise if it is the default double quote
  34. return c == '\"';
  35. }
  36. char GetMatch(IReadOnlyDictionary<char, char> dict, char ch)
  37. {
  38. // get the corresponding value for the key, if it exists
  39. // and if the dictionary is populated
  40. if (dict.Count != 0 && dict.TryGetValue(c, out var value))
  41. return value;
  42. // or get the default pair of the default double quote
  43. return '\"';
  44. }
  45. for (int curPos = startPos; curPos <= endPos; curPos++)
  46. {
  47. if (curPos < endPos)
  48. c = input[curPos];
  49. else
  50. c = '\0';
  51. //If we're processing an remainder parameter, ignore all other logic
  52. if (curParam != null && curParam.IsRemainder && curPos != endPos)
  53. {
  54. argBuilder.Append(c);
  55. continue;
  56. }
  57. //If this character is escaped, skip it
  58. if (isEscaping)
  59. {
  60. if (curPos != endPos)
  61. {
  62. // if this character matches the quotation mark of the end of the string
  63. // means that it should be escaped
  64. // but if is not, then there is no reason to escape it then
  65. if (c != matchQuote)
  66. {
  67. // if no reason to escape the next character, then re-add \ to the arg
  68. argBuilder.Append('\\');
  69. }
  70. argBuilder.Append(c);
  71. isEscaping = false;
  72. continue;
  73. }
  74. }
  75. //Are we escaping the next character?
  76. if (c == '\\' && (curParam == null || !curParam.IsRemainder))
  77. {
  78. isEscaping = true;
  79. continue;
  80. }
  81. //If we're not currently processing one, are we starting the next argument yet?
  82. if (curPart == ParserPart.None)
  83. {
  84. if (char.IsWhiteSpace(c) || curPos == endPos)
  85. continue; //Skip whitespace between arguments
  86. else if (curPos == lastArgEndPos)
  87. return ParseResult.FromError(CommandError.ParseFailed, "There must be at least one character of whitespace between arguments.");
  88. else
  89. {
  90. if (curParam == null)
  91. curParam = command.Parameters.Count > argList.Count ? command.Parameters[argList.Count] : null;
  92. if (curParam != null && curParam.IsRemainder)
  93. {
  94. argBuilder.Append(c);
  95. continue;
  96. }
  97. if (IsOpenQuote(aliasMap, c))
  98. {
  99. curPart = ParserPart.QuotedParameter;
  100. matchQuote = GetMatch(aliasMap, c);
  101. continue;
  102. }
  103. curPart = ParserPart.Parameter;
  104. }
  105. }
  106. //Has this parameter ended yet?
  107. string argString = null;
  108. if (curPart == ParserPart.Parameter)
  109. {
  110. if (curPos == endPos || char.IsWhiteSpace(c))
  111. {
  112. argString = argBuilder.ToString();
  113. lastArgEndPos = curPos;
  114. }
  115. else
  116. argBuilder.Append(c);
  117. }
  118. else if (curPart == ParserPart.QuotedParameter)
  119. {
  120. if (c == matchQuote)
  121. {
  122. argString = argBuilder.ToString(); //Remove quotes
  123. lastArgEndPos = curPos + 1;
  124. }
  125. else
  126. argBuilder.Append(c);
  127. }
  128. if (argString != null)
  129. {
  130. if (curParam == null)
  131. {
  132. if (command.IgnoreExtraArgs)
  133. break;
  134. else
  135. return ParseResult.FromError(CommandError.BadArgCount, "The input text has too many parameters.");
  136. }
  137. var typeReaderResult = await curParam.ParseAsync(context, argString, services).ConfigureAwait(false);
  138. if (!typeReaderResult.IsSuccess && typeReaderResult.Error != CommandError.MultipleMatches)
  139. return ParseResult.FromError(typeReaderResult, curParam);
  140. if (curParam.IsMultiple)
  141. {
  142. paramList.Add(typeReaderResult);
  143. curPart = ParserPart.None;
  144. }
  145. else
  146. {
  147. argList.Add(typeReaderResult);
  148. curParam = null;
  149. curPart = ParserPart.None;
  150. }
  151. argBuilder.Clear();
  152. }
  153. }
  154. if (curParam != null && curParam.IsRemainder)
  155. {
  156. var typeReaderResult = await curParam.ParseAsync(context, argBuilder.ToString(), services).ConfigureAwait(false);
  157. if (!typeReaderResult.IsSuccess)
  158. return ParseResult.FromError(typeReaderResult, curParam);
  159. argList.Add(typeReaderResult);
  160. }
  161. if (isEscaping)
  162. return ParseResult.FromError(CommandError.ParseFailed, "Input text may not end on an incomplete escape.");
  163. if (curPart == ParserPart.QuotedParameter)
  164. return ParseResult.FromError(CommandError.ParseFailed, "A quoted parameter is incomplete.");
  165. //Add missing optionals
  166. for (int i = argList.Count; i < command.Parameters.Count; i++)
  167. {
  168. var param = command.Parameters[i];
  169. if (param.IsMultiple)
  170. continue;
  171. if (!param.IsOptional)
  172. return ParseResult.FromError(CommandError.BadArgCount, "The input text has too few parameters.");
  173. argList.Add(TypeReaderResult.FromSuccess(param.DefaultValue));
  174. }
  175. return ParseResult.FromSuccess(argList.ToImmutable(), paramList.ToImmutable());
  176. }
  177. }
  178. }