Elements. Centralize child fragment creation in ElementBuilder.

This commit refactors the process of associating child fragments with
their parent fragments within the summary2 element builder. The primary
goal is to reduce code duplication and improve maintainability by
centralizing the logic for creating these parent-child relationships.

Previously, the logic for adding a child fragment to its parent was
repeated in multiple locations throughout FragmentBuilder. This
typically involved:
   1. Retrieving the parent fragment from the current _enclosingContext.
   2. Manually setting the enclosingFragment property on the child.
   3. Calling _libraryBuilder.addFragmentChild to register the relationship.

These scattered and repetitive blocks of code have been replaced with a
single, unified helper method.

Key changes:

   - A new private method _addChildFragment(FragmentImpl child) is introduced in FragmentBuilder. This method encapsulates the entire process of linking a child fragment to its parent, which is retrieved from the current context.

   - The responsibility for setting the child.enclosingFragment property has been moved into LibraryBuilder.addChildFragment(). This ensures that the enclosing fragment is always set consistently whenever a child is added, making the process more robust.

   - All call sites within FragmentBuilder (for constructors, enum constants, fields, methods, etc.) have been updated to use the new _addChildFragment() method, significantly simplifying the code in visitor methods.

   - visitEnumDeclaration now wraps creating children fragments with `_withEnclosing` so that `_addChildFragment` can rely on having enclosing enum fragment.

   - As part of this refactoring, the point at which a ConstructorFragment is added to its enclosing InterfaceFragment was moved from FragmentBuilder.visitConstructorDeclaration to ElementBuilder.buildConstructorElement. This is a more logical location for this operation, as it occurs during the final element construction phase.

This refactoring does not change any analyzer behavior but improves the
internal code quality, making it cleaner, more readable, and easier to
maintain.

Change-Id: I254a1fbc23fe9f27e72ed7d15b0661d6cfa47816
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/441836
Reviewed-by: Paul Berry <[email protected]>
Commit-Queue: Konstantin Shcheglov <[email protected]>

Author: scheglov

pkg/analyzer/lib/src/summary2/element_builder.dart

@@ -272,6 +272,9 @@ class ElementBuilder {
     FragmentImpl? lastFragment,
     ConstructorFragmentImpl fragment,
   ) {
+    var interfaceFragment = fragment.enclosingFragment;
+    interfaceFragment.addConstructor(fragment);
+
     var element = ConstructorElementImpl(
       name: fragment.name,
       reference: _addInstanceReference(
@@ -934,9 +937,7 @@ class FragmentBuilder extends ThrowingAstVisitor<void> {
     node.declaredFragment = fragment;
     _linker.elementNodes[fragment] = node;
 
-    var parentFragment = _enclosingContext.fragment;
-    _libraryBuilder.addFragmentChild(parentFragment, fragment);
-    (parentFragment as InterfaceFragmentImpl).addConstructor(fragment);
+    _addChildFragment(fragment);
 
     _buildExecutableElementChildren(
       fragment: fragment,
@@ -963,159 +964,156 @@ class FragmentBuilder extends ThrowingAstVisitor<void> {
 
     _libraryBuilder.addTopFragment(_unitElement, fragment);
 
+    node.withClause?.accept(this);
+    node.implementsClause?.accept(this);
+
     var holder = _EnclosingContext(fragment: fragment);
+    _withEnclosing(holder, () {
+      // Build fields for all enum constants.
+      var constants = node.constants;
+      var valuesElements = <SimpleIdentifierImpl>[];
+      var valuesNames = <String>{};
+      for (var i = 0; i < constants.length; ++i) {
+        var constant = constants[i];
+        var nameToken = constant.name;
+        var name = nameToken.lexeme;
+        var field =
+            FieldFragmentImpl(
+                name: _getFragmentName(nameToken),
+                firstTokenOffset: null,
+              )
+              ..hasImplicitType = true
+              ..hasInitializer = true
+              ..isAugmentation = constant.augmentKeyword != null
+              ..isConst = true
+              ..isEnumConstant = true
+              ..isStatic = true;
+        field.metadata = _buildMetadata(constant.metadata);
+
+        var constantArguments = constant.arguments;
+        var constructorSelector = constantArguments?.constructorSelector;
+        var constructorName = constructorSelector?.name.name;
+
+        var initializer = InstanceCreationExpressionImpl(
+          keyword: null,
+          constructorName: ConstructorNameImpl(
+            type: NamedTypeImpl(
+              importPrefix: null,
+              name: StringToken(TokenType.STRING, fragment.name ?? '', -1),
+              typeArguments: constantArguments?.typeArguments,
+              question: null,
+            ),
+            period: constructorName != null ? Tokens.period() : null,
+            name:
+                constructorName != null
+                    ? SimpleIdentifierImpl(
+                      token: StringToken(TokenType.STRING, constructorName, -1),
+                    )
+                    : null,
+          ),
+          argumentList:
+              constantArguments != null
+                  ? constantArguments.argumentList
+                  : ArgumentListImpl(
+                    leftParenthesis: Tokens.openParenthesis(),
+                    arguments: [],
+                    rightParenthesis: Tokens.closeParenthesis(),
+                  ),
+          typeArguments: null,
+        );
+
+        var variableDeclaration = VariableDeclarationImpl(
+          comment: null,
+          metadata: [],
+          name: StringToken(TokenType.STRING, name, -1),
+          equals: Tokens.eq(),
+          initializer: initializer,
+        );
+        constant.declaredFragment = field;
+        variableDeclaration.declaredFragment = field;
+        VariableDeclarationListImpl(
+          comment: null,
+          metadata: null,
+          lateKeyword: null,
+          keyword: null,
+          type: null,
+          variables: [variableDeclaration],
+        );
+        _linker.elementNodes[field] = variableDeclaration;
+
+        _addChildFragment(field);
+
+        AstNodeImpl.linkNodeTokens(initializer);
+        field.constantInitializer = initializer;
+
+        valuesElements.add(
+          SimpleIdentifierImpl(token: StringToken(TokenType.STRING, name, -1)),
+        );
+        valuesNames.add(name);
+      }
 
-    // Build fields for all enum constants.
-    var constants = node.constants;
-    var valuesElements = <SimpleIdentifierImpl>[];
-    var valuesNames = <String>{};
-    for (var i = 0; i < constants.length; ++i) {
-      var constant = constants[i];
-      var nameToken = constant.name;
-      var name = nameToken.lexeme;
-      var field =
-          FieldFragmentImpl(
-              name: _getFragmentName(nameToken),
-              firstTokenOffset: null,
-            )
-            ..hasImplicitType = true
-            ..hasInitializer = true
-            ..isAugmentation = constant.augmentKeyword != null
+      // Build the 'values' field.
+      var valuesField =
+          FieldFragmentImpl(name: 'values', firstTokenOffset: null)
+            ..hasEnclosingTypeParameterReference = false
             ..isConst = true
-            ..isEnumConstant = true
-            ..isStatic = true;
-      field.metadata = _buildMetadata(constant.metadata);
-
-      var constantArguments = constant.arguments;
-      var constructorSelector = constantArguments?.constructorSelector;
-      var constructorName = constructorSelector?.name.name;
-
-      var initializer = InstanceCreationExpressionImpl(
-        keyword: null,
-        constructorName: ConstructorNameImpl(
-          type: NamedTypeImpl(
-            importPrefix: null,
-            name: StringToken(TokenType.STRING, fragment.name ?? '', -1),
-            typeArguments: constantArguments?.typeArguments,
-            question: null,
-          ),
-          period: constructorName != null ? Tokens.period() : null,
-          name:
-              constructorName != null
-                  ? SimpleIdentifierImpl(
-                    token: StringToken(TokenType.STRING, constructorName, -1),
-                  )
-                  : null,
-        ),
-        argumentList:
-            constantArguments != null
-                ? constantArguments.argumentList
-                : ArgumentListImpl(
-                  leftParenthesis: Tokens.openParenthesis(),
-                  arguments: [],
-                  rightParenthesis: Tokens.closeParenthesis(),
-                ),
+            ..isStatic = true
+            ..isSynthetic = true;
+      var initializer = ListLiteralImpl(
+        constKeyword: null,
         typeArguments: null,
+        leftBracket: Tokens.openSquareBracket(),
+        elements: valuesElements,
+        rightBracket: Tokens.closeSquareBracket(),
       );
+      AstNodeImpl.linkNodeTokens(initializer);
+      valuesField.constantInitializer = initializer;
 
       var variableDeclaration = VariableDeclarationImpl(
         comment: null,
         metadata: [],
-        name: StringToken(TokenType.STRING, name, -1),
+        name: StringToken(TokenType.STRING, 'values', -1),
         equals: Tokens.eq(),
         initializer: initializer,
       );
-      constant.declaredFragment = field;
-      variableDeclaration.declaredFragment = field;
+      var valuesTypeNode = NamedTypeImpl(
+        importPrefix: null,
+        name: StringToken(TokenType.STRING, 'List', -1),
+        typeArguments: TypeArgumentListImpl(
+          leftBracket: Tokens.lt(),
+          arguments: [
+            NamedTypeImpl(
+              importPrefix: null,
+              name: StringToken(TokenType.STRING, fragment.name ?? '', -1),
+              typeArguments: null,
+              question: null,
+            ),
+          ],
+          rightBracket: Tokens.gt(),
+        ),
+        question: null,
+      );
       VariableDeclarationListImpl(
         comment: null,
         metadata: null,
         lateKeyword: null,
-        keyword: null,
-        type: null,
+        keyword: Tokens.const_(),
         variables: [variableDeclaration],
+        type: valuesTypeNode,
       );
-      _linker.elementNodes[field] = variableDeclaration;
+      _linker.elementNodes[valuesField] = variableDeclaration;
 
-      field.enclosingFragment = fragment;
-      _libraryBuilder.addFragmentChild(fragment, field);
+      _addChildFragment(valuesField);
 
-      AstNodeImpl.linkNodeTokens(initializer);
-      field.constantInitializer = initializer;
-
-      valuesElements.add(
-        SimpleIdentifierImpl(token: StringToken(TokenType.STRING, name, -1)),
+      _libraryBuilder.implicitEnumNodes[fragment] = ImplicitEnumNodes(
+        element: fragment,
+        valuesTypeNode: valuesTypeNode,
+        valuesNode: variableDeclaration,
+        valuesElement: valuesField,
+        valuesNames: valuesNames,
+        valuesInitializer: initializer,
       );
-      valuesNames.add(name);
-    }
-
-    // Build the 'values' field.
-    var valuesField =
-        FieldFragmentImpl(name: 'values', firstTokenOffset: null)
-          ..hasEnclosingTypeParameterReference = false
-          ..isConst = true
-          ..isStatic = true
-          ..isSynthetic = true;
-    var initializer = ListLiteralImpl(
-      constKeyword: null,
-      typeArguments: null,
-      leftBracket: Tokens.openSquareBracket(),
-      elements: valuesElements,
-      rightBracket: Tokens.closeSquareBracket(),
-    );
-    AstNodeImpl.linkNodeTokens(initializer);
-    valuesField.constantInitializer = initializer;
-
-    var variableDeclaration = VariableDeclarationImpl(
-      comment: null,
-      metadata: [],
-      name: StringToken(TokenType.STRING, 'values', -1),
-      equals: Tokens.eq(),
-      initializer: initializer,
-    );
-    var valuesTypeNode = NamedTypeImpl(
-      importPrefix: null,
-      name: StringToken(TokenType.STRING, 'List', -1),
-      typeArguments: TypeArgumentListImpl(
-        leftBracket: Tokens.lt(),
-        arguments: [
-          NamedTypeImpl(
-            importPrefix: null,
-            name: StringToken(TokenType.STRING, fragment.name ?? '', -1),
-            typeArguments: null,
-            question: null,
-          ),
-        ],
-        rightBracket: Tokens.gt(),
-      ),
-      question: null,
-    );
-    VariableDeclarationListImpl(
-      comment: null,
-      metadata: null,
-      lateKeyword: null,
-      keyword: Tokens.const_(),
-      variables: [variableDeclaration],
-      type: valuesTypeNode,
-    );
-    _linker.elementNodes[valuesField] = variableDeclaration;
-
-    valuesField.enclosingFragment = fragment;
-    _libraryBuilder.addFragmentChild(fragment, valuesField);
-
-    _libraryBuilder.implicitEnumNodes[fragment] = ImplicitEnumNodes(
-      element: fragment,
-      valuesTypeNode: valuesTypeNode,
-      valuesNode: variableDeclaration,
-      valuesElement: valuesField,
-      valuesNames: valuesNames,
-      valuesInitializer: initializer,
-    );
-
-    node.withClause?.accept(this);
-    node.implementsClause?.accept(this);
 
-    _withEnclosing(holder, () {
       node.typeParameters?.accept(this);
       node.members.accept(this);
     });
@@ -1240,9 +1238,7 @@ class FragmentBuilder extends ThrowingAstVisitor<void> {
       variable.declaredFragment = fragment;
       _linker.elementNodes[fragment] = variable;
 
-      var parentFragment = _enclosingContext.fragment;
-      fragment.enclosingFragment = parentFragment;
-      _libraryBuilder.addFragmentChild(parentFragment, fragment);
+      _addChildFragment(fragment);
     }
     node.fields.type?.accept(this);
   }
@@ -1516,11 +1512,7 @@ class FragmentBuilder extends ThrowingAstVisitor<void> {
       fragment.isAbstract = node.isAbstract;
       fragment.isAugmentation = node.augmentKeyword != null;
       fragment.isStatic = node.isStatic;
-
-      var parentFragment = _enclosingContext.fragment;
-      fragment.enclosingFragment = parentFragment;
-      _libraryBuilder.addFragmentChild(parentFragment, fragment);
-
+      _addChildFragment(fragment);
       executableFragment = fragment;
     } else if (node.isSetter) {
       var fragment = SetterFragmentImpl(
@@ -1530,11 +1522,7 @@ class FragmentBuilder extends ThrowingAstVisitor<void> {
       fragment.isAbstract = node.isAbstract;
       fragment.isAugmentation = node.augmentKeyword != null;
       fragment.isStatic = node.isStatic;
-
-      var parentFragment = _enclosingContext.fragment;
-      fragment.enclosingFragment = parentFragment;
-      _libraryBuilder.addFragmentChild(parentFragment, fragment);
-
+      _addChildFragment(fragment);
       executableFragment = fragment;
     } else {
       var fragment = MethodFragmentImpl(
@@ -1544,11 +1532,7 @@ class FragmentBuilder extends ThrowingAstVisitor<void> {
       fragment.isAbstract = node.isAbstract;
       fragment.isAugmentation = node.augmentKeyword != null;
       fragment.isStatic = node.isStatic;
-
-      var parentFragment = _enclosingContext.fragment;
-      fragment.enclosingFragment = parentFragment;
-      _libraryBuilder.addFragmentChild(parentFragment, fragment);
-
+      _addChildFragment(fragment);
       executableFragment = fragment;
     }
     executableFragment.hasImplicitReturnType = node.returnType == null;
@@ -1793,6 +1777,11 @@ class FragmentBuilder extends ThrowingAstVisitor<void> {
     node.mixinTypes.accept(this);
   }
 
+  void _addChildFragment(FragmentImpl child) {
+    var parent = _enclosingContext.fragment;
+    _libraryBuilder.addChildFragment(parent, child);
+  }
+
   void _buildExecutableElementChildren({
     required ExecutableFragmentImpl fragment,
     FormalParameterList? formalParameters,
@@ -1840,8 +1829,7 @@ class FragmentBuilder extends ThrowingAstVisitor<void> {
     representation.fieldFragment = fieldFragment;
     _linker.elementNodes[fieldFragment] = representation;
 
-    fieldFragment.enclosingFragment = extensionFragment;
-    _libraryBuilder.addFragmentChild(extensionFragment, fieldFragment);
+    _addChildFragment(fieldFragment);
 
     var formalParameterElement =
         FieldFormalParameterFragmentImpl(
@@ -1867,8 +1855,7 @@ class FragmentBuilder extends ThrowingAstVisitor<void> {
       representation.constructorFragment = constructorFragment;
       _linker.elementNodes[constructorFragment] = representation;
 
-      _libraryBuilder.addFragmentChild(extensionFragment, constructorFragment);
-      extensionFragment.addConstructor(constructorFragment);
+      _addChildFragment(constructorFragment);
     }
 
     representation.fieldType.accept(this);