|
| 1 | +// Copyright (c) 2022, the Dart project authors. Please see the AUTHORS file |
| 2 | +// for details. All rights reserved. Use of this source code is governed by a |
| 3 | +// BSD-style license that can be found in the LICENSE file. |
| 4 | + |
| 5 | +import 'package:analysis_server/src/services/correction/dart/abstract_producer.dart'; |
| 6 | +import 'package:analysis_server/src/services/correction/fix.dart'; |
| 7 | +import 'package:analyzer/dart/analysis/features.dart'; |
| 8 | +import 'package:analyzer/dart/ast/ast.dart'; |
| 9 | +import 'package:analyzer/dart/element/element.dart'; |
| 10 | +import 'package:analyzer/source/source_range.dart'; |
| 11 | +import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart'; |
| 12 | +import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dart'; |
| 13 | +import 'package:analyzer_plugin/utilities/fixes/fixes.dart'; |
| 14 | +import 'package:analyzer_plugin/utilities/range_factory.dart'; |
| 15 | +import 'package:collection/collection.dart'; |
| 16 | + |
| 17 | +class AddSuperParameter extends CorrectionProducer { |
| 18 | + int _missingCount = 0; |
| 19 | + |
| 20 | + @override |
| 21 | + List<Object> get fixArguments => [_missingCount == 1 ? '' : 's']; |
| 22 | + |
| 23 | + @override |
| 24 | + FixKind get fixKind => DartFixKind.ADD_SUPER_PARAMETER; |
| 25 | + |
| 26 | + @override |
| 27 | + Future<void> compute(ChangeBuilder builder) async { |
| 28 | + if (!libraryElement.featureSet.isEnabled(Feature.super_parameters)) { |
| 29 | + return; |
| 30 | + } |
| 31 | + var constructorDeclaration = node.parent; |
| 32 | + if (constructorDeclaration is! ConstructorDeclaration) return; |
| 33 | + var classDeclaration = constructorDeclaration.parent; |
| 34 | + if (classDeclaration is! ClassDeclaration) return; |
| 35 | + var superUnnamedConstructor = |
| 36 | + classDeclaration.declaredElement?.supertype?.element.unnamedConstructor; |
| 37 | + if (superUnnamedConstructor == null) return; |
| 38 | + var superParameters = superUnnamedConstructor.parameters; |
| 39 | + var parameters = constructorDeclaration.parameters.parameters; |
| 40 | + var missingNamedParameters = <ParameterElement>[]; |
| 41 | + var superPositionalParameters = <ParameterElement>[]; |
| 42 | + for (var superParameter in superParameters) { |
| 43 | + if (superParameter.isRequired) { |
| 44 | + var name = superParameter.name; |
| 45 | + if (superParameter.isNamed) { |
| 46 | + if (!parameters.any((parameter) => parameter.name?.lexeme == name)) { |
| 47 | + missingNamedParameters.add(superParameter); |
| 48 | + } |
| 49 | + } else { |
| 50 | + superPositionalParameters.add(superParameter); |
| 51 | + } |
| 52 | + } |
| 53 | + } |
| 54 | + |
| 55 | + var arePositionalOrdered = true; |
| 56 | + FormalParameter? lastPositionalParameter; |
| 57 | + for (var i = 0; i < parameters.length; i++) { |
| 58 | + var parameter = parameters[i]; |
| 59 | + if (parameter.isRequiredPositional) { |
| 60 | + if (parameter is! SuperFormalParameter || |
| 61 | + i >= superPositionalParameters.length || |
| 62 | + parameter.name.lexeme != superPositionalParameters[i].name) { |
| 63 | + arePositionalOrdered = false; |
| 64 | + break; |
| 65 | + } |
| 66 | + lastPositionalParameter = parameter; |
| 67 | + } |
| 68 | + } |
| 69 | + |
| 70 | + var missingPositionalParameters = <ParameterElement>[]; |
| 71 | + if (arePositionalOrdered) { |
| 72 | + var index = lastPositionalParameter == null |
| 73 | + ? 0 |
| 74 | + : parameters.indexOf(lastPositionalParameter) + 1; |
| 75 | + missingPositionalParameters = superPositionalParameters.sublist(index); |
| 76 | + } |
| 77 | + |
| 78 | + _missingCount = |
| 79 | + missingPositionalParameters.length + missingNamedParameters.length; |
| 80 | + |
| 81 | + if (parameters.isEmpty) { |
| 82 | + var offset = constructorDeclaration.parameters.leftParenthesis.end; |
| 83 | + await builder.addDartFileEdit(file, (builder) { |
| 84 | + builder.addInsertion(offset, (builder) { |
| 85 | + _writePositional(builder, missingPositionalParameters, |
| 86 | + needsInitialComma: false); |
| 87 | + |
| 88 | + if (missingNamedParameters.isNotEmpty) { |
| 89 | + _writeNamed( |
| 90 | + builder, |
| 91 | + missingNamedParameters, |
| 92 | + needsInitialComma: missingPositionalParameters.isNotEmpty, |
| 93 | + ); |
| 94 | + } |
| 95 | + }); |
| 96 | + }); |
| 97 | + } else { |
| 98 | + var lastNamedParameter = |
| 99 | + parameters.lastWhereOrNull((parameter) => parameter.isNamed); |
| 100 | + if (missingPositionalParameters.isNotEmpty) { |
| 101 | + var offset = lastPositionalParameter == null |
| 102 | + ? constructorDeclaration.parameters.leftParenthesis.end |
| 103 | + : lastPositionalParameter.end; |
| 104 | + |
| 105 | + await builder.addDartFileEdit(file, (builder) { |
| 106 | + builder.addInsertion(offset, (builder) { |
| 107 | + _writePositional(builder, missingPositionalParameters, |
| 108 | + needsInitialComma: lastPositionalParameter != null); |
| 109 | + if (lastPositionalParameter == null && lastNamedParameter != null) { |
| 110 | + builder.write(', '); |
| 111 | + } |
| 112 | + }); |
| 113 | + }); |
| 114 | + } |
| 115 | + |
| 116 | + if (missingNamedParameters.isNotEmpty) { |
| 117 | + SourceRange replacementRange; |
| 118 | + if (lastNamedParameter != null) { |
| 119 | + replacementRange = SourceRange(lastNamedParameter.end, 0); |
| 120 | + } else if (lastPositionalParameter != null) { |
| 121 | + replacementRange = range.endStart(lastPositionalParameter, |
| 122 | + constructorDeclaration.parameters.rightParenthesis); |
| 123 | + } else { |
| 124 | + replacementRange = SourceRange( |
| 125 | + constructorDeclaration.parameters.leftParenthesis.end, 0); |
| 126 | + } |
| 127 | + |
| 128 | + await builder.addDartFileEdit(file, (builder) { |
| 129 | + builder.addReplacement(replacementRange, (builder) { |
| 130 | + _writeNamed( |
| 131 | + builder, |
| 132 | + missingNamedParameters, |
| 133 | + needsInitialComma: true, |
| 134 | + lastNamedParameter: lastNamedParameter, |
| 135 | + ); |
| 136 | + }); |
| 137 | + }); |
| 138 | + } |
| 139 | + } |
| 140 | + } |
| 141 | + |
| 142 | + void _writeNamed( |
| 143 | + DartEditBuilder builder, |
| 144 | + List<ParameterElement> parameters, { |
| 145 | + FormalParameter? lastNamedParameter, |
| 146 | + required bool needsInitialComma, |
| 147 | + }) { |
| 148 | + var firstParameter = true; |
| 149 | + void writeComma() { |
| 150 | + if (firstParameter) { |
| 151 | + firstParameter = false; |
| 152 | + } else { |
| 153 | + builder.write(', '); |
| 154 | + } |
| 155 | + } |
| 156 | + |
| 157 | + if (needsInitialComma) { |
| 158 | + builder.write(', '); |
| 159 | + } |
| 160 | + if (lastNamedParameter == null) { |
| 161 | + builder.write('{'); |
| 162 | + } |
| 163 | + for (var parameter in parameters) { |
| 164 | + writeComma(); |
| 165 | + _writeParameter(builder, parameter); |
| 166 | + } |
| 167 | + if (lastNamedParameter == null) { |
| 168 | + builder.write('}'); |
| 169 | + } |
| 170 | + } |
| 171 | + |
| 172 | + void _writeParameter(DartEditBuilder builder, ParameterElement parameter) { |
| 173 | + var parameterName = parameter.displayName; |
| 174 | + |
| 175 | + if (parameter.isRequiredNamed) { |
| 176 | + builder.write('required '); |
| 177 | + } |
| 178 | + |
| 179 | + builder.write('super.'); |
| 180 | + builder.write(parameterName); |
| 181 | + } |
| 182 | + |
| 183 | + void _writePositional( |
| 184 | + DartEditBuilder builder, |
| 185 | + List<ParameterElement> parameters, { |
| 186 | + required bool needsInitialComma, |
| 187 | + }) { |
| 188 | + var firstParameter = true; |
| 189 | + void writeComma() { |
| 190 | + if (firstParameter && !needsInitialComma) { |
| 191 | + firstParameter = false; |
| 192 | + } else { |
| 193 | + builder.write(', '); |
| 194 | + } |
| 195 | + } |
| 196 | + |
| 197 | + for (var parameter in parameters) { |
| 198 | + writeComma(); |
| 199 | + _writeParameter(builder, parameter); |
| 200 | + } |
| 201 | + } |
| 202 | +} |
0 commit comments