ILSpy/ICSharpCode.Decompiler/CSharp/Transforms/AddXmlDocumentationTransform.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.

#nullable enable

using System;
using System.IO;
using System.Linq;
using System.Reflection.Metadata;
using System.Xml;

using ICSharpCode.Decompiler.CSharp.Syntax;
using ICSharpCode.Decompiler.Documentation;
using ICSharpCode.Decompiler.TypeSystem;

namespace ICSharpCode.Decompiler.CSharp.Transforms
{
	/// <summary>
	/// Adds XML documentation for member definitions.
	/// </summary>
	public class AddXmlDocumentationTransform : IAstTransform
	{
		public void Run(AstNode rootNode, TransformContext context)
		{
			if (!context.Settings.ShowXmlDocumentation || context.DecompileRun.DocumentationProvider == null)
				return;
			try
			{
				var provider = context.DecompileRun.DocumentationProvider;
				foreach (var entityDecl in rootNode.DescendantsAndSelf.OfType<EntityDeclaration>())
				{
					if (!(entityDecl.GetSymbol() is IEntity entity))
						continue;
					string doc = provider.GetDocumentation(entity);
					if (doc == null && entity is IMethod { AccessorOwner: IProperty owner } accessor
						&& owner.IsParameterizedProperty() && accessor.Equals(owner.Getter ?? owner.Setter))
					{
						// A parameterized property is decompiled to its accessor methods; show the
						// property's documentation on the first accessor.
						doc = provider.GetDocumentation(owner);
					}
					if (doc != null)
					{
						context.Step("Add XML documentation", entityDecl);
						InsertXmlDocumentation(entityDecl, new StringReader(doc));
					}
				}
			}
			catch (XmlException ex)
			{
				string[] msg = (" Exception while reading XmlDoc: " + ex).Split(new[] { '\r', '\n' }, StringSplitOptions.RemoveEmptyEntries);
				for (int i = 0; i < msg.Length; i++)
					rootNode.AddLeadingTrivia(new Comment(msg[i], CommentType.Documentation));
			}
		}

		static void InsertXmlDocumentation(AstNode node, StringReader r)
		{
			// Find the first non-empty line:
			string? firstLine;
			do
			{
				firstLine = r.ReadLine();
				if (firstLine == null)
					return;
			} while (string.IsNullOrWhiteSpace(firstLine));
			string indentation = firstLine.Substring(0, firstLine.Length - firstLine.TrimStart().Length);
			string? line = firstLine;
			int skippedWhitespaceLines = 0;
			// Copy all lines from input to output, except for empty lines at the end.
			while (line != null)
			{
				if (string.IsNullOrWhiteSpace(line))
				{
					skippedWhitespaceLines++;
				}
				else
				{
					while (skippedWhitespaceLines > 0)
					{
						Comment emptyLine = new Comment(string.Empty, CommentType.Documentation);
						emptyLine.AddAnnotation(node.GetResolveResult());
						node.AddLeadingTrivia(emptyLine);
						skippedWhitespaceLines--;
					}
					if (line.StartsWith(indentation, StringComparison.Ordinal))
						line = line.Substring(indentation.Length);
					Comment comment = new Comment(" " + line, CommentType.Documentation);
					comment.AddAnnotation(node.GetResolveResult());
					node.AddLeadingTrivia(comment);
				}
				line = r.ReadLine();
			}
		}
	}
}