2
// ExtractMethodAction.cs
5
// Mike KrĆ¼ger <mkrueger@xamarin.com>
7
// Copyright (c) 2012 Xamarin Inc. (http://xamarin.com)
9
// Permission is hereby granted, free of charge, to any person obtaining a copy
10
// of this software and associated documentation files (the "Software"), to deal
11
// in the Software without restriction, including without limitation the rights
12
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13
// copies of the Software, and to permit persons to whom the Software is
14
// furnished to do so, subject to the following conditions:
16
// The above copyright notice and this permission notice shall be included in
17
// all copies or substantial portions of the Software.
19
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27
using System.Collections.Generic;
28
using ICSharpCode.NRefactory.Semantics;
30
using ICSharpCode.NRefactory.CSharp.Resolver;
31
using ICSharpCode.NRefactory.CSharp.Analysis;
32
using System.Threading;
33
using ICSharpCode.NRefactory.TypeSystem;
34
using System.Threading.Tasks;
36
namespace ICSharpCode.NRefactory.CSharp.Refactoring.ExtractMethod
38
[ContextAction("Extract method", Description = "Creates a new method out of selected text.")]
39
public class ExtractMethodAction : ICodeActionProvider
41
public IEnumerable<CodeAction> GetActions(RefactoringContext context)
43
if (!context.IsSomethingSelected)
45
var selected = new List<AstNode>(context.GetSelectedNodes());
46
if (selected.Count == 0)
49
if (selected.Count == 1 && selected [0] is Expression) {
50
var codeAction = CreateFromExpression(context, (Expression)selected [0]);
51
if (codeAction == null)
53
yield return codeAction;
56
foreach (var node in selected) {
57
if (!(node is Statement) && !(node is Comment) && !(node is NewLineNode) && !(node is PreProcessorDirective))
60
var action = CreateFromStatements (context, new List<AstNode> (selected));
65
CodeAction CreateFromExpression(RefactoringContext context, Expression expression)
67
var resolveResult = context.Resolve(expression);
68
if (resolveResult.IsError)
71
return new CodeAction(context.TranslateString("Extract method"), script => {
72
string methodName = "NewMethod";
73
var method = new MethodDeclaration {
74
ReturnType = context.CreateShortType(resolveResult.Type),
76
Body = new BlockStatement {
77
new ReturnStatement(expression.Clone())
80
if (!StaticVisitor.UsesNotStaticMember(context, expression))
81
method.Modifiers |= Modifiers.Static;
83
var usedVariables = VariableLookupVisitor.Analyze(context, expression);
85
var inExtractedRegion = new VariableUsageAnalyzation (context, usedVariables);
87
usedVariables.Sort ((l, r) => l.Region.Begin.CompareTo (r.Region.Begin));
88
var target = new IdentifierExpression(methodName);
89
var invocation = new InvocationExpression(target);
90
foreach (var variable in usedVariables) {
91
Expression argumentExpression = new IdentifierExpression(variable.Name);
93
var mod = ParameterModifier.None;
94
if (inExtractedRegion.GetStatus (variable) == VariableState.Changed) {
95
mod = ParameterModifier.Ref;
96
argumentExpression = new DirectionExpression(FieldDirection.Ref, argumentExpression);
99
method.Parameters.Add(new ParameterDeclaration(context.CreateShortType(variable.Type), variable.Name, mod));
100
invocation.Arguments.Add(argumentExpression);
103
var task = script.InsertWithCursor(context.TranslateString("Extract method"), Script.InsertPosition.Before, method);
105
Action<Task> replaceStatements = delegate {
106
script.Replace(expression, invocation);
107
script.Link(target, method.NameToken);
110
if (task.IsCompleted) {
111
replaceStatements (null);
113
task.ContinueWith (replaceStatements, TaskScheduler.FromCurrentSynchronizationContext ());
118
CodeAction CreateFromStatements(RefactoringContext context, List<AstNode> statements)
120
if (!(statements [0].Parent is Statement))
123
return new CodeAction(context.TranslateString("Extract method"), script => {
124
string methodName = "NewMethod";
125
var method = new MethodDeclaration() {
126
ReturnType = new PrimitiveType("void"),
128
Body = new BlockStatement()
130
bool usesNonStaticMember = false;
131
foreach (var node in statements) {
132
usesNonStaticMember |= StaticVisitor.UsesNotStaticMember(context, node);
133
if (node is Statement) {
134
method.Body.Add((Statement)node.Clone());
136
method.Body.AddChildUnsafe (node.Clone (), node.Role);
139
if (!usesNonStaticMember)
140
method.Modifiers |= Modifiers.Static;
142
var target = new IdentifierExpression(methodName);
143
var invocation = new InvocationExpression(target);
145
var usedVariables = VariableLookupVisitor.Analyze(context, statements);
147
var inExtractedRegion = new VariableUsageAnalyzation (context, usedVariables);
148
var lastStatement = statements [statements.Count - 1];
150
var stmt = statements [0].GetParent<BlockStatement>();
151
while (stmt.GetParent<BlockStatement> () != null) {
152
stmt = stmt.GetParent<BlockStatement>();
155
inExtractedRegion.SetAnalyzedRange(statements [0], lastStatement);
156
stmt.AcceptVisitor (inExtractedRegion);
158
var beforeExtractedRegion = new VariableUsageAnalyzation (context, usedVariables);
159
beforeExtractedRegion.SetAnalyzedRange(statements [0].Parent, statements [0], true, false);
160
stmt.AcceptVisitor (beforeExtractedRegion);
162
var afterExtractedRegion = new VariableUsageAnalyzation (context, usedVariables);
163
afterExtractedRegion.SetAnalyzedRange(lastStatement, stmt.Statements.Last(), false, true);
164
stmt.AcceptVisitor (afterExtractedRegion);
165
usedVariables.Sort ((l, r) => l.Region.Begin.CompareTo (r.Region.Begin));
167
IVariable generatedReturnVariable = null;
168
foreach (var variable in usedVariables) {
169
if ((variable is IParameter) || beforeExtractedRegion.Has (variable) || !afterExtractedRegion.Has (variable))
171
generatedReturnVariable = variable;
172
method.ReturnType = context.CreateShortType (variable.Type);
173
method.Body.Add (new ReturnStatement (new IdentifierExpression (variable.Name)));
177
foreach (var variable in usedVariables) {
178
if (!(variable is IParameter) && !beforeExtractedRegion.Has (variable) && !afterExtractedRegion.Has (variable))
180
if (variable == generatedReturnVariable)
182
Expression argumentExpression = new IdentifierExpression(variable.Name);
184
ParameterModifier mod = ParameterModifier.None;
185
if (inExtractedRegion.GetStatus (variable) == VariableState.Changed) {
186
if (beforeExtractedRegion.GetStatus (variable) == VariableState.None) {
187
mod = ParameterModifier.Out;
188
argumentExpression = new DirectionExpression(FieldDirection.Out, argumentExpression);
190
mod = ParameterModifier.Ref;
191
argumentExpression = new DirectionExpression(FieldDirection.Ref, argumentExpression);
195
method.Parameters.Add(new ParameterDeclaration(context.CreateShortType(variable.Type), variable.Name, mod));
196
invocation.Arguments.Add(argumentExpression);
198
var task = script.InsertWithCursor(context.TranslateString("Extract method"), Script.InsertPosition.Before, method);
199
Action<Task> replaceStatements = delegate {
200
foreach (var node in statements.Skip (1)) {
201
if (node is NewLineNode)
205
foreach (var variable in usedVariables) {
206
if ((variable is IParameter) || beforeExtractedRegion.Has (variable) || !afterExtractedRegion.Has (variable))
208
if (variable == generatedReturnVariable)
210
script.InsertBefore (statements [0], new VariableDeclarationStatement (context.CreateShortType(variable.Type), variable.Name));
212
AstNode invocationStatement;
214
if (generatedReturnVariable != null) {
215
invocationStatement = new VariableDeclarationStatement (new SimpleType ("var"), generatedReturnVariable.Name, invocation);
217
invocationStatement = new ExpressionStatement(invocation);
219
script.Replace(statements [0], invocationStatement);
222
script.Link(target, method.NameToken);
225
if (task.IsCompleted) {
226
replaceStatements (null);
228
task.ContinueWith (replaceStatements, TaskScheduler.FromCurrentSynchronizationContext ());
230
}, statements.First ().StartLocation, statements.Last ().EndLocation);