| // Copyright (c) 2019, 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 'package:analyzer/dart/element/element.dart'; |
| import 'package:dartdoc/src/model/feature.dart'; |
| import 'package:dartdoc/src/model/model.dart'; |
| import 'package:dartdoc/src/render/source_code_renderer.dart'; |
| |
| class Field extends ModelElement |
| with GetterSetterCombo, ContainerMember, Inheritable |
| implements EnclosedElement { |
| bool _isInherited = false; |
| Container _enclosingContainer; |
| @override |
| final ContainerAccessor getter; |
| @override |
| final ContainerAccessor setter; |
| |
| Field(FieldElement element, Library library, PackageGraph packageGraph, |
| this.getter, this.setter) |
| : super(element, library, packageGraph) { |
| assert(getter != null || setter != null); |
| if (getter != null) getter.enclosingCombo = this; |
| if (setter != null) setter.enclosingCombo = this; |
| } |
| |
| factory Field.inherited( |
| FieldElement element, |
| Container enclosingContainer, |
| Library library, |
| PackageGraph packageGraph, |
| Accessor getter, |
| Accessor setter) { |
| var newField = Field(element, library, packageGraph, getter, setter); |
| newField._isInherited = true; |
| newField._enclosingContainer = enclosingContainer; |
| // Can't set _isInherited to true if this is the defining element, because |
| // that would mean it isn't inherited. |
| assert(newField.enclosingElement != newField.definingEnclosingContainer); |
| return newField; |
| } |
| |
| @override |
| String get documentation { |
| // Verify that hasSetter and hasGetterNoSetter are mutually exclusive, |
| // to prevent displaying more or less than one summary. |
| if (isPublic) { |
| var assertCheck = <dynamic>{} |
| ..addAll(<bool>[hasPublicSetter, hasPublicGetterNoSetter]); |
| assert(assertCheck.containsAll([true, false])); |
| } |
| documentationFrom; |
| return super.documentation; |
| } |
| |
| @override |
| Container get enclosingElement { |
| _enclosingContainer ??= modelBuilder.from(field.enclosingElement, library); |
| return _enclosingContainer; |
| } |
| |
| @override |
| String get filePath => |
| '${enclosingElement.library.dirName}/${enclosingElement.name}/$fileName'; |
| |
| @override |
| String get href { |
| if (!identical(canonicalModelElement, this)) { |
| return canonicalModelElement?.href; |
| } |
| assert(canonicalLibrary != null); |
| assert(canonicalEnclosingContainer == enclosingElement); |
| assert(canonicalLibrary == library); |
| return '${package.baseHref}$filePath'; |
| } |
| |
| @override |
| bool get isConst => field.isConst; |
| |
| /// Returns true if the FieldElement is covariant, or if the first parameter |
| /// for the setter is covariant. |
| @override |
| bool get isCovariant => setter?.isCovariant == true || field.isCovariant; |
| |
| @override |
| bool get isFinal { |
| /// isFinal returns true for the field even if it has an explicit getter |
| /// (which means we should not document it as "final"). |
| if (hasExplicitGetter) return false; |
| return field.isFinal; |
| } |
| |
| @override |
| bool get isLate => isFinal && field.isLate; |
| |
| @override |
| bool get isInherited => _isInherited; |
| |
| @override |
| String get kind => isConst ? 'constant' : 'property'; |
| |
| String get fullkind { |
| if (field.isAbstract) return 'abstract $kind'; |
| return kind; |
| } |
| |
| @override |
| Set<Feature> get features { |
| var allFeatures = super.features..addAll(comboFeatures); |
| // Combo features can indicate 'inherited' and 'override' if |
| // either the getter or setter has one of those properties, but that's not |
| // really specific enough for [Field]s that have public getter/setters. |
| if (hasPublicGetter && hasPublicSetter) { |
| if (getter.isInherited && setter.isInherited) { |
| allFeatures.add(Feature.inherited); |
| } else { |
| allFeatures.remove(Feature.inherited); |
| if (getter.isInherited) allFeatures.add(Feature.inheritedGetter); |
| if (setter.isInherited) allFeatures.add(Feature.inheritedSetter); |
| } |
| if (getter.isOverride && setter.isOverride) { |
| allFeatures.add(Feature.overrideFeature); |
| } else { |
| allFeatures.remove(Feature.overrideFeature); |
| if (getter.isOverride) allFeatures.add(Feature.overrideGetter); |
| if (setter.isOverride) allFeatures.add(Feature.overrideSetter); |
| } |
| } else { |
| if (isInherited) allFeatures.add(Feature.inherited); |
| if (isOverride) allFeatures.add(Feature.overrideFeature); |
| } |
| return allFeatures; |
| } |
| |
| FieldElement get field => (element as FieldElement); |
| |
| @override |
| String get fileName => '${isConst ? '$name-constant' : name}.$fileType'; |
| |
| SourceCodeRenderer get _sourceCodeRenderer => |
| packageGraph.rendererFactory.sourceCodeRenderer; |
| |
| String _sourceCode; |
| |
| @override |
| String get sourceCode { |
| if (_sourceCode == null) { |
| // We could use a set to figure the dupes out, but that would lose ordering. |
| var fieldSourceCode = modelNode.sourceCode ?? ''; |
| var getterSourceCode = getter?.sourceCode ?? ''; |
| var setterSourceCode = setter?.sourceCode ?? ''; |
| var buffer = StringBuffer(); |
| if (fieldSourceCode.isNotEmpty) { |
| fieldSourceCode = _sourceCodeRenderer.renderSourceCode(fieldSourceCode); |
| buffer.write(fieldSourceCode); |
| } |
| if (buffer.isNotEmpty) buffer.write('\n\n'); |
| if (fieldSourceCode != getterSourceCode) { |
| if (getterSourceCode != setterSourceCode) { |
| buffer.write(getterSourceCode); |
| if (buffer.isNotEmpty) buffer.write('\n\n'); |
| } |
| } |
| if (fieldSourceCode != setterSourceCode) { |
| buffer.write(setterSourceCode); |
| } |
| _sourceCode = buffer.toString(); |
| } |
| return _sourceCode; |
| } |
| |
| @override |
| Inheritable get overriddenElement => null; |
| } |