languages/dart-sdk
languages/dart-sdk
1
0
Fork 0
mirror of https://github.com/dart-lang/sdk synced 2024-10-14 19:10:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add support for selection ranges to ChangeBuilder

Browse source 
Change-Id: Icd4c1bcf2ecb66020a9a7f478a037c478e8a109f
Reviewed-on: https://dart-review.googlesource.com/42024
Reviewed-by: Konstantin Shcheglov <scheglov@google.com>
Reviewed-by: Phil Quitslund <pquitslund@google.com>
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com>
This commit is contained in:
Brian Wilkerson 2018-02-16 19:23:06 +00:00 committed by commit-bot@chromium.org
parent b17ac68b60
commit 3d183f6999
4 changed files with 233 additions and 164 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
pkg/analyzer_plugin/lib/src/utilities/change_builder/change_builder_core.dart
View file

@ -31,6 +31,12 @@ class ChangeBuilderImpl implements ChangeBuilder {
final Map<String, LinkedEditGroup> _linkedEditGroups =
<String, LinkedEditGroup>{};
/**
* The range of the selection for the change being built, or `null` if there
* is no selection.
*/
SourceRange _selectionRange;
/**
* The set of [Position]s that belong to the current [EditBuilderImpl] and
* should not be updated in result of inserting this builder.
@ -42,6 +48,9 @@ class ChangeBuilderImpl implements ChangeBuilder {
*/
ChangeBuilderImpl();
@override
SourceRange get selectionRange => _selectionRange;
@override
SourceChange get sourceChange {
_linkedEditGroups.forEach((String name, LinkedEditGroup group) {
@ -86,6 +95,10 @@ class ChangeBuilderImpl implements ChangeBuilder {
_change.selection = position;
}
void _setSelectionRange(SourceRange range) {
_selectionRange = range;
}
/**
* Update the offsets of any positions that occur at or after the given
* [offset] such that the positions are offset by the given [delta]. Positions
@ -131,10 +144,10 @@ class EditBuilderImpl implements EditBuilder {
final int length;
/**
* The offset of the selection for the change being built, or `-1` if the
* The range of the selection for the change being built, or `null` if the
* selection is not inside the change being built.
*/
int _selectionOffset = -1;
SourceRange _selectionRange;
/**
* The end-of-line marker used in the file being edited, or `null` if the
@ -202,9 +215,17 @@ class EditBuilderImpl implements EditBuilder {
return new LinkedEditBuilderImpl(this);
}
@override
void selectAll(void writer()) {
int rangeOffset = _buffer.length;
writer();
int rangeLength = _buffer.length - rangeOffset;
_selectionRange = new SourceRange(offset + rangeOffset, rangeLength);
}
@override
void selectHere() {
_selectionOffset = offset + _buffer.length;
_selectionRange = new SourceRange(offset + _buffer.length, 0);
}
@override
@ -331,11 +352,12 @@ class FileEditBuilderImpl implements FileEditBuilder {
* Capture the selection offset if one was set.
*/
void _captureSelection(EditBuilderImpl builder, SourceEdit edit) {
int offset = builder._selectionOffset;
if (offset >= 0) {
SourceRange range = builder._selectionRange;
if (range != null) {
Position position =
new Position(fileEdit.file, offset + _deltaToEdit(edit));
new Position(fileEdit.file, range.offset + _deltaToEdit(edit));
changeBuilder.setSelection(position);
changeBuilder._setSelectionRange(range);
}
}

77
pkg/analyzer_plugin/lib/src/utilities/change_builder/change_builder_dart.dart
View file

@ -321,7 +321,7 @@ class DartEditBuilderImpl extends EditBuilderImpl implements DartEditBuilder {
String prefix2 = getIndent(2);
ElementKind elementKind = member.kind;
// TODO(brianwilkerson) Look for a non-abstract inherited member farther up
// in the superclass chain.
// in the superclass chain that we could invoke.
bool isAbstract = member.isAbstract;
bool isGetter = elementKind == ElementKind.GETTER;
bool isSetter = elementKind == ElementKind.SETTER;
@ -359,13 +359,21 @@ class DartEditBuilderImpl extends EditBuilderImpl implements DartEditBuilder {
// name
write(memberName, displayTextBuffer: displayTextBuffer);
// parameters + body
if (isGetter) {
if (isAbstract) {
writeln(' => null;');
write(' => ');
selectAll(() {
write('null');
});
writeln(';');
} else {
write(' => super.');
write(memberName);
write(' => ');
selectAll(() {
write('super.');
write(memberName);
});
writeln(';');
}
displayTextBuffer?.write(' => …');
@ -384,42 +392,53 @@ class DartEditBuilderImpl extends EditBuilderImpl implements DartEditBuilder {
if (returnType.isVoid) {
if (!isAbstract) {
write(prefix2);
write('super.');
write(memberName);
write('(');
for (int i = 0; i < parameters.length; i++) {
if (i > 0) {
write(', ');
selectAll(() {
write('super.');
write(memberName);
write('(');
for (int i = 0; i < parameters.length; i++) {
if (i > 0) {
write(', ');
}
write(parameters[i].name);
}
write(parameters[i].name);
}
writeln(');');
write(');');
});
writeln();
}
} else if (isSetter) {
if (!isAbstract) {
write(prefix2);
write('super.');
write(memberName);
write(' = ');
write(parameters[0].name);
writeln(';');
selectAll(() {
write('super.');
write(memberName);
write(' = ');
write(parameters[0].name);
write(';');
});
writeln();
}
} else {
write(prefix2);
if (isAbstract) {
writeln('return null;');
selectAll(() {
write('return null;');
});
} else {
write(prefix2);
write('return super.');
write(memberName);
write('(');
for (int i = 0; i < parameters.length; i++) {
if (i > 0) {
write(', ');
selectAll(() {
write('return super.');
write(memberName);
write('(');
for (int i = 0; i < parameters.length; i++) {
if (i > 0) {
write(', ');
}
write(parameters[i].name);
}
write(parameters[i].name);
}
writeln(');');
write(');');
});
}
writeln();
}
// close method
write(prefix);

13
pkg/analyzer_plugin/lib/utilities/change_builder/change_builder_core.dart
View file

@ -19,6 +19,12 @@ abstract class ChangeBuilder {
*/
factory ChangeBuilder() = ChangeBuilderImpl;
/**
* Return the range of the selection for the change being built, or `null` if
* there is no selection.
*/
SourceRange get selectionRange;
/**
* Return the source change that was built. The source change will not be
* complete until all of the futures returned by [addFileEdit] have completed.
@ -66,7 +72,12 @@ abstract class EditBuilder {
{LinkedEditSuggestionKind kind, List<String> suggestions});
/**
* Set the selection to the given location within the edit being built.
* Set the selection to cover all of the code written by the given [writer].
*/
void selectAll(void writer());
/**
* Set the selection to the current location within the edit being built.
*/
void selectHere();

273
pkg/analyzer_plugin/test/src/utilities/change_builder/change_builder_dart_test.dart
View file

@ -895,10 +895,10 @@ abstract class A {
class B extends A {
}
''', '''
@override
// TODO: implement zero
int get zero => null;
''', displayText: 'zero => …');
@override
// TODO: implement zero
int get zero => null;
''', displayText: 'zero => …', selection: new SourceRange(113, 4));
}
test_writeOverrideOfInheritedMember_getter_concrete() async {
@ -909,10 +909,10 @@ class A {
class B extends A {
}
''', '''
@override
// TODO: implement zero
int get zero => super.zero;
''', displayText: 'zero => …');
@override
// TODO: implement zero
int get zero => super.zero;
''', displayText: 'zero => …', selection: new SourceRange(109, 10));
}
test_writeOverrideOfInheritedMember_method_abstract() async {
@ -923,12 +923,12 @@ abstract class A {
class B extends A {
}
''', '''
@override
A add(A a) {
// TODO: implement add
return null;
}
''', displayText: 'add(A a) { … }');
@override
A add(A a) {
// TODO: implement add
return null;
}
''', displayText: 'add(A a) { … }', selection: new SourceRange(113, 12));
}
test_writeOverrideOfInheritedMember_method_concrete() async {
@ -939,12 +939,12 @@ class A {
class B extends A {
}
''', '''
@override
A add(A a) {
// TODO: implement add
return super.add(a);
}
''', displayText: 'add(A a) { … }');
@override
A add(A a) {
// TODO: implement add
return super.add(a);
}
''', displayText: 'add(A a) { … }', selection: new SourceRange(112, 20));
}
test_writeOverrideOfInheritedMember_method_functionTypeAlias_abstract() async {
@ -956,11 +956,11 @@ abstract class A {
class B extends A {
}
''', '''
@override
void perform(F f) {
// TODO: implement perform
}
''', displayText: 'perform(F f) { … }');
@override
void perform(F f) {
// TODO: implement perform
}
''', displayText: 'perform(F f) { … }', selection: null);
}
test_writeOverrideOfInheritedMember_method_functionTypeAlias_concrete() async {
@ -972,12 +972,12 @@ class A {
class B extends A {
}
''', '''
@override
void perform(F f) {
// TODO: implement perform
super.perform(f);
}
''', displayText: 'perform(F f) { … }');
@override
void perform(F f) {
// TODO: implement perform
super.perform(f);
}
''', displayText: 'perform(F f) { … }', selection: new SourceRange(160, 17));
}
test_writeOverrideOfInheritedMember_method_functionTypedParameter_abstract() async {
@ -985,16 +985,17 @@ void perform(F f) {
abstract class A {
forEach(int f(double p1, String p2));
}
class B extends A {
}
''', '''
@override
forEach(int Function(double p1, String p2) f) {
// TODO: implement forEach
return null;
}
''', displayText: 'forEach(int Function(double p1, String p2) f) { … }');
@override
forEach(int Function(double p1, String p2) f) {
// TODO: implement forEach
return null;
}
''',
displayText: 'forEach(int Function(double p1, String p2) f) { … }',
selection: new SourceRange(178, 12));
}
test_writeOverrideOfInheritedMember_method_functionTypedParameter_concrete() async {
@ -1002,16 +1003,17 @@ forEach(int Function(double p1, String p2) f) {
class A {
forEach(int f(double p1, String p2)) {}
}
class B extends A {
}
''', '''
@override
forEach(int Function(double p1, String p2) f) {
// TODO: implement forEach
return super.forEach(f);
}
''', displayText: 'forEach(int Function(double p1, String p2) f) { … }');
@override
forEach(int Function(double p1, String p2) f) {
// TODO: implement forEach
return super.forEach(f);
}
''',
displayText: 'forEach(int Function(double p1, String p2) f) { … }',
selection: new SourceRange(171, 24));
}
test_writeOverrideOfInheritedMember_method_generic_noBounds_abstract() async {
@ -1022,12 +1024,12 @@ abstract class A {
class B implements A {
}
''', '''
@override
List<T> get<T>(T key) {
// TODO: implement get
return null;
}
''', displayText: 'get<T>(T key) { … }');
@override
List<T> get<T>(T key) {
// TODO: implement get
return null;
}
''', displayText: 'get<T>(T key) { … }', selection: new SourceRange(138, 12));
}
test_writeOverrideOfInheritedMember_method_generic_noBounds_concrete() async {
@ -1038,12 +1040,12 @@ class A {
class B implements A {
}
''', '''
@override
List<T> get<T>(T key) {
// TODO: implement get
return super.get(key);
}
''', displayText: 'get<T>(T key) { … }');
@override
List<T> get<T>(T key) {
// TODO: implement get
return super.get(key);
}
''', displayText: 'get<T>(T key) { … }', selection: new SourceRange(131, 22));
}
test_writeOverrideOfInheritedMember_method_generic_withBounds_abstract() async {
@ -1054,12 +1056,14 @@ abstract class A<K1, V1> {
class B<K2, V2> implements A<K2, V2> {
}
''', '''
@override
List<T> get<T extends V2>(K2 key) {
// TODO: implement get
return null;
}
''', displayText: 'get<T extends V2>(K2 key) { … }');
@override
List<T> get<T extends V2>(K2 key) {
// TODO: implement get
return null;
}
''',
displayText: 'get<T extends V2>(K2 key) { … }',
selection: new SourceRange(186, 12));
}
test_writeOverrideOfInheritedMember_method_generic_withBounds_concrete() async {
@ -1072,12 +1076,14 @@ class A<K1, V1> {
class B<K2, V2> implements A<K2, V2> {
}
''', '''
@override
List<T> get<T extends V2>(K2 key) {
// TODO: implement get
return super.get(key);
}
''', displayText: 'get<T extends V2>(K2 key) { … }');
@override
List<T> get<T extends V2>(K2 key) {
// TODO: implement get
return super.get(key);
}
''',
displayText: 'get<T extends V2>(K2 key) { … }',
selection: new SourceRange(199, 22));
}
test_writeOverrideOfInheritedMember_method_genericFunctionTypedParameter_abstract() async {
@ -1085,16 +1091,17 @@ List<T> get<T extends V2>(K2 key) {
abstract class A {
int foo(T Function<T>() fn);
}
class B extends A {
}
''', '''
@override
int foo(T Function<T>() fn) {
// TODO: implement foo
return null;
}
''', displayText: 'foo(T Function<T>() fn) { … }');
@override
int foo(T Function<T>() fn) {
// TODO: implement foo
return null;
}
''',
displayText: 'foo(T Function<T>() fn) { … }',
selection: new SourceRange(147, 12));
}
test_writeOverrideOfInheritedMember_method_genericFunctionTypedParameter_concrete() async {
@ -1102,16 +1109,17 @@ int foo(T Function<T>() fn) {
class A {
int foo(T Function<T>() fn) => 0;
}
class B extends A {
}
''', '''
@override
int foo(T Function<T>() fn) {
// TODO: implement foo
return super.foo(fn);
}
''', displayText: 'foo(T Function<T>() fn) { … }');
@override
int foo(T Function<T>() fn) {
// TODO: implement foo
return super.foo(fn);
}
''',
displayText: 'foo(T Function<T>() fn) { … }',
selection: new SourceRange(143, 21));
}
test_writeOverrideOfInheritedMember_method_nullAsTypeArgument_abstract() async {
@ -1119,16 +1127,15 @@ int foo(T Function<T>() fn) {
abstract class A {
List<Null> foo();
}
class B extends A {
}
''', '''
@override
List<Null> foo() {
// TODO: implement foo
return null;
}
''', displayText: 'foo() { … }');
@override
List<Null> foo() {
// TODO: implement foo
return null;
}
''', displayText: 'foo() { … }', selection: new SourceRange(125, 12));
}
test_writeOverrideOfInheritedMember_method_nullAsTypeArgument_concrete() async {
@ -1136,16 +1143,15 @@ List<Null> foo() {
class A {
List<Null> foo() => null
}
class B extends A {
}
''', '''
@override
List<Null> foo() {
// TODO: implement foo
return super.foo();
}
''', displayText: 'foo() { … }');
@override
List<Null> foo() {
// TODO: implement foo
return super.foo();
}
''', displayText: 'foo() { … }', selection: new SourceRange(123, 19));
}
test_writeOverrideOfInheritedMember_method_voidAsTypeArgument_abstract() async {
@ -1153,16 +1159,15 @@ List<Null> foo() {
abstract class A {
List<void> foo();
}
class B extends A {
}
''', '''
@override
List<void> foo() {
// TODO: implement foo
return null;
}
''', displayText: 'foo() { … }');
@override
List<void> foo() {
// TODO: implement foo
return null;
}
''', displayText: 'foo() { … }', selection: new SourceRange(125, 12));
}
test_writeOverrideOfInheritedMember_method_voidAsTypeArgument_concrete() async {
@ -1170,16 +1175,15 @@ List<void> foo() {
class A {
List<void> foo() => null;
}
class B extends A {
}
''', '''
@override
List<void> foo() {
// TODO: implement foo
return super.foo();
}
''', displayText: 'foo() { … }');
@override
List<void> foo() {
// TODO: implement foo
return super.foo();
}
''', displayText: 'foo() { … }', selection: new SourceRange(124, 19));
}
test_writeOverrideOfInheritedMember_setter_abstract() async {
@ -1190,11 +1194,11 @@ abstract class A {
class B extends A {
}
''', '''
@override
set value(int value) {
// TODO: implement value
}
''', displayText: 'value(int value) { … }');
@override
set value(int value) {
// TODO: implement value
}
''', displayText: 'value(int value) { … }', selection: null);
}
test_writeOverrideOfInheritedMember_setter_concrete() async {
@ -1205,12 +1209,14 @@ class A {
class B extends A {
}
''', '''
@override
set value(int value) {
// TODO: implement value
super.value = value;
}
''', displayText: 'value(int value) { … }');
@override
set value(int value) {
// TODO: implement value
super.value = value;
}
''',
displayText: 'value(int value) { … }',
selection: new SourceRange(128, 20));
}
test_writeParameterMatchingArgument() async {
@ -1631,12 +1637,15 @@ f(int i, String s) {
/**
* Assuming that the [content] being edited defines a class named 'A' whose
* first accessor is the member to be overridden and ends with a class to which
* an inherited method is to be added, assert that the text of the overridden
* member matches the [expected] text (modulo white space).
* first accessor is the member to be overridden and ends with a class to
* which an inherited method is to be added, assert that the text of the
* overridden member matches the [expected] text (modulo white space). Assert
* that the generated display text matches the given [displayText]. If a
* [selection] is provided, assert that the generated selection range matches
* it.
*/
_assertWriteOverrideOfInheritedAccessor(String content, String expected,
{String displayText}) async {
{String displayText, SourceRange selection}) async {
String path = provider.convertPath('/test.dart');
addSource(path, content);
ClassElement classA = await _getClassElement(path, 'A');
@ -1655,16 +1664,21 @@ f(int i, String s) {
SourceEdit edit = getEdit(builder);
expect(edit.replacement, equalsIgnoringWhitespace(expected));
expect(displayBuffer?.toString(), displayText);
if (selection != null) {
expect(builder.selectionRange, selection);
}
}
/**
* Assuming that the [content] being edited defines a class named 'A' whose
* first method is the member to be overridden and ends with a class to which
* an inherited method is to be added, assert that the text of the overridden
* member matches the [expected] text (modulo white space).
* member matches the [expected] text (modulo white space). Assert that the
* generated display text matches the given [displayText]. If a [selection] is
* provided, assert that the generated selection range matches it.
*/
_assertWriteOverrideOfInheritedMethod(String content, String expected,
{String displayText}) async {
{String displayText, SourceRange selection}) async {
String path = provider.convertPath('/test.dart');
addSource(path, content);
ClassElement classA = await _getClassElement(path, 'A');
@ -1683,6 +1697,9 @@ f(int i, String s) {
SourceEdit edit = getEdit(builder);
expect(edit.replacement, equalsIgnoringWhitespace(expected));
expect(displayBuffer?.toString(), displayText);
if (selection != null) {
expect(builder.selectionRange, selection);
}
}
Future<ClassElement> _getClassElement(String path, String name) async {