1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
//
// GeneratedCodeSettings.cs
//
// Author:
// Mike Krüger <mkrueger@xamarin.com>
//
// Copyright (c) 2012 Xamarin Inc. (http://xamarin.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 System;
using System.Collections.Generic;
namespace ICSharpCode.NRefactory.CSharp
{
public enum GeneratedCodeMember
{
Unknown,
StaticFields,
InstanceFields,
StaticProperties,
InstanceProperties,
Indexer,
Constructors,
StaticMethods,
InstanceMethods,
StaticEvents,
InstanceEvents,
Operators,
NestedTypes
}
public class GeneratedCodeSettings
{
List<GeneratedCodeMember> codeMemberOrder;
public List<GeneratedCodeMember> CodeMemberOrder {
get {
return codeMemberOrder;
}
set {
codeMemberOrder = value;
}
}
public bool GenerateCategoryComments {
get;
set;
}
public bool SubOrderAlphabetical {
get;
set;
}
public void Apply (AstNode rootNode)
{
if (rootNode == null)
throw new ArgumentNullException ("rootNode");
rootNode.AcceptVisitor (new GenerateCodeVisitior (this));
}
public virtual string GetCategoryLabel(GeneratedCodeMember memberCategory)
{
switch (memberCategory) {
case GeneratedCodeMember.StaticFields:
return "Static Fields";
case GeneratedCodeMember.InstanceFields:
return "Fields";
case GeneratedCodeMember.StaticProperties:
return "Static Properties";
case GeneratedCodeMember.InstanceProperties:
return "Properties";
case GeneratedCodeMember.Indexer:
return "Indexer";
case GeneratedCodeMember.Constructors:
return "Constructors";
case GeneratedCodeMember.StaticMethods:
return "Static Methods";
case GeneratedCodeMember.InstanceMethods:
return "Methods";
case GeneratedCodeMember.StaticEvents:
return "Static Events";
case GeneratedCodeMember.InstanceEvents:
return "Events";
case GeneratedCodeMember.Operators:
return "Operators";
case GeneratedCodeMember.NestedTypes:
return "Nested Types";
}
return null;
}
class GenerateCodeVisitior : DepthFirstAstVisitor
{
GeneratedCodeSettings settings;
public GenerateCodeVisitior(GeneratedCodeSettings settings)
{
if (settings == null)
throw new ArgumentNullException("settings");
this.settings = settings;
}
GeneratedCodeMember GetCodeMemberCategory(EntityDeclaration x)
{
bool isStatic = x.HasModifier(Modifiers.Static) || x.HasModifier(Modifiers.Const);
if (x is FieldDeclaration)
return isStatic ? GeneratedCodeMember.StaticFields : GeneratedCodeMember.InstanceFields;
if (x is IndexerDeclaration)
return GeneratedCodeMember.Indexer;
if (x is PropertyDeclaration)
return isStatic ? GeneratedCodeMember.StaticProperties : GeneratedCodeMember.InstanceProperties;
if (x is ConstructorDeclaration || x is DestructorDeclaration)
return GeneratedCodeMember.Constructors;
if (x is MethodDeclaration)
return isStatic ? GeneratedCodeMember.StaticMethods : GeneratedCodeMember.InstanceMethods;
if (x is OperatorDeclaration)
return GeneratedCodeMember.Operators;
if (x is EventDeclaration || x is CustomEventDeclaration)
return isStatic ? GeneratedCodeMember.StaticEvents : GeneratedCodeMember.InstanceEvents;
if (x is TypeDeclaration)
return GeneratedCodeMember.NestedTypes;
return GeneratedCodeMember.Unknown;
}
public override void VisitTypeDeclaration (TypeDeclaration typeDeclaration)
{
if (typeDeclaration.ClassType == ClassType.Enum)
return;
var entities = new List<EntityDeclaration> (typeDeclaration.Members);
entities.Sort ((x, y) => {
int i1 = settings.CodeMemberOrder.IndexOf (GetCodeMemberCategory (x));
int i2 = settings.CodeMemberOrder.IndexOf (GetCodeMemberCategory (y));
if (i1 != i2)
return i1.CompareTo (i2);
if (settings.SubOrderAlphabetical)
return (x.Name ?? "").CompareTo ((y.Name ?? ""));
return entities.IndexOf (x).CompareTo (entities.IndexOf (y));
});
typeDeclaration.Members.Clear ();
typeDeclaration.Members.AddRange (entities);
if (settings.GenerateCategoryComments) {
var curCat = GeneratedCodeMember.Unknown;
foreach (var mem in entities) {
if (mem.NextSibling is EntityDeclaration)
mem.Parent.InsertChildAfter (mem, new UnixNewLine (), Roles.NewLine);
var cat = GetCodeMemberCategory (mem);
if (cat == curCat)
continue;
curCat = cat;
var label = settings.GetCategoryLabel (curCat);
if (string.IsNullOrEmpty (label))
continue;
var cmt = new Comment ("", CommentType.SingleLine);
var cmt2 = new Comment (" " + label, CommentType.SingleLine);
var cmt3 = new Comment ("", CommentType.SingleLine);
mem.Parent.InsertChildBefore (mem, cmt, Roles.Comment);
mem.Parent.InsertChildBefore (mem, cmt2, Roles.Comment);
mem.Parent.InsertChildBefore (mem, cmt3, Roles.Comment);
if (cmt.PrevSibling is EntityDeclaration)
mem.Parent.InsertChildBefore (cmt, new UnixNewLine (), Roles.NewLine);
}
}
}
}
static Lazy<GeneratedCodeSettings> defaultSettings = new Lazy<GeneratedCodeSettings>(
() => new GeneratedCodeSettings() {
CodeMemberOrder = new List<GeneratedCodeMember>() {
GeneratedCodeMember.StaticFields,
GeneratedCodeMember.InstanceFields,
GeneratedCodeMember.StaticProperties,
GeneratedCodeMember.InstanceProperties,
GeneratedCodeMember.Indexer,
GeneratedCodeMember.Constructors,
GeneratedCodeMember.StaticMethods,
GeneratedCodeMember.InstanceMethods,
GeneratedCodeMember.StaticEvents,
GeneratedCodeMember.InstanceEvents,
GeneratedCodeMember.Operators,
GeneratedCodeMember.NestedTypes
},
GenerateCategoryComments = true,
SubOrderAlphabetical = true
});
public static GeneratedCodeSettings Default {
get {
return defaultSettings.Value;
}
}
}
}
|
