Skip to content

Handle inline var and const in PlatformDependentTruncation #355

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.

Sign up for GitHub

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
Mar 31, 2025
Merged

Handle inline var and const in PlatformDependentTruncation #355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- False positives from case statements in `LoopExecutingAtMostOnce`.
- False positives from nested finally-except blocks in `RedundantJump`.
- False positives around wrapped type declarations in `VisibilityKeywordIndentation`.
- False negatives around inline `var` and `const` in `PlatformDependentTruncation`.
- Trailing whitespace within comments not recognized in `TrailingWhitespace`.
- Several compiler directives were not being recognized:
- `E`
Expand Down
27 changes: 27 additions & 0 deletions ...hecks/src/main/java/au/com/integradev/delphi/checks/PlatformDependentTruncationCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,18 @@
package au.com.integradev.delphi.checks;

import java.util.List;
import javax.annotation.Nullable;
import org.sonar.check.Rule;
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.ConstStatementNode;
import org.sonar.plugins.communitydelphi.api.ast.ExpressionNode;
import org.sonar.plugins.communitydelphi.api.ast.NameReferenceNode;
import org.sonar.plugins.communitydelphi.api.ast.Node;
import org.sonar.plugins.communitydelphi.api.ast.TypeNode;
import org.sonar.plugins.communitydelphi.api.ast.VarStatementNode;
import org.sonar.plugins.communitydelphi.api.check.DelphiCheck;
import org.sonar.plugins.communitydelphi.api.check.DelphiCheckContext;
import org.sonar.plugins.communitydelphi.api.symbol.declaration.NameDeclaration;
Expand All @@ -51,6 +55,22 @@ public DelphiCheckContext visit(AssignmentStatementNode assignment, DelphiCheckC
return super.visit(assignment, context);
}

@Override
public DelphiCheckContext visit(VarStatementNode varStatement, DelphiCheckContext context) {
if (isViolation(varStatement.getExpression(), varStatement.getTypeNode())) {
reportIssue(context, varStatement, MESSAGE);
}
return super.visit(varStatement, context);
}

@Override
public DelphiCheckContext visit(ConstStatementNode constStatement, DelphiCheckContext context) {
if (isViolation(constStatement.getExpression(), constStatement.getTypeNode())) {
reportIssue(context, constStatement, MESSAGE);
}
return super.visit(constStatement, context);
}

@Override
public DelphiCheckContext visit(ArgumentListNode argumentList, DelphiCheckContext context) {
Node previous = argumentList.getParent().getChild(argumentList.getChildIndex() - 1);
Expand Down Expand Up @@ -85,6 +105,13 @@ private static ProceduralType getProceduralType(NameReferenceNode reference) {
return null;
}

private static boolean isViolation(@Nullable ExpressionNode from, @Nullable TypeNode to) {
if (from == null || to == null) {
return false;
}
return isViolation(from, to.getType());
}

private static boolean isViolation(ExpressionNode from, Type to) {
if (!from.getType().isInteger() || !to.isInteger()) {
return false;
Expand Down
219 changes: 219 additions & 0 deletions ...s/src/test/java/au/com/integradev/delphi/checks/PlatformDependentTruncationCheckTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,4 +282,223 @@ void testPlatformDependentCastInBinaryExpressionShouldNotAddIssue(String version
.appendImpl("end;"))
.verifyNoIssues();
}

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

@ParameterizedTest
@ValueSource(strings = {VERSION_ALEXANDRIA, VERSION_ATHENS})
void testInt64ToNativeIntInlineVarAssignmentShouldAddIssue(String versionSymbol) {
CheckVerifier.newVerifier()
.withCheck(new PlatformDependentTruncationCheck())
.withCompilerVersion(CompilerVersion.fromVersionSymbol(versionSymbol))
.onFile(
new DelphiTestUnitBuilder()
.appendImpl("procedure Foo;")
.appendImpl("var")
.appendImpl(" I64: Int64;")
.appendImpl("begin")
.appendImpl(" var Nat: NativeInt := I64; // Noncompliant")
.appendImpl("end;"))
.verifyIssues();
}

@ParameterizedTest
@ValueSource(strings = {VERSION_ALEXANDRIA, VERSION_ATHENS})
void testNativeIntToIntegerInlineVarAssignmentShouldAddIssue(String versionSymbol) {
CheckVerifier.newVerifier()
.withCheck(new PlatformDependentTruncationCheck())
.withCompilerVersion(CompilerVersion.fromVersionSymbol(versionSymbol))
.onFile(
new DelphiTestUnitBuilder()
.appendImpl("procedure Foo;")
.appendImpl("var")
.appendImpl(" Nat: NativeInt;")
.appendImpl("begin")
.appendImpl(" var Int: Integer := Nat; // Noncompliant")
.appendImpl("end;"))
.verifyIssues();
}

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

@ParameterizedTest
@ValueSource(strings = {VERSION_ALEXANDRIA, VERSION_ATHENS})
void testNativeIntToNativeIntInlineVarAssignmentShouldNotAddIssue(String versionSymbol) {
CheckVerifier.newVerifier()
.withCheck(new PlatformDependentTruncationCheck())
.withCompilerVersion(CompilerVersion.fromVersionSymbol(versionSymbol))
.onFile(
new DelphiTestUnitBuilder()
.appendImpl("procedure Foo;")
.appendImpl("var")
.appendImpl(" Nat2: NativeInt;")
.appendImpl("begin")
.appendImpl(" var Nat1: NativeInt := Nat2;")
.appendImpl("end;"))
.verifyNoIssues();
}

@ParameterizedTest
@ValueSource(strings = {VERSION_ALEXANDRIA, VERSION_ATHENS})
void testNativeIntToTypeInferredInlineVarAssignmentShouldNotAddIssue(String versionSymbol) {
CheckVerifier.newVerifier()
.withCheck(new PlatformDependentTruncationCheck())
.withCompilerVersion(CompilerVersion.fromVersionSymbol(versionSymbol))
.onFile(
new DelphiTestUnitBuilder()
.appendImpl("procedure Foo;")
.appendImpl("var")
.appendImpl(" Nat2: NativeInt;")
.appendImpl("begin")
.appendImpl(" var Nat1 := Nat2;")
.appendImpl("end;"))
.verifyNoIssues();
}

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

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

@ParameterizedTest
@ValueSource(strings = {VERSION_ALEXANDRIA, VERSION_ATHENS})
void testInt64ToNativeIntInlineConstAssignmentShouldAddIssue(String versionSymbol) {
CheckVerifier.newVerifier()
.withCheck(new PlatformDependentTruncationCheck())
.withCompilerVersion(CompilerVersion.fromVersionSymbol(versionSymbol))
.onFile(
new DelphiTestUnitBuilder()
.appendImpl("procedure Foo;")
.appendImpl("var")
.appendImpl(" I64: Int64;")
.appendImpl("begin")
.appendImpl(" const Nat: NativeInt = I64; // Noncompliant")
.appendImpl("end;"))
.verifyIssues();
}

@ParameterizedTest
@ValueSource(strings = {VERSION_ALEXANDRIA, VERSION_ATHENS})
void testNativeIntToIntegerInlineConstAssignmentShouldAddIssue(String versionSymbol) {
CheckVerifier.newVerifier()
.withCheck(new PlatformDependentTruncationCheck())
.withCompilerVersion(CompilerVersion.fromVersionSymbol(versionSymbol))
.onFile(
new DelphiTestUnitBuilder()
.appendImpl("procedure Foo;")
.appendImpl("var")
.appendImpl(" Nat: NativeInt;")
.appendImpl("begin")
.appendImpl(" const Int: Integer = Nat; // Noncompliant")
.appendImpl("end;"))
.verifyIssues();
}

@ParameterizedTest
@ValueSource(strings = {VERSION_ALEXANDRIA, VERSION_ATHENS})
void testNativeIntToI64InlineConstAssignmentShouldNotAddIssue(String versionSymbol) {
CheckVerifier.newVerifier()
.withCheck(new PlatformDependentTruncationCheck())
.withCompilerVersion(CompilerVersion.fromVersionSymbol(versionSymbol))
.onFile(
new DelphiTestUnitBuilder()
.appendImpl("procedure Foo;")
.appendImpl("var")
.appendImpl(" Nat: NativeInt;")
.appendImpl("begin")
.appendImpl(" const I64: Int64 = Nat;")
.appendImpl("end;"))
.verifyNoIssues();
}

@ParameterizedTest
@ValueSource(strings = {VERSION_ALEXANDRIA, VERSION_ATHENS})
void testNativeIntToNativeIntInlineConstAssignmentShouldNotAddIssue(String versionSymbol) {
CheckVerifier.newVerifier()
.withCheck(new PlatformDependentTruncationCheck())
.withCompilerVersion(CompilerVersion.fromVersionSymbol(versionSymbol))
.onFile(
new DelphiTestUnitBuilder()
.appendImpl("procedure Foo;")
.appendImpl("var")
.appendImpl(" Nat2: NativeInt;")
.appendImpl("begin")
.appendImpl(" const Nat1: NativeInt = Nat2;")
.appendImpl("end;"))
.verifyNoIssues();
}

@ParameterizedTest
@ValueSource(strings = {VERSION_ALEXANDRIA, VERSION_ATHENS})
void testNativeIntToTypeInferredInlineConstAssignmentShouldNotAddIssue(String versionSymbol) {
CheckVerifier.newVerifier()
.withCheck(new PlatformDependentTruncationCheck())
.withCompilerVersion(CompilerVersion.fromVersionSymbol(versionSymbol))
.onFile(
new DelphiTestUnitBuilder()
.appendImpl("procedure Foo;")
.appendImpl("var")
.appendImpl(" Nat2: NativeInt;")
.appendImpl("begin")
.appendImpl(" const Nat1 = Nat2;")
.appendImpl("end;"))
.verifyNoIssues();
}
}