SharpDevelop/ICSharpCode.NRefactory.CSharp/OutputVisitor/CSharpAmbience.cs

// Copyright (c) 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 ICSharpCode.NRefactory.CSharp.Refactoring;
using ICSharpCode.NRefactory.TypeSystem;
using ICSharpCode.NRefactory.TypeSystem.Implementation;

namespace ICSharpCode.NRefactory.CSharp
{
	/// <summary>
	/// C# ambience.
	/// </summary>
	public class CSharpAmbience : IAmbience
	{
		public ConversionFlags ConversionFlags { get; set; }
		
		#region ConvertEntity
		public string ConvertEntity(IEntity e, ITypeResolveContext context)
		{
			using (var ctx = context.Synchronize()) {
				StringWriter writer = new StringWriter();
				
				if (e.EntityType == EntityType.TypeDefinition) {
					ConvertTypeDeclaration((ITypeDefinition)e, ctx, writer);
				} else {
					ConvertMember((IMember)e, ctx, writer);
				}
				
				return writer.ToString().TrimEnd();
			}
		}
		
		void ConvertMember(IMember member, ISynchronizedTypeResolveContext ctx, StringWriter writer)
		{
			TypeSystemAstBuilder astBuilder = CreateAstBuilder(ctx);
			astBuilder.ShowParameterNames = (ConversionFlags & ConversionFlags.ShowParameterNames) == ConversionFlags.ShowParameterNames;
			
			AttributedNode node = (AttributedNode)astBuilder.ConvertEntity(member);
			PrintModifiers(node.Modifiers, writer);
			
			if ((ConversionFlags & ConversionFlags.ShowReturnType) == ConversionFlags.ShowReturnType) {
				var rt = node.GetChildByRole(AstNode.Roles.Type);
				if (rt != AstNode.Roles.Type.NullObject) {
					writer.Write(rt.AcceptVisitor(CreatePrinter(writer), null));
					writer.Write(' ');
				}
			}
			
			WriteMemberDeclarationName(member, ctx, writer);
			
			if ((ConversionFlags & ConversionFlags.ShowParameterList) == ConversionFlags.ShowParameterList
			    && member is IParameterizedMember && member.EntityType != EntityType.Property) {
				writer.Write((node is IndexerDeclaration) ? '[' : '(');
				bool first = true;
				foreach (var param in node.GetChildrenByRole(AstNode.Roles.Parameter)) {
					if (first)
						first = false;
					else
						writer.Write(", ");
					param.AcceptVisitor(CreatePrinter(writer), null);
				}
				writer.Write((node is IndexerDeclaration) ? ']' : ')');
			}
		}

		TypeSystemAstBuilder CreateAstBuilder(ITypeResolveContext ctx)
		{
			TypeSystemAstBuilder astBuilder = new TypeSystemAstBuilder(ctx);
			astBuilder.ShowModifiers = (ConversionFlags & ConversionFlags.ShowModifiers) == ConversionFlags.ShowModifiers;
			astBuilder.ShowAccessibility = (ConversionFlags & ConversionFlags.ShowAccessibility) == ConversionFlags.ShowAccessibility;
			astBuilder.AlwaysUseShortTypeNames = (ConversionFlags & ConversionFlags.UseFullyQualifiedTypeNames) != ConversionFlags.UseFullyQualifiedTypeNames;
			return astBuilder;
		}
		
		void ConvertTypeDeclaration(ITypeDefinition typeDef, ITypeResolveContext ctx, StringWriter writer)
		{
			TypeSystemAstBuilder astBuilder = CreateAstBuilder(ctx);
			TypeDeclaration typeDeclaration = (TypeDeclaration)astBuilder.ConvertEntity(typeDef);
			PrintModifiers(typeDeclaration.Modifiers, writer);
			if ((ConversionFlags & ConversionFlags.ShowDefinitionKeyWord) == ConversionFlags.ShowDefinitionKeyWord) {
				switch (typeDeclaration.ClassType) {
					case ClassType.Class:
						writer.Write("class");
						break;
					case ClassType.Struct:
						writer.Write("struct");
						break;
					case ClassType.Interface:
						writer.Write("interface");
						break;
					case ClassType.Enum:
						writer.Write("enum");
						break;
					default:
						throw new Exception("Invalid value for ClassType");
				}
				writer.Write(' ');
			}
			WriteTypeDeclarationName(typeDef, ctx, writer);
		}

		void WriteTypeDeclarationName(ITypeDefinition typeDef, ITypeResolveContext ctx, StringWriter writer)
		{
			TypeSystemAstBuilder astBuilder = CreateAstBuilder(ctx);
			if (typeDef.DeclaringTypeDefinition != null) {
				WriteTypeDeclarationName(typeDef.DeclaringTypeDefinition, ctx, writer);
				writer.Write('.');
			} else if ((ConversionFlags & ConversionFlags.UseFullyQualifiedMemberNames) == ConversionFlags.UseFullyQualifiedMemberNames) {
				writer.Write(typeDef.Namespace);
				writer.Write('.');
			}
			writer.Write(typeDef.Name);
			if ((ConversionFlags & ConversionFlags.ShowTypeParameterList) == ConversionFlags.ShowTypeParameterList) {
				CreatePrinter(writer).WriteTypeParameters(((TypeDeclaration)astBuilder.ConvertEntity(typeDef)).TypeParameters);
			}
		}
		
		void WriteMemberDeclarationName(IMember member, ITypeResolveContext ctx, StringWriter writer)
		{
			TypeSystemAstBuilder astBuilder = CreateAstBuilder(ctx);
			if ((ConversionFlags & ConversionFlags.UseFullyQualifiedMemberNames) == ConversionFlags.UseFullyQualifiedMemberNames) {
				writer.Write(ConvertType(member.DeclaringType));
				writer.Write('.');
			}
			switch (member.EntityType) {
				case EntityType.Indexer:
					writer.Write("this");
					break;
				case EntityType.Constructor:
					writer.Write(member.DeclaringType.Name);
					break;
				case EntityType.Destructor:
					writer.Write('~');
					writer.Write(member.DeclaringType.Name);
					break;
				case EntityType.Operator:
					switch (member.Name) {
						case "op_Implicit":
							writer.Write("implicit operator ");
							writer.Write(ConvertType(member.ReturnType, ctx));
							break;
						case "op_Explicit":
							writer.Write("explicit operator ");
							writer.Write(ConvertType(member.ReturnType, ctx));
							break;
						default:
							writer.Write("operator ");
							var operatorType = OperatorDeclaration.GetOperatorType(member.Name);
							if (operatorType.HasValue)
								writer.Write(OperatorDeclaration.GetToken(operatorType.Value));
							else
								writer.Write(member.Name);
							break;
					}
					break;
				default:
					writer.Write(member.Name);
					break;
			}
			if ((ConversionFlags & ConversionFlags.ShowTypeParameterList) == ConversionFlags.ShowTypeParameterList && member.EntityType == EntityType.Method) {
				CreatePrinter(writer).WriteTypeParameters(astBuilder.ConvertEntity(member).GetChildrenByRole(AstNode.Roles.TypeParameter));
			}
		}
		
		CSharpOutputVisitor CreatePrinter(StringWriter writer)
		{
			return new CSharpOutputVisitor(writer, new CSharpFormattingOptions());
		}
		
		void PrintModifiers(Modifiers modifiers, StringWriter writer)
		{
			foreach (var m in CSharpModifierToken.AllModifiers) {
				if ((modifiers & m) == m) {
					writer.Write(CSharpModifierToken.GetModifierName(m));
					writer.Write(' ');
				}
			}
		}
		#endregion
		
		public string ConvertVariable(IVariable v, ITypeResolveContext context)
		{
			using (var ctx = context.Synchronize()) {
				TypeSystemAstBuilder astBuilder = CreateAstBuilder(ctx);
				AstNode astNode = astBuilder.ConvertVariable(v);
				CSharpFormattingOptions formatting = new CSharpFormattingOptions();
				StringWriter writer = new StringWriter();
				astNode.AcceptVisitor(new CSharpOutputVisitor(writer, formatting), null);
				return writer.ToString().TrimEnd(';', '\r', '\n');
			}
		}
		
		public string ConvertType(IType type)
		{
			TypeSystemAstBuilder astBuilder = CreateAstBuilder(MinimalResolveContext.Instance);
			AstType astType = astBuilder.ConvertType(type);
			CSharpFormattingOptions formatting = new CSharpFormattingOptions();
			StringWriter writer = new StringWriter();
			astType.AcceptVisitor(new CSharpOutputVisitor(writer, formatting), null);
			return writer.ToString();
		}
		
		public string ConvertType(ITypeReference type, ITypeResolveContext context)
		{
			using (var ctx = context.Synchronize()) {
				TypeSystemAstBuilder astBuilder = CreateAstBuilder(ctx);
				AstType astType = astBuilder.ConvertTypeReference(type);
				CSharpFormattingOptions formatting = new CSharpFormattingOptions();
				StringWriter writer = new StringWriter();
				astType.AcceptVisitor(new CSharpOutputVisitor(writer, formatting), null);
				return writer.ToString();
			}
		}
		
		public string WrapAttribute(string attribute)
		{
			return "[" + attribute + "]";
		}
		
		public string WrapComment(string comment)
		{
			return "// " + comment;
		}
	}
}