diff --git a/src/Discord.Net.Core/Entities/Messages/Builders/CodeLanguage.cs b/src/Discord.Net.Core/Entities/Messages/Builders/CodeLanguage.cs new file mode 100644 index 000000000..7cfddbde6 --- /dev/null +++ b/src/Discord.Net.Core/Entities/Messages/Builders/CodeLanguage.cs @@ -0,0 +1,101 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Discord +{ + /// + /// Represents a language in which codeblocks can be formatted. + /// + public struct CodeLanguage + { + /// + /// Gets the tag of the language. + /// + public string Tag { get; } + + /// + /// Gets the name of the language. if this was constructed with no name provided. + /// + public string Name { get; } = string.Empty; + + /// + /// Gets the CSharp language format. + /// + public static readonly CodeLanguage CSharp = new("cs", "csharp"); + + /// + /// Gets the Javascript language format. + /// + public static readonly CodeLanguage JavaScript = new("js", "javascript"); + + /// + /// Gets the XML language format. + /// + public static readonly CodeLanguage XML = new("xml", "xml"); + + /// + /// Gets the HTML language format. + /// + public static readonly CodeLanguage HTML = new("html", "html"); + + /// + /// Gets the CSS markdown format. + /// + public static readonly CodeLanguage CSS = new("css", "css"); + + /// + /// Gets a language format that represents none. + /// + public static readonly CodeLanguage None = new("", "none"); + + /// + /// Creates a new language format with name & tag. + /// + /// The tag with which markdown will be formatted. + /// The name of the language. + public CodeLanguage(string tag, string name) + { + Tag = tag; + Name = name; + } + + /// + /// Creates a new language format with a tag. + /// + /// The tag with which markdown will be formatted. + public CodeLanguage(string tag) + => Tag = tag; + + /// + /// Gets the tag of the language. + /// + /// + public static implicit operator string(CodeLanguage language) + => language.Tag; + + /// + /// Gets a language based on the tag. + /// + /// + public static implicit operator CodeLanguage(string tag) + => new(tag); + + /// + /// Creates markdown format for this language. + /// + /// The input string to format. + /// A markdown formatted code-block with this language. + public string ToMarkdown(string input) + => $"```{Tag}\n{input}\n```"; + + /// + /// Gets the tag of the language. + /// + /// + public override string ToString() + => $"{Tag}"; + } +} diff --git a/src/Discord.Net.Core/Entities/Messages/Builders/HeaderFormat.cs b/src/Discord.Net.Core/Entities/Messages/Builders/HeaderFormat.cs new file mode 100644 index 000000000..029110a1b --- /dev/null +++ b/src/Discord.Net.Core/Entities/Messages/Builders/HeaderFormat.cs @@ -0,0 +1,64 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Discord +{ + /// + /// Represents the format in which a markdown header should be presented. + /// + public readonly struct HeaderFormat + { + public string Format { get; } + + /// + /// The biggest header type. + /// + public static readonly HeaderFormat H1 = new("#"); + + /// + /// An above-average sized header. + /// + public static readonly HeaderFormat H2 = new("##"); + + /// + /// An average-sized header. + /// + public static readonly HeaderFormat H3 = new("###"); + + /// + /// A subheader. + /// + public static readonly HeaderFormat H4 = new("####"); + + /// + /// A smaller subheader. + /// + public static readonly HeaderFormat H5 = new("#####"); + + /// + /// Slightly bigger than regular bold markdown. + /// + public static readonly HeaderFormat H6 = new("######"); + + private HeaderFormat(string format) + => Format = format; + + /// + /// Formats this header into markdown, appending provided string. + /// + /// The string to turn into a header. + /// A markdown formatted header title. + public string ToMarkdown(string input) + => $"{Format} {input}"; + + /// + /// Gets the markdown format for this header. + /// + /// The markdown format for this header. + public override string ToString() + => $"{Format}"; + } +} diff --git a/src/Discord.Net.Core/Entities/Messages/MessageBuilder.cs b/src/Discord.Net.Core/Entities/Messages/Builders/MessageBuilder.cs similarity index 84% rename from src/Discord.Net.Core/Entities/Messages/MessageBuilder.cs rename to src/Discord.Net.Core/Entities/Messages/Builders/MessageBuilder.cs index c03f38029..be740fe26 100644 --- a/src/Discord.Net.Core/Entities/Messages/MessageBuilder.cs +++ b/src/Discord.Net.Core/Entities/Messages/Builders/MessageBuilder.cs @@ -8,35 +8,40 @@ using System.Threading.Tasks; namespace Discord { /// - /// Represents a generic message builder that can build s. + /// Represents a generic message builder that can build 's. /// public class MessageBuilder { - private string _content; - private List _stickers = new(); - private List _embeds = new(); - private List _files = new(); + private readonly List _files; + + private List _stickers; + private List _embeds; + /// /// Gets or sets the content of this message /// - /// The content is bigger than the . - public string Content - { - get => _content; - set - { - if (_content?.Length > DiscordConfig.MaxMessageSize) - throw new ArgumentOutOfRangeException(nameof(value), $"Message size must be less than or equal to {DiscordConfig.MaxMessageSize} characters"); - - _content = value; - } - } + public TextBuilder Content { get; set; } /// /// Gets or sets whether or not this message is TTS. /// public bool IsTTS { get; set; } + /// + /// Gets or sets the allowed mentions of this message. + /// + public AllowedMentions AllowedMentions { get; set; } + + /// + /// Gets or sets the message reference (reply to) of this message. + /// + public MessageReference MessageReference { get; set; } + + /// + /// Gets or sets the components of this message. + /// + public ComponentBuilder Components { get; set; } + /// /// Gets or sets the embeds of this message. /// @@ -52,21 +57,6 @@ namespace Discord } } - /// - /// Gets or sets the allowed mentions of this message. - /// - public AllowedMentions AllowedMentions { get; set; } - - /// - /// Gets or sets the message reference (reply to) of this message. - /// - public MessageReference MessageReference { get; set; } - - /// - /// Gets or sets the components of this message. - /// - public ComponentBuilder Components { get; set; } = new(); - /// /// Gets or sets the stickers sent with this message. /// @@ -100,14 +90,32 @@ namespace Discord /// public MessageFlags Flags { get; set; } + /// + /// Creates a new based on the value of . + /// + /// The message content to create this from. + public MessageBuilder(string content) + { + Content = new TextBuilder(content); + } + + public MessageBuilder() + { + _embeds = new(); + _stickers = new(); + _files = new(); + + Components = new(); + } + /// /// Sets the of this message. /// /// The content of the message. /// The current builder. - public MessageBuilder WithContent(string content) + public virtual MessageBuilder WithContent(TextBuilder builder) { - Content = content; + Content = builder; return this; } @@ -116,7 +124,7 @@ namespace Discord /// /// whether or not this message is tts. /// The current builder. - public MessageBuilder WithTTS(bool isTTS) + public virtual MessageBuilder WithTTS(bool isTTS) { IsTTS = isTTS; return this; @@ -128,7 +136,7 @@ namespace Discord /// The embeds to be put in this message. /// The current builder. /// A message can only contain a maximum of embeds. - public MessageBuilder WithEmbeds(params EmbedBuilder[] embeds) + public virtual MessageBuilder WithEmbeds(params EmbedBuilder[] embeds) { Embeds = new(embeds); return this; @@ -140,7 +148,7 @@ namespace Discord /// The embed builder to add /// The current builder. /// A message can only contain a maximum of embeds. - public MessageBuilder AddEmbed(EmbedBuilder embed) + public virtual MessageBuilder AddEmbed(EmbedBuilder embed) { if (_embeds?.Count >= DiscordConfig.MaxEmbedsPerMessage) throw new ArgumentOutOfRangeException(nameof(embed.Length), $"A message can only contain a maximum of {DiscordConfig.MaxEmbedsPerMessage} embeds"); @@ -157,7 +165,7 @@ namespace Discord /// /// The allowed mentions for this message. /// The current builder. - public MessageBuilder WithAllowedMentions(AllowedMentions allowedMentions) + public virtual MessageBuilder WithAllowedMentions(AllowedMentions allowedMentions) { AllowedMentions = allowedMentions; return this; @@ -168,7 +176,7 @@ namespace Discord /// /// The message reference (reply-to) for this message. /// The current builder. - public MessageBuilder WithMessageReference(MessageReference reference) + public virtual MessageBuilder WithMessageReference(MessageReference reference) { MessageReference = reference; return this; @@ -179,7 +187,7 @@ namespace Discord /// /// The message to set as a reference. /// The current builder. - public MessageBuilder WithMessageReference(IMessage message) + public virtual MessageBuilder WithMessageReference(IMessage message) { if (message != null) MessageReference = new MessageReference(message.Id, message.Channel?.Id, ((IGuildChannel)message.Channel)?.GuildId); @@ -191,7 +199,7 @@ namespace Discord /// /// The component builder to set. /// The current builder. - public MessageBuilder WithComponentBuilder(ComponentBuilder builder) + public virtual MessageBuilder WithComponentBuilder(ComponentBuilder builder) { Components = builder; return this; @@ -203,7 +211,7 @@ namespace Discord /// The button builder to add. /// The optional row to place the button on. /// The current builder. - public MessageBuilder WithButton(ButtonBuilder button, int row = 0) + public virtual MessageBuilder WithButton(ButtonBuilder button, int row = 0) { Components ??= new(); Components.WithButton(button, row); @@ -221,7 +229,7 @@ namespace Discord /// Whether or not the newly created button is disabled. /// The row the button should be placed on. /// The current builder. - public MessageBuilder WithButton( + public virtual MessageBuilder WithButton( string label = null, string customId = null, ButtonStyle style = ButtonStyle.Primary, @@ -241,7 +249,7 @@ namespace Discord /// The select menu builder to add. /// The optional row to place the select menu on. /// The current builder. - public MessageBuilder WithSelectMenu(SelectMenuBuilder menu, int row = 0) + public virtual MessageBuilder WithSelectMenu(SelectMenuBuilder menu, int row = 0) { Components ??= new(); Components.WithSelectMenu(menu, row); @@ -259,7 +267,7 @@ namespace Discord /// Whether or not the menu is disabled. /// The row to add the menu to. /// The current builder. - public MessageBuilder WithSelectMenu(string customId, List options, + public virtual MessageBuilder WithSelectMenu(string customId, List options, string placeholder = null, int minValues = 1, int maxValues = 1, bool disabled = false, int row = 0) { Components ??= new(); @@ -272,7 +280,7 @@ namespace Discord /// /// The file collection to set. /// The current builder. - public MessageBuilder WithFiles(IEnumerable files) + public virtual MessageBuilder WithFiles(IEnumerable files) { Files = new List(files); return this; @@ -283,7 +291,7 @@ namespace Discord /// /// The file to add. /// The current builder. - public MessageBuilder AddFile(FileAttachment file) + public virtual MessageBuilder AddFile(FileAttachment file) { Files.Add(file); return this; @@ -300,7 +308,7 @@ namespace Discord : ImmutableArray.Empty; return new Message( - _content, + Content.Build(), IsTTS, embeds, AllowedMentions, diff --git a/src/Discord.Net.Core/Entities/Messages/Builders/MultiLineBuilder.cs b/src/Discord.Net.Core/Entities/Messages/Builders/MultiLineBuilder.cs new file mode 100644 index 000000000..a571a94f7 --- /dev/null +++ b/src/Discord.Net.Core/Entities/Messages/Builders/MultiLineBuilder.cs @@ -0,0 +1,125 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Discord +{ + /// + /// Represents a builder for multi-line text. + /// + public class MultiLineBuilder + { + /// + /// The underlying list of lines this builder uses to construct multiline text. + /// + public List Lines { get; set; } + + /// + /// Creates a new instance of . + /// + public MultiLineBuilder() + { + Lines = new(); + } + + /// + /// Creates a new instance of with a pre-defined capacity. + /// + /// + public MultiLineBuilder(int capacity) + { + Lines = new(capacity); + } + + /// + /// Creates a new instance of with a number of lines pre-defined. + /// + /// The range of lines to add to this builder. + public MultiLineBuilder(params string[] entries) + { + Lines = new(entries); + } + + /// + /// Adds a line to the builder. + /// + /// The text to add to this line. + /// The same instance with a line appended. + public MultiLineBuilder AddLine(string text) + { + Lines.Add(text); + return this; + } + + /// + /// Adds a range of lines to the builder. + /// + /// The range of text to add. + /// The same instance with a range of lines appended. + public MultiLineBuilder AddLines(IEnumerable text) + { + if (!text.Any()) + throw new ArgumentException("The passed range does not contain any values", nameof(text)); + + Lines.AddRange(text); + return this; + } + + /// + /// Removes a (or more) line(s) from the builder. + /// + /// The predicate to remove lines with. + /// The same instance with all lines matching removed. + public MultiLineBuilder RemoveLine(Predicate predicate) + { + if (predicate is null) + throw new ArgumentNullException(nameof(predicate)); + + Lines.RemoveAll(x => predicate(x)); + return this; + } + + /// + /// Removes a line from the builder. + /// + /// The index to remove a line at. + /// + public MultiLineBuilder RemoveLine(int index) + { + Lines.RemoveAt(index); + return this; + } + + /// + /// Gets the line at a specific index. + /// + /// The index to get a line for. + /// The line at defined . + public string this[int index] + { + get + { + return Lines[index]; + } + } + + /// + /// Builds the builder into multiline text. + /// + /// A string representing the lines added in this builder. + public string Build() + => string.Join(Environment.NewLine, Lines); + + /// + /// Creates a string from the lines currently present in . + /// + /// + /// This method has the same behavior as . + /// + /// A string representing the lines added in this builder. + public override string ToString() + => string.Join(Environment.NewLine, Lines); + } +} diff --git a/src/Discord.Net.Core/Entities/Messages/Builders/TextBuilder.cs b/src/Discord.Net.Core/Entities/Messages/Builders/TextBuilder.cs new file mode 100644 index 000000000..3cff92c6c --- /dev/null +++ b/src/Discord.Net.Core/Entities/Messages/Builders/TextBuilder.cs @@ -0,0 +1,493 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Discord +{ + /// + /// Represents a builder to build Discord messages with markdown with. + /// + public class TextBuilder + { + private readonly StringBuilder _builder; + + private bool _lineStart = false; + + /// + /// Creates a new instance of . + /// + public TextBuilder() + { + _builder = new(); + } + + /// + /// Creates a new instance of with a starting string appended. + /// + /// The string to start the builder with. + public TextBuilder(string startingString) + { + _builder = new(startingString); + } + + /// + /// Creates a new instance of with a capacity and (optionally) max capacity defined. + /// + /// The init capacity of the underlying . + /// The maximum capacity of the underlying . + public TextBuilder(int capacity, int? maxCapacity = null) + { + if (maxCapacity is not null) + _builder = new(capacity, maxCapacity.Value); + else + _builder = new(capacity); + } + + /// + /// Adds a header to the builder. + /// + /// + /// [Note] Headers are only supported in forums, which are not released publically yet. + /// + /// The text to be present in the header. + /// The header format. + /// If the builder should skip a line when creating the next parameter. + /// The same instance with a header appended. This method will append a new line below the header. + public TextBuilder AddHeader(string text, HeaderFormat format, bool skipLine = true) + { + if (string.IsNullOrEmpty(text)) + throw new ArgumentException("Value cannot be null or empty.", nameof(text)); + + if (skipLine) + _builder.AppendLine(); + _builder.AppendLine(text.ToHeader(format)); + _lineStart = true; + return this; + } + + /// + /// Adds bold text to the builder. + /// + /// The text to be present in the markdown. + /// If the text should be appended in the same line or if it should append to a new line. + /// The same instance with bold text appended. + public TextBuilder AddBoldText(string text, bool inline = true) + { + if (string.IsNullOrEmpty(text)) + throw new ArgumentException("Value cannot be null or empty.", nameof(text)); + + Construct(Format.Bold(text), inline); + return this; + } + + /// + /// Adds bold text to the builder. + /// + /// A builder for multiline text. + /// If the text should be appended in the same line or if it should append to a new line. + /// The same instance with bold text appended. + public TextBuilder AddBoldText(MultiLineBuilder builder, bool inline = true) + { + if (builder is null) + throw new ArgumentNullException(nameof(builder)); + + var text = builder.Build(); + return AddBoldText(text, inline); + } + + /// + /// Adds italic text to the builder. + /// + /// The text to be present in the markdown. + /// If the text should be appended in the same line or if it should append to a new line. + /// The same instance with italic appended. + public TextBuilder AddItalicText(string text, bool inline = true) + { + if (string.IsNullOrEmpty(text)) + throw new ArgumentException("Value cannot be null or empty.", nameof(text)); + + Construct(Discord.Format.Italics(text), inline); + return this; + } + + /// + /// Adds italic text to the builder. + /// + /// A builder for multiline text. + /// If the text should be appended in the same line or if it should append to a new line. + /// The same instance with italic text appended. + public TextBuilder AddItalicText(MultiLineBuilder builder, bool inline = true) + { + if (builder is null) + throw new ArgumentNullException(nameof(builder)); + + var text = builder.Build(); + return AddItalicText(text, inline); + } + + /// + /// Adds plain text to the builder. + /// + /// The text to be present in the markdown. + /// If the text should be appended in the same line or if it should append to a new line. + /// The same instance with plain text appended. + public TextBuilder AddPlainText(string text, bool inline = true) + { + if (string.IsNullOrEmpty(text)) + throw new ArgumentException("Value cannot be null or empty.", nameof(text)); + + Construct(text, inline); + return this; + } + + /// + /// Adds plain text to the builder. + /// + /// A builder for multiline text. + /// If the text should be appended in the same line or if it should append to a new line. + /// The same instance with plain text appended. + public TextBuilder AddPlainText(MultiLineBuilder builder, bool inline = true) + { + if (builder is null) + throw new ArgumentNullException(nameof(builder)); + + var text = builder.Build(); + return AddPlainText(text, inline); + } + + /// + /// Adds underlined text to the builder. + /// + /// The text to be present in the markdown. + /// If the text should be appended in the same line or if it should append to a new line. + /// The same instance with underlined text appended. + public TextBuilder AddUnderlinedText(string text, bool inline = true) + { + if (string.IsNullOrEmpty(text)) + throw new ArgumentException("Value cannot be null or empty.", nameof(text)); + + Construct(text.ToUnderline(), inline); + return this; + } + + /// + /// Adds underlined text to the builder. + /// + /// A builder for multiline text. + /// If the text should be appended in the same line or if it should append to a new line. + /// The same instance with underlined text appended. + public TextBuilder AddUnderlinedText(MultiLineBuilder builder, bool inline = true) + { + if (builder is null) + throw new ArgumentNullException(nameof(builder)); + + var text = builder.Build(); + return AddUnderlinedText(text, inline); + } + + /// + /// Adds a timestamp to the builder. + /// + /// The time for which this timestamp should be created. + /// The style of the stamp. + /// If the stamp should be appended in the same line or if it should append to a new line. + /// The same instance with a timestamp appended. + public TextBuilder AddTimestamp(DateTime dateTime, TimestampTagStyles style, bool inline = true) + { + Construct(TimestampTag.FromDateTime(dateTime, style).ToString(), inline); + return this; + } + + /// + /// Adds strikethrough text to the builder. + /// + /// The text to be present in the markdown. + /// If the text should be appended in the same line or if it should append to a new line. + /// The same instance with striked through text appended. + public TextBuilder AddStrikeThroughText(string text, bool inline = true) + { + if (string.IsNullOrEmpty(text)) + throw new ArgumentException("Value cannot be null or empty.", nameof(text)); + + Construct(text.ToStrikethrough(), inline); + return this; + } + + /// + /// Adds strikethrough text to the builder. + /// + /// A builder for multiline text. + /// If the text should be appended in the same line or if it should append to a new line. + /// The same instance with striked through text appended. + public TextBuilder AddStrikeThroughText(MultiLineBuilder builder, bool inline = true) + { + if (builder is null) + throw new ArgumentNullException(nameof(builder)); + + var text = builder.Build(); + return AddStrikeThroughText(text, inline); + } + + /// + /// Adds a spoiler to the builder. + /// + /// The text to be present in the markdown. + /// If the text should be appended in the same line or if it should append to a new line. + /// The same instance with a spoiler appended. + public TextBuilder AddSpoiler(string text, bool inline = true) + { + if (string.IsNullOrEmpty(text)) + throw new ArgumentException("Value cannot be null or empty.", nameof(text)); + + Construct(text.ToSpoiler(), inline); + return this; + } + + /// + /// Adds a spoiler to the builder. + /// + /// A builder for multiline text. + /// If the text should be appended in the same line or if it should append to a new line. + /// The same instance with a spoiler appended. + public TextBuilder AddSpoiler(MultiLineBuilder builder, bool inline = true) + { + if (builder is null) + throw new ArgumentNullException(nameof(builder)); + + var text = builder.Build(); + return AddSpoiler(text, inline); + } + + /// + /// Adds a quote to the builder. + /// + /// The text to be present in the markdown. + /// If the builder should skip a line when creating the next parameter. + /// The same instance with a quote appended. This method will append a new line below the quote. + public TextBuilder AddQuote(string text, bool skipLine = true) + { + if (string.IsNullOrEmpty(text)) + throw new ArgumentException("Value cannot be null or empty.", nameof(text)); + + if (skipLine) + _builder.AppendLine(); + _builder.AppendLine(text.ToQuote()); + _lineStart = true; + return this; + } + + /// + /// Adds a quote to the builder. + /// + /// A builder for multiline text. + /// If the text should be appended in the same line or if it should append to a new line. + /// The same instance with a quote appended. + public TextBuilder AddQuote(MultiLineBuilder builder, bool inline = true) + { + if (builder is null) + throw new ArgumentNullException(nameof(builder)); + + var text = builder.Build(); + return AddQuote(text, inline); + } + + /// + /// Adds a block quote to the builder. + /// + /// The text to be present in the markdown. + /// If the builder should skip a line when creating the next parameter. + /// The same instance with a block quote appended. This method will append a new line below the quote. + public TextBuilder AddBlockQuote(string text, bool skipLine = true) + { + if (string.IsNullOrEmpty(text)) + throw new ArgumentException("Value cannot be null or empty.", nameof(text)); + + if (skipLine) + _builder.AppendLine(); + _builder.AppendLine(text.ToBlockQuote()); + _lineStart = true; + return this; + } + + /// + /// Adds a block quote to the builder. + /// + /// A builder for multiline text. + /// If the builder should skip a line when creating the next parameter. + /// The same instance with a block quote appended. This method will append a new line below the quote. + public TextBuilder AddBlockQuote(MultiLineBuilder builder, bool skipLine = true) + { + if (builder is null) + throw new ArgumentNullException(nameof(builder)); + + var text = builder.Build(); + return AddBlockQuote(text, skipLine); + } + + /// + /// Adds code marked text to the builder. + /// + /// The text to be present in the markdown. + /// If the text should be appended in the same line or if it should append to a new line. + /// The same instance with code marked text appended. + public TextBuilder AddCode(string text, bool inline = false) + { + if (string.IsNullOrEmpty(text)) + throw new ArgumentException("Value cannot be null or empty.", nameof(text)); + + Construct(text.ToCode(), inline); + return this; + } + + /// + /// Adds code marked text to the builder. + /// + /// A builder for multiline text. + /// If the text should be appended in the same line or if it should append to a new line. + /// The same instance with code marked text appended. + public TextBuilder AddCode(MultiLineBuilder builder, bool inline = true) + { + if (builder is null) + throw new ArgumentNullException(nameof(builder)); + + var text = builder.Build(); + return AddCode(text, inline); + } + + /// + /// Adds a code block to the builder. + /// + /// The text to be present in the markdown. + /// The language in which this code should be presented. + /// If the builder should skip a line when creating the next parameter. + /// The same instance with a code block appended. This method will append a new line below the block. + public TextBuilder AddCodeBlock(string text, CodeLanguage? lang = null, bool skipLine = true) + { + if (string.IsNullOrEmpty(text)) + throw new ArgumentException("Value cannot be null or empty.", nameof(text)); + + lang ??= CodeLanguage.None; + if (skipLine) + _builder.AppendLine(); + _builder.AppendLine(text.ToCodeBlock(lang)); + _lineStart = true; + return this; + } + + /// + /// Adds a code block to the builder. + /// + /// A builder for multiline text. + /// The language in which this code should be presented. + /// If the builder should skip a line when creating the next parameter. + /// The same instance with a code block appended. This method will append a new line below the quote. + public TextBuilder AddCodeBlock(MultiLineBuilder builder, CodeLanguage? lang = null, bool skipLine = true) + { + if (builder is null) + throw new ArgumentNullException(nameof(builder)); + + var text = builder.Build(); + return AddCodeBlock(text, lang, skipLine); + } + + /// + /// Adds an emote to the builder. + /// + /// The emote to add. + /// If the emote should be appended in the same line or if it should append to a new line. + /// The same instance with an emote appended. + public TextBuilder AddEmote(IEmote emote, bool inline = false) + { + if (emote is null) + throw new ArgumentNullException(nameof(emote)); + var str = emote switch + { + Emote ee => ee.ToString(), + Emoji ei => ei.ToString(), + _ => null + }; + + Construct(str, inline); + return this; + } + + /// + /// Adds a range of emotes to the builder. + /// + /// The seperator to join the emotes with. + /// If the emotes should be appended in the same line or if it should append to a new line. + /// The range of emotes to add. + /// The same instance with a range of emotes appended. + public TextBuilder AddEmotes(string seperator, bool inline = false, params IEmote[] emotes) + { + if (!emotes.Any()) + throw new ArgumentException("No values were found in the passed selection", nameof(emotes)); + + var str = string.Join(seperator, emotes.Select(x => + { + return x switch + { + Emote emote => emote.ToString(), + Emoji emoji => emoji.ToString(), + _ => throw new ArgumentNullException(nameof(emotes)), + }; + })); + Construct(str, inline); + return this; + } + + /// + /// Starts the next query to the builder on a new line. + /// + /// The same instance with an empty line appended. + public TextBuilder AddNewline() + { + _builder.AppendLine(); + _lineStart = true; + return this; + } + + /// + /// Builds a Discord message string from this instance. + /// + /// The string to send to Discord. + public string Build() + => _builder.ToString(); + + private void Construct(string text, bool inline) + { + if (_builder.Length + text.Length > DiscordConfig.MaxMessageSize) + throw new ArgumentOutOfRangeException(nameof(text), $"Maximum message length of {DiscordConfig.MaxMessageSize} has been reached."); + + if (inline) + { + if (!_lineStart) + text = " " + text; + + else + _lineStart = false; + + _builder.Append(text); // add a space to define + } + else + { + if (_lineStart) + _lineStart = false; + _builder.AppendLine(); + _builder.Append(text); + } + } + + /// + /// Builds the underlying to a string. + /// + /// + /// This method has the same functionality as . + /// + /// The string to send to Discord. + public override string ToString() + => _builder.ToString(); + } +} diff --git a/src/Discord.Net.Core/Extensions/MarkdownExtensions.cs b/src/Discord.Net.Core/Extensions/MarkdownExtensions.cs new file mode 100644 index 000000000..c1be9208c --- /dev/null +++ b/src/Discord.Net.Core/Extensions/MarkdownExtensions.cs @@ -0,0 +1,101 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Discord +{ + internal static class MarkdownExtensions + { + public static string ToBold(this string text, int index = 0, int? count = null) //=> $"**{text}**"; + { + var length = count ?? (text.Length - index); + + return text.Format($"**{text.Substring(index, (index + length))}**", index, length); + } + + public static string ToItalic(this string text, int index = 0, int? count = null) //=> $"*{text}*"; + { + var length = count ?? (text.Length - index); + + return text.Format($"*{text.Substring(index, (index + length))}*", index, length); + } + + public static string ToUnderline(this string text, int index = 0, int? count = null) //=> $"__{text}__"; + { + var length = count ?? (text.Length - index); + + return text.Format($"__{text.Substring(index, (index + length))}__", index, length); + } + + public static string ToStrikethrough(this string text, int index = 0, int? count = null) //=> $"~~{text}~~"; + { + var length = count ?? (text.Length - index); + + return text.Format($"~~{text.Substring(index, (index + length))}~~", index, length); + } + + public static string ToSpoiler(this string text, int index = 0, int? count = null) //=> $"||{text}||"; + { + var length = count ?? (text.Length - index); + + return text.Format($"||{text.Substring(index, (index + length))}||", index, length); + } + + public static string ToQuote(this string text, int index = 0, int? count = null) //=> $"> {text}"; + { + if (index is 0 && count is null) + text = text.Replace(Environment.NewLine, $"{Environment.NewLine}> "); + + var length = count ?? (text.Length - index); + + return text.Format($"{Environment.NewLine}> {text.Substring(index, (index + length))}{Environment.NewLine}", index, length); + } + + public static string ToBlockQuote(this string text, int index = 0, int? count = null) //=> $">>> {text}"; + { + var length = count ?? (text.Length - index); + + return text.Format($"{Environment.NewLine}>>> {text.Substring(index, (index + length))}{Environment.NewLine}", index, length); + } + + public static string ToCode(this string text, int index = 0, int? count = null) //=> $"`{text}`"; + { + var length = count ?? (text.Length - index); + + return text.Format($"`{text.Substring(index, (index + length))}`", index, length); + } + + public static string ToCodeBlock(this string text, CodeLanguage? lang = null, int index = 0, int? count = null) + { + lang ??= CodeLanguage.None; + + var length = count ?? (text.Length - index); + + return text.Format($"```{lang.Value}{Environment.NewLine}{text.Substring(index, (index + length))}{Environment.NewLine}```", index, length); + } + + public static string ToHyperLink(this string text, string url, int index = 0, int? count = null) + { + var length = count ?? (text.Length - index); + + return text.Format($"[{text.Substring(index, (index + length))}]({url})", index, length); + } + + public static string ToHeader(this string text, HeaderFormat format, int index = 0, int? count = null) + { + var length = count ?? (text.Length - index); + + return text.Format($"{Environment.NewLine}{format.Format} {text.Substring(index, (index + length))} {Environment.NewLine}", index, length); + } + + public static string WithTimestamp(this string text, DateTime dateTime, TimestampTagStyles style, int index = 0) + => text.Insert(index, TimestampTag.FromDateTime(dateTime, style).ToString()); + + private static string Format(this string text, string format, int index, int length) + { + return text.Insert(index, format).Remove(index + format.Length, length); + } + } +} diff --git a/src/Discord.Net.Core/Format.cs b/src/Discord.Net.Core/Format.cs index dc2a06540..66a9bdb2f 100644 --- a/src/Discord.Net.Core/Format.cs +++ b/src/Discord.Net.Core/Format.cs @@ -10,22 +10,44 @@ namespace Discord private static readonly string[] SensitiveCharacters = { "\\", "*", "_", "~", "`", ".", ":", "/", ">", "|" }; - /// Returns a markdown-formatted string with bold formatting. + /// + /// Returns a markdown-formatted string with bold formatting. + /// public static string Bold(string text) => $"**{text}**"; - /// Returns a markdown-formatted string with italics formatting. + + /// + /// Returns a markdown-formatted string with italics formatting. + /// public static string Italics(string text) => $"*{text}*"; - /// Returns a markdown-formatted string with underline formatting. + + /// + /// Returns a markdown-formatted string with underline formatting. + /// public static string Underline(string text) => $"__{text}__"; - /// Returns a markdown-formatted string with strike-through formatting. + + /// + /// Returns a markdown-formatted string with strike-through formatting. + /// public static string Strikethrough(string text) => $"~~{text}~~"; - /// Returns a string with spoiler formatting. + + /// + /// Returns a string with spoiler formatting. + /// public static string Spoiler(string text) => $"||{text}||"; - /// Returns a markdown-formatted URL. Only works in descriptions and fields. + + /// + /// Returns a markdown-formatted URL. Only works in descriptions and fields. + /// public static string Url(string text, string url) => $"[{text}]({url})"; - /// Escapes a URL so that a preview is not generated. + + /// + /// Escapes a URL so that a preview is not generated. + /// public static string EscapeUrl(string url) => $"<{url}>"; - /// Returns a markdown-formatted string with codeblock formatting. + /// + /// Returns a markdown-formatted string with codeblock formatting. + /// public static string Code(string text, string language = null) { if (language != null || text.Contains("\n")) @@ -34,7 +56,9 @@ namespace Discord return $"`{text}`"; } - /// Sanitizes the string, safely escaping any Markdown sequences. + /// + /// Sanitizes the string, safely escaping any Markdown sequences. + /// public static string Sanitize(string text) { foreach (string unsafeChar in SensitiveCharacters)