Dnspy/dnSpy/dnSpy.Contracts.Logic/Decompiler/XmlDoc/XmlDocRenderer.cs

// Copyright (c) 2011 AlphaSierraPapa for the SharpDevelop Team
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
// software and associated documentation files (the "Software"), to deal in the Software
// without restriction, including without limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
// to whom the Software is furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all copies or
// substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

using System;
using System.IO;
using System.Text;
using System.Text.RegularExpressions;
using System.Xml;
using dnSpy.Contracts.Text;

namespace dnSpy.Contracts.Decompiler.XmlDoc {
	/// <summary>
	/// XML doc output
	/// </summary>
	public interface IXmlDocOutput {
		/// <summary>
		/// Writes a new line
		/// </summary>
		void WriteNewLine();

		/// <summary>
		/// Writes a space character
		/// </summary>
		void WriteSpace();

		/// <summary>
		/// Writes text
		/// </summary>
		/// <param name="s">Text</param>
		/// <param name="data">Data</param>
		void Write(string s, object data);
	}

	/// <summary>
	/// Renders XML documentation
	/// </summary>
	public class XmlDocRenderer : IXmlDocOutput {
		readonly StringBuilder ret = new StringBuilder();

		void IXmlDocOutput.WriteNewLine() => ret.AppendLine();
		void IXmlDocOutput.WriteSpace() => ret.Append(' ');
		void IXmlDocOutput.Write(string s, object data) => ret.Append(s);

		/// <summary>
		/// Appends text
		/// </summary>
		/// <param name="text">Text</param>
		public void AppendText(string text) => ret.Append(text);

		/// <summary>
		/// Adds xml documentation
		/// </summary>
		/// <param name="xmlDocumentation">XML documentation</param>
		public void AddXmlDocumentation(string xmlDocumentation) => WriteXmlDoc(this, xmlDocumentation);

		/// <summary>
		/// Writes XML documentation
		/// </summary>
		/// <param name="output">Output</param>
		/// <param name="xmlDocumentation">XML documentation</param>
		/// <returns></returns>
		public static bool WriteXmlDoc(IXmlDocOutput output, string? xmlDocumentation) {
			if (xmlDocumentation is null)
				return false;
			try {
				XmlTextReader r = new XmlTextReader(new StringReader("<docroot>" + xmlDocumentation + "</docroot>"));
				r.XmlResolver = null;
				AddXmlDocumentation(output, r);
			}
			catch (XmlException) {
			}
			return true;
		}

		/// <summary>
		/// Whitespace regex
		/// </summary>
		public static Regex WhitespaceRegex => whitespace;
		static readonly Regex whitespace = new Regex(@"\s+");

		static void AddXmlDocumentation(IXmlDocOutput output, XmlReader xml) {
			bool isNewLine = true;
			while (xml.Read()) {
				if (xml.NodeType == XmlNodeType.Element) {
					string elname = xml.Name.ToLowerInvariant();
					switch (elname) {
					case "filterpriority":
					case "remarks":
						xml.Skip();
						break;
					case "example":
						output.WriteNewLine();
						output.Write("Example", BoxedTextColor.XmlDocToolTipHeader);
						output.Write(":", BoxedTextColor.Text);
						output.WriteNewLine();
						isNewLine = true;
						break;
					case "exception":
						output.WriteNewLine();
						output.Write(GetCref(xml["cref"]), BoxedTextColor.XmlDocToolTipHeader);
						output.Write(":", BoxedTextColor.Text);
						output.WriteSpace();
						isNewLine = false;
						break;
					case "returns":
						output.WriteNewLine();
						output.Write("Returns", BoxedTextColor.XmlDocToolTipHeader);
						output.Write(":", BoxedTextColor.Text);
						output.WriteSpace();
						isNewLine = false;
						break;
					case "see":
						output.Write(GetCref(xml["cref"]), BoxedTextColor.Text);
						output.Write((xml["langword"] ?? string.Empty).Trim(), BoxedTextColor.Keyword);
						isNewLine = false;
						break;
					case "seealso":
						output.WriteNewLine();
						output.Write("See also", BoxedTextColor.XmlDocToolTipHeader);
						output.Write(":", BoxedTextColor.Text);
						output.WriteSpace();
						output.Write(GetCref(xml["cref"]), BoxedTextColor.Text);
						isNewLine = false;
						break;
					case "paramref":
						output.Write((xml["name"] ?? string.Empty).Trim(), BoxedTextColor.Parameter);
						isNewLine = false;
						break;
					case "param":
						output.WriteNewLine();
						output.Write(whitespace.Replace((xml["name"] ?? string.Empty).Trim(), " "), BoxedTextColor.Parameter);
						output.Write(":", BoxedTextColor.Text);
						output.WriteSpace();
						isNewLine = false;
						break;
					case "typeparam":
						output.WriteNewLine();
						output.Write(whitespace.Replace((xml["name"] ?? string.Empty).Trim(), " "), BoxedTextColor.TypeGenericParameter);
						output.Write(":", BoxedTextColor.Text);
						output.WriteSpace();
						isNewLine = false;
						break;
					case "value":
						output.WriteNewLine();
						output.Write("Value", BoxedTextColor.Keyword);
						output.Write(":", BoxedTextColor.Text);
						output.WriteNewLine();
						isNewLine = true;
						break;
					case "br":
					case "para":
						output.WriteNewLine();
						isNewLine = true;
						break;
					default:
						break;
					}
				}
				else if (xml.NodeType == XmlNodeType.Text) {
					var s = whitespace.Replace(xml.Value, " ");
					if (isNewLine)
						s = s.TrimStart();
					output.Write(s, BoxedTextColor.Text);
					isNewLine = false;
				}
			}
		}

		/// <summary>
		/// Gets a cref
		/// </summary>
		/// <param name="cref"></param>
		/// <returns></returns>
		public static string GetCref(string? cref) {
			if (string2.IsNullOrWhiteSpace(cref))
				return string.Empty;
			if (cref.Length < 2) {
				return cref.Trim();
			}
			if (cref.Substring(1, 1) == ":") {
				return cref.Substring(2, cref.Length - 2).Trim();
			}
			return cref.Trim();
		}

		/// <inheritdoc/>
		public override string ToString() => ret.ToString();
	}
}