Skip to content

Remove @RelevantJavaTypes annotation from SameLenChecker #6256

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 2 commits into from
Oct 24, 2023
Merged

Remove @RelevantJavaTypes annotation from SameLenChecker #6256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b947f16
Remove `@RelevantJavaTypes` annotation from `SameLenChecker`
mernst Oct 23, 2023
8197f24
Update test
mernst Oct 23, 2023
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
5 changes: 3 additions & 2 deletions checker/src/main/java/org/checkerframework/checker/index/samelen/SameLenChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package org.checkerframework.checker.index.samelen;

import org.checkerframework.common.basetype.BaseTypeChecker;
import org.checkerframework.framework.qual.RelevantJavaTypes;
import org.checkerframework.framework.source.SuppressWarningsPrefix;

/**
Expand All @@ -10,7 +9,9 @@
*
* @checker_framework.manual #index-checker Index Checker
*/
@RelevantJavaTypes({CharSequence.class, Object[].class, Object.class})
// This @RelevantJavaTypes annotation is incorrect, because @SameLen can apply to an arbitrary
// user-defined datatype: https://checkerframework.org/manual/#index-annotating-fixed-size .
// @RelevantJavaTypes({CharSequence.class, Object[].class, Object.class})
@SuppressWarningsPrefix({"index", "samelen"})
public class SameLenChecker extends BaseTypeChecker {
/** Create a new SameLenChecker. */
Expand Down
10 changes: 7 additions & 3 deletions checker/tests/index/SameLenIrrelevant.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
// Tests that adding an @SameLen annotation to a primitive type is still
// an error.

// All the errors in this test case are disabled. They were issued when `@SameLen` was restricted
// to arrays and CharSequence, but @SameLen can be written on an arbitrary user-defined type:
// https://checkerframework.org/manual/#index-annotating-fixed-size .
Copy link
Contributor

@kelloggm kelloggm Oct 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be better for these errors, which are on primitive types, to be preserved: @SameLen is fine on array, CharSequences, and user-defined types, but it does not make sense on primitives.

Is there a way to use @RelevantJavaTypes to express that? Maybe it needs to be done procedurally?

Copy link
Member Author

@mernst mernst Oct 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that behavior is desirable. There is not a way for @RelevantJavaTypes to express that fact. We could add such a mechanism, or we could enforce the constraint procedurally. I think those belong in a different pull request than this one, which exists to unblock #6254.

Copy link
Contributor

@kelloggm kelloggm Oct 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is not a way for @RelevantJavaTypes to express that fact

Thanks for confirming. We can address it in a later PR.


import org.checkerframework.checker.index.qual.SameLen;

public class SameLenIrrelevant {
// :: error: (anno.on.irrelevant)
// NO :: error: (anno.on.irrelevant)
public void test(@SameLen("#2") int x, int y) {
// do nothing
}

// :: error: (anno.on.irrelevant)
// NO :: error: (anno.on.irrelevant)
public void test(@SameLen("#2") double x, double y) {
// do nothing
}

// :: error: (anno.on.irrelevant)
// NO :: error: (anno.on.irrelevant)
public void test(@SameLen("#2") char x, char y) {
// do nothing
}
Expand Down