|
| 1 | +// Copyright (c) 2021, 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:analyzer/dart/ast/ast.dart'; |
| 6 | +import 'package:analyzer/dart/element/element.dart'; |
| 7 | +import 'package:analyzer/dart/element/type.dart'; |
| 8 | +import 'package:analyzer/src/dart/ast/ast.dart'; |
| 9 | +import 'package:analyzer/src/dart/element/type_provider.dart'; |
| 10 | +import 'package:analyzer/src/dart/resolver/type_property_resolver.dart'; |
| 11 | +import 'package:analyzer/src/generated/resolver.dart'; |
| 12 | + |
| 13 | +class CommentReferenceResolver { |
| 14 | + final TypeProviderImpl _typeProvider; |
| 15 | + |
| 16 | + final ResolverVisitor _resolver; |
| 17 | + |
| 18 | + /// Helper for resolving properties on types. |
| 19 | + final TypePropertyResolver _typePropertyResolver; |
| 20 | + |
| 21 | + CommentReferenceResolver(this._typeProvider, this._resolver) |
| 22 | + : _typePropertyResolver = _resolver.typePropertyResolver; |
| 23 | + |
| 24 | + /// Resolves [commentReference]. |
| 25 | + void resolve(CommentReference commentReference) { |
| 26 | + var expression = commentReference.expression; |
| 27 | + if (expression is SimpleIdentifierImpl) { |
| 28 | + _resolveSimpleIdentifierReference(expression, |
| 29 | + hasNewKeyword: commentReference.newKeyword != null); |
| 30 | + } else if (expression is PrefixedIdentifierImpl) { |
| 31 | + _resolvePrefixedIdentifierReference(expression, |
| 32 | + hasNewKeyword: commentReference.newKeyword != null); |
| 33 | + } else if (expression is PropertyAccessImpl) { |
| 34 | + _resolvePropertyAccessReference(expression, |
| 35 | + hasNewKeyword: commentReference.newKeyword != null); |
| 36 | + } |
| 37 | + } |
| 38 | + |
| 39 | + void _resolvePrefixedIdentifierReference( |
| 40 | + PrefixedIdentifierImpl expression, { |
| 41 | + required bool hasNewKeyword, |
| 42 | + }) { |
| 43 | + var prefix = expression.prefix; |
| 44 | + var prefixElement = _resolveSimpleIdentifier(prefix); |
| 45 | + prefix.staticElement = prefixElement; |
| 46 | + |
| 47 | + if (prefixElement == null) { |
| 48 | + return; |
| 49 | + } |
| 50 | + |
| 51 | + var name = expression.identifier; |
| 52 | + |
| 53 | + if (prefixElement is PrefixElement) { |
| 54 | + var prefixScope = prefixElement.scope; |
| 55 | + var lookupResult = prefixScope.lookup(name.name); |
| 56 | + var element = lookupResult.getter ?? lookupResult.setter; |
| 57 | + element = _resolver.toLegacyElement(element); |
| 58 | + name.staticElement = element; |
| 59 | + return; |
| 60 | + } |
| 61 | + |
| 62 | + if (!hasNewKeyword) { |
| 63 | + if (prefixElement is ClassElement) { |
| 64 | + name.staticElement = prefixElement.getMethod(name.name) ?? |
| 65 | + prefixElement.getGetter(name.name) ?? |
| 66 | + prefixElement.getSetter(name.name) ?? |
| 67 | + prefixElement.getNamedConstructor(name.name); |
| 68 | + } else if (prefixElement is ExtensionElement) { |
| 69 | + name.staticElement = prefixElement.getMethod(name.name) ?? |
| 70 | + prefixElement.getGetter(name.name) ?? |
| 71 | + prefixElement.getSetter(name.name); |
| 72 | + } else { |
| 73 | + // TODO(brianwilkerson) Report this error. |
| 74 | + } |
| 75 | + } else if (prefixElement is ClassElement) { |
| 76 | + var constructor = prefixElement.getNamedConstructor(name.name); |
| 77 | + if (constructor == null) { |
| 78 | + // TODO(brianwilkerson) Report this error. |
| 79 | + } else { |
| 80 | + name.staticElement = constructor; |
| 81 | + } |
| 82 | + } else { |
| 83 | + // TODO(brianwilkerson) Report this error. |
| 84 | + } |
| 85 | + } |
| 86 | + |
| 87 | + void _resolvePropertyAccessReference( |
| 88 | + PropertyAccessImpl expression, { |
| 89 | + required bool hasNewKeyword, |
| 90 | + }) { |
| 91 | + var target = expression.target; |
| 92 | + if (target is! PrefixedIdentifierImpl) { |
| 93 | + // A PropertyAccess with a target more complex than a |
| 94 | + // [PrefixedIdentifier] is not a valid comment reference. |
| 95 | + return; |
| 96 | + } |
| 97 | + |
| 98 | + var prefix = target.prefix; |
| 99 | + var prefixElement = _resolveSimpleIdentifier(prefix); |
| 100 | + prefix.staticElement = prefixElement; |
| 101 | + |
| 102 | + if (prefixElement is! PrefixElement) { |
| 103 | + // The only valid prefixElement is a PrefixElement; otherwise, this is |
| 104 | + // not a comment reference. |
| 105 | + return; |
| 106 | + } |
| 107 | + |
| 108 | + var name = target.identifier; |
| 109 | + var prefixScope = prefixElement.scope; |
| 110 | + var lookupResult = prefixScope.lookup(name.name); |
| 111 | + var element = lookupResult.getter ?? lookupResult.setter; |
| 112 | + element = _resolver.toLegacyElement(element); |
| 113 | + name.staticElement = element; |
| 114 | + |
| 115 | + var propertyName = expression.propertyName; |
| 116 | + if (element is ClassElement) { |
| 117 | + propertyName.staticElement = element.getMethod(propertyName.name) ?? |
| 118 | + element.getGetter(propertyName.name) ?? |
| 119 | + element.getSetter(propertyName.name) ?? |
| 120 | + element.getNamedConstructor(propertyName.name); |
| 121 | + } else if (element is ExtensionElement) { |
| 122 | + propertyName.staticElement = element.getMethod(propertyName.name) ?? |
| 123 | + element.getGetter(propertyName.name) ?? |
| 124 | + element.getSetter(propertyName.name); |
| 125 | + } |
| 126 | + } |
| 127 | + |
| 128 | + /// Resolves the given simple [identifier] if possible. |
| 129 | + /// |
| 130 | + /// Returns the resolved element, or `null` if the identifier could not be |
| 131 | + /// resolved. This does not record the results of the resolution. |
| 132 | + Element? _resolveSimpleIdentifier(SimpleIdentifierImpl identifier) { |
| 133 | + var lookupResult = identifier.scopeLookupResult!; |
| 134 | + |
| 135 | + var element = _resolver.toLegacyElement(lookupResult.getter) ?? |
| 136 | + _resolver.toLegacyElement(lookupResult.setter); |
| 137 | + |
| 138 | + if (element == null) { |
| 139 | + InterfaceType enclosingType; |
| 140 | + var enclosingClass = _resolver.enclosingClass; |
| 141 | + if (enclosingClass != null) { |
| 142 | + enclosingType = enclosingClass.thisType; |
| 143 | + } else { |
| 144 | + var enclosingExtension = _resolver.enclosingExtension; |
| 145 | + if (enclosingExtension == null) { |
| 146 | + return null; |
| 147 | + } |
| 148 | + var extendedType = enclosingExtension.extendedType |
| 149 | + .resolveToBound(_typeProvider.objectType); |
| 150 | + if (extendedType is InterfaceType) { |
| 151 | + enclosingType = extendedType; |
| 152 | + } else if (extendedType is FunctionType) { |
| 153 | + enclosingType = _typeProvider.functionType; |
| 154 | + } else { |
| 155 | + return null; |
| 156 | + } |
| 157 | + } |
| 158 | + var result = _typePropertyResolver.resolve( |
| 159 | + receiver: null, |
| 160 | + receiverType: enclosingType, |
| 161 | + name: identifier.name, |
| 162 | + propertyErrorEntity: identifier, |
| 163 | + nameErrorEntity: identifier, |
| 164 | + ); |
| 165 | + if (identifier.parent is CommentReference) { |
| 166 | + // TODO(srawlins): Why is the setter preferred? This seems very flawed |
| 167 | + // as it will only use the setter for a [SimpleIdentifier] comment |
| 168 | + // reference, and not a [PrefixedIdentifier] or a [PropertyAccess]. |
| 169 | + element = result.setter; |
| 170 | + } |
| 171 | + element ??= result.getter; |
| 172 | + } |
| 173 | + return element; |
| 174 | + } |
| 175 | + |
| 176 | + void _resolveSimpleIdentifierReference( |
| 177 | + SimpleIdentifierImpl expression, { |
| 178 | + required bool hasNewKeyword, |
| 179 | + }) { |
| 180 | + var element = _resolveSimpleIdentifier(expression); |
| 181 | + if (element == null) { |
| 182 | + return; |
| 183 | + } |
| 184 | + expression.staticElement = element; |
| 185 | + if (hasNewKeyword) { |
| 186 | + if (element is ClassElement) { |
| 187 | + var constructor = element.unnamedConstructor; |
| 188 | + if (constructor == null) { |
| 189 | + // TODO(brianwilkerson) Report this error. |
| 190 | + } else { |
| 191 | + expression.staticElement = constructor; |
| 192 | + } |
| 193 | + } else { |
| 194 | + // TODO(brianwilkerson) Report this error. |
| 195 | + } |
| 196 | + } |
| 197 | + } |
| 198 | +} |
0 commit comments