1
// Copyright (c) 2010-2013 AlphaSierraPapa for the SharpDevelop Team
3
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
4
// software and associated documentation files (the "Software"), to deal in the Software
5
// without restriction, including without limitation the rights to use, copy, modify, merge,
6
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
7
// to whom the Software is furnished to do so, subject to the following conditions:
9
// The above copyright notice and this permission notice shall be included in all copies or
10
// substantial portions of the Software.
12
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
13
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
14
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
15
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
16
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
17
// DEALINGS IN THE SOFTWARE.
21
using ICSharpCode.NRefactory.CSharp.Refactoring;
22
using ICSharpCode.NRefactory.TypeSystem;
24
namespace ICSharpCode.NRefactory.CSharp
29
public class CSharpAmbience : IAmbience
31
public ConversionFlags ConversionFlags { get; set; }
34
public string ConvertEntity(IEntity entity)
37
throw new ArgumentNullException("entity");
39
StringWriter writer = new StringWriter();
40
ConvertEntity(entity, new TextWriterOutputFormatter(writer), FormattingOptionsFactory.CreateMono ());
41
return writer.ToString();
44
public void ConvertEntity(IEntity entity, IOutputFormatter formatter, CSharpFormattingOptions formattingPolicy)
47
throw new ArgumentNullException("entity");
48
if (formatter == null)
49
throw new ArgumentNullException("formatter");
50
if (formattingPolicy == null)
51
throw new ArgumentNullException("options");
53
TypeSystemAstBuilder astBuilder = CreateAstBuilder();
54
EntityDeclaration node = astBuilder.ConvertEntity(entity);
55
PrintModifiers(node.Modifiers, formatter);
57
if ((ConversionFlags & ConversionFlags.ShowDefinitionKeyword) == ConversionFlags.ShowDefinitionKeyword) {
58
if (node is TypeDeclaration) {
59
switch (((TypeDeclaration)node).ClassType) {
61
formatter.WriteKeyword("class");
63
case ClassType.Struct:
64
formatter.WriteKeyword("struct");
66
case ClassType.Interface:
67
formatter.WriteKeyword("interface");
70
formatter.WriteKeyword("enum");
73
throw new Exception("Invalid value for ClassType");
76
} else if (node is DelegateDeclaration) {
77
formatter.WriteKeyword("delegate");
79
} else if (node is EventDeclaration) {
80
formatter.WriteKeyword("event");
85
if ((ConversionFlags & ConversionFlags.ShowReturnType) == ConversionFlags.ShowReturnType) {
86
var rt = node.GetChildByRole(Roles.Type);
88
rt.AcceptVisitor(new CSharpOutputVisitor(formatter, formattingPolicy));
93
if (entity is ITypeDefinition)
94
WriteTypeDeclarationName((ITypeDefinition)entity, formatter, formattingPolicy);
96
WriteMemberDeclarationName((IMember)entity, formatter, formattingPolicy);
98
if ((ConversionFlags & ConversionFlags.ShowParameterList) == ConversionFlags.ShowParameterList && HasParameters(entity)) {
99
formatter.WriteToken(entity.EntityType == EntityType.Indexer ? "[" : "(");
101
foreach (var param in node.GetChildrenByRole(Roles.Parameter)) {
105
formatter.WriteToken(",");
108
param.AcceptVisitor(new CSharpOutputVisitor(formatter, formattingPolicy));
110
formatter.WriteToken(entity.EntityType == EntityType.Indexer ? "]" : ")");
113
if ((ConversionFlags & ConversionFlags.ShowBody) == ConversionFlags.ShowBody && !(node is TypeDeclaration)) {
114
IProperty property = entity as IProperty;
115
if (property != null) {
117
formatter.WriteToken("{");
119
if (property.CanGet) {
120
formatter.WriteKeyword("get");
121
formatter.WriteToken(";");
124
if (property.CanSet) {
125
formatter.WriteKeyword("set");
126
formatter.WriteToken(";");
129
formatter.WriteToken("}");
131
formatter.WriteToken(";");
136
bool HasParameters(IEntity e)
138
switch (e.EntityType) {
139
case EntityType.TypeDefinition:
140
return ((ITypeDefinition)e).Kind == TypeKind.Delegate;
141
case EntityType.Indexer:
142
case EntityType.Method:
143
case EntityType.Operator:
144
case EntityType.Constructor:
145
case EntityType.Destructor:
152
TypeSystemAstBuilder CreateAstBuilder()
154
TypeSystemAstBuilder astBuilder = new TypeSystemAstBuilder();
155
astBuilder.AddAnnotations = true;
156
astBuilder.ShowModifiers = (ConversionFlags & ConversionFlags.ShowModifiers) == ConversionFlags.ShowModifiers;
157
astBuilder.ShowAccessibility = (ConversionFlags & ConversionFlags.ShowAccessibility) == ConversionFlags.ShowAccessibility;
158
astBuilder.AlwaysUseShortTypeNames = (ConversionFlags & ConversionFlags.UseFullyQualifiedTypeNames) != ConversionFlags.UseFullyQualifiedTypeNames;
159
astBuilder.ShowParameterNames = (ConversionFlags & ConversionFlags.ShowParameterNames) == ConversionFlags.ShowParameterNames;
163
void WriteTypeDeclarationName(ITypeDefinition typeDef, IOutputFormatter formatter, CSharpFormattingOptions formattingPolicy)
165
TypeSystemAstBuilder astBuilder = CreateAstBuilder();
166
if (typeDef.DeclaringTypeDefinition != null) {
167
WriteTypeDeclarationName(typeDef.DeclaringTypeDefinition, formatter, formattingPolicy);
168
formatter.WriteToken(".");
169
} else if ((ConversionFlags & ConversionFlags.UseFullyQualifiedTypeNames) == ConversionFlags.UseFullyQualifiedTypeNames) {
170
formatter.WriteIdentifier(typeDef.Namespace);
171
formatter.WriteToken(".");
173
formatter.WriteIdentifier(typeDef.Name);
174
if ((ConversionFlags & ConversionFlags.ShowTypeParameterList) == ConversionFlags.ShowTypeParameterList) {
175
var outputVisitor = new CSharpOutputVisitor(formatter, formattingPolicy);
176
outputVisitor.WriteTypeParameters(astBuilder.ConvertEntity(typeDef).GetChildrenByRole(Roles.TypeParameter));
180
void WriteMemberDeclarationName(IMember member, IOutputFormatter formatter, CSharpFormattingOptions formattingPolicy)
182
TypeSystemAstBuilder astBuilder = CreateAstBuilder();
183
if ((ConversionFlags & ConversionFlags.ShowDeclaringType) == ConversionFlags.ShowDeclaringType) {
184
ConvertType(member.DeclaringType, formatter, formattingPolicy);
185
formatter.WriteToken(".");
187
switch (member.EntityType) {
188
case EntityType.Indexer:
189
formatter.WriteKeyword("this");
191
case EntityType.Constructor:
192
formatter.WriteIdentifier(member.DeclaringType.Name);
194
case EntityType.Destructor:
195
formatter.WriteToken("~");
196
formatter.WriteIdentifier(member.DeclaringType.Name);
198
case EntityType.Operator:
199
switch (member.Name) {
201
formatter.WriteKeyword("implicit");
203
formatter.WriteKeyword("operator");
205
ConvertType(member.ReturnType, formatter, formattingPolicy);
208
formatter.WriteKeyword("explicit");
210
formatter.WriteKeyword("operator");
212
ConvertType(member.ReturnType, formatter, formattingPolicy);
215
formatter.WriteKeyword("operator");
217
var operatorType = OperatorDeclaration.GetOperatorType(member.Name);
218
if (operatorType.HasValue)
219
formatter.WriteToken(OperatorDeclaration.GetToken(operatorType.Value));
221
formatter.WriteIdentifier(member.Name);
226
formatter.WriteIdentifier(member.Name);
229
if ((ConversionFlags & ConversionFlags.ShowTypeParameterList) == ConversionFlags.ShowTypeParameterList && member.EntityType == EntityType.Method) {
230
var outputVisitor = new CSharpOutputVisitor(formatter, formattingPolicy);
231
outputVisitor.WriteTypeParameters(astBuilder.ConvertEntity(member).GetChildrenByRole(Roles.TypeParameter));
235
void PrintModifiers(Modifiers modifiers, IOutputFormatter formatter)
237
foreach (var m in CSharpModifierToken.AllModifiers) {
238
if ((modifiers & m) == m) {
239
formatter.WriteKeyword(CSharpModifierToken.GetModifierName(m));
246
public string ConvertVariable(IVariable v)
248
TypeSystemAstBuilder astBuilder = CreateAstBuilder();
249
AstNode astNode = astBuilder.ConvertVariable(v);
250
return astNode.GetText().TrimEnd(';', '\r', '\n');
253
public string ConvertType(IType type)
256
throw new ArgumentNullException("type");
258
TypeSystemAstBuilder astBuilder = CreateAstBuilder();
259
AstType astType = astBuilder.ConvertType(type);
260
return astType.GetText();
263
public void ConvertType(IType type, IOutputFormatter formatter, CSharpFormattingOptions formattingPolicy)
265
TypeSystemAstBuilder astBuilder = CreateAstBuilder();
266
AstType astType = astBuilder.ConvertType(type);
267
astType.AcceptVisitor(new CSharpOutputVisitor(formatter, formattingPolicy));
270
public string WrapComment(string comment)
272
return "// " + comment;