[vm/ffi] Add error for FFI annotation with opt. args.

Optional arguments (positional and named) in @FfiNative
annotations are not meaningful, and should result in a
compile-time error.

TEST=tests/ffi/ffi_native_test.dart
Bug: #47169
Change-Id: I8896e6a43f9399b537e6ee7c7a0e2857a370203f
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/232622
Reviewed-by: Daco Harkes <[email protected]>
Reviewed-by: Chloe Stefantsova <[email protected]>
Commit-Queue: Clement Skau <[email protected]>

Author: Clement Skau

pkg/_fe_analyzer_shared/lib/src/messages/codes_generated.dart

@@ -686,6 +686,52 @@ const MessageCode messageCantDisambiguateNotEnoughInformation = const MessageCod
     correctionMessage:
         r"""Try providing type arguments for the literal explicitly to disambiguate it.""");
 
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+const Template<Message Function(String name)> templateCantHaveNamedParameters =
+    const Template<Message Function(String name)>(
+        problemMessageTemplate:
+            r"""'#name' can't be declared with named parameters.""",
+        withArguments: _withArgumentsCantHaveNamedParameters);
+
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+const Code<Message Function(String name)> codeCantHaveNamedParameters =
+    const Code<Message Function(String name)>(
+  "CantHaveNamedParameters",
+);
+
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+Message _withArgumentsCantHaveNamedParameters(String name) {
+  if (name.isEmpty) throw 'No name provided';
+  name = demangleMixinApplicationName(name);
+  return new Message(codeCantHaveNamedParameters,
+      problemMessage: """'${name}' can't be declared with named parameters.""",
+      arguments: {'name': name});
+}
+
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+const Template<Message Function(String name)>
+    templateCantHaveOptionalParameters =
+    const Template<Message Function(String name)>(
+        problemMessageTemplate:
+            r"""'#name' can't be declared with optional parameters.""",
+        withArguments: _withArgumentsCantHaveOptionalParameters);
+
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+const Code<Message Function(String name)> codeCantHaveOptionalParameters =
+    const Code<Message Function(String name)>(
+  "CantHaveOptionalParameters",
+);
+
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+Message _withArgumentsCantHaveOptionalParameters(String name) {
+  if (name.isEmpty) throw 'No name provided';
+  name = demangleMixinApplicationName(name);
+  return new Message(codeCantHaveOptionalParameters,
+      problemMessage:
+          """'${name}' can't be declared with optional parameters.""",
+      arguments: {'name': name});
+}
+
 // DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
 const Code<Null> codeCantInferPackagesFromManyInputs =
     messageCantInferPackagesFromManyInputs;

pkg/front_end/lib/src/api_unstable/vm.dart

@@ -68,6 +68,8 @@ export '../fasta/fasta_codes.dart'
         messageFfiPackedAnnotationAlignment,
         messageNonPositiveArrayDimensions,
         noLength,
+        templateCantHaveNamedParameters,
+        templateCantHaveOptionalParameters,
         templateFfiDartTypeMismatch,
         templateFfiEmptyStruct,
         templateFfiExpectedConstantArg,

pkg/front_end/messages.status

@@ -56,6 +56,8 @@ CannotReadSdkSpecification/example: Fail
 CantDetermineConstness/analyzerCode: Fail
 CantDisambiguateAmbiguousInformation/analyzerCode: Fail # There's no analyzer code for that error yet.
 CantDisambiguateNotEnoughInformation/analyzerCode: Fail # There's no analyzer code for that error yet.
+CantHaveNamedParameters/analyzerCode: Fail
+CantHaveOptionalParameters/analyzerCode: Fail
 CantInferPackagesFromManyInputs/analyzerCode: Fail
 CantInferPackagesFromManyInputs/example: Fail
 CantInferPackagesFromPackageUri/analyzerCode: Fail

pkg/front_end/messages.yaml

@@ -4760,6 +4760,16 @@ SpreadTypeMismatch:
         var b = [...a];
       }
 
+CantHaveNamedParameters:
+  # Used by dart:ffi
+  problemMessage: "'#name' can't be declared with named parameters."
+  external: test/ffi_test.dart
+
+CantHaveOptionalParameters:
+  # Used by dart:ffi
+  problemMessage: "'#name' can't be declared with optional parameters."
+  external: test/ffi_test.dart
+
 SpreadElementTypeMismatch:
   problemMessage: "Can't assign spread elements of type '#type' to collection elements of type '#type2'."
   analyzerCode: LIST_ELEMENT_TYPE_NOT_ASSIGNABLE

pkg/vm/lib/transformations/ffi/native.dart

@@ -6,6 +6,8 @@ import 'package:front_end/src/api_unstable/vm.dart'
     show
         messageFfiNativeMustBeExternal,
         messageFfiNativeOnlyNativeFieldWrapperClassCanBePointer,
+        templateCantHaveNamedParameters,
+        templateCantHaveOptionalParameters,
         templateFfiNativeUnexpectedNumberOfParameters,
         templateFfiNativeUnexpectedNumberOfParametersWithReceiver;
 
@@ -344,6 +346,25 @@ class FfiNativeTransformer extends FfiTransformer {
   // annotation matches.
   bool _verifySignatures(Procedure node, FunctionType dartFunctionType,
       FunctionType ffiFunctionType, int annotationOffset) {
+    if (ffiFunctionType.namedParameters.length > 0) {
+      diagnosticReporter.report(
+          templateCantHaveNamedParameters.withArguments('FfiNative'),
+          annotationOffset,
+          0,
+          node.location?.file);
+      return false;
+    }
+
+    if (ffiFunctionType.positionalParameters.length >
+        ffiFunctionType.requiredParameterCount) {
+      diagnosticReporter.report(
+          templateCantHaveOptionalParameters.withArguments('FfiNative'),
+          annotationOffset,
+          0,
+          node.location?.file);
+      return false;
+    }
+
     if (dartFunctionType.positionalParameters.length !=
         ffiFunctionType.positionalParameters.length) {
       final template = (node.isStatic
@@ -384,7 +405,7 @@ class FfiNativeTransformer extends FfiTransformer {
       FunctionType ffiFunctionType,
       List<Expression> argumentList) {
     if (!_verifySignatures(
-        node, ffiFunctionType, dartFunctionType, annotationOffset)) {
+        node, dartFunctionType, ffiFunctionType, annotationOffset)) {
       return node;
     }
 

tests/ffi/ffi_native_test.dart

@@ -95,4 +95,12 @@ class DoesNotExtend implements NativeFieldWrapperClass1 {
   external static int bad3(DoesNotExtend obj); //# 11: compile-time error
 }
 
+// Error: 'FfiNative' can't be declared with optional parameters.
+@FfiNative<Void Function([Double])>('doesntmatter') //# 12: compile-time error
+external static int badOptParam(); //# 12: compile-time error
+
+// Error: 'FfiNative' can't be declared with named parameters.
+@FfiNative<Void Function({Double})>('doesntmatter') //# 13: compile-time error
+external static int badNamedParam(); //# 13: compile-time error
+
 void main() {/* Intentionally empty: Compile-time error tests. */}