CopyCommentsFromInterface.cs

// 
// CopyCommentsFromInterface.cs
//  
// Author:
//       Ji Kun <jikun.nus@gmail.com>
// 
// Copyright (c) 2013 Ji Kun <jikun.nus@gmail.com>
// 
// 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 ICSharpCode.NRefactory.TypeSystem;
using ICSharpCode.NRefactory.Semantics;

namespace ICSharpCode.NRefactory.CSharp.Refactoring
{
	/// <summary>
	///  Copies documented comments from interface to overriding methods.
	/// </summary>
	using System;
	using System.Collections.Generic;
	using System.Linq;
	
	[ContextAction("Copy comments from interface", Description = "Copies documented comments from interface to implementing methods.")]
	public class CopyCommentsFromInterface: SpecializedCodeAction <MethodDeclaration>
	{
		protected override CodeAction GetAction(RefactoringContext context, MethodDeclaration node)
		{
			if (!(node.PrivateImplementationType.IsNull))
				return null;
			
			if (!node.NameToken.Contains(context.Location))
				return null;
			
			var memberResolveResult = context.Resolve(node) as MemberResolveResult;
			if (memberResolveResult == null)
				return null;
			var method = memberResolveResult.Member as IMethod;
			if (method == null || method.Documentation != null)
				return null;
			
			IList<IMember> interfaceMethods = method.ImplementedInterfaceMembers;
			
			if (interfaceMethods.Count != 1 || method.DeclaringType.Kind == TypeKind.Interface)
				return null;
			
			var interfaceMethod = interfaceMethods.SingleOrDefault();

			if (interfaceMethod == null)
				return null;

			if (interfaceMethod.Documentation == null)
				return null;

			string comments = interfaceMethod.Documentation.ToString();
			
			if (comments == "")
				return null;
			
			string[] lines = comments.Split(new string[] { Environment.NewLine }, StringSplitOptions.RemoveEmptyEntries);
			return new CodeAction(context.TranslateString("Copy comments from interface"), script =>
			{
				foreach (string co in lines) {
					script.InsertBefore(node, new Comment(co, CommentType.Documentation));
				}
			}, node);
			
		}
	}
}