Adding notcheckdeadcode option #633

Ao-senXiong · 2023-11-25T14:00:27Z

Fixes #627

Do you need more test cases on this option?

wmdietl

Thanks for starting work on this issue!
At the moment this isn't tested at all, so please do add a new test directory that enables the option.
When I tried it before, there was a problem with the Nullness Checker, so do use that.
Write tests e.g. like the one in the issue and things like an empty try block where an impossible catch block does something bad.

wmdietl · 2023-11-25T15:03:52Z

framework/src/main/java/org/checkerframework/framework/source/SourceChecker.java

@@ -150,6 +150,9 @@
    // org.checkerframework.framework.source.SourceChecker.report
    "warns",

+    // Make checker ignore the expression in dead branch
+    "notCheckDeadCode",


How about ignoreDeadCode to have more symmetry with other ignoreXXX options?

By convention, for each option we list the main point where that option is used. Please add such a reference.

By convention, for each option we list the main point where that option is used. Please add such a reference.

Thanks, already addressed the comment in 1d1c348

How about ignoreDeadCode to have more symmetry with other ignoreXXX options?

addressed this comment in 58f4773

wmdietl · 2023-11-25T15:05:31Z

framework/src/main/java/org/checkerframework/framework/type/GenericAnnotatedTypeFactory.java

-                                 }
-                             });
-        */
+        if (checker.hasOption("notCheckDeadCode")) {


Here, and probably in the BaseTypeVisitor, put the option into a protected variable, so that we don't look up the option multiple times. See how other options are handled.

Here, and probably in the BaseTypeVisitor, put the option into a protected variable, so that we don't look up the option multiple times. See how other options are handled.

addressed this comment in 2540cd3

Ao-senXiong · 2023-11-25T18:54:03Z

Thanks for starting work on this issue! At the moment this isn't tested at all, so please do add a new test directory that enables the option. When I tried it before, there was a problem with the Nullness Checker, so do use that. Write tests e.g. like the one in the issue and things like an empty try block where an impossible catch block does something bad.

Thanks, I will add test cases later.

wmdietl

@Ao-senXiong Were there more tests you wanted to add? Can you wrap up this PR?

wmdietl · 2024-06-26T13:43:45Z

framework/src/main/java/org/checkerframework/framework/source/SourceChecker.java

@@ -150,6 +150,10 @@
    // org.checkerframework.framework.source.SourceChecker.report
    "warns",

+    // Make checker ignore the expression in dead branch
+    // org.checkerframework.framework.common.basetype.BaseTypeVisitor.shouldSkipUses
+    "ignoreCheckDeadCode",


As noted in #633 (comment) ignoreDeadCode would seem simpler.

wmdietl · 2024-06-26T13:44:19Z

checker/tests/nullness-deadbranch/DeadBranchNPE.java

@@ -0,0 +1,31 @@
+// @skip-test until the bug is fixed


Do these tests not work?

wmdietl · 2024-06-26T13:44:48Z

checker/tests/nullness-deadbranch/DeadBranchNPE.java

+        // :: error: (dereference.of.nullable)
+        obj.toString();
+        for (int i = 0; i < 0; i++) {
+            obj.toString();


Add a comment to each dead branch why they are dead.

wmdietl · 2024-06-26T13:45:12Z

docs/CHANGELOG.md

@@ -3,6 +3,9 @@ Version 3.40.0-eisop3 (November ??, 2023)

 **User-visible changes:**

+Add a new command-line argument `-AignoreCheckDeadCode` disables the checker for code in dead expression.


When you update the branch, make sure to move this to the next upcoming release.

And try to make this sentence easier to read.

wmdietl · 2024-06-26T13:45:39Z

framework/src/main/java/org/checkerframework/common/basetype/BaseTypeVisitor.java

-        //     return true;
-        // }
+        if (ignoreCheckDeadCode) {
+            System.out.printf("shouldSkipUses: %s: %s%n", exprTree.getClass(), exprTree);


This is debugging output and should remain a comment.

Also, the debugging output shouldn't be guarded by the new condition.
You can combine the two 'if's into one check.

wmdietl · 2024-06-26T13:46:48Z

checker/src/main/java/org/checkerframework/checker/nullness/NullnessNoInitVisitor.java

-        // if (atypeFactory.isUnreachable(tree)) {
-        //     return super.visitMemberSelect(tree, p);
-        // }
+        if (ignoreCheckDeadCode) {


Why make these two separate 'if's?

wmdietl · 2024-06-26T13:47:33Z

checker/src/test/java/org/checkerframework/checker/test/junit/NullnessDeadBranchTest.java

+
+    @Parameterized.Parameters
+    public static String[] getTestDirs() {
+        return new String[] {"nullness-deadbranch"};


How about nullness-ignoredeadcode to name the directory after the option?

wmdietl · 2024-06-26T13:49:22Z

docs/CHANGELOG.md

@@ -3,6 +3,9 @@ Version 3.40.0-eisop3 (November ??, 2023)

 **User-visible changes:**

+Add a new command-line argument `-AignoreCheckDeadCode` disables the checker for code in dead expression.
+This option is not enabled by default.


Please also add documentation in the manual, where we have a short paragraph for each option.

Ao-senXiong and others added 2 commits November 25, 2023 08:58

initial commit for adding notcheckdeadcode option

7102456

Merge branch 'master' into add-not-check-dead-code-option

bd2e5e7

wmdietl requested changes Nov 25, 2023

View reviewed changes

wmdietl assigned Ao-senXiong Nov 25, 2023

Ao-senXiong and others added 5 commits November 25, 2023 13:27

change option name to ignoreCheckDeadCode

58f4773

add comment for entry point of the option

1d1c348

add protect variable of checker option

2540cd3

add * make javadoc happy

02c69a8

Merge branch 'master' into add-not-check-dead-code-option

a3e4013

add deadbranch test case and skip the test first

73de62f

wmdietl requested changes Jun 26, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding notcheckdeadcode option #633

Adding notcheckdeadcode option #633

Ao-senXiong commented Nov 25, 2023

wmdietl left a comment

wmdietl Nov 25, 2023

wmdietl Nov 25, 2023

Ao-senXiong Nov 25, 2023

Ao-senXiong Nov 25, 2023

wmdietl Nov 25, 2023

Ao-senXiong Nov 25, 2023

Ao-senXiong commented Nov 25, 2023

wmdietl left a comment

wmdietl Jun 26, 2024

wmdietl Jun 26, 2024

wmdietl Jun 26, 2024

wmdietl Jun 26, 2024

wmdietl Jun 26, 2024

wmdietl Jun 26, 2024

wmdietl Jun 26, 2024

wmdietl Jun 26, 2024

wmdietl Jun 26, 2024

wmdietl Jun 26, 2024

		@@ -3,6 +3,9 @@ Version 3.40.0-eisop3 (November ??, 2023)

		User-visible changes:

		Add a new command-line argument `-AignoreCheckDeadCode` disables the checker for code in dead expression.

Adding notcheckdeadcode option #633

Are you sure you want to change the base?

Adding notcheckdeadcode option #633

Conversation

Ao-senXiong commented Nov 25, 2023

wmdietl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ao-senXiong commented Nov 25, 2023

wmdietl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment