Skip to content

Fix FPs around binary expressions in PlatformDependentTruncation #320

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

Merged
merged 1 commit into from
Dec 6, 2024
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed

- Various intrinsic routines had incorrect signatures around dynamic and open arrays.
- False positives around platform-dependent binary expressions in `PlatformDependentTruncation`.

## [1.12.0] - 2024-12-02

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import org.sonar.plugins.communitydelphi.api.ast.ArgumentListNode;
import org.sonar.plugins.communitydelphi.api.ast.ArgumentNode;
import org.sonar.plugins.communitydelphi.api.ast.AssignmentStatementNode;
import org.sonar.plugins.communitydelphi.api.ast.BinaryExpressionNode;
import org.sonar.plugins.communitydelphi.api.ast.ExpressionNode;
import org.sonar.plugins.communitydelphi.api.ast.NameReferenceNode;
import org.sonar.plugins.communitydelphi.api.ast.Node;
Expand All @@ -44,7 +45,7 @@ public class PlatformDependentTruncationCheck extends DelphiCheck {

@Override
public DelphiCheckContext visit(AssignmentStatementNode assignment, DelphiCheckContext context) {
if (isViolation(assignment.getValue().getType(), assignment.getAssignee().getType())) {
if (isViolation(assignment.getValue(), assignment.getAssignee().getType())) {
reportIssue(context, assignment, MESSAGE);
}
return super.visit(assignment, context);
Expand All @@ -66,7 +67,7 @@ public DelphiCheckContext visit(ArgumentListNode argumentList, DelphiCheckContex
List<Parameter> parameters = procedural.parameters();
for (int i = 0; i < arguments.size() && i < parameters.size(); ++i) {
ExpressionNode argument = arguments.get(i).getExpression();
if (isViolation(argument.getType(), parameters.get(i).getType())) {
if (isViolation(argument, parameters.get(i).getType())) {
reportIssue(context, argument, MESSAGE);
}
}
Expand All @@ -84,16 +85,26 @@ private static ProceduralType getProceduralType(NameReferenceNode reference) {
return null;
}

private static boolean isViolation(Type from, Type to) {
if (!from.isInteger() || !to.isInteger()) {
private static boolean isViolation(ExpressionNode from, Type to) {
if (!from.getType().isInteger() || !to.isInteger()) {
return false;
}

if (isNativeInteger(from) == isNativeInteger(to)) {
return false;
}

return (isNativeInteger(from) && to.size() < 8) || (isNativeInteger(to) && from.size() > 4);
return (isNativeInteger(from) && to.size() < 8)
|| (isNativeInteger(to) && from.getType().size() > 4);
}

private static boolean isNativeInteger(ExpressionNode expression) {
expression = expression.skipParentheses();
if (expression instanceof BinaryExpressionNode) {
BinaryExpressionNode binary = (BinaryExpressionNode) expression;
return isNativeInteger(binary.getLeft()) || isNativeInteger(binary.getRight());
}
return isNativeInteger(expression.getType());
}

private static boolean isNativeInteger(Type type) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import au.com.integradev.delphi.builders.DelphiTestUnitBuilder;
import au.com.integradev.delphi.checks.verifier.CheckVerifier;
import au.com.integradev.delphi.compiler.CompilerVersion;
import au.com.integradev.delphi.compiler.Toolchain;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;

Expand Down Expand Up @@ -207,4 +208,78 @@ void testNativeIntArgumentToNativeIntParameterShouldNotAddIssue(String versionSy
.appendImpl("end;"))
.verifyNoIssues();
}

@ParameterizedTest
@ValueSource(strings = {VERSION_ALEXANDRIA, VERSION_ATHENS})
void testNativeIntAssignmentInBinaryExpressionShouldNotAddIssue(String versionSymbol) {
CheckVerifier.newVerifier()
.withCheck(new PlatformDependentTruncationCheck())
.withCompilerVersion(CompilerVersion.fromVersionSymbol(versionSymbol))
.withToolchain(Toolchain.DCC64)
.onFile(
new DelphiTestUnitBuilder()
.appendImpl("procedure Foo;")
.appendImpl("var")
.appendImpl(" Nat: NativeInt;")
.appendImpl("begin")
.appendImpl(" Nat := Nat + 1;")
.appendImpl("end;"))
.verifyNoIssues();
}

@ParameterizedTest
@ValueSource(strings = {VERSION_ALEXANDRIA, VERSION_ATHENS})
void testNativeIntArgumentInBinaryExpressionShouldNotAddIssue(String versionSymbol) {
CheckVerifier.newVerifier()
.withCheck(new PlatformDependentTruncationCheck())
.withCompilerVersion(CompilerVersion.fromVersionSymbol(versionSymbol))
.withToolchain(Toolchain.DCC64)
.onFile(
new DelphiTestUnitBuilder()
.appendDecl("procedure Bar(Nat: NativeInt);")
.appendImpl("procedure Foo;")
.appendImpl("var")
.appendImpl(" Nat: NativeInt;")
.appendImpl("begin")
.appendImpl(" Bar(Nat + 1);")
.appendImpl("end;"))
.verifyNoIssues();
}

@ParameterizedTest
@ValueSource(strings = {VERSION_ALEXANDRIA, VERSION_ATHENS})
void testNativeIntAssignmentInNestedBinaryExpressionShouldNotAddIssue(String versionSymbol) {
CheckVerifier.newVerifier()
.withCheck(new PlatformDependentTruncationCheck())
.withCompilerVersion(CompilerVersion.fromVersionSymbol(versionSymbol))
.withToolchain(Toolchain.DCC64)
.onFile(
new DelphiTestUnitBuilder()
.appendImpl("procedure Foo;")
.appendImpl("var")
.appendImpl(" Nat: NativeInt;")
.appendImpl("begin")
.appendImpl(" Nat := (Nat + 1) + 1;")
.appendImpl("end;"))
.verifyNoIssues();
}

@ParameterizedTest
@ValueSource(strings = {VERSION_ALEXANDRIA, VERSION_ATHENS})
void testPlatformDependentCastInBinaryExpressionShouldNotAddIssue(String versionSymbol) {
CheckVerifier.newVerifier()
.withCheck(new PlatformDependentTruncationCheck())
.withCompilerVersion(CompilerVersion.fromVersionSymbol(versionSymbol))
.withToolchain(Toolchain.DCC64)
.onFile(
new DelphiTestUnitBuilder()
.appendImpl("procedure Foo;")
.appendImpl("var")
.appendImpl(" Int: Integer;")
.appendImpl(" Nat: NativeInt;")
.appendImpl("begin")
.appendImpl(" Int := Integer(Nat) + 1;")
.appendImpl("end;"))
.verifyNoIssues();
}
}
Loading