1
// Copyright (c) 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;
23
using ICSharpCode.NRefactory.TypeSystem.Implementation;
25
namespace ICSharpCode.NRefactory.CSharp
30
public class CSharpAmbience : IAmbience
32
public ConversionFlags ConversionFlags { get; set; }
35
public string ConvertEntity(IEntity entity)
38
throw new ArgumentNullException("entity");
40
StringWriter writer = new StringWriter();
41
ConvertEntity(entity, new TextWriterOutputFormatter(writer), FormattingOptionsFactory.CreateMono ());
42
return writer.ToString();
45
public void ConvertEntity(IEntity entity, IOutputFormatter formatter, CSharpFormattingOptions formattingPolicy)
48
throw new ArgumentNullException("entity");
49
if (formatter == null)
50
throw new ArgumentNullException("formatter");
51
if (formattingPolicy == null)
52
throw new ArgumentNullException("options");
54
TypeSystemAstBuilder astBuilder = CreateAstBuilder();
55
EntityDeclaration node = astBuilder.ConvertEntity(entity);
56
PrintModifiers(node.Modifiers, formatter);
58
if ((ConversionFlags & ConversionFlags.ShowDefinitionKeyword) == ConversionFlags.ShowDefinitionKeyword) {
59
if (node is TypeDeclaration) {
60
switch (((TypeDeclaration)node).ClassType) {
62
formatter.WriteKeyword("class");
64
case ClassType.Struct:
65
formatter.WriteKeyword("struct");
67
case ClassType.Interface:
68
formatter.WriteKeyword("interface");
71
formatter.WriteKeyword("enum");
74
throw new Exception("Invalid value for ClassType");
77
} else if (node is DelegateDeclaration) {
78
formatter.WriteKeyword("delegate");
80
} else if (node is EventDeclaration) {
81
formatter.WriteKeyword("event");
86
if ((ConversionFlags & ConversionFlags.ShowReturnType) == ConversionFlags.ShowReturnType) {
87
var rt = node.GetChildByRole(Roles.Type);
89
rt.AcceptVisitor(new CSharpOutputVisitor(formatter, formattingPolicy));
94
if (entity is ITypeDefinition)
95
WriteTypeDeclarationName((ITypeDefinition)entity, formatter, formattingPolicy);
97
WriteMemberDeclarationName((IMember)entity, formatter, formattingPolicy);
99
if ((ConversionFlags & ConversionFlags.ShowParameterList) == ConversionFlags.ShowParameterList && HasParameters(entity)) {
100
formatter.WriteToken(entity.EntityType == EntityType.Indexer ? "[" : "(");
102
foreach (var param in node.GetChildrenByRole(Roles.Parameter)) {
106
formatter.WriteToken(",");
109
param.AcceptVisitor(new CSharpOutputVisitor(formatter, formattingPolicy));
111
formatter.WriteToken(entity.EntityType == EntityType.Indexer ? "]" : ")");
114
if ((ConversionFlags & ConversionFlags.ShowBody) == ConversionFlags.ShowBody && !(node is TypeDeclaration)) {
115
IProperty property = entity as IProperty;
116
if (property != null) {
118
formatter.WriteToken("{");
120
if (property.CanGet) {
121
formatter.WriteKeyword("get");
122
formatter.WriteToken(";");
125
if (property.CanSet) {
126
formatter.WriteKeyword("set");
127
formatter.WriteToken(";");
130
formatter.WriteToken("}");
132
formatter.WriteToken(";");
137
bool HasParameters(IEntity e)
139
switch (e.EntityType) {
140
case EntityType.TypeDefinition:
141
return ((ITypeDefinition)e).Kind == TypeKind.Delegate;
142
case EntityType.Indexer:
143
case EntityType.Method:
144
case EntityType.Operator:
145
case EntityType.Constructor:
146
case EntityType.Destructor:
153
TypeSystemAstBuilder CreateAstBuilder()
155
TypeSystemAstBuilder astBuilder = new TypeSystemAstBuilder();
156
astBuilder.AddAnnotations = true;
157
astBuilder.ShowModifiers = (ConversionFlags & ConversionFlags.ShowModifiers) == ConversionFlags.ShowModifiers;
158
astBuilder.ShowAccessibility = (ConversionFlags & ConversionFlags.ShowAccessibility) == ConversionFlags.ShowAccessibility;
159
astBuilder.AlwaysUseShortTypeNames = (ConversionFlags & ConversionFlags.UseFullyQualifiedTypeNames) != ConversionFlags.UseFullyQualifiedTypeNames;
160
astBuilder.ShowParameterNames = (ConversionFlags & ConversionFlags.ShowParameterNames) == ConversionFlags.ShowParameterNames;
164
void WriteTypeDeclarationName(ITypeDefinition typeDef, IOutputFormatter formatter, CSharpFormattingOptions formattingPolicy)
166
TypeSystemAstBuilder astBuilder = CreateAstBuilder();
167
if (typeDef.DeclaringTypeDefinition != null) {
168
WriteTypeDeclarationName(typeDef.DeclaringTypeDefinition, formatter, formattingPolicy);
169
formatter.WriteToken(".");
170
} else if ((ConversionFlags & ConversionFlags.UseFullyQualifiedTypeNames) == ConversionFlags.UseFullyQualifiedTypeNames) {
171
formatter.WriteIdentifier(typeDef.Namespace);
172
formatter.WriteToken(".");
174
formatter.WriteIdentifier(typeDef.Name);
175
if ((ConversionFlags & ConversionFlags.ShowTypeParameterList) == ConversionFlags.ShowTypeParameterList) {
176
var outputVisitor = new CSharpOutputVisitor(formatter, formattingPolicy);
177
outputVisitor.WriteTypeParameters(astBuilder.ConvertEntity(typeDef).GetChildrenByRole(Roles.TypeParameter));
181
void WriteMemberDeclarationName(IMember member, IOutputFormatter formatter, CSharpFormattingOptions formattingPolicy)
183
TypeSystemAstBuilder astBuilder = CreateAstBuilder();
184
if ((ConversionFlags & ConversionFlags.ShowDeclaringType) == ConversionFlags.ShowDeclaringType) {
185
ConvertType(member.DeclaringType, formatter, formattingPolicy);
186
formatter.WriteToken(".");
188
switch (member.EntityType) {
189
case EntityType.Indexer:
190
formatter.WriteKeyword("this");
192
case EntityType.Constructor:
193
formatter.WriteIdentifier(member.DeclaringType.Name);
195
case EntityType.Destructor:
196
formatter.WriteToken("~");
197
formatter.WriteIdentifier(member.DeclaringType.Name);
199
case EntityType.Operator:
200
switch (member.Name) {
202
formatter.WriteKeyword("implicit");
204
formatter.WriteKeyword("operator");
206
ConvertType(member.ReturnType, formatter, formattingPolicy);
209
formatter.WriteKeyword("explicit");
211
formatter.WriteKeyword("operator");
213
ConvertType(member.ReturnType, formatter, formattingPolicy);
216
formatter.WriteKeyword("operator");
218
var operatorType = OperatorDeclaration.GetOperatorType(member.Name);
219
if (operatorType.HasValue)
220
formatter.WriteToken(OperatorDeclaration.GetToken(operatorType.Value));
222
formatter.WriteIdentifier(member.Name);
227
formatter.WriteIdentifier(member.Name);
230
if ((ConversionFlags & ConversionFlags.ShowTypeParameterList) == ConversionFlags.ShowTypeParameterList && member.EntityType == EntityType.Method) {
231
var outputVisitor = new CSharpOutputVisitor(formatter, formattingPolicy);
232
outputVisitor.WriteTypeParameters(astBuilder.ConvertEntity(member).GetChildrenByRole(Roles.TypeParameter));
236
void PrintModifiers(Modifiers modifiers, IOutputFormatter formatter)
238
foreach (var m in CSharpModifierToken.AllModifiers) {
239
if ((modifiers & m) == m) {
240
formatter.WriteKeyword(CSharpModifierToken.GetModifierName(m));
247
public string ConvertVariable(IVariable v)
249
TypeSystemAstBuilder astBuilder = CreateAstBuilder();
250
AstNode astNode = astBuilder.ConvertVariable(v);
251
return astNode.GetText().TrimEnd(';', '\r', '\n');
254
public string ConvertType(IType type)
257
throw new ArgumentNullException("type");
259
TypeSystemAstBuilder astBuilder = CreateAstBuilder();
260
AstType astType = astBuilder.ConvertType(type);
261
return astType.GetText();
264
public void ConvertType(IType type, IOutputFormatter formatter, CSharpFormattingOptions formattingPolicy)
266
TypeSystemAstBuilder astBuilder = CreateAstBuilder();
267
AstType astType = astBuilder.ConvertType(type);
268
astType.AcceptVisitor(new CSharpOutputVisitor(formatter, formattingPolicy));
271
public string WrapComment(string comment)
273
return "// " + comment;