Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: warning if literal types or union types have duplicate entries #658

Merged
merged 4 commits into from
Oct 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
"configurationDefaults": {
"[safe-ds]": {
"editor.semanticHighlighting.enabled": true,
"editor.wordSeparators": "`~!@#$%^&*()-=+[]{}\\|;:'\",.<>/?»«",
"editor.wordSeparators": "`~!@#%^&*()-=+[]{}\\|;:'\",.<>/?»«",
"files.trimTrailingWhitespace": true
}
}
Expand Down
3 changes: 3 additions & 0 deletions src/language/typing/safe-ds-type-computer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ import {
isSdsSegment,
isSdsTemplateString,
isSdsType,
isSdsTypeArgument,
isSdsTypeProjection,
isSdsUnionType,
isSdsYield,
Expand Down Expand Up @@ -140,6 +141,8 @@ export class SafeDsTypeComputer {
return this.computeTypeOfExpression(node);
} else if (isSdsType(node)) {
return this.computeTypeOfType(node);
} else if (isSdsTypeArgument(node)) {
return this.computeType(node.value);
} else if (isSdsTypeProjection(node)) {
return this.computeTypeOfType(node.type);
} /* c8 ignore start */ else {
Expand Down
28 changes: 26 additions & 2 deletions src/language/validation/other/types/literalTypes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,20 @@ import { isSdsList, isSdsMap, SdsLiteralType } from '../../../generated/ast.js';
import { ValidationAcceptor } from 'langium';
import { literalsOrEmpty } from '../../../helpers/nodeProperties.js';
import { isEmpty } from 'radash';
import { SafeDsServices } from '../../../safe-ds-module.js';
import { EvaluatedNode } from '../../../partialEvaluation/model.js';

export const CODE_UNION_TYPE_MISSING_LITERALS = 'union-type/missing-literals';
export const CODE_LITERAL_TYPE_DUPLICATE_LITERAL = 'literal-type/duplicate-literal';
export const CODE_LITERAL_TYPE_LIST_LITERAL = 'literal-type/list-literal';
export const CODE_LITERAL_TYPE_MAP_LITERAL = 'literal-type/map-literal';
export const CODE_LITERAL_TYPE_MISSING_LITERALS = 'literal-type/missing-literals';

export const literalTypeMustHaveLiterals = (node: SdsLiteralType, accept: ValidationAcceptor): void => {
if (isEmpty(literalsOrEmpty(node))) {
accept('error', 'A literal type must have at least one literal.', {
node,
property: 'literalList',
code: CODE_UNION_TYPE_MISSING_LITERALS,
code: CODE_LITERAL_TYPE_MISSING_LITERALS,
});
}
};
Expand All @@ -38,3 +41,24 @@ export const literalTypeMustNotContainMapLiteral = (node: SdsLiteralType, accept
}
}
};

export const literalTypeShouldNotHaveDuplicateLiteral = (services: SafeDsServices) => {
const partialEvaluator = services.evaluation.PartialEvaluator;

return (node: SdsLiteralType, accept: ValidationAcceptor): void => {
const literals = literalsOrEmpty(node);
const constants: EvaluatedNode[] = [];

for (const literal of literals) {
const constant = partialEvaluator.evaluate(literal);
if (constants.some((it) => it.equals(constant))) {
accept('warning', `The literal ${constant.toString()} was already listed.`, {
node: literal,
code: CODE_LITERAL_TYPE_DUPLICATE_LITERAL,
});
} else {
constants.push(constant);
}
}
};
};
32 changes: 28 additions & 4 deletions src/language/validation/other/types/unionTypes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,39 @@ import { SdsUnionType } from '../../../generated/ast.js';
import { ValidationAcceptor } from 'langium';
import { isEmpty } from 'radash';
import { typeArgumentsOrEmpty } from '../../../helpers/nodeProperties.js';
import { SafeDsServices } from '../../../safe-ds-module.js';
import { Type } from '../../../typing/model.js';

export const CODE_UNION_TYPE_MISSING_TYPE_ARGUMENTS = 'union-type/missing-type-arguments';
export const CODE_UNION_TYPE_DUPLICATE_TYPE = 'union-type/duplicate-type';
export const CODE_UNION_TYPE_MISSING_TYPES = 'union-type/missing-types';

export const unionTypeMustHaveTypeArguments = (node: SdsUnionType, accept: ValidationAcceptor): void => {
export const unionTypeMustHaveTypes = (node: SdsUnionType, accept: ValidationAcceptor): void => {
if (isEmpty(typeArgumentsOrEmpty(node.typeArgumentList))) {
accept('error', 'A union type must have at least one type argument.', {
accept('error', 'A union type must have at least one type.', {
node,
property: 'typeArgumentList',
code: CODE_UNION_TYPE_MISSING_TYPE_ARGUMENTS,
code: CODE_UNION_TYPE_MISSING_TYPES,
});
}
};

export const unionTypeShouldNotHaveDuplicateTypes = (services: SafeDsServices) => {
const typeComputer = services.types.TypeComputer;

return (node: SdsUnionType, accept: ValidationAcceptor): void => {
const typeArguments = typeArgumentsOrEmpty(node.typeArgumentList);
const knownTypes: Type[] = [];

for (const typeArgument of typeArguments) {
const type = typeComputer.computeType(typeArgument);
if (knownTypes.some((it) => it.equals(type))) {
accept('warning', `The type '${type.toString()}' was already listed.`, {
node: typeArgument,
code: CODE_UNION_TYPE_DUPLICATE_TYPE,
});
} else {
knownTypes.push(type);
}
}
};
};
10 changes: 8 additions & 2 deletions src/language/validation/safe-ds-validator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ import {
import { moduleDeclarationsMustMatchFileKind, moduleWithDeclarationsMustStatePackage } from './other/modules.js';
import { typeParameterConstraintLeftOperandMustBeOwnTypeParameter } from './other/declarations/typeParameterConstraints.js';
import { parameterListMustNotHaveRequiredParametersAfterOptionalParameters } from './other/declarations/parameterLists.js';
import { unionTypeMustHaveTypeArguments } from './other/types/unionTypes.js';
import { unionTypeMustHaveTypes, unionTypeShouldNotHaveDuplicateTypes } from './other/types/unionTypes.js';
import {
callableTypeMustNotHaveOptionalParameters,
callableTypeParameterMustNotHaveConstModifier,
Expand Down Expand Up @@ -124,6 +124,7 @@ import {
literalTypeMustHaveLiterals,
literalTypeMustNotContainListLiteral,
literalTypeMustNotContainMapLiteral,
literalTypeShouldNotHaveDuplicateLiteral,
} from './other/types/literalTypes.js';

/**
Expand Down Expand Up @@ -211,6 +212,7 @@ export const registerValidationChecks = function (services: SafeDsServices) {
literalTypeMustNotContainListLiteral,
literalTypeMustNotContainMapLiteral,
literalTypesShouldBeUsedWithCaution,
literalTypeShouldNotHaveDuplicateLiteral(services),
],
SdsMap: [mapsShouldBeUsedWithCaution],
SdsMemberAccess: [
Expand Down Expand Up @@ -261,7 +263,11 @@ export const registerValidationChecks = function (services: SafeDsServices) {
SdsTemplateString: [templateStringMustHaveExpressionBetweenTwoStringParts],
SdsTypeParameterConstraint: [typeParameterConstraintLeftOperandMustBeOwnTypeParameter],
SdsTypeParameterList: [typeParameterListShouldNotBeEmpty],
SdsUnionType: [unionTypeMustHaveTypeArguments, unionTypeShouldNotHaveASingularTypeArgument],
SdsUnionType: [
unionTypeMustHaveTypes,
unionTypeShouldNotHaveDuplicateTypes(services),
unionTypeShouldNotHaveASingularTypeArgument,
],
SdsYield: [yieldMustNotBeUsedInPipeline],
};
registry.register(checks);
Expand Down
29 changes: 29 additions & 0 deletions tests/resources/typing/types/type arguments/main.sdstest
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package tests.typing.types.typeArguments

class MyClass<T>

enum MyEnum {
MyEnumVariant<T>
}

fun myFunction(
// $TEST$ serialization Int
a: MyClass<»Int«>,
// $TEST$ serialization Int
b: MyClass<»T = Int«>,

// $TEST$ serialization String
c: MyEnum.MyEnumVariant<»T = String«>,
// $TEST$ serialization String
d: MyEnum.MyEnumVariant<»T = String«>,

// $TEST$ serialization Boolean
e: unresolved<»Boolean«>,
// $TEST$ serialization Boolean
f: unresolved<»T = Boolean«>,

// $TEST$ serialization $Unknown
g: MyClass<»unresolved«>,
// $TEST$ serialization $Unknown
h: MyClass<»T = unresolved«>,
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package tests.validation.other.types.literalTypes.duplicateLiterals

// $TEST$ no warning r"The literal .* was already listed."

segment mySegment1(
p: literal<>
) {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package tests.validation.other.types.literalTypes.duplicateLiterals

segment mySegment(
// $TEST$ no warning r"The literal .* was already listed."
p: literal<»1«>,
q: literal<
// $TEST$ no warning r"The literal .* was already listed."
»1«,
// $TEST$ no warning r"The literal .* was already listed."
»2«,
// $TEST$ warning r"The literal 1 was already listed."
»1«,
>,
) {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package tests.validation.other.types.unionTypes.duplicateTypes

// $TEST$ no warning r"The type .* was already listed."

segment mySegment1(
p: union<>
) {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package tests.validation.other.types.unionTypes.duplicateTypes

segment mySegment(
// $TEST$ no warning r"The type .* was already listed."
p: union<»Int«>,
q: union<
// $TEST$ no warning r"The type .* was already listed."
»Int«,
// $TEST$ no warning r"The type .* was already listed."
»String«,
// $TEST$ warning r"The type 'Int' was already listed."
»Int«,
>,
) {}

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
package tests.validation.other.types.unionTypes.mustHaveTypes

// $TEST$ error "A union type must have at least one type."
segment mySegment1(
p: union»<>«
) {}

// $TEST$ no error "A union type must have at least one type."
segment mySegment2(
p: union»<Int>«
) {}

// $TEST$ no error "A union type must have at least one type."
segment mySegment3(
p: union»<Int, Float>«
) {}