Reference all genearted file paths to pkg directory.

Modifies `GeneratedDirectory.outputDirPath` and
`GeneratedFile.outputPath` to be relative to the SDK's `pkg` directory
rather than relative to the containing package. Accordingly, modifies
the `GeneratedContent` methods `check`, `checkAll`, `generate`,
`generateAll`, `output`, as well as the `DirectoryContentsComputer`
and `FileContentsComputer` callbacks, so that their first parameter is
the path to the `pkg` directory rather than the path to the containing
package.

Also modifies the `readApi` functions in `pkg/analysis_server` and
`pkg/analyzer_plugin` to accept a path to the `pkg` directory rather
than a path to the containing package, since these functions are
called by code generation callbacks.

These changes should make code generation logic easier to reason
about. They also will make it easier to move the outputs of code
generation from one package to another, which will pave the way for
some follow-up work in which I intend to start sharing error message
representations belonging to `pkg/analyzer`, `pkg/front_end`, and
`pkg/_fe_analyzer_shared`.

Change-Id: Ia9b369b16f2df931c8a472f91400f2c5a0b8be9d
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/438480
Reviewed-by: Samuel Rawlins <[email protected]>
Commit-Queue: Paul Berry <[email protected]>

Author: stereotype441

pkg/analysis_server/integration_test/coverage_test.dart

@@ -15,7 +15,7 @@ import '../tool/spec/from_html.dart';
 void main() {
   // parse the API file
   var pathPrefix = path.join(pkg_root.packageRoot, 'analysis_server');
-  var api = readApi(pathPrefix);
+  var api = readApi(pkg_root.packageRoot);
 
   var coverageFile = File(
     path.join(pathPrefix, 'integration_test', 'coverage.md'),

pkg/analysis_server/tool/generate_analyzer_version.dart

@@ -10,15 +10,14 @@ import 'package:path/path.dart';
 import 'package:yaml/yaml.dart';
 
 void main() async {
-  await GeneratedContent.generateAll(
-    normalize(join(packageRoot, 'analysis_server')),
-    allTargets,
-  );
+  await GeneratedContent.generateAll(packageRoot, allTargets);
 }
 
 List<GeneratedContent> get allTargets {
   return [
-    GeneratedFile('lib/src/plugin2/analyzer_version.g.dart', (_) async {
+    GeneratedFile('analysis_server/lib/src/plugin2/analyzer_version.g.dart', (
+      _,
+    ) async {
       var buffer = StringBuffer('''
 // Copyright (c) 2024, the Dart project authors. Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a

pkg/analysis_server/tool/spec/check_all_test.dart

@@ -13,7 +13,7 @@ import 'generate_all.dart';
 Future<void> main() async {
   var pkgPath = normalize(join(pkg_root.packageRoot, 'analysis_server'));
   await GeneratedContent.checkAll(
-    pkgPath,
+    pkg_root.packageRoot,
     join(pkgPath, 'tool', 'spec', 'generate_all.dart'),
     allTargets,
   );

pkg/analysis_server/tool/spec/codegen_analysis_server.dart

@@ -11,7 +11,7 @@ import 'api.dart';
 import 'codegen_java.dart';
 
 final GeneratedFile target = javaGeneratedFile(
-  'tool/spec/generated/java/AnalysisServer.java',
+  'analysis_server/tool/spec/generated/java/AnalysisServer.java',
   (Api api) => CodegenAnalysisServer(api),
 );
 

pkg/analysis_server/tool/spec/codegen_dart_notification_handler.dart

@@ -13,9 +13,9 @@ import 'from_html.dart';
 
 GeneratedFile clientTarget() {
   return GeneratedFile(
-    '../analysis_server_client/lib/handler/notification_handler.dart',
-    (String pkgPath) async {
-      var visitor = CodegenNotificationHandlerVisitor(readApi(pkgPath));
+    'analysis_server_client/lib/handler/notification_handler.dart',
+    (pkgRoot) async {
+      var visitor = CodegenNotificationHandlerVisitor(readApi(pkgRoot));
       return visitor.collectCode(visitor.visitApi);
     },
   );

pkg/analysis_server/tool/spec/codegen_dart_protocol.dart

@@ -6,7 +6,6 @@ import 'dart:convert';
 
 import 'package:analyzer_utilities/html_dom.dart' as dom;
 import 'package:analyzer_utilities/tools.dart';
-import 'package:path/path.dart' as path;
 
 import 'api.dart';
 import 'codegen_dart.dart';
@@ -30,14 +29,14 @@ GeneratedFile clientTarget(
   CodegenUriConverterKind clientUriConverterKind,
 ) {
   return GeneratedFile(
-    '../analysis_server_client/lib/src/protocol/protocol_generated.dart',
-    (String pkgPath) async {
+    'analysis_server_client/lib/src/protocol/protocol_generated.dart',
+    (pkgRoot) async {
       var visitor = CodegenProtocolVisitor(
         'analysis_server_client',
         responseRequiresRequestTime,
         clientUriConverterKind,
         false,
-        readApi(pkgPath),
+        readApi(pkgRoot),
       );
       return visitor.collectCode(visitor.visitApi);
     },
@@ -48,15 +47,15 @@ GeneratedFile serverTarget(
   bool responseRequiresRequestTime,
   CodegenUriConverterKind clientUriConverterKind,
 ) {
-  return GeneratedFile('lib/protocol/protocol_generated.dart', (
-    String pkgPath,
+  return GeneratedFile('analysis_server/lib/protocol/protocol_generated.dart', (
+    pkgRoot,
   ) async {
     var visitor = CodegenProtocolVisitor(
-      path.basename(pkgPath),
+      'analysis_server',
       responseRequiresRequestTime,
       clientUriConverterKind,
       true,
-      readApi(pkgPath),
+      readApi(pkgRoot),
     );
     return visitor.collectCode(visitor.visitApi);
   });

pkg/analysis_server/tool/spec/codegen_inttest_methods.dart

@@ -6,19 +6,18 @@
 library;
 
 import 'package:analyzer_utilities/tools.dart';
-import 'package:path/path.dart' as path;
 
 import 'api.dart';
 import 'codegen_dart.dart';
 import 'from_html.dart';
 import 'to_html.dart';
 
 final GeneratedFile target = GeneratedFile(
-  'integration_test/support/integration_test_methods.dart',
-  (String pkgPath) async {
+  'analysis_server/integration_test/support/integration_test_methods.dart',
+  (pkgRoot) async {
     var visitor = CodegenInttestMethodsVisitor(
-      path.basename(pkgPath),
-      readApi(pkgPath),
+      'analysis_server',
+      readApi(pkgRoot),
     );
     return visitor.collectCode(visitor.visitApi);
   },

pkg/analysis_server/tool/spec/codegen_java.dart

@@ -18,8 +18,8 @@ GeneratedFile javaGeneratedFile(
   String path,
   CodegenJavaVisitor Function(Api api) createVisitor,
 ) {
-  return GeneratedFile(path, (String pkgPath) async {
-    var visitor = createVisitor(readApi(pkgPath));
+  return GeneratedFile(path, (pkgRoot) async {
+    var visitor = createVisitor(readApi(pkgRoot));
     return visitor.collectCode(visitor.visitApi);
   });
 }

pkg/analysis_server/tool/spec/codegen_java_types.dart

@@ -43,12 +43,12 @@ const Map<String, String> _extraMethodsOnElement = {
 /// Type references in the spec that are named something else in Java.
 const Map<String, String> _typeRenames = {'Override': 'OverrideMember'};
 
-final String pathToGenTypes = 'tool/spec/generated/java/types';
+final String pathToGenTypes = 'analysis_server/tool/spec/generated/java/types';
 
 final GeneratedDirectory targetDir = GeneratedDirectory(pathToGenTypes, (
-  String pkgPath,
+  pkgRoot,
 ) {
-  var api = readApi(pkgPath);
+  var api = readApi(pkgRoot);
   var impliedTypes = computeImpliedTypes(api);
   var map = <String, FileContentsComputer>{};
   for (var impliedType in impliedTypes.values) {
@@ -67,7 +67,7 @@ final GeneratedDirectory targetDir = GeneratedDirectory(pathToGenTypes, (
         if (renamedTo != null) {
           typeNameInJava = renamedTo;
         }
-        map['$typeNameInJava.java'] = (String pkgPath) async {
+        map['$typeNameInJava.java'] = (pkgRoot) async {
           String? superclassName;
           if (isRefactoringFeedback) {
             superclassName = 'RefactoringFeedback';

pkg/analysis_server/tool/spec/codegen_matchers.dart

@@ -13,9 +13,9 @@ import 'implied_types.dart';
 import 'to_html.dart';
 
 final GeneratedFile target = GeneratedFile(
-  'integration_test/support/protocol_matchers.dart',
-  (String pkgPath) async {
-    var visitor = CodegenMatchersVisitor(readApi(pkgPath));
+  'analysis_server/integration_test/support/protocol_matchers.dart',
+  (pkgRoot) async {
+    var visitor = CodegenMatchersVisitor(readApi(pkgRoot));
     return visitor.collectCode(visitor.visitApi);
   },
 );