| // Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file |
| // for details. All rights reserved. Use of this source code is governed by a |
| // BSD-style license that can be found in the LICENSE file. |
| |
| library services.src.refactoring.extract_method; |
| |
| import 'dart:async'; |
| |
| import 'package:analysis_server/src/protocol_server.dart' hide Element; |
| import 'package:analysis_server/src/services/correction/name_suggestion.dart'; |
| import 'package:analysis_server/src/services/correction/selection_analyzer.dart'; |
| import 'package:analysis_server/src/services/correction/source_range.dart'; |
| import 'package:analysis_server/src/services/correction/statement_analyzer.dart'; |
| import 'package:analysis_server/src/services/correction/status.dart'; |
| import 'package:analysis_server/src/services/correction/util.dart'; |
| import 'package:analysis_server/src/services/refactoring/naming_conventions.dart'; |
| import 'package:analysis_server/src/services/refactoring/refactoring.dart'; |
| import 'package:analysis_server/src/services/refactoring/refactoring_internal.dart'; |
| import 'package:analysis_server/src/services/refactoring/rename_class_member.dart'; |
| import 'package:analysis_server/src/services/refactoring/rename_unit_member.dart'; |
| import 'package:analysis_server/src/services/search/element_visitors.dart'; |
| import 'package:analysis_server/src/services/search/search_engine.dart'; |
| import 'package:analyzer/dart/ast/ast.dart'; |
| import 'package:analyzer/dart/ast/standard_resolution_map.dart'; |
| import 'package:analyzer/dart/ast/token.dart'; |
| import 'package:analyzer/dart/ast/visitor.dart'; |
| import 'package:analyzer/dart/element/element.dart'; |
| import 'package:analyzer/dart/element/type.dart'; |
| import 'package:analyzer/src/dart/ast/utilities.dart'; |
| import 'package:analyzer/src/generated/engine.dart'; |
| import 'package:analyzer/src/generated/java_core.dart'; |
| import 'package:analyzer/src/generated/resolver.dart' show ExitDetector; |
| import 'package:analyzer/src/generated/source.dart'; |
| |
| const String _TOKEN_SEPARATOR = '\uFFFF'; |
| |
| Element _getLocalElement(SimpleIdentifier node) { |
| Element element = node.staticElement; |
| if (element is LocalVariableElement || |
| element is ParameterElement || |
| element is FunctionElement && element.visibleRange != null) { |
| return element; |
| } |
| return null; |
| } |
| |
| /** |
| * Returns the "normalized" version of the given source, which is reconstructed |
| * from tokens, so ignores all the comments and spaces. |
| */ |
| String _getNormalizedSource(String src) { |
| List<Token> selectionTokens = TokenUtils.getTokens(src); |
| return selectionTokens.join(_TOKEN_SEPARATOR); |
| } |
| |
| /** |
| * Returns the [Map] which maps [map] values to their keys. |
| */ |
| Map<String, String> _inverseMap(Map<String, String> map) { |
| Map<String, String> result = <String, String>{}; |
| map.forEach((String key, String value) { |
| result[value] = key; |
| }); |
| return result; |
| } |
| |
| /** |
| * [ExtractMethodRefactoring] implementation. |
| */ |
| class ExtractMethodRefactoringImpl extends RefactoringImpl |
| implements ExtractMethodRefactoring { |
| static const ERROR_EXITS = |
| 'Selected statements contain a return statement, but not all possible ' |
| 'execution flows exit. Semantics may not be preserved.'; |
| |
| final SearchEngine searchEngine; |
| final CompilationUnit unit; |
| final int selectionOffset; |
| final int selectionLength; |
| AnalysisContext context; |
| CompilationUnitElement unitElement; |
| LibraryElement libraryElement; |
| SourceRange selectionRange; |
| CorrectionUtils utils; |
| Set<Source> librariesToImport = new Set<Source>(); |
| |
| String returnType = ''; |
| String variableType; |
| String name; |
| bool extractAll = true; |
| bool canCreateGetter = false; |
| bool createGetter = false; |
| final List<String> names = <String>[]; |
| final List<int> offsets = <int>[]; |
| final List<int> lengths = <int>[]; |
| |
| /** |
| * The map of local names to their visibility ranges. |
| */ |
| Map<String, List<SourceRange>> _localNames = <String, List<SourceRange>>{}; |
| |
| /** |
| * The set of names that are referenced without any qualifier. |
| */ |
| Set<String> _unqualifiedNames = new Set<String>(); |
| |
| Set<String> _excludedNames = new Set<String>(); |
| List<RefactoringMethodParameter> _parameters = <RefactoringMethodParameter>[]; |
| Map<String, RefactoringMethodParameter> _parametersMap = |
| <String, RefactoringMethodParameter>{}; |
| Map<String, List<SourceRange>> _parameterReferencesMap = |
| <String, List<SourceRange>>{}; |
| bool _hasAwait = false; |
| DartType _returnType; |
| String _returnVariableName; |
| AstNode _parentMember; |
| Expression _selectionExpression; |
| FunctionExpression _selectionFunctionExpression; |
| List<Statement> _selectionStatements; |
| List<_Occurrence> _occurrences = []; |
| bool _staticContext = false; |
| |
| ExtractMethodRefactoringImpl(this.searchEngine, this.unit, |
| this.selectionOffset, this.selectionLength) { |
| unitElement = unit.element; |
| libraryElement = unitElement.library; |
| context = libraryElement.context; |
| selectionRange = new SourceRange(selectionOffset, selectionLength); |
| utils = new CorrectionUtils(unit); |
| } |
| |
| @override |
| List<RefactoringMethodParameter> get parameters => _parameters; |
| |
| @override |
| void set parameters(List<RefactoringMethodParameter> parameters) { |
| _parameters = parameters.toList(); |
| } |
| |
| @override |
| String get refactoringName { |
| AstNode node = new NodeLocator(selectionOffset).searchWithin(unit); |
| if (node != null && |
| node.getAncestor((node) => node is ClassDeclaration) != null) { |
| return 'Extract Method'; |
| } |
| return 'Extract Function'; |
| } |
| |
| String get signature { |
| StringBuffer sb = new StringBuffer(); |
| if (createGetter) { |
| sb.write('get '); |
| sb.write(name); |
| } else { |
| sb.write(name); |
| sb.write('('); |
| // add all parameters |
| bool firstParameter = true; |
| for (RefactoringMethodParameter parameter in _parameters) { |
| // may be comma |
| if (firstParameter) { |
| firstParameter = false; |
| } else { |
| sb.write(', '); |
| } |
| // type |
| { |
| String typeSource = parameter.type; |
| if ('dynamic' != typeSource && '' != typeSource) { |
| sb.write(typeSource); |
| sb.write(' '); |
| } |
| } |
| // name |
| sb.write(parameter.name); |
| // optional function-typed parameter parameters |
| if (parameter.parameters != null) { |
| sb.write(parameter.parameters); |
| } |
| } |
| sb.write(')'); |
| } |
| // done |
| return sb.toString(); |
| } |
| |
| @override |
| Future<RefactoringStatus> checkFinalConditions() async { |
| RefactoringStatus result = new RefactoringStatus(); |
| result.addStatus(validateMethodName(name)); |
| result.addStatus(_checkParameterNames()); |
| RefactoringStatus status = await _checkPossibleConflicts(); |
| result.addStatus(status); |
| return result; |
| } |
| |
| @override |
| Future<RefactoringStatus> checkInitialConditions() { |
| RefactoringStatus result = new RefactoringStatus(); |
| // selection |
| result.addStatus(_checkSelection()); |
| if (result.hasFatalError) { |
| return new Future.value(result); |
| } |
| // prepare parts |
| result.addStatus(_initializeParameters()); |
| _initializeHasAwait(); |
| _initializeReturnType(); |
| // occurrences |
| _initializeOccurrences(); |
| _prepareOffsetsLengths(); |
| // getter |
| canCreateGetter = _computeCanCreateGetter(); |
| createGetter = |
| canCreateGetter && _isExpressionForGetter(_selectionExpression); |
| // names |
| _prepareExcludedNames(); |
| _prepareNames(); |
| // closure cannot have parameters |
| if (_selectionFunctionExpression != null && !_parameters.isEmpty) { |
| String message = format( |
| 'Cannot extract closure as method, it references {0} external variable(s).', |
| _parameters.length); |
| RefactoringStatus result = new RefactoringStatus.fatal(message); |
| return new Future.value(result); |
| } |
| return new Future.value(result); |
| } |
| |
| @override |
| RefactoringStatus checkName() { |
| return validateMethodName(name); |
| } |
| |
| @override |
| Future<SourceChange> createChange() async { |
| SourceChange change = new SourceChange(refactoringName); |
| // replace occurrences with method invocation |
| for (_Occurrence occurrence in _occurrences) { |
| SourceRange range = occurrence.range; |
| // may be replacement of duplicates disabled |
| if (!extractAll && !occurrence.isSelection) { |
| continue; |
| } |
| // prepare invocation source |
| String invocationSource; |
| if (_selectionFunctionExpression != null) { |
| invocationSource = name; |
| } else { |
| StringBuffer sb = new StringBuffer(); |
| // may be returns value |
| if (_selectionStatements != null && variableType != null) { |
| // single variable assignment / return statement |
| if (_returnVariableName != null) { |
| String occurrenceName = |
| occurrence._parameterOldToOccurrenceName[_returnVariableName]; |
| // may be declare variable |
| if (!_parametersMap.containsKey(_returnVariableName)) { |
| if (variableType.isEmpty) { |
| sb.write('var '); |
| } else { |
| sb.write(variableType); |
| sb.write(' '); |
| } |
| } |
| // assign the return value |
| sb.write(occurrenceName); |
| sb.write(' = '); |
| } else { |
| sb.write('return '); |
| } |
| } |
| // await |
| if (_hasAwait) { |
| sb.write('await '); |
| } |
| // invocation itself |
| sb.write(name); |
| if (!createGetter) { |
| sb.write('('); |
| bool firstParameter = true; |
| for (RefactoringMethodParameter parameter in _parameters) { |
| // may be comma |
| if (firstParameter) { |
| firstParameter = false; |
| } else { |
| sb.write(', '); |
| } |
| // argument name |
| { |
| String argumentName = |
| occurrence._parameterOldToOccurrenceName[parameter.id]; |
| sb.write(argumentName); |
| } |
| } |
| sb.write(')'); |
| } |
| invocationSource = sb.toString(); |
| // statements as extracted with their ";", so add new after invocation |
| if (_selectionStatements != null) { |
| invocationSource += ';'; |
| } |
| } |
| // add replace edit |
| SourceEdit edit = newSourceEdit_range(range, invocationSource); |
| doSourceChange_addElementEdit(change, unitElement, edit); |
| } |
| // add method declaration |
| { |
| // prepare environment |
| String prefix = utils.getNodePrefix(_parentMember); |
| String eol = utils.endOfLine; |
| // prepare annotations |
| String annotations = ''; |
| { |
| // may be "static" |
| if (_staticContext) { |
| annotations = 'static '; |
| } |
| } |
| // prepare declaration source |
| String declarationSource = null; |
| { |
| String returnExpressionSource = _getMethodBodySource(); |
| // closure |
| if (_selectionFunctionExpression != null) { |
| declarationSource = '$name$returnExpressionSource'; |
| if (_selectionFunctionExpression.body is ExpressionFunctionBody) { |
| declarationSource += ';'; |
| } |
| } |
| // optional 'async' body modifier |
| String asyncKeyword = _hasAwait ? ' async' : ''; |
| // expression |
| if (_selectionExpression != null) { |
| // add return type |
| if (returnType.isNotEmpty) { |
| annotations += '$returnType '; |
| } |
| // just return expression |
| declarationSource = '$annotations$signature$asyncKeyword => '; |
| declarationSource += '$returnExpressionSource;'; |
| } |
| // statements |
| if (_selectionStatements != null) { |
| if (returnType.isNotEmpty) { |
| annotations += returnType + ' '; |
| } |
| declarationSource = '$annotations$signature$asyncKeyword {$eol'; |
| declarationSource += returnExpressionSource; |
| if (_returnVariableName != null) { |
| declarationSource += '$prefix return $_returnVariableName;$eol'; |
| } |
| declarationSource += '$prefix}'; |
| } |
| } |
| // insert declaration |
| if (declarationSource != null) { |
| int offset = _parentMember.end; |
| SourceEdit edit = |
| new SourceEdit(offset, 0, '$eol$eol$prefix$declarationSource'); |
| doSourceChange_addElementEdit(change, unitElement, edit); |
| } |
| } |
| // done |
| addLibraryImports(change, libraryElement, librariesToImport); |
| return change; |
| } |
| |
| @override |
| bool requiresPreview() => false; |
| |
| /** |
| * Adds a new reference to the parameter with the given name. |
| */ |
| void _addParameterReference(String name, SourceRange range) { |
| List<SourceRange> references = _parameterReferencesMap[name]; |
| if (references == null) { |
| references = []; |
| _parameterReferencesMap[name] = references; |
| } |
| references.add(range); |
| } |
| |
| RefactoringStatus _checkParameterNames() { |
| RefactoringStatus result = new RefactoringStatus(); |
| for (RefactoringMethodParameter parameter in _parameters) { |
| result.addStatus(validateParameterName(parameter.name)); |
| for (RefactoringMethodParameter other in _parameters) { |
| if (!identical(parameter, other) && other.name == parameter.name) { |
| result.addError( |
| format("Parameter '{0}' already exists", parameter.name)); |
| return result; |
| } |
| } |
| if (_isParameterNameConflictWithBody(parameter)) { |
| result.addError(format( |
| "'{0}' is already used as a name in the selected code", |
| parameter.name)); |
| return result; |
| } |
| } |
| return result; |
| } |
| |
| /** |
| * Checks if created method will shadow or will be shadowed by other elements. |
| */ |
| Future<RefactoringStatus> _checkPossibleConflicts() async { |
| RefactoringStatus result = new RefactoringStatus(); |
| AstNode parent = _parentMember.parent; |
| // top-level function |
| if (parent is CompilationUnit) { |
| LibraryElement libraryElement = |
| resolutionMap.elementDeclaredByCompilationUnit(parent).library; |
| return validateCreateFunction(searchEngine, libraryElement, name); |
| } |
| // method of class |
| if (parent is ClassDeclaration) { |
| ClassElement classElement = parent.element; |
| return validateCreateMethod(searchEngine, classElement, name); |
| } |
| // OK |
| return new Future<RefactoringStatus>.value(result); |
| } |
| |
| /** |
| * Checks if [selectionRange] selects [Expression] which can be extracted, and |
| * location of this [DartExpression] in AST allows extracting. |
| */ |
| RefactoringStatus _checkSelection() { |
| _ExtractMethodAnalyzer selectionAnalyzer = |
| new _ExtractMethodAnalyzer(unit, selectionRange); |
| unit.accept(selectionAnalyzer); |
| // may be fatal error |
| { |
| RefactoringStatus status = selectionAnalyzer.status; |
| if (status.hasFatalError) { |
| return status; |
| } |
| } |
| // check selected nodes |
| List<AstNode> selectedNodes = selectionAnalyzer.selectedNodes; |
| if (!selectedNodes.isEmpty) { |
| AstNode coveringNode = selectionAnalyzer.coveringNode; |
| _parentMember = getEnclosingClassOrUnitMember(coveringNode); |
| // single expression selected |
| if (selectedNodes.length == 1 && |
| !utils.selectionIncludesNonWhitespaceOutsideNode( |
| selectionRange, selectionAnalyzer.firstSelectedNode)) { |
| AstNode selectedNode = selectionAnalyzer.firstSelectedNode; |
| if (selectedNode is Expression) { |
| _selectionExpression = selectedNode; |
| // additional check for closure |
| if (_selectionExpression is FunctionExpression) { |
| _selectionFunctionExpression = |
| _selectionExpression as FunctionExpression; |
| _selectionExpression = null; |
| } |
| // OK |
| return new RefactoringStatus(); |
| } |
| } |
| // statements selected |
| { |
| List<Statement> selectedStatements = []; |
| for (AstNode selectedNode in selectedNodes) { |
| if (selectedNode is Statement) { |
| selectedStatements.add(selectedNode); |
| } |
| } |
| if (selectedStatements.length == selectedNodes.length) { |
| _selectionStatements = selectedStatements; |
| return new RefactoringStatus(); |
| } |
| } |
| } |
| // invalid selection |
| return new RefactoringStatus.fatal( |
| 'Can only extract a single expression or a set of statements.'); |
| } |
| |
| /** |
| * Initializes [canCreateGetter] flag. |
| */ |
| bool _computeCanCreateGetter() { |
| // is a function expression |
| if (_selectionFunctionExpression != null) { |
| return false; |
| } |
| // has parameters |
| if (!parameters.isEmpty) { |
| return false; |
| } |
| // is assignment |
| if (_selectionExpression != null) { |
| if (_selectionExpression is AssignmentExpression) { |
| return false; |
| } |
| } |
| // doesn't return a value |
| if (_selectionStatements != null) { |
| return returnType != 'void'; |
| } |
| // OK |
| return true; |
| } |
| |
| /** |
| * Returns the selected [Expression] source, with applying new parameter |
| * names. |
| */ |
| String _getMethodBodySource() { |
| String source = utils.getRangeText(selectionRange); |
| // prepare operations to replace variables with parameters |
| List<SourceEdit> replaceEdits = []; |
| for (RefactoringMethodParameter parameter in _parameters) { |
| List<SourceRange> ranges = _parameterReferencesMap[parameter.id]; |
| if (ranges != null) { |
| for (SourceRange range in ranges) { |
| replaceEdits.add(new SourceEdit(range.offset - selectionRange.offset, |
| range.length, parameter.name)); |
| } |
| } |
| } |
| replaceEdits.sort((a, b) => b.offset - a.offset); |
| // apply replacements |
| source = SourceEdit.applySequence(source, replaceEdits); |
| // change indentation |
| if (_selectionFunctionExpression != null) { |
| AstNode baseNode = |
| _selectionFunctionExpression.getAncestor((node) => node is Statement); |
| if (baseNode != null) { |
| String baseIndent = utils.getNodePrefix(baseNode); |
| String targetIndent = utils.getNodePrefix(_parentMember); |
| source = utils.replaceSourceIndent(source, baseIndent, targetIndent); |
| source = source.trim(); |
| } |
| } |
| if (_selectionStatements != null) { |
| String selectionIndent = utils.getNodePrefix(_selectionStatements[0]); |
| String targetIndent = utils.getNodePrefix(_parentMember) + ' '; |
| source = utils.replaceSourceIndent(source, selectionIndent, targetIndent); |
| } |
| // done |
| return source; |
| } |
| |
| _SourcePattern _getSourcePattern(SourceRange range) { |
| String originalSource = utils.getText(range.offset, range.length); |
| _SourcePattern pattern = new _SourcePattern(); |
| List<SourceEdit> replaceEdits = <SourceEdit>[]; |
| unit.accept(new _GetSourcePatternVisitor(range, pattern, replaceEdits)); |
| replaceEdits = replaceEdits.reversed.toList(); |
| String source = SourceEdit.applySequence(originalSource, replaceEdits); |
| pattern.normalizedSource = _getNormalizedSource(source); |
| return pattern; |
| } |
| |
| String _getTypeCode(DartType type) { |
| return utils.getTypeSource(type, librariesToImport); |
| } |
| |
| void _initializeHasAwait() { |
| _HasAwaitVisitor visitor = new _HasAwaitVisitor(); |
| if (_selectionExpression != null) { |
| _selectionExpression.accept(visitor); |
| } else if (_selectionStatements != null) { |
| _selectionStatements.forEach((statement) { |
| statement.accept(visitor); |
| }); |
| } |
| _hasAwait = visitor.result; |
| } |
| |
| /** |
| * Fills [_occurrences] field. |
| */ |
| void _initializeOccurrences() { |
| _occurrences.clear(); |
| // prepare selection |
| _SourcePattern selectionPattern = _getSourcePattern(selectionRange); |
| Map<String, String> patternToSelectionName = |
| _inverseMap(selectionPattern.originalToPatternNames); |
| // prepare an enclosing parent - class or unit |
| AstNode enclosingMemberParent = _parentMember.parent; |
| // visit nodes which will able to access extracted method |
| enclosingMemberParent.accept(new _InitializeOccurrencesVisitor( |
| this, selectionPattern, patternToSelectionName)); |
| } |
| |
| /** |
| * Prepares information about used variables, which should be turned into |
| * parameters. |
| */ |
| RefactoringStatus _initializeParameters() { |
| _parameters.clear(); |
| _parametersMap.clear(); |
| _parameterReferencesMap.clear(); |
| RefactoringStatus result = new RefactoringStatus(); |
| List<VariableElement> assignedUsedVariables = []; |
| unit.accept(new _InitializeParametersVisitor(this, assignedUsedVariables)); |
| // single expression |
| if (_selectionExpression != null) { |
| _returnType = _selectionExpression.bestType; |
| } |
| // verify that none or all execution flows end with a "return" |
| if (_selectionStatements != null) { |
| bool hasReturn = _selectionStatements.any(_mayEndWithReturnStatement); |
| if (hasReturn && !ExitDetector.exits(_selectionStatements.last)) { |
| result.addError(ERROR_EXITS); |
| } |
| } |
| // maybe ends with "return" statement |
| if (_selectionStatements != null) { |
| _ReturnTypeComputer returnTypeComputer = new _ReturnTypeComputer(context); |
| _selectionStatements.forEach((statement) { |
| statement.accept(returnTypeComputer); |
| }); |
| _returnType = returnTypeComputer.returnType; |
| } |
| // maybe single variable to return |
| if (assignedUsedVariables.length == 1) { |
| // we cannot both return variable and have explicit return statement |
| if (_returnType != null) { |
| result.addFatalError( |
| 'Ambiguous return value: Selected block contains assignment(s) to ' |
| 'local variables and return statement.'); |
| return result; |
| } |
| // prepare to return an assigned variable |
| VariableElement returnVariable = assignedUsedVariables[0]; |
| _returnType = returnVariable.type; |
| _returnVariableName = returnVariable.displayName; |
| } |
| // fatal, if multiple variables assigned and used after selection |
| if (assignedUsedVariables.length > 1) { |
| StringBuffer sb = new StringBuffer(); |
| for (VariableElement variable in assignedUsedVariables) { |
| sb.write(variable.displayName); |
| sb.write('\n'); |
| } |
| result.addFatalError(format( |
| 'Ambiguous return value: Selected block contains more than one ' |
| 'assignment to local variables. Affected variables are:\n\n{0}', |
| sb.toString().trim())); |
| } |
| // done |
| return result; |
| } |
| |
| void _initializeReturnType() { |
| InterfaceType futureType = context.typeProvider.futureType; |
| if (_selectionFunctionExpression != null) { |
| variableType = ''; |
| returnType = ''; |
| } else if (_returnType == null) { |
| variableType = null; |
| if (_hasAwait) { |
| returnType = _getTypeCode(futureType); |
| } else { |
| returnType = 'void'; |
| } |
| } else if (_returnType.isDynamic) { |
| variableType = ''; |
| if (_hasAwait) { |
| returnType = _getTypeCode(futureType); |
| } else { |
| returnType = ''; |
| } |
| } else { |
| variableType = _getTypeCode(_returnType); |
| if (_hasAwait) { |
| if (_returnType.element != futureType.element) { |
| returnType = _getTypeCode(futureType.instantiate([_returnType])); |
| } |
| } else { |
| returnType = variableType; |
| } |
| } |
| } |
| |
| /** |
| * Checks if the given [element] is declared in [selectionRange]. |
| */ |
| bool _isDeclaredInSelection(Element element) { |
| return selectionRange.contains(element.nameOffset); |
| } |
| |
| /** |
| * Checks if it is OK to extract the node with the given [SourceRange]. |
| */ |
| bool _isExtractable(SourceRange range) { |
| _ExtractMethodAnalyzer analyzer = new _ExtractMethodAnalyzer(unit, range); |
| utils.unit.accept(analyzer); |
| return analyzer.status.isOK; |
| } |
| |
| bool _isParameterNameConflictWithBody(RefactoringMethodParameter parameter) { |
| String id = parameter.id; |
| String name = parameter.name; |
| List<SourceRange> parameterRanges = _parameterReferencesMap[id]; |
| List<SourceRange> otherRanges = _localNames[name]; |
| for (SourceRange parameterRange in parameterRanges) { |
| if (otherRanges != null) { |
| for (SourceRange otherRange in otherRanges) { |
| if (parameterRange.intersects(otherRange)) { |
| return true; |
| } |
| } |
| } |
| } |
| if (_unqualifiedNames.contains(name)) { |
| return true; |
| } |
| return false; |
| } |
| |
| /** |
| * Checks if [element] is referenced after [selectionRange]. |
| */ |
| bool _isUsedAfterSelection(Element element) { |
| var visitor = new _IsUsedAfterSelectionVisitor(this, element); |
| _parentMember.accept(visitor); |
| return visitor.result; |
| } |
| |
| /** |
| * Prepare names that are used in the enclosing function, so should not be |
| * proposed as names of the extracted method. |
| */ |
| void _prepareExcludedNames() { |
| _excludedNames.clear(); |
| ExecutableElement enclosingExecutable = |
| getEnclosingExecutableElement(_parentMember); |
| if (enclosingExecutable != null) { |
| visitChildren(enclosingExecutable, (Element element) { |
| if (element is LocalElement) { |
| SourceRange elementRange = element.visibleRange; |
| if (elementRange != null) { |
| _excludedNames.add(element.displayName); |
| } |
| } |
| return true; |
| }); |
| } |
| } |
| |
| void _prepareNames() { |
| names.clear(); |
| if (_selectionExpression != null) { |
| names.addAll(getVariableNameSuggestionsForExpression( |
| _selectionExpression.staticType, |
| _selectionExpression, |
| _excludedNames)); |
| } |
| } |
| |
| void _prepareOffsetsLengths() { |
| offsets.clear(); |
| lengths.clear(); |
| for (_Occurrence occurrence in _occurrences) { |
| offsets.add(occurrence.range.offset); |
| lengths.add(occurrence.range.length); |
| } |
| } |
| |
| /** |
| * Checks if the given [expression] is reasonable to extract as a getter. |
| */ |
| static bool _isExpressionForGetter(Expression expression) { |
| if (expression is BinaryExpression) { |
| return _isExpressionForGetter(expression.leftOperand) && |
| _isExpressionForGetter(expression.rightOperand); |
| } |
| if (expression is Literal) { |
| return true; |
| } |
| if (expression is PrefixExpression) { |
| return _isExpressionForGetter(expression.operand); |
| } |
| if (expression is PrefixedIdentifier) { |
| return _isExpressionForGetter(expression.prefix); |
| } |
| if (expression is PropertyAccess) { |
| return _isExpressionForGetter(expression.target); |
| } |
| if (expression is SimpleIdentifier) { |
| return true; |
| } |
| return false; |
| } |
| |
| /** |
| * Returns `true` if the given [statement] may end with a [ReturnStatement]. |
| */ |
| static bool _mayEndWithReturnStatement(Statement statement) { |
| _HasReturnStatementVisitor visitor = new _HasReturnStatementVisitor(); |
| statement.accept(visitor); |
| return visitor.hasReturn; |
| } |
| } |
| |
| /** |
| * [SelectionAnalyzer] for [ExtractMethodRefactoringImpl]. |
| */ |
| class _ExtractMethodAnalyzer extends StatementAnalyzer { |
| _ExtractMethodAnalyzer(CompilationUnit unit, SourceRange selection) |
| : super(unit, selection); |
| |
| @override |
| void handleNextSelectedNode(AstNode node) { |
| super.handleNextSelectedNode(node); |
| _checkParent(node); |
| } |
| |
| @override |
| void handleSelectionEndsIn(AstNode node) { |
| super.handleSelectionEndsIn(node); |
| invalidSelection( |
| 'The selection does not cover a set of statements or an expression. ' |
| 'Extend selection to a valid range.'); |
| } |
| |
| @override |
| Object visitAssignmentExpression(AssignmentExpression node) { |
| super.visitAssignmentExpression(node); |
| Expression lhs = node.leftHandSide; |
| if (_isFirstSelectedNode(lhs)) { |
| invalidSelection('Cannot extract the left-hand side of an assignment.', |
| newLocation_fromNode(lhs)); |
| } |
| return null; |
| } |
| |
| @override |
| Object visitConstructorInitializer(ConstructorInitializer node) { |
| super.visitConstructorInitializer(node); |
| if (_isFirstSelectedNode(node)) { |
| invalidSelection( |
| 'Cannot extract a constructor initializer. ' |
| 'Select expression part of initializer.', |
| newLocation_fromNode(node)); |
| } |
| return null; |
| } |
| |
| @override |
| Object visitForStatement(ForStatement node) { |
| super.visitForStatement(node); |
| if (identical(node.variables, firstSelectedNode)) { |
| invalidSelection( |
| "Cannot extract initialization part of a 'for' statement."); |
| } else if (node.updaters.contains(lastSelectedNode)) { |
| invalidSelection("Cannot extract increment part of a 'for' statement."); |
| } |
| return null; |
| } |
| |
| @override |
| Object visitSimpleIdentifier(SimpleIdentifier node) { |
| super.visitSimpleIdentifier(node); |
| if (_isFirstSelectedNode(node)) { |
| // name of declaration |
| if (node.inDeclarationContext()) { |
| invalidSelection('Cannot extract the name part of a declaration.'); |
| } |
| // method name |
| Element element = node.bestElement; |
| if (element is FunctionElement || element is MethodElement) { |
| invalidSelection('Cannot extract a single method name.'); |
| } |
| // name in property access |
| if (node.parent is PrefixedIdentifier && |
| (node.parent as PrefixedIdentifier).identifier == node) { |
| invalidSelection('Can not extract name part of a property access.'); |
| } |
| } |
| return null; |
| } |
| |
| @override |
| Object visitTypeName(TypeName node) { |
| super.visitTypeName(node); |
| if (_isFirstSelectedNode(node)) { |
| invalidSelection('Cannot extract a single type reference.'); |
| } |
| return null; |
| } |
| |
| @override |
| Object visitVariableDeclaration(VariableDeclaration node) { |
| super.visitVariableDeclaration(node); |
| if (_isFirstSelectedNode(node)) { |
| invalidSelection( |
| 'Cannot extract a variable declaration fragment. ' |
| 'Select whole declaration statement.', |
| newLocation_fromNode(node)); |
| } |
| return null; |
| } |
| |
| void _checkParent(AstNode node) { |
| AstNode firstParent = firstSelectedNode.parent; |
| do { |
| node = node.parent; |
| if (identical(node, firstParent)) { |
| return; |
| } |
| } while (node != null); |
| invalidSelection( |
| 'Not all selected statements are enclosed by the same parent statement.'); |
| } |
| |
| bool _isFirstSelectedNode(AstNode node) => identical(firstSelectedNode, node); |
| } |
| |
| class _GetSourcePatternVisitor extends GeneralizingAstVisitor { |
| final SourceRange partRange; |
| final _SourcePattern pattern; |
| final List<SourceEdit> replaceEdits; |
| |
| _GetSourcePatternVisitor(this.partRange, this.pattern, this.replaceEdits); |
| |
| @override |
| visitSimpleIdentifier(SimpleIdentifier node) { |
| SourceRange nodeRange = rangeNode(node); |
| if (partRange.covers(nodeRange)) { |
| Element element = _getLocalElement(node); |
| if (element != null) { |
| // name of a named expression |
| if (isNamedExpressionName(node)) { |
| return; |
| } |
| // continue |
| String originalName = element.displayName; |
| String patternName = pattern.originalToPatternNames[originalName]; |
| if (patternName == null) { |
| DartType parameterType = _getElementType(element); |
| pattern.parameterTypes.add(parameterType); |
| patternName = '__refVar${pattern.originalToPatternNames.length}'; |
| pattern.originalToPatternNames[originalName] = patternName; |
| } |
| replaceEdits.add(new SourceEdit(nodeRange.offset - partRange.offset, |
| nodeRange.length, patternName)); |
| } |
| } |
| } |
| |
| DartType _getElementType(Element element) { |
| if (element is VariableElement) { |
| return element.type; |
| } |
| if (element is FunctionElement) { |
| return element.type; |
| } |
| throw new StateError('Unknown element type: ${element?.runtimeType}'); |
| } |
| } |
| |
| class _HasAwaitVisitor extends GeneralizingAstVisitor { |
| bool result = false; |
| |
| @override |
| visitAwaitExpression(AwaitExpression node) { |
| result = true; |
| } |
| |
| @override |
| visitForEachStatement(ForEachStatement node) { |
| if (node.awaitKeyword != null) { |
| result = true; |
| } |
| super.visitForEachStatement(node); |
| } |
| } |
| |
| class _HasReturnStatementVisitor extends RecursiveAstVisitor { |
| bool hasReturn = false; |
| |
| @override |
| visitBlockFunctionBody(BlockFunctionBody node) {} |
| |
| @override |
| visitReturnStatement(ReturnStatement node) { |
| hasReturn = true; |
| } |
| } |
| |
| class _InitializeOccurrencesVisitor extends GeneralizingAstVisitor<Object> { |
| final ExtractMethodRefactoringImpl ref; |
| final _SourcePattern selectionPattern; |
| final Map<String, String> patternToSelectionName; |
| |
| bool forceStatic = false; |
| |
| _InitializeOccurrencesVisitor( |
| this.ref, this.selectionPattern, this.patternToSelectionName); |
| |
| @override |
| Object visitBlock(Block node) { |
| if (ref._selectionStatements != null) { |
| _visitStatements(node.statements); |
| } |
| return super.visitBlock(node); |
| } |
| |
| @override |
| Object visitConstructorInitializer(ConstructorInitializer node) { |
| forceStatic = true; |
| try { |
| return super.visitConstructorInitializer(node); |
| } finally { |
| forceStatic = false; |
| } |
| } |
| |
| @override |
| Object visitExpression(Expression node) { |
| if (ref._selectionFunctionExpression != null || |
| ref._selectionExpression != null && |
| node.runtimeType == ref._selectionExpression.runtimeType) { |
| SourceRange nodeRange = rangeNode(node); |
| _tryToFindOccurrence(nodeRange); |
| } |
| return super.visitExpression(node); |
| } |
| |
| @override |
| Object visitMethodDeclaration(MethodDeclaration node) { |
| forceStatic = node.isStatic; |
| try { |
| return super.visitMethodDeclaration(node); |
| } finally { |
| forceStatic = false; |
| } |
| } |
| |
| @override |
| Object visitSwitchMember(SwitchMember node) { |
| if (ref._selectionStatements != null) { |
| _visitStatements(node.statements); |
| } |
| return super.visitSwitchMember(node); |
| } |
| |
| /** |
| * Checks if given [SourceRange] matched selection source and adds [_Occurrence]. |
| */ |
| bool _tryToFindOccurrence(SourceRange nodeRange) { |
| // check if can be extracted |
| if (!ref._isExtractable(nodeRange)) { |
| return false; |
| } |
| // prepare node source |
| _SourcePattern nodePattern = ref._getSourcePattern(nodeRange); |
| // if matches normalized node source, then add as occurrence |
| if (selectionPattern.isCompatible(nodePattern)) { |
| _Occurrence occurrence = |
| new _Occurrence(nodeRange, ref.selectionRange.intersects(nodeRange)); |
| ref._occurrences.add(occurrence); |
| // prepare mapping of parameter names to the occurrence variables |
| nodePattern.originalToPatternNames |
| .forEach((String originalName, String patternName) { |
| String selectionName = patternToSelectionName[patternName]; |
| occurrence._parameterOldToOccurrenceName[selectionName] = originalName; |
| }); |
| // update static |
| if (forceStatic) { |
| ref._staticContext = true; |
| } |
| // we have match |
| return true; |
| } |
| // no match |
| return false; |
| } |
| |
| void _visitStatements(List<Statement> statements) { |
| int beginStatementIndex = 0; |
| int selectionCount = ref._selectionStatements.length; |
| while (beginStatementIndex + selectionCount <= statements.length) { |
| SourceRange nodeRange = rangeStartEnd(statements[beginStatementIndex], |
| statements[beginStatementIndex + selectionCount - 1]); |
| bool found = _tryToFindOccurrence(nodeRange); |
| // next statement |
| if (found) { |
| beginStatementIndex += selectionCount; |
| } else { |
| beginStatementIndex++; |
| } |
| } |
| } |
| } |
| |
| class _InitializeParametersVisitor extends GeneralizingAstVisitor { |
| final ExtractMethodRefactoringImpl ref; |
| final List<VariableElement> assignedUsedVariables; |
| |
| _InitializeParametersVisitor(this.ref, this.assignedUsedVariables); |
| |
| @override |
| void visitSimpleIdentifier(SimpleIdentifier node) { |
| SourceRange nodeRange = rangeNode(node); |
| if (!ref.selectionRange.covers(nodeRange)) { |
| return; |
| } |
| String name = node.name; |
| // analyze local element |
| Element element = _getLocalElement(node); |
| if (element != null) { |
| // name of the named expression |
| if (isNamedExpressionName(node)) { |
| return; |
| } |
| // if declared outside, add parameter |
| if (!ref._isDeclaredInSelection(element)) { |
| // add parameter |
| RefactoringMethodParameter parameter = ref._parametersMap[name]; |
| if (parameter == null) { |
| DartType parameterType = node.bestType; |
| StringBuffer parametersBuffer = new StringBuffer(); |
| String parameterTypeCode = ref.utils.getTypeSource( |
| parameterType, ref.librariesToImport, |
| parametersBuffer: parametersBuffer); |
| String parametersCode = |
| parametersBuffer.isNotEmpty ? parametersBuffer.toString() : null; |
| parameter = new RefactoringMethodParameter( |
| RefactoringMethodParameterKind.REQUIRED, parameterTypeCode, name, |
| parameters: parametersCode, id: name); |
| ref._parameters.add(parameter); |
| ref._parametersMap[name] = parameter; |
| } |
| // add reference to parameter |
| ref._addParameterReference(name, nodeRange); |
| } |
| // remember, if assigned and used after selection |
| if (isLeftHandOfAssignment(node) && ref._isUsedAfterSelection(element)) { |
| if (!assignedUsedVariables.contains(element)) { |
| assignedUsedVariables.add(element); |
| } |
| } |
| } |
| // remember information for conflicts checking |
| if (element is LocalElement) { |
| // declared local elements |
| if (node.inDeclarationContext()) { |
| ref._localNames.putIfAbsent(name, () => <SourceRange>[]); |
| ref._localNames[name].add(element.visibleRange); |
| } |
| } else { |
| // unqualified non-local names |
| if (!node.isQualified) { |
| ref._unqualifiedNames.add(name); |
| } |
| } |
| } |
| } |
| |
| class _IsUsedAfterSelectionVisitor extends GeneralizingAstVisitor { |
| final ExtractMethodRefactoringImpl ref; |
| final Element element; |
| bool result = false; |
| |
| _IsUsedAfterSelectionVisitor(this.ref, this.element); |
| |
| @override |
| visitSimpleIdentifier(SimpleIdentifier node) { |
| Element nodeElement = node.staticElement; |
| if (identical(nodeElement, element)) { |
| int nodeOffset = node.offset; |
| if (nodeOffset > ref.selectionRange.end) { |
| result = true; |
| } |
| } |
| } |
| } |
| |
| /** |
| * Description of a single occurrence of the selected expression or set of |
| * statements. |
| */ |
| class _Occurrence { |
| final SourceRange range; |
| final bool isSelection; |
| |
| Map<String, String> _parameterOldToOccurrenceName = <String, String>{}; |
| |
| _Occurrence(this.range, this.isSelection); |
| } |
| |
| class _ReturnTypeComputer extends RecursiveAstVisitor { |
| final AnalysisContext context; |
| |
| DartType returnType; |
| |
| _ReturnTypeComputer(this.context); |
| |
| @override |
| visitBlockFunctionBody(BlockFunctionBody node) {} |
| |
| @override |
| visitReturnStatement(ReturnStatement node) { |
| // prepare expression |
| Expression expression = node.expression; |
| if (expression == null) { |
| return; |
| } |
| // prepare type |
| DartType type = expression.bestType; |
| if (type.isBottom) { |
| return; |
| } |
| // combine types |
| if (returnType == null) { |
| returnType = type; |
| } else { |
| if (returnType is InterfaceType && type is InterfaceType) { |
| returnType = InterfaceType.getSmartLeastUpperBound(returnType, type); |
| } else { |
| returnType = context.typeSystem.getLeastUpperBound(returnType, type); |
| } |
| } |
| } |
| } |
| |
| /** |
| * Generalized version of some source, in which references to the specific |
| * variables are replaced with pattern variables, with back mapping from the |
| * pattern to the original variable names. |
| */ |
| class _SourcePattern { |
| final List<DartType> parameterTypes = <DartType>[]; |
| String normalizedSource; |
| Map<String, String> originalToPatternNames = {}; |
| |
| bool isCompatible(_SourcePattern other) { |
| if (other.normalizedSource != normalizedSource) { |
| return false; |
| } |
| if (other.parameterTypes.length != parameterTypes.length) { |
| return false; |
| } |
| for (int i = 0; i < parameterTypes.length; i++) { |
| if (other.parameterTypes[i] != parameterTypes[i]) { |
| return false; |
| } |
| } |
| return true; |
| } |
| } |
