feat: optional parameters must be passed by name

Safe-DS · Jan 7, 2025 · 297a0b9 · 297a0b9
1 parent 790fc17
commit 297a0b9
Show file tree

Hide file tree

Showing 6 changed files with 76 additions and 11 deletions.
diff --git a/packages/safe-ds-lang/src/language/validation/other/declarations/annotationCalls.ts b/packages/safe-ds-lang/src/language/validation/other/declarations/annotationCalls.ts
@@ -18,7 +18,7 @@ import {
 } from '../../../helpers/nodeProperties.js';
 import type { SafeDsServices } from '../../../safe-ds-module.js';
 
-export const CODE_ANNOTATION_CALL_CONSTANT_ARGUMENT = 'annotation-call/constant-argument';
+export const CODE_ANNOTATION_CALL_CONSTANT_ARGUMENT = 'annotation-call/non-constant-argument';
 export const CODE_ANNOTATION_CALL_MISSING_ARGUMENT_LIST = 'annotation-call/missing-argument-list';
 export const CODE_ANNOTATION_CALL_TARGET_PARAMETER = 'annotation-call/target-parameter';
 export const CODE_ANNOTATION_CALL_TARGET_RESULT = 'annotation-call/target-result';

diff --git a/packages/safe-ds-lang/src/language/validation/other/expressions/arguments.ts b/packages/safe-ds-lang/src/language/validation/other/expressions/arguments.ts
@@ -0,0 +1,25 @@
+import { SafeDsServices } from '../../../safe-ds-module.js';
+import type { SdsArgument } from '../../../generated/ast.js';
+import { ValidationAcceptor } from 'langium';
+import { Argument, Parameter } from '../../../helpers/nodeProperties.js';
+
+export const CODE_ARGUMENT_POSITIONAL = 'argument/positional';
+
+export const argumentMustBeNamedIfParameterIsOptional = (services: SafeDsServices) => {
+    const nodeMapper = services.helpers.NodeMapper;
+
+    return (node: SdsArgument, accept: ValidationAcceptor) => {
+        const parameter = nodeMapper.argumentToParameter(node);
+        if (!Parameter.isOptional(parameter)) {
+            return;
+        }
+
+        if (!Argument.isNamed(node)) {
+            accept('error', 'Argument must be named if the parameter is optional.', {
+                node,
+                property: 'value',
+                code: CODE_ARGUMENT_POSITIONAL,
+            });
+        }
+    };
+};
diff --git a/packages/safe-ds-lang/src/language/validation/other/expressions/calls.ts b/packages/safe-ds-lang/src/language/validation/other/expressions/calls.ts
@@ -3,7 +3,7 @@ import { type SdsCall } from '../../../generated/ast.js';
 import { getArguments, Parameter } from '../../../helpers/nodeProperties.js';
 import { SafeDsServices } from '../../../safe-ds-module.js';
 
-export const CODE_CALL_CONSTANT_ARGUMENT = 'call/constant-argument';
+export const CODE_CALL_CONSTANT_ARGUMENT = 'call/non-constant-argument';
 export const CODE_CALL_INFINITE_RECURSION = 'call/infinite-recursion';
 
 export const callArgumentMustBeConstantIfParameterIsConstant = (services: SafeDsServices) => {

diff --git a/packages/safe-ds-lang/src/language/validation/safe-ds-validator.ts b/packages/safe-ds-lang/src/language/validation/safe-ds-validator.ts
@@ -192,22 +192,14 @@ import {
     outputStatementMustOnlyBeUsedInPipeline,
 } from './other/statements/outputStatements.js';
 import { messageOfConstraintsMustOnlyReferenceConstantParameters } from './other/declarations/constraints.js';
+import { argumentMustBeNamedIfParameterIsOptional } from './other/expressions/arguments.js';
 
 /**
  * Register custom validation checks.
  */
 export const registerValidationChecks = function (services: SafeDsServices) {
     const registry = services.validation.ValidationRegistry;
     const checks: ValidationChecks<SafeDsAstType> = {
-        SdsAssignee: [
-            assigneeAssignedResultShouldNotBeDeprecated(services),
-            assigneeAssignedResultShouldNotBeExperimental(services),
-        ],
-        SdsAssignment: [
-            assignmentAssigneeMustGetValue(services),
-            assignmentShouldNotImplicitlyIgnoreResult(services),
-            assignmentShouldHaveMoreThanWildcardsAsAssignees(services),
-        ],
         SdsAbstractCall: [
             argumentListMustNotHaveTooManyArguments(services),
             argumentListMustSetAllRequiredParameters(services),
@@ -230,11 +222,21 @@ export const registerValidationChecks = function (services: SafeDsServices) {
         SdsArgument: [
             argumentCorrespondingParameterShouldNotBeDeprecated(services),
             argumentCorrespondingParameterShouldNotBeExperimental(services),
+            argumentMustBeNamedIfParameterIsOptional(services),
         ],
         SdsArgumentList: [
             argumentListMustNotHavePositionalArgumentsAfterNamedArguments,
             argumentListMustNotSetParameterMultipleTimes(services),
         ],
+        SdsAssignee: [
+            assigneeAssignedResultShouldNotBeDeprecated(services),
+            assigneeAssignedResultShouldNotBeExperimental(services),
+        ],
+        SdsAssignment: [
+            assignmentAssigneeMustGetValue(services),
+            assignmentShouldNotImplicitlyIgnoreResult(services),
+            assignmentShouldHaveMoreThanWildcardsAsAssignees(services),
+        ],
         SdsAttribute: [attributeMustHaveTypeHint],
         SdsBlockLambda: [blockLambdaMustContainUniqueNames],
         SdsCall: [

diff --git a/...ther/expressions/arguments/must be named if parameter is optional/annotation calls.sdsdev b/...ther/expressions/arguments/must be named if parameter is optional/annotation calls.sdsdev
@@ -0,0 +1,19 @@
+package tests.validation.other.expressions.arguments.mustBeNamedIfParameterIsOptional
+
+@Repeatable
+annotation MyAnnotation(required: Int, optional: Int = 0)
+
+// $TEST$ no error "Argument must be named if the parameter is optional."
+// $TEST$ error "Argument must be named if the parameter is optional."
+@MyAnnotation(»1«, »2«)
+// $TEST$ no error "Argument must be named if the parameter is optional."
+// $TEST$ no error "Argument must be named if the parameter is optional."
+@MyAnnotation(»required = 1«, »optional = 2«)
+
+// $TEST$ no error "Argument must be named if the parameter is optional."
+@Unresolved(»1«)
+// $TEST$ no error "Argument must be named if the parameter is optional."
+@MyAnnotation(1, 2, »3«)
+// $TEST$ no error "Argument must be named if the parameter is optional."
+@MyAnnotation(unresolved = »1«)
+pipeline testPipeline {}
diff --git a/...alidation/other/expressions/arguments/must be named if parameter is optional/calls.sdsdev b/...alidation/other/expressions/arguments/must be named if parameter is optional/calls.sdsdev
@@ -0,0 +1,19 @@
+package tests.validation.other.expressions.arguments.mustBeNamedIfParameterIsOptional
+
+@Pure fun myFunction(required: Int, optional: Int = 0)
+
+pipeline testPipeline {
+    // $TEST$ no error "Argument must be named if the parameter is optional."
+    // $TEST$ error "Argument must be named if the parameter is optional."
+    myFunction(»1«, »2«);
+    // $TEST$ no error "Argument must be named if the parameter is optional."
+    // $TEST$ no error "Argument must be named if the parameter is optional."
+    myFunction(»required = 1«, »optional = 2«);
+
+    // $TEST$ no error "Argument must be named if the parameter is optional."
+    unresolved(»1«);
+    // $TEST$ no error "Argument must be named if the parameter is optional."
+    myFunction(1, 2, »3«);
+    // $TEST$ no error "Argument must be named if the parameter is optional."
+    myFunction(unresolved = »1«);
+}