blob: 17944cd1a3702dd8d86bf7bd8a74fe94655de62e [file] [log] [blame]
// 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.correction.fix;
import 'dart:collection';
import 'package:analysis_server/src/protocol.dart'
hide AnalysisError, Element, ElementKind;
import 'package:analysis_server/src/protocol_server.dart'
show doSourceChange_addElementEdit, doSourceChange_addSourceEdit;
import 'package:analysis_server/src/services/correction/fix.dart';
import 'package:analysis_server/src/services/correction/levenshtein.dart';
import 'package:analysis_server/src/services/correction/name_suggestion.dart';
import 'package:analysis_server/src/services/correction/namespace.dart';
import 'package:analysis_server/src/services/correction/source_buffer.dart';
import 'package:analysis_server/src/services/correction/source_range.dart'
as rf;
import 'package:analysis_server/src/services/correction/strings.dart';
import 'package:analysis_server/src/services/correction/util.dart';
import 'package:analysis_server/src/services/search/hierarchy.dart';
import 'package:analyzer/src/generated/ast.dart';
import 'package:analyzer/src/generated/element.dart';
import 'package:analyzer/src/generated/engine.dart';
import 'package:analyzer/src/generated/error.dart';
import 'package:analyzer/src/generated/java_core.dart';
import 'package:analyzer/src/generated/parser.dart';
import 'package:analyzer/src/generated/scanner.dart';
import 'package:analyzer/src/generated/sdk.dart';
import 'package:analyzer/src/generated/source.dart';
import 'package:analyzer/src/generated/utilities_dart.dart';
import 'package:path/path.dart';
/**
* A predicate is a one-argument function that returns a boolean value.
*/
typedef bool Predicate<E>(E argument);
/**
* The computer for Dart fixes.
*/
class FixProcessor {
static const int MAX_LEVENSHTEIN_DISTANCE = 3;
final CompilationUnit unit;
final AnalysisError error;
AnalysisContext context;
String file;
int fileStamp;
CompilationUnitElement unitElement;
Source unitSource;
LibraryElement unitLibraryElement;
String unitLibraryFile;
String unitLibraryFolder;
final List<Fix> fixes = <Fix>[];
SourceChange change = new SourceChange('<message>');
final LinkedHashMap<String, LinkedEditGroup> linkedPositionGroups =
new LinkedHashMap<String, LinkedEditGroup>();
Position exitPosition = null;
Set<LibraryElement> librariesToImport = new Set<LibraryElement>();
CorrectionUtils utils;
int errorOffset;
int errorLength;
int errorEnd;
AstNode node;
AstNode coveredNode;
FixProcessor(this.unit, this.error) {
unitElement = unit.element;
context = unitElement.context;
unitSource = unitElement.source;
file = unitSource.fullName;
fileStamp = context.getModificationStamp(unitSource);
unitLibraryElement = unitElement.library;
unitLibraryFile = unitLibraryElement.source.fullName;
unitLibraryFolder = dirname(unitLibraryFile);
}
DartType get coreTypeBool => _getCoreType('bool');
/**
* Returns the EOL to use for this [CompilationUnit].
*/
String get eol => utils.endOfLine;
List<Fix> compute() {
utils = new CorrectionUtils(unit);
errorOffset = error.offset;
errorLength = error.length;
errorEnd = errorOffset + errorLength;
node = new NodeLocator.con1(errorOffset).searchWithin(unit);
coveredNode = new NodeLocator.con2(errorOffset, errorOffset + errorLength)
.searchWithin(unit);
// analyze ErrorCode
ErrorCode errorCode = error.errorCode;
if (errorCode == StaticWarningCode.UNDEFINED_CLASS_BOOLEAN) {
_addFix_boolInsteadOfBoolean();
}
if (errorCode ==
CompileTimeErrorCode.CONST_INITIALIZED_WITH_NON_CONSTANT_VALUE) {
_addFix_replaceWithConstInstanceCreation();
}
if (errorCode == CompileTimeErrorCode.INVALID_ANNOTATION) {
if (node is Annotation) {
Annotation annotation = node;
Identifier name = annotation.name;
if (name != null && name.staticElement == null) {
node = name;
if (annotation.arguments == null) {
_addFix_importLibrary_withTopLevelVariable();
} else {
_addFix_importLibrary_withType();
_addFix_createClass();
_addFix_undefinedClass_useSimilar();
}
}
}
}
if (errorCode ==
CompileTimeErrorCode.NO_DEFAULT_SUPER_CONSTRUCTOR_EXPLICIT) {
_addFix_createConstructorSuperExplicit();
}
if (errorCode ==
CompileTimeErrorCode.NO_DEFAULT_SUPER_CONSTRUCTOR_IMPLICIT) {
_addFix_createConstructorSuperImplicit();
}
if (errorCode ==
CompileTimeErrorCode.UNDEFINED_CONSTRUCTOR_IN_INITIALIZER_DEFAULT) {
_addFix_createConstructorSuperExplicit();
}
if (errorCode == CompileTimeErrorCode.URI_DOES_NOT_EXIST) {
_addFix_createImportUri();
_addFix_replaceImportUri();
}
if (errorCode == HintCode.DIVISION_OPTIMIZATION) {
_addFix_useEffectiveIntegerDivision();
}
if (errorCode == HintCode.TYPE_CHECK_IS_NOT_NULL) {
_addFix_isNotNull();
}
if (errorCode == HintCode.TYPE_CHECK_IS_NULL) {
_addFix_isNull();
}
if (errorCode == HintCode.UNNECESSARY_CAST) {
_addFix_removeUnnecessaryCast();
}
if (errorCode == HintCode.UNUSED_IMPORT) {
_addFix_removeUnusedImport();
}
if (errorCode == ParserErrorCode.EXPECTED_TOKEN) {
_addFix_insertSemicolon();
}
if (errorCode == ParserErrorCode.GETTER_WITH_PARAMETERS) {
_addFix_removeParameters_inGetterDeclaration();
}
if (errorCode == ParserErrorCode.VAR_AS_TYPE_NAME) {
_addFix_replaceVarWithDynamic();
}
if (errorCode == StaticWarningCode.CONCRETE_CLASS_WITH_ABSTRACT_MEMBER) {
_addFix_makeEnclosingClassAbstract();
}
if (errorCode == StaticWarningCode.EXTRA_POSITIONAL_ARGUMENTS) {
_addFix_createConstructor_insteadOfSyntheticDefault();
}
if (errorCode == StaticWarningCode.NEW_WITH_UNDEFINED_CONSTRUCTOR) {
_addFix_createConstructor_named();
}
if (errorCode ==
StaticWarningCode.NON_ABSTRACT_CLASS_INHERITS_ABSTRACT_MEMBER_ONE ||
errorCode ==
StaticWarningCode.NON_ABSTRACT_CLASS_INHERITS_ABSTRACT_MEMBER_TWO ||
errorCode ==
StaticWarningCode.NON_ABSTRACT_CLASS_INHERITS_ABSTRACT_MEMBER_THREE ||
errorCode ==
StaticWarningCode.NON_ABSTRACT_CLASS_INHERITS_ABSTRACT_MEMBER_FOUR ||
errorCode ==
StaticWarningCode.NON_ABSTRACT_CLASS_INHERITS_ABSTRACT_MEMBER_FIVE_PLUS) {
// make class abstract
_addFix_makeEnclosingClassAbstract();
// implement methods
AnalysisErrorWithProperties errorWithProperties =
error as AnalysisErrorWithProperties;
Object property =
errorWithProperties.getProperty(ErrorProperty.UNIMPLEMENTED_METHODS);
List<ExecutableElement> missingOverrides =
property as List<ExecutableElement>;
_addFix_createMissingOverrides(missingOverrides);
_addFix_createNoSuchMethod();
}
if (errorCode == StaticWarningCode.CAST_TO_NON_TYPE ||
errorCode == StaticWarningCode.TYPE_TEST_WITH_UNDEFINED_NAME ||
errorCode == StaticWarningCode.UNDEFINED_CLASS) {
_addFix_importLibrary_withType();
_addFix_createClass();
_addFix_undefinedClass_useSimilar();
}
if (errorCode == StaticWarningCode.UNDEFINED_IDENTIFIER) {
bool isAsync = _addFix_addAsync();
if (!isAsync) {
_addFix_createField();
_addFix_createGetter();
_addFix_createFunction_forFunctionType();
_addFix_importLibrary_withType();
_addFix_importLibrary_withTopLevelVariable();
_addFix_createLocalVariable();
}
}
if (errorCode == StaticTypeWarningCode.INSTANCE_ACCESS_TO_STATIC_MEMBER) {
_addFix_useStaticAccess_method();
_addFix_useStaticAccess_property();
}
if (errorCode == StaticTypeWarningCode.INVOCATION_OF_NON_FUNCTION) {
_addFix_removeParentheses_inGetterInvocation();
}
if (errorCode == StaticTypeWarningCode.NON_TYPE_AS_TYPE_ARGUMENT) {
_addFix_importLibrary_withType();
_addFix_createClass();
}
if (errorCode == StaticTypeWarningCode.UNDEFINED_FUNCTION) {
_addFix_importLibrary_withFunction();
_addFix_undefinedFunction_useSimilar();
_addFix_undefinedFunction_create();
}
if (errorCode == StaticTypeWarningCode.UNDEFINED_GETTER) {
_addFix_createField();
_addFix_createGetter();
_addFix_createFunction_forFunctionType();
}
if (errorCode == HintCode.UNDEFINED_METHOD ||
errorCode == StaticTypeWarningCode.UNDEFINED_METHOD) {
_addFix_importLibrary_withFunction();
_addFix_undefinedMethod_useSimilar();
_addFix_undefinedMethod_create();
_addFix_undefinedFunction_create();
}
if (errorCode == StaticTypeWarningCode.UNDEFINED_SETTER) {
_addFix_createField();
}
// done
return fixes;
}
/**
* Adds a new [SourceEdit] to [change].
*/
void _addEdit(Element target, SourceEdit edit) {
if (target == null) {
target = unitElement;
}
Source source = target.source;
if (source.isInSystemLibrary) {
return;
}
doSourceChange_addElementEdit(change, target, edit);
}
void _addFix(FixKind kind, List args) {
if (change.edits.isEmpty) {
return;
}
// configure Change
change.message = formatList(kind.message, args);
linkedPositionGroups.values
.forEach((group) => change.addLinkedEditGroup(group));
change.selection = exitPosition;
// add imports
addLibraryImports(change, unitLibraryElement, librariesToImport);
// add Fix
Fix fix = new Fix(kind, change);
fixes.add(fix);
// clear
change = new SourceChange('<message>');
linkedPositionGroups.clear();
exitPosition = null;
librariesToImport.clear();
}
/**
* Returns `true` if the `async` proposal was added.
*/
bool _addFix_addAsync() {
AstNode node = this.node;
if (_isAwaitNode()) {
FunctionBody body = node.getAncestor((n) => n is FunctionBody);
if (body.keyword == null) {
_addReplaceEdit(rf.rangeStartLength(body, 0), 'async ');
_addFix(FixKind.ADD_ASYNC, []);
return true;
}
}
return false;
}
void _addFix_boolInsteadOfBoolean() {
SourceRange range = rf.rangeError(error);
_addReplaceEdit(range, 'bool');
_addFix(FixKind.REPLACE_BOOLEAN_WITH_BOOL, []);
}
void _addFix_createClass() {
if (_mayBeTypeIdentifier(node)) {
String name = (node as SimpleIdentifier).name;
// prepare environment
CompilationUnitMember enclosingMember =
node.getAncestor((node) => node is CompilationUnitMember);
int offset = enclosingMember.end;
String prefix = '';
// prepare source
SourceBuilder sb = new SourceBuilder(file, offset);
{
sb.append('$eol$eol');
sb.append(prefix);
// "class"
sb.append('class ');
// append name
{
sb.startPosition('NAME');
sb.append(name);
sb.endPosition();
}
// no members
sb.append(' {');
sb.append(eol);
sb.append('}');
}
// insert source
_insertBuilder(sb, unitElement);
_addLinkedPosition('NAME', sb, rf.rangeNode(node));
// add proposal
_addFix(FixKind.CREATE_CLASS, [name]);
}
}
void _addFix_createConstructor_insteadOfSyntheticDefault() {
TypeName typeName = null;
ConstructorName constructorName = null;
InstanceCreationExpression instanceCreation = null;
if (node is SimpleIdentifier) {
if (node.parent is TypeName) {
typeName = node.parent as TypeName;
if (typeName.name == node && typeName.parent is ConstructorName) {
constructorName = typeName.parent as ConstructorName;
// should be synthetic default constructor
{
ConstructorElement constructorElement =
constructorName.staticElement;
if (constructorElement == null ||
!constructorElement.isDefaultConstructor ||
!constructorElement.isSynthetic) {
return;
}
}
// prepare InstanceCreationExpression
if (constructorName.parent is InstanceCreationExpression) {
instanceCreation =
constructorName.parent as InstanceCreationExpression;
if (instanceCreation.constructorName != constructorName) {
return;
}
}
}
}
}
// do we have enough information?
if (instanceCreation == null) {
return;
}
// prepare target
DartType targetType = typeName.type;
if (targetType is! InterfaceType) {
return;
}
ClassElement targetElement = targetType.element as ClassElement;
String targetFile = targetElement.source.fullName;
ClassDeclaration targetClass = targetElement.node;
_ConstructorLocation targetLocation =
_prepareNewConstructorLocation(targetClass);
// build method source
SourceBuilder sb = new SourceBuilder(targetFile, targetLocation.offset);
{
String indent = ' ';
sb.append(targetLocation.prefix);
sb.append(indent);
sb.append(targetElement.name);
_addFix_undefinedMethod_create_parameters(
sb, instanceCreation.argumentList);
sb.append(') {$eol$indent}');
sb.append(targetLocation.suffix);
}
// insert source
_insertBuilder(sb, targetElement);
// add proposal
_addFix(FixKind.CREATE_CONSTRUCTOR, [constructorName]);
}
void _addFix_createConstructor_named() {
SimpleIdentifier name = null;
ConstructorName constructorName = null;
InstanceCreationExpression instanceCreation = null;
if (node is SimpleIdentifier) {
// name
name = node as SimpleIdentifier;
if (name.parent is ConstructorName) {
constructorName = name.parent as ConstructorName;
if (constructorName.name == name) {
// Type.name
if (constructorName.parent is InstanceCreationExpression) {
instanceCreation =
constructorName.parent as InstanceCreationExpression;
// new Type.name()
if (instanceCreation.constructorName != constructorName) {
return;
}
}
}
}
}
// do we have enough information?
if (instanceCreation == null) {
return;
}
// prepare target interface type
DartType targetType = constructorName.type.type;
if (targetType is! InterfaceType) {
return;
}
ClassElement targetElement = targetType.element as ClassElement;
String targetFile = targetElement.source.fullName;
ClassDeclaration targetClass = targetElement.node;
_ConstructorLocation targetLocation =
_prepareNewConstructorLocation(targetClass);
// build method source
SourceBuilder sb = new SourceBuilder(targetFile, targetLocation.offset);
{
String indent = ' ';
sb.append(targetLocation.prefix);
sb.append(indent);
sb.append(targetElement.name);
sb.append('.');
// append name
{
sb.startPosition('NAME');
sb.append(name.name);
sb.endPosition();
}
_addFix_undefinedMethod_create_parameters(
sb, instanceCreation.argumentList);
sb.append(') {$eol$indent}');
sb.append(targetLocation.suffix);
}
// insert source
_insertBuilder(sb, targetElement);
if (targetFile == file) {
_addLinkedPosition('NAME', sb, rf.rangeNode(name));
}
// add proposal
_addFix(FixKind.CREATE_CONSTRUCTOR, [constructorName]);
}
void _addFix_createConstructorSuperExplicit() {
ConstructorDeclaration targetConstructor =
node.parent as ConstructorDeclaration;
ClassDeclaration targetClassNode =
targetConstructor.parent as ClassDeclaration;
ClassElement targetClassElement = targetClassNode.element;
ClassElement superClassElement = targetClassElement.supertype.element;
// add proposals for all super constructors
List<ConstructorElement> superConstructors = superClassElement.constructors;
for (ConstructorElement superConstructor in superConstructors) {
String constructorName = superConstructor.name;
// skip private
if (Identifier.isPrivateName(constructorName)) {
continue;
}
// prepare SourceBuilder
SourceBuilder sb;
{
List<ConstructorInitializer> initializers =
targetConstructor.initializers;
if (initializers.isEmpty) {
int insertOffset = targetConstructor.parameters.end;
sb = new SourceBuilder(file, insertOffset);
sb.append(' : ');
} else {
ConstructorInitializer lastInitializer =
initializers[initializers.length - 1];
int insertOffset = lastInitializer.end;
sb = new SourceBuilder(file, insertOffset);
sb.append(', ');
}
}
// add super constructor name
sb.append('super');
if (!StringUtils.isEmpty(constructorName)) {
sb.append('.');
sb.append(constructorName);
}
// add arguments
sb.append('(');
bool firstParameter = true;
for (ParameterElement parameter in superConstructor.parameters) {
// skip non-required parameters
if (parameter.parameterKind != ParameterKind.REQUIRED) {
break;
}
// comma
if (firstParameter) {
firstParameter = false;
} else {
sb.append(', ');
}
// default value
DartType parameterType = parameter.type;
sb.startPosition(parameter.name);
sb.append(getDefaultValueCode(parameterType));
sb.endPosition();
}
sb.append(')');
// insert proposal
_insertBuilder(sb, unitElement);
// add proposal
String proposalName = _getConstructorProposalName(superConstructor);
_addFix(FixKind.ADD_SUPER_CONSTRUCTOR_INVOCATION, [proposalName]);
}
}
void _addFix_createConstructorSuperImplicit() {
ClassDeclaration targetClassNode = node.parent as ClassDeclaration;
ClassElement targetClassElement = targetClassNode.element;
ClassElement superClassElement = targetClassElement.supertype.element;
String targetClassName = targetClassElement.name;
// add proposals for all super constructors
List<ConstructorElement> superConstructors = superClassElement.constructors;
for (ConstructorElement superConstructor in superConstructors) {
String constructorName = superConstructor.name;
// skip private
if (Identifier.isPrivateName(constructorName)) {
continue;
}
// prepare parameters and arguments
SourceBuilder parametersBuffer = new SourceBuilder.buffer();
SourceBuilder argumentsBuffer = new SourceBuilder.buffer();
bool firstParameter = true;
for (ParameterElement parameter in superConstructor.parameters) {
// skip non-required parameters
if (parameter.parameterKind != ParameterKind.REQUIRED) {
break;
}
// comma
if (firstParameter) {
firstParameter = false;
} else {
parametersBuffer.append(', ');
argumentsBuffer.append(', ');
}
// name
String parameterName = parameter.displayName;
if (parameterName.length > 1 && parameterName.startsWith('_')) {
parameterName = parameterName.substring(1);
}
// parameter & argument
_appendParameterSource(parametersBuffer, parameter.type, parameterName);
argumentsBuffer.append(parameterName);
}
// add proposal
_ConstructorLocation targetLocation =
_prepareNewConstructorLocation(targetClassNode);
SourceBuilder sb = new SourceBuilder(file, targetLocation.offset);
{
String indent = utils.getIndent(1);
sb.append(targetLocation.prefix);
sb.append(indent);
sb.append(targetClassName);
if (!constructorName.isEmpty) {
sb.startPosition('NAME');
sb.append('.');
sb.append(constructorName);
sb.endPosition();
}
sb.append('(');
sb.append(parametersBuffer.toString());
sb.append(') : super');
if (!constructorName.isEmpty) {
sb.append('.');
sb.append(constructorName);
}
sb.append('(');
sb.append(argumentsBuffer.toString());
sb.append(');');
sb.append(targetLocation.suffix);
}
_insertBuilder(sb, unitElement);
// add proposal
String proposalName = _getConstructorProposalName(superConstructor);
_addFix(FixKind.CREATE_CONSTRUCTOR_SUPER, [proposalName]);
}
}
void _addFix_createField() {
SimpleIdentifier nameNode = node;
String name = nameNode.name;
// prepare target Expression
Expression target;
{
AstNode nameParent = nameNode.parent;
if (nameParent is PrefixedIdentifier) {
target = nameParent.prefix;
}
if (nameParent is PropertyAccess) {
target = nameParent.realTarget;
}
}
// prepare target ClassElement
bool staticModifier = false;
ClassElement targetClassElement;
if (target != null) {
// prepare target interface type
DartType targetType = target.bestType;
if (targetType is! InterfaceType) {
return;
}
targetClassElement = targetType.element;
// maybe static
if (target is Identifier) {
Identifier targetIdentifier = target;
Element targetElement = targetIdentifier.staticElement;
staticModifier = targetElement.kind == ElementKind.CLASS;
}
} else {
targetClassElement = getEnclosingClassElement(node);
if (targetClassElement == null) {
return;
}
staticModifier = _inStaticContext();
}
utils.targetClassElement = targetClassElement;
// prepare target ClassDeclaration
AstNode targetTypeNode = targetClassElement.node;
if (targetTypeNode is! ClassDeclaration) {
return;
}
ClassDeclaration targetClassNode = targetTypeNode;
// prepare location
_FieldLocation targetLocation = _prepareNewFieldLocation(targetClassNode);
// build method source
String targetFile = targetClassElement.source.fullName;
SourceBuilder sb = new SourceBuilder(targetFile, targetLocation.offset);
{
sb.append(targetLocation.prefix);
// maybe "static"
if (staticModifier) {
sb.append('static ');
}
// append type
Expression fieldTypeNode = climbPropertyAccess(nameNode);
DartType fieldType = _inferUndefinedExpressionType(fieldTypeNode);
_appendType(sb, fieldType, groupId: 'TYPE', orVar: true);
// append name
{
sb.startPosition('NAME');
sb.append(name);
sb.endPosition();
}
sb.append(';');
sb.append(targetLocation.suffix);
}
// insert source
_insertBuilder(sb, targetClassElement);
// add linked positions
if (targetFile == file) {
_addLinkedPosition('NAME', sb, rf.rangeNode(node));
}
// add proposal
_addFix(FixKind.CREATE_FIELD, [name]);
}
void _addFix_createFunction_forFunctionType() {
if (node is SimpleIdentifier) {
SimpleIdentifier nameNode = node as SimpleIdentifier;
// prepare argument expression (to get parameter)
ClassElement targetElement;
Expression argument;
{
Expression target = getQualifiedPropertyTarget(node);
if (target != null) {
DartType targetType = target.bestType;
if (targetType != null && targetType.element is ClassElement) {
targetElement = targetType.element as ClassElement;
argument = target.parent as Expression;
} else {
return;
}
} else {
ClassDeclaration enclosingClass =
node.getAncestor((node) => node is ClassDeclaration);
targetElement =
enclosingClass != null ? enclosingClass.element : null;
argument = nameNode;
}
}
argument = stepUpNamedExpression(argument);
// should be argument of some invocation
ParameterElement parameterElement = argument.bestParameterElement;
if (parameterElement == null) {
return;
}
// should be parameter of function type
DartType parameterType = parameterElement.type;
if (parameterType is InterfaceType && parameterType.isDartCoreFunction) {
ExecutableElement element = new MethodElementImpl('', -1);
parameterType = new FunctionTypeImpl.con1(element);
}
if (parameterType is! FunctionType) {
return;
}
FunctionType functionType = parameterType as FunctionType;
// add proposal
if (targetElement != null) {
_addProposal_createFunction_method(targetElement, functionType);
} else {
_addProposal_createFunction_function(functionType);
}
}
}
void _addFix_createGetter() {
SimpleIdentifier nameNode = node;
String name = nameNode.name;
if (!nameNode.inGetterContext()) {
return;
}
// prepare target Expression
Expression target;
{
AstNode nameParent = nameNode.parent;
if (nameParent is PrefixedIdentifier) {
target = nameParent.prefix;
}
if (nameParent is PropertyAccess) {
target = nameParent.realTarget;
}
}
// prepare target ClassElement
bool staticModifier = false;
ClassElement targetClassElement;
if (target != null) {
// prepare target interface type
DartType targetType = target.bestType;
if (targetType is! InterfaceType) {
return;
}
targetClassElement = targetType.element;
// maybe static
if (target is Identifier) {
Identifier targetIdentifier = target;
Element targetElement = targetIdentifier.staticElement;
staticModifier = targetElement.kind == ElementKind.CLASS;
}
} else {
targetClassElement = getEnclosingClassElement(node);
if (targetClassElement == null) {
return;
}
staticModifier = _inStaticContext();
}
utils.targetClassElement = targetClassElement;
// prepare target ClassDeclaration
AstNode targetTypeNode = targetClassElement.node;
if (targetTypeNode is! ClassDeclaration) {
return;
}
ClassDeclaration targetClassNode = targetTypeNode;
// prepare location
_FieldLocation targetLocation = _prepareNewGetterLocation(targetClassNode);
// build method source
String targetFile = targetClassElement.source.fullName;
SourceBuilder sb = new SourceBuilder(targetFile, targetLocation.offset);
{
sb.append(targetLocation.prefix);
// maybe "static"
if (staticModifier) {
sb.append('static ');
}
// append type
Expression fieldTypeNode = climbPropertyAccess(nameNode);
DartType fieldType = _inferUndefinedExpressionType(fieldTypeNode);
_appendType(sb, fieldType, groupId: 'TYPE');
sb.append('get ');
// append name
{
sb.startPosition('NAME');
sb.append(name);
sb.endPosition();
}
sb.append(' => null;');
sb.append(targetLocation.suffix);
}
// insert source
_insertBuilder(sb, targetClassElement);
// add linked positions
if (targetFile == file) {
_addLinkedPosition('NAME', sb, rf.rangeNode(node));
}
// add proposal
_addFix(FixKind.CREATE_GETTER, [name]);
}
void _addFix_createImportUri() {
if (node is SimpleStringLiteral && node.parent is ImportDirective) {
ImportDirective importDirective = node.parent;
Source source = importDirective.source;
if (source != null) {
String file = source.fullName;
if (isAbsolute(file)) {
String libName = removeEnd(source.shortName, '.dart');
libName = libName.replaceAll('_', '.');
SourceEdit edit = new SourceEdit(0, 0, 'library $libName;$eol$eol');
change.addEdit(file, -1, edit);
doSourceChange_addSourceEdit(change, context, source, edit);
}
_addFix(FixKind.CREATE_FILE, [file]);
}
}
}
void _addFix_createLocalVariable() {
SimpleIdentifier nameNode = node;
String name = nameNode.name;
// if variable is assigned, convert assignment into declaration
if (node.parent is AssignmentExpression) {
AssignmentExpression assignment = node.parent;
if (assignment.leftHandSide == node &&
assignment.operator.type == TokenType.EQ &&
assignment.parent is ExpressionStatement) {
_addInsertEdit(node.offset, 'var ');
_addFix(FixKind.CREATE_LOCAL_VARIABLE, [name]);
return;
}
}
// prepare target Statement
Statement target = node.getAncestor((x) => x is Statement);
if (target == null) {
return;
}
String prefix = utils.getNodePrefix(target);
// build variable declaration source
SourceBuilder sb = new SourceBuilder(file, target.offset);
{
// append type
DartType type = _inferUndefinedExpressionType(node);
if (!(type == null ||
type is InterfaceType ||
type is FunctionType &&
type.element != null &&
!type.element.isSynthetic)) {
return;
}
_appendType(sb, type, groupId: 'TYPE', orVar: true);
// append name
{
sb.startPosition('NAME');
sb.append(name);
sb.endPosition();
}
sb.append(';');
sb.append(eol);
sb.append(prefix);
}
// insert source
_insertBuilder(sb, unitElement);
// add linked positions
_addLinkedPosition('NAME', sb, rf.rangeNode(node));
// add proposal
_addFix(FixKind.CREATE_LOCAL_VARIABLE, [name]);
}
void _addFix_createMissingOverrides(List<ExecutableElement> elements) {
elements = elements.toList();
int numElements = elements.length;
// sort by name, getters before setters
elements.sort((Element a, Element b) {
int names = compareStrings(a.displayName, b.displayName);
if (names != 0) {
return names;
}
if (a.kind == ElementKind.GETTER) {
return -1;
}
return 1;
});
ClassDeclaration targetClass = node.parent as ClassDeclaration;
int insertOffset = targetClass.end - 1;
SourceBuilder sb = new SourceBuilder(file, insertOffset);
// EOL management
bool isFirst = true;
void addEolIfNotFirst() {
if (!isFirst || !targetClass.members.isEmpty) {
sb.append(eol);
}
isFirst = false;
}
// merge getter/setter pairs into fields
for (int i = 0; i < elements.length; i++) {
ExecutableElement element = elements[i];
if (element.kind == ElementKind.GETTER && i + 1 < elements.length) {
ExecutableElement nextElement = elements[i + 1];
if (nextElement.kind == ElementKind.SETTER) {
// remove this and the next elements, adjust iterator
elements.removeAt(i + 1);
elements.removeAt(i);
i--;
numElements--;
// add field
addEolIfNotFirst();
sb.append(utils.getIndent(1));
_appendType(sb, element.type.returnType);
sb.append(element.name);
sb.append(';');
sb.append(eol);
}
}
}
// add elements
for (ExecutableElement element in elements) {
addEolIfNotFirst();
_addFix_createMissingOverrides_single(sb, targetClass, element);
}
// add proposal
exitPosition = new Position(file, insertOffset);
_insertBuilder(sb, unitElement);
_addFix(FixKind.CREATE_MISSING_OVERRIDES, [numElements]);
}
void _addFix_createMissingOverrides_single(SourceBuilder sb,
ClassDeclaration targetClass, ExecutableElement element) {
// prepare environment
String prefix = utils.getIndent(1);
String prefix2 = utils.getIndent(2);
// may be property
ElementKind elementKind = element.kind;
bool isGetter = elementKind == ElementKind.GETTER;
bool isSetter = elementKind == ElementKind.SETTER;
bool isMethod = elementKind == ElementKind.METHOD;
bool isOperator = isMethod && (element as MethodElement).isOperator;
sb.append(prefix);
if (isGetter) {
sb.append('// TODO: implement ${element.displayName}');
sb.append(eol);
sb.append(prefix);
}
// @override
{
sb.append('@override');
sb.append(eol);
sb.append(prefix);
}
// return type
_appendType(sb, element.type.returnType);
if (isGetter) {
sb.append('get ');
} else if (isSetter) {
sb.append('set ');
} else if (isOperator) {
sb.append('operator ');
}
// name
sb.append(element.displayName);
// parameters + body
if (isGetter) {
sb.append(' => null;');
} else {
List<ParameterElement> parameters = element.parameters;
_appendParameters(sb, parameters);
sb.append(' {');
// TO-DO
sb.append(eol);
sb.append(prefix2);
sb.append('// TODO: implement ${element.displayName}');
sb.append(eol);
// close method
sb.append(prefix);
sb.append('}');
}
sb.append(eol);
}
void _addFix_createNoSuchMethod() {
ClassDeclaration targetClass = node.parent as ClassDeclaration;
// prepare environment
String prefix = utils.getIndent(1);
int insertOffset = targetClass.end - 1;
// prepare source
SourceBuilder sb = new SourceBuilder(file, insertOffset);
{
// insert empty line before existing member
if (!targetClass.members.isEmpty) {
sb.append(eol);
}
// append method
sb.append(prefix);
sb.append(
'noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);');
sb.append(eol);
}
// done
_insertBuilder(sb, unitElement);
exitPosition = new Position(file, insertOffset);
// add proposal
_addFix(FixKind.CREATE_NO_SUCH_METHOD, []);
}
void _addFix_importLibrary(FixKind kind, String importPath) {
CompilationUnitElement libraryUnitElement =
unitLibraryElement.definingCompilationUnit;
CompilationUnit libraryUnit = libraryUnitElement.node;
// prepare new import location
int offset = 0;
String prefix;
String suffix;
{
// if no directives
prefix = '';
suffix = eol;
CorrectionUtils libraryUtils = new CorrectionUtils(libraryUnit);
// after last directive in library
for (Directive directive in libraryUnit.directives) {
if (directive is LibraryDirective || directive is ImportDirective) {
offset = directive.end;
prefix = eol;
suffix = '';
}
}
// if still beginning of file, skip shebang and line comments
if (offset == 0) {
CorrectionUtils_InsertDesc desc = libraryUtils.getInsertDescTop();
offset = desc.offset;
prefix = desc.prefix;
suffix = '${desc.suffix}$eol';
}
}
// insert new import
String importSource = "${prefix}import '$importPath';$suffix";
_addInsertEdit(offset, importSource, libraryUnitElement);
// add proposal
_addFix(kind, [importPath]);
}
void _addFix_importLibrary_withElement(String name, ElementKind kind) {
// ignore if private
if (name.startsWith('_')) {
return;
}
// may be there is an existing import,
// but it is with prefix and we don't use this prefix
for (ImportElement imp in unitLibraryElement.imports) {
// prepare element
LibraryElement libraryElement = imp.importedLibrary;
Element element = getExportedElement(libraryElement, name);
if (element == null) {
continue;
}
if (element is PropertyAccessorElement) {
element = (element as PropertyAccessorElement).variable;
}
if (element.kind != kind) {
continue;
}
// may be apply prefix
PrefixElement prefix = imp.prefix;
if (prefix != null) {
SourceRange range = rf.rangeStartLength(node, 0);
_addReplaceEdit(range, '${prefix.displayName}.');
_addFix(FixKind.IMPORT_LIBRARY_PREFIX,
[libraryElement.displayName, prefix.displayName]);
continue;
}
// may be update "show" directive
List<NamespaceCombinator> combinators = imp.combinators;
if (combinators.length == 1 && combinators[0] is ShowElementCombinator) {
ShowElementCombinator showCombinator =
combinators[0] as ShowElementCombinator;
// prepare new set of names to show
Set<String> showNames = new SplayTreeSet<String>();
showNames.addAll(showCombinator.shownNames);
showNames.add(name);
// prepare library name - unit name or 'dart:name' for SDK library
String libraryName = libraryElement.definingCompilationUnit.displayName;
if (libraryElement.isInSdk) {
libraryName = imp.uri;
}
// update library
String newShowCode = 'show ${StringUtils.join(showNames, ", ")}';
_addReplaceEdit(
rf.rangeOffsetEnd(showCombinator), newShowCode, unitLibraryElement);
_addFix(FixKind.IMPORT_LIBRARY_SHOW, [libraryName]);
// we support only one import without prefix
return;
}
}
// check SDK libraries
{
DartSdk sdk = context.sourceFactory.dartSdk;
List<SdkLibrary> sdkLibraries = sdk.sdkLibraries;
for (SdkLibrary sdkLibrary in sdkLibraries) {
SourceFactory sdkSourceFactory = context.sourceFactory;
String libraryUri = sdkLibrary.shortName;
Source librarySource =
sdkSourceFactory.resolveUri(unitSource, libraryUri);
// prepare LibraryElement
LibraryElement libraryElement =
context.getLibraryElement(librarySource);
if (libraryElement == null) {
continue;
}
// prepare exported Element
Element element = getExportedElement(libraryElement, name);
if (element == null) {
continue;
}
if (element is PropertyAccessorElement) {
element = (element as PropertyAccessorElement).variable;
}
if (element.kind != kind) {
continue;
}
// add import
_addFix_importLibrary(FixKind.IMPORT_LIBRARY_SDK, libraryUri);
}
}
// check project libraries
{
List<Source> librarySources = context.librarySources;
for (Source librarySource in librarySources) {
// we don't need SDK libraries here
if (librarySource.isInSystemLibrary) {
continue;
}
// prepare LibraryElement
LibraryElement libraryElement =
context.getLibraryElement(librarySource);
if (libraryElement == null) {
continue;
}
// prepare exported Element
Element element = getExportedElement(libraryElement, name);
if (element == null) {
continue;
}
if (element is PropertyAccessorElement) {
element = (element as PropertyAccessorElement).variable;
}
if (element.kind != kind) {
continue;
}
// prepare "library" file
String libraryFile = librarySource.fullName;
// may be "package:" URI
{
String libraryPackageUri = findAbsoluteUri(context, libraryFile);
if (libraryPackageUri != null) {
_addFix_importLibrary(
FixKind.IMPORT_LIBRARY_PROJECT, libraryPackageUri);
continue;
}
}
// relative URI
String relativeFile = relative(libraryFile, from: unitLibraryFolder);
relativeFile = split(relativeFile).join('/');
_addFix_importLibrary(FixKind.IMPORT_LIBRARY_PROJECT, relativeFile);
}
}
}
void _addFix_importLibrary_withFunction() {
if (node is SimpleIdentifier && node.parent is MethodInvocation) {
MethodInvocation invocation = node.parent as MethodInvocation;
if (invocation.realTarget == null && invocation.methodName == node) {
String name = (node as SimpleIdentifier).name;
_addFix_importLibrary_withElement(name, ElementKind.FUNCTION);
}
}
}
void _addFix_importLibrary_withTopLevelVariable() {
if (node is SimpleIdentifier) {
String name = (node as SimpleIdentifier).name;
_addFix_importLibrary_withElement(name, ElementKind.TOP_LEVEL_VARIABLE);
}
}
void _addFix_importLibrary_withType() {
if (_mayBeTypeIdentifier(node)) {
String typeName = (node as SimpleIdentifier).name;
_addFix_importLibrary_withElement(typeName, ElementKind.CLASS);
_addFix_importLibrary_withElement(
typeName, ElementKind.FUNCTION_TYPE_ALIAS);
}
}
void _addFix_insertSemicolon() {
if (error.message.contains("';'")) {
if (_isAwaitNode()) {
return;
}
int insertOffset = error.offset + error.length;
_addInsertEdit(insertOffset, ';');
_addFix(FixKind.INSERT_SEMICOLON, []);
}
}
void _addFix_isNotNull() {
if (coveredNode is IsExpression) {
IsExpression isExpression = coveredNode as IsExpression;
_addReplaceEdit(
rf.rangeEndEnd(isExpression.expression, isExpression), ' != null');
_addFix(FixKind.USE_NOT_EQ_NULL, []);
}
}
void _addFix_isNull() {
if (coveredNode is IsExpression) {
IsExpression isExpression = coveredNode as IsExpression;
_addReplaceEdit(
rf.rangeEndEnd(isExpression.expression, isExpression), ' == null');
_addFix(FixKind.USE_EQ_EQ_NULL, []);
}
}
void _addFix_makeEnclosingClassAbstract() {
ClassDeclaration enclosingClass =
node.getAncestor((node) => node is ClassDeclaration);
String className = enclosingClass.name.name;
_addInsertEdit(enclosingClass.classKeyword.offset, 'abstract ');
_addFix(FixKind.MAKE_CLASS_ABSTRACT, [className]);
}
void _addFix_removeParameters_inGetterDeclaration() {
if (node is SimpleIdentifier && node.parent is MethodDeclaration) {
MethodDeclaration method = node.parent as MethodDeclaration;
FunctionBody body = method.body;
if (method.name == node && body != null) {
_addReplaceEdit(rf.rangeEndStart(node, body), ' ');
_addFix(FixKind.REMOVE_PARAMETERS_IN_GETTER_DECLARATION, []);
}
}
}
void _addFix_removeParentheses_inGetterInvocation() {
if (node is SimpleIdentifier && node.parent is MethodInvocation) {
MethodInvocation invocation = node.parent as MethodInvocation;
if (invocation.methodName == node && invocation.target != null) {
_addRemoveEdit(rf.rangeEndEnd(node, invocation));
_addFix(FixKind.REMOVE_PARENTHESIS_IN_GETTER_INVOCATION, []);
}
}
}
void _addFix_removeUnnecessaryCast() {
if (coveredNode is! AsExpression) {
return;
}
AsExpression asExpression = coveredNode as AsExpression;
Expression expression = asExpression.expression;
int expressionPrecedence = getExpressionPrecedence(expression);
// remove 'as T' from 'e as T'
_addRemoveEdit(rf.rangeEndEnd(expression, asExpression));
_removeEnclosingParentheses(asExpression, expressionPrecedence);
// done
_addFix(FixKind.REMOVE_UNNECASSARY_CAST, []);
}
void _addFix_removeUnusedImport() {
// prepare ImportDirective
ImportDirective importDirective =
node.getAncestor((node) => node is ImportDirective);
if (importDirective == null) {
return;
}
// remove the whole line with import
_addRemoveEdit(utils.getLinesRange(rf.rangeNode(importDirective)));
// done
_addFix(FixKind.REMOVE_UNUSED_IMPORT, []);
}
void _addFix_replaceImportUri() {
if (node is SimpleStringLiteral) {
SimpleStringLiteral stringLiteral = node;
String uri = stringLiteral.value;
String uriName = substringAfterLast(uri, '/');
for (Source libSource in context.librarySources) {
String libFile = libSource.fullName;
if (substringAfterLast(libFile, '/') == uriName) {
String fixedUri;
// may be "package:" URI
String libPackageUri = findAbsoluteUri(context, libFile);
if (libPackageUri != null) {
fixedUri = libPackageUri;
} else {
String relativeFile = relative(libFile, from: unitLibraryFolder);
fixedUri = split(relativeFile).join('/');
}
// add fix
SourceRange range = rf.rangeNode(node);
_addReplaceEdit(range, "'$fixedUri'");
_addFix(FixKind.REPLACE_IMPORT_URI, [fixedUri]);
}
}
}
}
void _addFix_replaceVarWithDynamic() {
SourceRange range = rf.rangeError(error);
_addReplaceEdit(range, 'dynamic');
_addFix(FixKind.REPLACE_VAR_WITH_DYNAMIC, []);
}
void _addFix_replaceWithConstInstanceCreation() {
if (coveredNode is InstanceCreationExpression) {
var instanceCreation = coveredNode as InstanceCreationExpression;
_addReplaceEdit(rf.rangeToken(instanceCreation.keyword), 'const');
_addFix(FixKind.USE_CONST, []);
}
}
void _addFix_undefinedClass_useSimilar() {
if (_mayBeTypeIdentifier(node)) {
String name = (node as SimpleIdentifier).name;
_ClosestElementFinder finder = new _ClosestElementFinder(name,
(Element element) => element is ClassElement,
MAX_LEVENSHTEIN_DISTANCE);
// find closest element
{
// elements of this library
for (CompilationUnitElement unit in unitLibraryElement.units) {
finder._updateList(unit.types);
}
// elements from imports
for (ImportElement importElement in unitLibraryElement.imports) {
if (importElement.prefix == null) {
Map<String, Element> namespace = getImportNamespace(importElement);
finder._updateList(namespace.values);
}
}
}
// if we have close enough element, suggest to use it
if (finder._element != null) {
String closestName = finder._element.name;
_addReplaceEdit(rf.rangeNode(node), closestName);
// add proposal
if (closestName != null) {
_addFix(FixKind.CHANGE_TO, [closestName]);
}
}
}
}
void _addFix_undefinedFunction_create() {
// should be the name of the invocation
if (node is SimpleIdentifier && node.parent is MethodInvocation) {} else {
return;
}
String name = (node as SimpleIdentifier).name;
MethodInvocation invocation = node.parent as MethodInvocation;
// function invocation has no target
Expression target = invocation.realTarget;
if (target != null) {
return;
}
// prepare environment
int insertOffset;
String sourcePrefix;
AstNode enclosingMember =
node.getAncestor((node) => node is CompilationUnitMember);
insertOffset = enclosingMember.end;
sourcePrefix = '$eol$eol';
utils.targetClassElement = null;
// build method source
SourceBuilder sb = new SourceBuilder(file, insertOffset);
{
sb.append(sourcePrefix);
// append return type
{
DartType type = _inferUndefinedExpressionType(invocation);
_appendType(sb, type, groupId: 'RETURN_TYPE');
}
// append name
{
sb.startPosition('NAME');
sb.append(name);
sb.endPosition();
}
_addFix_undefinedMethod_create_parameters(sb, invocation.argumentList);
sb.append(') {$eol}');
}
// insert source
_insertBuilder(sb, unitElement);
_addLinkedPosition('NAME', sb, rf.rangeNode(node));
// add proposal
_addFix(FixKind.CREATE_FUNCTION, [name]);
}
void _addFix_undefinedFunction_useSimilar() {
if (node is SimpleIdentifier) {
String name = (node as SimpleIdentifier).name;
_ClosestElementFinder finder = new _ClosestElementFinder(name,
(Element element) => element is FunctionElement,
MAX_LEVENSHTEIN_DISTANCE);
// this library
for (CompilationUnitElement unit in unitLibraryElement.units) {
finder._updateList(unit.functions);
}
// imports
for (ImportElement importElement in unitLibraryElement.imports) {
if (importElement.prefix == null) {
Map<String, Element> namespace = getImportNamespace(importElement);
finder._updateList(namespace.values);
}
}
// if we have close enough element, suggest to use it
if (finder._element != null) {
String closestName = finder._element.name;
_addReplaceEdit(rf.rangeNode(node), closestName);
_addFix(FixKind.CHANGE_TO, [closestName]);
}
}
}
void _addFix_undefinedMethod_create() {
if (node is SimpleIdentifier && node.parent is MethodInvocation) {
String name = (node as SimpleIdentifier).name;
MethodInvocation invocation = node.parent as MethodInvocation;
// prepare environment
Element targetElement;
String prefix;
int insertOffset;
String sourcePrefix;
String sourceSuffix;
bool staticModifier = false;
Expression target = invocation.realTarget;
if (target == null) {
targetElement = unitElement;
ClassMember enclosingMember =
node.getAncestor((node) => node is ClassMember);
ClassDeclaration enclosingClass = enclosingMember.parent;
utils.targetClassElement = enclosingClass.element;
staticModifier = _inStaticContext();
prefix = utils.getNodePrefix(enclosingMember);
insertOffset = enclosingMember.end;
sourcePrefix = '$eol$eol';
sourceSuffix = '';
} else {
// prepare target interface type
DartType targetType = target.bestType;
if (targetType is! InterfaceType) {
return;
}
ClassElement targetClassElement = targetType.element as ClassElement;
targetElement = targetClassElement;
// may be static
if (target is Identifier) {
staticModifier = target.bestElement.kind == ElementKind.CLASS;
}
// prepare insert offset
ClassDeclaration targetClassNode = targetClassElement.node;
prefix = ' ';
insertOffset = targetClassNode.end - 1;
if (targetClassNode.members.isEmpty) {
sourcePrefix = '';
} else {
sourcePrefix = eol;
}
sourceSuffix = eol;
}
String targetFile = targetElement.source.fullName;
// build method source
SourceBuilder sb = new SourceBuilder(targetFile, insertOffset);
{
sb.append(sourcePrefix);
sb.append(prefix);
// maybe "static"
if (staticModifier) {
sb.append('static ');
}
// append return type
{
DartType type = _inferUndefinedExpressionType(invocation);
_appendType(sb, type, groupId: 'RETURN_TYPE');
}
// append name
{
sb.startPosition('NAME');
sb.append(name);
sb.endPosition();
}
_addFix_undefinedMethod_create_parameters(sb, invocation.argumentList);
sb.append(') {$eol$prefix}');
sb.append(sourceSuffix);
}
// insert source
_insertBuilder(sb, targetElement);
// add linked positions
if (targetFile == file) {
_addLinkedPosition('NAME', sb, rf.rangeNode(node));
}
// add proposal
_addFix(FixKind.CREATE_METHOD, [name]);
}
}
void _addFix_undefinedMethod_create_parameters(
SourceBuilder sb, ArgumentList argumentList) {
// append parameters
sb.append('(');
Set<String> excluded = new Set();
List<Expression> arguments = argumentList.arguments;
for (int i = 0; i < arguments.length; i++) {
Expression argument = arguments[i];
// append separator
if (i != 0) {
sb.append(', ');
}
// append type name
DartType type = argument.bestType;
String typeSource = utils.getTypeSource(type, librariesToImport);
if (typeSource != 'dynamic') {
sb.startPosition('TYPE$i');
sb.append(typeSource);
_addSuperTypeProposals(sb, new Set(), type);
sb.endPosition();
sb.append(' ');
}
// append parameter name
{
List<String> suggestions =
_getArgumentNameSuggestions(excluded, type, argument, i);
String favorite = suggestions[0];
excluded.add(favorite);
sb.startPosition('ARG$i');
sb.append(favorite);
sb.addSuggestions(LinkedEditSuggestionKind.PARAMETER, suggestions);
sb.endPosition();
}
}
}
void _addFix_undefinedMethod_useSimilar() {
if (node is SimpleIdentifier && node.parent is MethodInvocation) {
MethodInvocation invocation = node.parent as MethodInvocation;
String name = (node as SimpleIdentifier).name;
_ClosestElementFinder finder = new _ClosestElementFinder(name,
(Element element) => element is MethodElement && !element.isOperator,
MAX_LEVENSHTEIN_DISTANCE);
// unqualified invocation
Expression target = invocation.realTarget;
if (target == null) {
ClassDeclaration clazz =
invocation.getAncestor((node) => node is ClassDeclaration);
if (clazz != null) {
ClassElement classElement = clazz.element;
_updateFinderWithClassMembers(finder, classElement);
}
} else {
DartType type = target.bestType;
if (type is InterfaceType) {
ClassElement classElement = type.element;
_updateFinderWithClassMembers(finder, classElement);
}
}
// if we have close enough element, suggest to use it
if (finder._element != null) {
String closestName = finder._element.name;
_addReplaceEdit(rf.rangeNode(node), closestName);
_addFix(FixKind.CHANGE_TO, [closestName]);
}
}
}
void _addFix_useEffectiveIntegerDivision() {
for (AstNode n = node; n != null; n = n.parent) {
if (n is MethodInvocation &&
n.offset == errorOffset &&
n.length == errorLength) {
MethodInvocation invocation = n as MethodInvocation;
Expression target = invocation.target;
while (target is ParenthesizedExpression) {
target = (target as ParenthesizedExpression).expression;
}
// replace "/" with "~/"
BinaryExpression binary = target as BinaryExpression;
_addReplaceEdit(rf.rangeToken(binary.operator), '~/');
// remove everything before and after
_addRemoveEdit(rf.rangeStartStart(invocation, binary.leftOperand));
_addRemoveEdit(rf.rangeEndEnd(binary.rightOperand, invocation));
// add proposal
_addFix(FixKind.USE_EFFECTIVE_INTEGER_DIVISION, []);
// done
break;
}
}
}
/**
* Adds a fix that replaces [target] with a reference to the class declaring
* the given [element].
*/
void _addFix_useStaticAccess(AstNode target, Element element) {
Element declaringElement = element.enclosingElement;
if (declaringElement is ClassElement) {
DartType declaringType = declaringElement.type;
String declaringTypeCode =
utils.getTypeSource(declaringType, librariesToImport);
// replace "target" with class name
SourceRange range = rf.rangeNode(target);
_addReplaceEdit(range, declaringTypeCode);
// add proposal
_addFix(FixKind.CHANGE_TO_STATIC_ACCESS, [declaringType]);
}
}
void _addFix_useStaticAccess_method() {
if (node is SimpleIdentifier && node.parent is MethodInvocation) {
MethodInvocation invocation = node.parent as MethodInvocation;
if (invocation.methodName == node) {
Expression target = invocation.target;
Element invokedElement = invocation.methodName.bestElement;
_addFix_useStaticAccess(target, invokedElement);
}
}
}
void _addFix_useStaticAccess_property() {
if (node is SimpleIdentifier && node.parent is PrefixedIdentifier) {
PrefixedIdentifier prefixed = node.parent as PrefixedIdentifier;
if (prefixed.identifier == node) {
Expression target = prefixed.prefix;
Element invokedElement = prefixed.identifier.bestElement;
_addFix_useStaticAccess(target, invokedElement);
}
}
}
/**
* Adds a new [SourceEdit] to [change].
*/
void _addInsertEdit(int offset, String text, [Element target]) {
SourceEdit edit = new SourceEdit(offset, 0, text);
_addEdit(target, edit);
}
/**
* Adds a single linked position to [groupId].
*/
void _addLinkedPosition(String groupId, SourceBuilder sb, SourceRange range) {
// prepare offset
int offset = range.offset;
if (sb.offset < offset) {
int delta = sb.length;
offset += delta;
}
// prepare group
LinkedEditGroup group = _getLinkedPosition(groupId);
// add position
Position position = new Position(file, offset);
group.addPosition(position, range.length);
}
/**
* Prepares proposal for creating function corresponding to the given
* [FunctionType].
*/
void _addProposal_createFunction(FunctionType functionType, String name,
Source targetSource, int insertOffset, bool isStatic, String prefix,
String sourcePrefix, String sourceSuffix, Element target) {
// build method source
String targetFile = targetSource.fullName;
SourceBuilder sb = new SourceBuilder(targetFile, insertOffset);
{
sb.append(sourcePrefix);
sb.append(prefix);
// may be static
if (isStatic) {
sb.append('static ');
}
// append return type
_appendType(sb, functionType.returnType, groupId: 'RETURN_TYPE');
// append name
{
sb.startPosition('NAME');
sb.append(name);
sb.endPosition();
}
// append parameters
sb.append('(');
List<ParameterElement> parameters = functionType.parameters;
for (int i = 0; i < parameters.length; i++) {
ParameterElement parameter = parameters[i];
// append separator
if (i != 0) {
sb.append(', ');
}
// append type name
DartType type = parameter.type;
if (!type.isDynamic) {
String typeSource = utils.getTypeSource(type, librariesToImport);
{
sb.startPosition('TYPE$i');
sb.append(typeSource);
_addSuperTypeProposals(sb, new Set(), type);
sb.endPosition();
}
sb.append(' ');
}
// append parameter name
{
sb.startPosition('ARG$i');
sb.append(parameter.displayName);
sb.endPosition();
}
}
sb.append(')');
// close method
sb.append(' {$eol$prefix}');
sb.append(sourceSuffix);
}
// insert source
_insertBuilder(sb, target);
// add linked positions
if (targetSource == unitSource) {
_addLinkedPosition('NAME', sb, rf.rangeNode(node));
}
}
/**
* Adds proposal for creating method corresponding to the given [FunctionType] in the given
* [ClassElement].
*/
void _addProposal_createFunction_function(FunctionType functionType) {
String name = (node as SimpleIdentifier).name;
// prepare environment
int insertOffset = unit.end;
// prepare prefix
String prefix = '';
String sourcePrefix = '$eol';
String sourceSuffix = eol;
_addProposal_createFunction(functionType, name, unitSource, insertOffset,
false, prefix, sourcePrefix, sourceSuffix, unitElement);
// add proposal
_addFix(FixKind.CREATE_FUNCTION, [name]);
}
/**
* Adds proposal for creating method corresponding to the given [FunctionType] in the given
* [ClassElement].
*/
void _addProposal_createFunction_method(
ClassElement targetClassElement, FunctionType functionType) {
String name = (node as SimpleIdentifier).name;
// prepare environment
Source targetSource = targetClassElement.source;
// prepare insert offset
ClassDeclaration targetClassNode = targetClassElement.node;
int insertOffset = targetClassNode.end - 1;
// prepare prefix
String prefix = ' ';
String sourcePrefix;
if (targetClassNode.members.isEmpty) {
sourcePrefix = '';
} else {
sourcePrefix = eol;
}
String sourceSuffix = eol;
_addProposal_createFunction(functionType, name, targetSource, insertOffset,
_inStaticContext(), prefix, sourcePrefix, sourceSuffix,
targetClassElement);
// add proposal
_addFix(FixKind.CREATE_METHOD, [name]);
}
/**
* Adds a new [Edit] to [edits].
*/
void _addRemoveEdit(SourceRange range) {
_addReplaceEdit(range, '');
}
/**
* Adds a new [SourceEdit] to [change].
*/
void _addReplaceEdit(SourceRange range, String text, [Element target]) {
SourceEdit edit = new SourceEdit(range.offset, range.length, text);
_addEdit(target, edit);
}
void _appendParameters(SourceBuilder sb, List<ParameterElement> parameters) {
sb.append('(');
bool firstParameter = true;
bool sawNamed = false;
bool sawPositional = false;
for (ParameterElement parameter in parameters) {
if (!firstParameter) {
sb.append(', ');
} else {
firstParameter = false;
}
// may be optional
ParameterKind parameterKind = parameter.parameterKind;
if (parameterKind == ParameterKind.NAMED) {
if (!sawNamed) {
sb.append('{');
sawNamed = true;
}
}
if (parameterKind == ParameterKind.POSITIONAL) {
if (!sawPositional) {
sb.append('[');
sawPositional = true;
}
}
// parameter
_appendParameterSource(sb, parameter.type, parameter.name);
// default value
String defaultCode = parameter.defaultValueCode;
if (defaultCode != null) {
if (sawPositional) {
sb.append(' = ');
} else {
sb.append(': ');
}
sb.append(defaultCode);
}
}
// close parameters
if (sawNamed) {
sb.append('}');
}
if (sawPositional) {
sb.append(']');
}
sb.append(')');
}
void _appendParameterSource(SourceBuilder sb, DartType type, String name) {
String parameterSource =
utils.getParameterSource(type, name, librariesToImport);
sb.append(parameterSource);
}
void _appendType(SourceBuilder sb, DartType type,
{String groupId, bool orVar: false}) {
if (type != null && !type.isDynamic) {
String typeSource = utils.getTypeSource(type, librariesToImport);
if (groupId != null) {
sb.startPosition(groupId);
sb.append(typeSource);
sb.endPosition();
} else {
sb.append(typeSource);
}
sb.append(' ');
} else if (orVar) {
sb.append('var ');
}
}
/**
* @return the string to display as the name of the given constructor in a proposal name.
*/
String _getConstructorProposalName(ConstructorElement constructor) {
SourceBuilder proposalNameBuffer = new SourceBuilder.buffer();
proposalNameBuffer.append('super');
// may be named
String constructorName = constructor.displayName;
if (!constructorName.isEmpty) {
proposalNameBuffer.append('.');
proposalNameBuffer.append(constructorName);
}
// parameters
_appendParameters(proposalNameBuffer, constructor.parameters);
// done
return proposalNameBuffer.toString();
}
/**
* Returns the [Type] with given name from the `dart:core` library.
*/
DartType _getCoreType(String name) {
List<LibraryElement> libraries = unitLibraryElement.importedLibraries;
for (LibraryElement library in libraries) {
if (library.isDartCore) {
ClassElement classElement = library.getType(name);
if (classElement != null) {
return classElement.type;
}
return null;
}
}
return null;
}
/**
* Returns an existing or just added [LinkedEditGroup] with [groupId].
*/
LinkedEditGroup _getLinkedPosition(String groupId) {
LinkedEditGroup group = linkedPositionGroups[groupId];
if (group == null) {
group = new LinkedEditGroup.empty();
linkedPositionGroups[groupId] = group;
}
return group;
}
/**
* Returns an expected [DartType] of [expression], may be `null` if cannot be
* inferred.
*/
DartType _inferUndefinedExpressionType(Expression expression) {
AstNode parent = expression.parent;
// myFunction();
if (parent is ExpressionStatement) {
if (expression is MethodInvocation) {
return VoidTypeImpl.instance;
}
}
// return myFunction();
if (parent is ReturnStatement) {
ExecutableElement executable = getEnclosingExecutableElement(expression);
return executable != null ? executable.returnType : null;
}
// int v = myFunction();
if (parent is VariableDeclaration) {
VariableDeclaration variableDeclaration = parent;
if (variableDeclaration.initializer == expression) {
VariableElement variableElement = variableDeclaration.element;
if (variableElement != null) {
return variableElement.type;
}
}
}
// myField = 42;
if (parent is AssignmentExpression) {
AssignmentExpression assignment = parent;
if (assignment.leftHandSide == expression) {
Expression rhs = assignment.rightHandSide;
if (rhs != null) {
return rhs.bestType;
}
}
}
// v = myFunction();
if (parent is AssignmentExpression) {
AssignmentExpression assignment = parent;
if (assignment.rightHandSide == expression) {
if (assignment.operator.type == TokenType.EQ) {
// v = myFunction();
Expression lhs = assignment.leftHandSide;
if (lhs != null) {
return lhs.bestType;
}
} else {
// v += myFunction();
MethodElement method = assignment.bestElement;
if (method != null) {
List<ParameterElement> parameters = method.parameters;
if (parameters.length == 1) {
return parameters[0].type;
}
}
}
}
}
// v + myFunction();
if (parent is BinaryExpression) {
BinaryExpression binary = parent;
MethodElement method = binary.bestElement;
if (method != null) {
if (binary.rightOperand == expression) {
List<ParameterElement> parameters = method.parameters;
return parameters.length == 1 ? parameters[0].type : null;
}
}
}
// foo( myFunction() );
if (parent is ArgumentList) {
ParameterElement parameter = expression.bestParameterElement;
return parameter != null ? parameter.type : null;
}
// bool
{
// assert( myFunction() );
if (parent is AssertStatement) {
AssertStatement statement = parent;
if (statement.condition == expression) {
return coreTypeBool;
}
}
// if ( myFunction() ) {}
if (parent is IfStatement) {
IfStatement statement = parent;
if (statement.condition == expression) {
return coreTypeBool;
}
}
// while ( myFunction() ) {}
if (parent is WhileStatement) {
WhileStatement statement = parent;
if (statement.condition == expression) {
return coreTypeBool;
}
}
// do {} while ( myFunction() );
if (parent is DoStatement) {
DoStatement statement = parent;
if (statement.condition == expression) {
return coreTypeBool;
}
}
// !myFunction()
if (parent is PrefixExpression) {
PrefixExpression prefixExpression = parent;
if (prefixExpression.operator.type == TokenType.BANG) {
return coreTypeBool;
}
}
// binary expression '&&' or '||'
if (parent is BinaryExpression) {
BinaryExpression binaryExpression = parent;
TokenType operatorType = binaryExpression.operator.type;
if (operatorType == TokenType.AMPERSAND_AMPERSAND ||
operatorType == TokenType.BAR_BAR) {
return coreTypeBool;
}
}
}
// we don't know
return null;
}
/**
* Inserts the given [SourceBuilder] at its offset.
*/
void _insertBuilder(SourceBuilder builder, Element target) {
String text = builder.toString();
_addInsertEdit(builder.offset, text, target);
// add linked positions
builder.linkedPositionGroups.forEach((String id, LinkedEditGroup group) {
LinkedEditGroup fixGroup = _getLinkedPosition(id);
group.positions.forEach((Position position) {
fixGroup.addPosition(position, group.length);
});
group.suggestions.forEach((LinkedEditSuggestion suggestion) {
fixGroup.addSuggestion(suggestion);
});
});
}
/**
* Returns `true` if [node] is in static context.
*/
bool _inStaticContext() {
// constructor initializer cannot reference "this"
if (node.getAncestor((node) => node is ConstructorInitializer) != null) {
return true;
}
// field initializer cannot reference "this"
if (node.getAncestor((node) => node is FieldDeclaration) != null) {
return true;
}
// static method
MethodDeclaration method = node.getAncestor((node) {
return node is MethodDeclaration;
});
return method != null && method.isStatic;
}
bool _isAwaitNode() {
AstNode node = this.node;
return node is SimpleIdentifier && node.name == 'await';
}
_ConstructorLocation _prepareNewConstructorLocation(
ClassDeclaration classDeclaration) {
List<ClassMember> members = classDeclaration.members;
// find the last field/constructor
ClassMember lastFieldOrConstructor = null;
for (ClassMember member in members) {
if (member is FieldDeclaration || member is ConstructorDeclaration) {
lastFieldOrConstructor = member;
} else {
break;
}
}
// after the last field/constructor
if (lastFieldOrConstructor != null) {
return new _ConstructorLocation(
eol + eol, lastFieldOrConstructor.end, '');
}
// at the beginning of the class
String suffix = members.isEmpty ? '' : eol;
return new _ConstructorLocation(
eol, classDeclaration.leftBracket.end, suffix);
}
_FieldLocation _prepareNewFieldLocation(ClassDeclaration classDeclaration) {
String indent = utils.getIndent(1);
// find the last field
ClassMember lastFieldOrConstructor = null;
List<ClassMember> members = classDeclaration.members;
for (ClassMember member in members) {
if (member is FieldDeclaration) {
lastFieldOrConstructor = member;
} else {
break;
}
}
// after the last field
if (lastFieldOrConstructor != null) {
return new _FieldLocation(
eol + eol + indent, lastFieldOrConstructor.end, '');
}
// at the beginning of the class
String suffix = members.isEmpty ? '' : eol;
return new _FieldLocation(
eol + indent, classDeclaration.leftBracket.end, suffix);
}
_FieldLocation _prepareNewGetterLocation(ClassDeclaration classDeclaration) {
String indent = utils.getIndent(1);
// find an existing target member
ClassMember prevMember = null;
List<ClassMember> members = classDeclaration.members;
for (ClassMember member in members) {
if (member is FieldDeclaration ||
member is ConstructorDeclaration ||
member is MethodDeclaration && member.isGetter) {
prevMember = member;
} else {
break;
}
}
// after the last field/getter
if (prevMember != null) {
return new _FieldLocation(eol + eol + indent, prevMember.end, '');
}
// at the beginning of the class
String suffix = members.isEmpty ? '' : eol;
return new _FieldLocation(
eol + indent, classDeclaration.leftBracket.end, suffix);
}
/**
* Removes any [ParenthesizedExpression] enclosing [expr].
*
* [exprPrecedence] - the effective precedence of [expr].
*/
void _removeEnclosingParentheses(Expression expr, int exprPrecedence) {
while (expr.parent is ParenthesizedExpression) {
ParenthesizedExpression parenthesized =
expr.parent as ParenthesizedExpression;
if (getExpressionParentPrecedence(parenthesized) > exprPrecedence) {
break;
}
_addRemoveEdit(rf.rangeToken(parenthesized.leftParenthesis));
_addRemoveEdit(rf.rangeToken(parenthesized.rightParenthesis));
expr = parenthesized;
}
}
void _updateFinderWithClassMembers(
_ClosestElementFinder finder, ClassElement clazz) {
if (clazz != null) {
List<Element> members = getMembers(clazz);
finder._updateList(members);
}
}
static void _addSuperTypeProposals(
SourceBuilder sb, Set<DartType> alreadyAdded, DartType type) {
if (type != null &&
!alreadyAdded.contains(type) &&
type.element is ClassElement) {
alreadyAdded.add(type);
ClassElement element = type.element as ClassElement;
sb.addSuggestion(LinkedEditSuggestionKind.TYPE, element.name);
_addSuperTypeProposals(sb, alreadyAdded, element.supertype);
for (InterfaceType interfaceType in element.interfaces) {
_addSuperTypeProposals(sb, alreadyAdded, interfaceType);
}
}
}
/**
* @return the suggestions for given [Type] and [DartExpression], not empty.
*/
static List<String> _getArgumentNameSuggestions(
Set<String> excluded, DartType type, Expression expression, int index) {
List<String> suggestions =
getVariableNameSuggestionsForExpression(type, expression, excluded);
if (suggestions.length != 0) {
return suggestions;
}
return <String>['arg$index'];
}
/**
* Returns `true` if [node] is a type name.
*/
static bool _mayBeTypeIdentifier(AstNode node) {
if (node is SimpleIdentifier) {
AstNode parent = node.parent;
if (parent is Annotation) {
return true;
}
if (parent is TypeName) {
return true;
}
if (parent is MethodInvocation) {
return parent.realTarget == node;
}
if (parent is PrefixedIdentifier) {
return parent.prefix == node;
}
}
return false;
}
}
/**
* Helper for finding [Element] with name closest to the given.
*/
class _ClosestElementFinder {
final String _targetName;
final Predicate<Element> _predicate;
Element _element = null;
int _distance;
_ClosestElementFinder(this._targetName, this._predicate, this._distance);
void _update(Element element) {
if (_predicate(element)) {
int memberDistance = levenshtein(element.name, _targetName, _distance);
if (memberDistance < _distance) {
_element = element;
_distance = memberDistance;
}
}
}
void _updateList(Iterable<Element> elements) {
for (Element element in elements) {
_update(element);
}
}
}
/**
* Describes the location for a newly created [ConstructorDeclaration].
*/
class _ConstructorLocation {
final String prefix;
final int offset;
final String suffix;
_ConstructorLocation(this.prefix, this.offset, this.suffix);
}
/**
* Describes the location for a newly created [FieldDeclaration].
*/
class _FieldLocation {
final String prefix;
final int offset;
final String suffix;
_FieldLocation(this.prefix, this.offset, this.suffix);
}