blob: 61dd33821002efe02195d26632743845d3c6f48f [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.
import 'dart:async';
import 'package:analysis_server/src/protocol_server.dart' hide Element;
import 'package:analysis_server/src/services/correction/status.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/search/hierarchy.dart';
import 'package:analysis_server/src/services/search/search_engine.dart';
import 'package:analyzer/dart/ast/ast.dart';
import 'package:analyzer/dart/ast/token.dart';
import 'package:analyzer/dart/element/element.dart';
import 'package:analyzer/src/dart/element/ast_provider.dart';
import 'package:analyzer/src/generated/source.dart';
import 'package:analyzer_plugin/utilities/range_factory.dart';
/**
* [ConvertMethodToGetterRefactoring] implementation.
*/
class ConvertGetterToMethodRefactoringImpl extends RefactoringImpl
implements ConvertGetterToMethodRefactoring {
final SearchEngine searchEngine;
final AstProvider astProvider;
final PropertyAccessorElement element;
SourceChange change;
ConvertGetterToMethodRefactoringImpl(
this.searchEngine, this.astProvider, this.element);
@override
String get refactoringName => 'Convert Getter To Method';
@override
Future<RefactoringStatus> checkFinalConditions() {
RefactoringStatus result = new RefactoringStatus();
return new Future.value(result);
}
@override
Future<RefactoringStatus> checkInitialConditions() {
RefactoringStatus result = _checkInitialConditions();
return new Future.value(result);
}
@override
Future<SourceChange> createChange() async {
// TODO(brianwilkerson) Determine whether this await is necessary.
await null;
change = new SourceChange(refactoringName);
// function
if (element.enclosingElement is CompilationUnitElement) {
await _updateElementDeclaration(element);
await _updateElementReferences(element);
}
// method
if (element.enclosingElement is ClassElement) {
FieldElement field = element.variable;
Set<ClassMemberElement> elements =
await getHierarchyMembers(searchEngine, field);
await Future.forEach(elements, (ClassMemberElement member) async {
// TODO(brianwilkerson) Determine whether this await is necessary.
await null;
if (member is FieldElement) {
PropertyAccessorElement getter = member.getter;
if (!getter.isSynthetic) {
await _updateElementDeclaration(getter);
return _updateElementReferences(getter);
}
}
});
}
// done
return change;
}
RefactoringStatus _checkInitialConditions() {
if (!element.isGetter || element.isSynthetic) {
return new RefactoringStatus.fatal(
'Only explicit getters can be converted to methods.');
}
return new RefactoringStatus();
}
Future<void> _updateElementDeclaration(
PropertyAccessorElement element) async {
// TODO(brianwilkerson) Determine whether this await is necessary.
await null;
// prepare "get" keyword
Token getKeyword = null;
{
AstNode name = await astProvider.getParsedNameForElement(element);
AstNode declaration = name?.parent;
if (declaration is MethodDeclaration) {
getKeyword = declaration.propertyKeyword;
} else if (declaration is FunctionDeclaration) {
getKeyword = declaration.propertyKeyword;
} else {
return;
}
}
// remove "get "
if (getKeyword != null) {
SourceRange getRange =
range.startOffsetEndOffset(getKeyword.offset, element.nameOffset);
SourceEdit edit = newSourceEdit_range(getRange, '');
doSourceChange_addElementEdit(change, element, edit);
}
// add parameters "()"
{
SourceEdit edit = new SourceEdit(range.elementName(element).end, 0, '()');
doSourceChange_addElementEdit(change, element, edit);
}
}
Future _updateElementReferences(Element element) async {
// TODO(brianwilkerson) Determine whether this await is necessary.
await null;
List<SearchMatch> matches = await searchEngine.searchReferences(element);
List<SourceReference> references = getSourceReferences(matches);
for (SourceReference reference in references) {
Element refElement = reference.element;
SourceRange refRange = reference.range;
// insert "()"
var edit = new SourceEdit(refRange.end, 0, "()");
doSourceChange_addElementEdit(change, refElement, edit);
}
}
}