Add MetadataAnnotation class and metadata fields to relevant objects

Bug: dart-lang/language#1930
Change-Id: I3ba6facd4c0487b0af18108c8d1db21ee6d5a498
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/313640
Auto-Submit: Jake Macdonald <[email protected]>
Reviewed-by: Bob Nystrom <[email protected]>
Commit-Queue: Jake Macdonald <[email protected]>

Author: jakemac53

pkg/_fe_analyzer_shared/lib/src/macros/api/introspection.dart

@@ -9,6 +9,11 @@ part of '../api.dart';
 /// Could be a [Declaration] or [Library].
 abstract interface class MacroTarget {}
 
+/// The interface for things that can be annotated with [MetadataAnnotation]s.
+abstract interface class Annotatable {
+  Iterable<MetadataAnnotation> get metadata;
+}
+
 /// A concrete reference to a named declaration, which may or may not yet be
 /// resolved.
 ///
@@ -100,7 +105,7 @@ abstract interface class StaticType {
 abstract interface class NamedStaticType implements StaticType {}
 
 /// The interface for all declarations.
-abstract interface class Declaration implements MacroTarget {
+abstract interface class Declaration implements Annotatable, MacroTarget {
   /// The library in which this declaration is defined.
   Library get library;
 
@@ -297,7 +302,7 @@ abstract interface class FieldDeclaration
 
 /// General parameter introspection information, see the subtypes
 /// [FunctionTypeParameter] and [ParameterDeclaration].
-abstract interface class Parameter {
+abstract interface class Parameter implements Annotatable {
   /// The type of this parameter.
   TypeAnnotation get type;
 
@@ -356,7 +361,7 @@ abstract interface class RecordFieldDeclaration implements Declaration {
 }
 
 /// Introspection information for a Library.
-abstract interface class Library implements MacroTarget {
+abstract interface class Library implements Annotatable, MacroTarget {
   /// The language version of this library.
   LanguageVersion get languageVersion;
 
@@ -371,3 +376,26 @@ abstract interface class LanguageVersion {
 
   int get minor;
 }
+
+/// A metadata annotation on a declaration or library directive.
+abstract interface class MetadataAnnotation {}
+
+/// A [MetadataAnnotation] which is a reference to a const value.
+abstract interface class IdentifierMetadataAnnotation
+    implements MetadataAnnotation {
+  /// The [Identifier] for the const reference.
+  Identifier get identifier;
+}
+
+/// A [Metadata] annotation which is a constructor call.
+abstract interface class ConstructorMetadataAnnotation
+    implements MetadataAnnotation {
+  /// And [Identifier] referring to the type that is being constructed.
+  Identifier get type;
+
+  /// An [Identifier] referring to the specific constructor being called.
+  ///
+  /// For unnamed constructors, the name of this identifier will be the empty
+  /// String.
+  Identifier get constructor;
+}

pkg/_fe_analyzer_shared/lib/src/macros/executor/introspection_impls.dart

@@ -158,6 +158,7 @@ class RecordFieldDeclarationImpl extends DeclarationImpl
     required super.id,
     required super.identifier,
     required super.library,
+    required super.metadata,
     required this.name,
     required this.type,
   });
@@ -253,17 +254,71 @@ class OmittedTypeAnnotationImpl extends TypeAnnotationImpl
   RemoteInstanceKind get kind => RemoteInstanceKind.omittedTypeAnnotation;
 }
 
+abstract class MetadataAnnotationImpl extends RemoteInstance
+    implements MetadataAnnotation {
+  MetadataAnnotationImpl(super.id);
+}
+
+class IdentifierMetadataAnnotationImpl extends MetadataAnnotationImpl
+    implements IdentifierMetadataAnnotation {
+  @override
+  final IdentifierImpl identifier;
+
+  @override
+  RemoteInstanceKind get kind =>
+      RemoteInstanceKind.identifierMetadataAnnotation;
+
+  IdentifierMetadataAnnotationImpl({required int id, required this.identifier})
+      : super(id);
+
+  @override
+  void serializeUncached(Serializer serializer) {
+    super.serializeUncached(serializer);
+
+    identifier.serialize(serializer);
+  }
+}
+
+class ConstructorMetadataAnnotationImpl extends MetadataAnnotationImpl
+    implements ConstructorMetadataAnnotation {
+  @override
+  final IdentifierImpl constructor;
+
+  @override
+  final IdentifierImpl type;
+
+  @override
+  RemoteInstanceKind get kind =>
+      RemoteInstanceKind.constructorMetadataAnnotation;
+
+  ConstructorMetadataAnnotationImpl(
+      {required int id, required this.constructor, required this.type})
+      : super(id);
+
+  @override
+  void serializeUncached(Serializer serializer) {
+    super.serializeUncached(serializer);
+
+    constructor.serialize(serializer);
+    type.serialize(serializer);
+  }
+}
+
 abstract class DeclarationImpl extends RemoteInstance implements Declaration {
   @override
   final IdentifierImpl identifier;
 
   @override
   final LibraryImpl library;
 
+  @override
+  final List<MetadataAnnotationImpl> metadata;
+
   DeclarationImpl({
     required int id,
     required this.identifier,
     required this.library,
+    required this.metadata,
   }) : super(id);
 
   @override
@@ -272,6 +327,11 @@ abstract class DeclarationImpl extends RemoteInstance implements Declaration {
 
     identifier.serialize(serializer);
     library.serialize(serializer);
+    serializer.startList();
+    for (MetadataAnnotationImpl annotation in metadata) {
+      annotation.serialize(serializer);
+    }
+    serializer.endList();
   }
 }
 
@@ -293,6 +353,7 @@ class ParameterDeclarationImpl extends DeclarationImpl
     required super.id,
     required super.identifier,
     required super.library,
+    required super.metadata,
     required this.isNamed,
     required this.isRequired,
     required this.type,
@@ -322,6 +383,9 @@ class FunctionTypeParameterImpl extends RemoteInstance
   @override
   final bool isRequired;
 
+  @override
+  final List<MetadataAnnotationImpl> metadata;
+
   @override
   final String? name;
 
@@ -335,6 +399,7 @@ class FunctionTypeParameterImpl extends RemoteInstance
     required int id,
     required this.isNamed,
     required this.isRequired,
+    required this.metadata,
     required this.name,
     required this.type,
   }) : super(id);
@@ -345,6 +410,12 @@ class FunctionTypeParameterImpl extends RemoteInstance
 
     serializer.addBool(isNamed);
     serializer.addBool(isRequired);
+
+    serializer.startList();
+    for (MetadataAnnotationImpl annotation in metadata) {
+      annotation.serialize(serializer);
+    }
+    serializer.endList();
     serializer.addNullableString(name);
     type.serialize(serializer);
   }
@@ -368,6 +439,7 @@ class TypeParameterDeclarationImpl extends DeclarationImpl
     required super.id,
     required super.identifier,
     required super.library,
+    required super.metadata,
     required this.bound,
   });
 
@@ -424,6 +496,7 @@ class FunctionDeclarationImpl extends DeclarationImpl
     required super.id,
     required super.identifier,
     required super.library,
+    required super.metadata,
     required this.isAbstract,
     required this.isExternal,
     required this.isGetter,
@@ -481,6 +554,7 @@ class MethodDeclarationImpl extends FunctionDeclarationImpl
     required super.id,
     required super.identifier,
     required super.library,
+    required super.metadata,
     // Function fields.
     required super.isAbstract,
     required super.isExternal,
@@ -518,6 +592,7 @@ class ConstructorDeclarationImpl extends MethodDeclarationImpl
     required super.id,
     required super.identifier,
     required super.library,
+    required super.metadata,
     // Function fields.
     required super.isAbstract,
     required super.isExternal,
@@ -565,6 +640,7 @@ class VariableDeclarationImpl extends DeclarationImpl
     required super.id,
     required super.identifier,
     required super.library,
+    required super.metadata,
     required this.isExternal,
     required this.isFinal,
     required this.isLate,
@@ -596,6 +672,7 @@ class FieldDeclarationImpl extends VariableDeclarationImpl
     required super.id,
     required super.identifier,
     required super.library,
+    required super.metadata,
     // Variable fields.
     required super.isExternal,
     required super.isFinal,
@@ -630,6 +707,7 @@ abstract class ParameterizedTypeDeclarationImpl extends DeclarationImpl
     required super.id,
     required super.identifier,
     required super.library,
+    required super.metadata,
     required this.typeParameters,
   });
 
@@ -695,6 +773,7 @@ class ClassDeclarationImpl extends ParameterizedTypeDeclarationImpl
     required super.id,
     required super.identifier,
     required super.library,
+    required super.metadata,
     // TypeDeclaration fields.
     required super.typeParameters,
     // ClassDeclaration fields.
@@ -762,6 +841,7 @@ class EnumDeclarationImpl extends ParameterizedTypeDeclarationImpl
     required super.id,
     required super.identifier,
     required super.library,
+    required super.metadata,
     // TypeDeclaration fields.
     required super.typeParameters,
     // EnumDeclaration fields.
@@ -799,6 +879,7 @@ class EnumValueDeclarationImpl extends DeclarationImpl
     required super.id,
     required super.identifier,
     required super.library,
+    required super.metadata,
     required this.definingEnum,
   });
 
@@ -836,6 +917,7 @@ class MixinDeclarationImpl extends ParameterizedTypeDeclarationImpl
     required super.id,
     required super.identifier,
     required super.library,
+    required super.metadata,
     // TypeDeclaration fields.
     required super.typeParameters,
     // MixinDeclaration fields.
@@ -878,6 +960,7 @@ class TypeAliasDeclarationImpl extends ParameterizedTypeDeclarationImpl
     required super.id,
     required super.identifier,
     required super.library,
+    required super.metadata,
     // TypeDeclaration fields.
     required super.typeParameters,
     // TypeAlias fields.
@@ -899,18 +982,29 @@ class LibraryImpl extends RemoteInstance implements Library {
   @override
   final LanguageVersionImpl languageVersion;
 
+  @override
+  final List<MetadataAnnotationImpl> metadata;
+
   @override
   final Uri uri;
 
   LibraryImpl(
-      {required int id, required this.languageVersion, required this.uri})
+      {required int id,
+      required this.languageVersion,
+      required this.metadata,
+      required this.uri})
       : super(id);
 
   @override
   void serializeUncached(Serializer serializer) {
     super.serializeUncached(serializer);
 
     languageVersion.serialize(serializer);
+    serializer.startList();
+    for (MetadataAnnotationImpl annotation in metadata) {
+      annotation.serialize(serializer);
+    }
+    serializer.endList();
     serializer.addUri(uri);
   }
 }

pkg/_fe_analyzer_shared/lib/src/macros/executor/remote_instance.dart

@@ -101,13 +101,15 @@ class RemoteInstanceImpl extends RemoteInstance {
 enum RemoteInstanceKind {
   classDeclaration,
   constructorDeclaration,
+  constructorMetadataAnnotation,
   enumDeclaration,
   enumValueDeclaration,
   fieldDeclaration,
   functionDeclaration,
   functionTypeAnnotation,
   functionTypeParameter,
   identifier,
+  identifierMetadataAnnotation,
   identifierResolver,
   introspectableClassDeclaration,
   introspectableEnumDeclaration,