org.checkerframework.checker.signedness

Class SignednessVisitor

java.lang.Object

com.sun.source.util.TreeScanner<R,P>

com.sun.source.util.TreePathScanner<R,P>

org.checkerframework.framework.source.SourceVisitor<java.lang.Void,java.lang.Void>

org.checkerframework.common.basetype.BaseTypeVisitor<SignednessAnnotatedTypeFactory>

org.checkerframework.checker.signedness.SignednessVisitor

All Implemented Interfaces:

com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

public class SignednessVisitor
extends BaseTypeVisitor<SignednessAnnotatedTypeFactory>

The SignednessVisitor enforces the Signedness Checker rules. These rules are described in the Checker Framework Manual.

See the Checker Framework Manual:

Signedness Checker

Nested Class Summary

Nested classes/interfaces inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

BaseTypeVisitor.OverrideChecker

Field Summary

Fields inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

atypeFactory, checker, contractsUtils, positions, TARGET, targetValueElement, typeValidator, visitorState

Fields inherited from class org.checkerframework.framework.source.SourceVisitor

elements, root, trees, treesWithSuppressWarnings, types

Constructor Summary

Constructors

Constructor and Description
SignednessVisitor(BaseTypeChecker checker)

Method Summary

Modifier and Type	Method and Description
java.lang.Void	visitBinary(com.sun.source.tree.BinaryTree node, java.lang.Void p) Enforces the following rules on binary operations involving Unsigned and Signed types: Do not allow any Unsigned types or PolySigned types in {/, %} operations.
java.lang.Void	visitCompoundAssignment(com.sun.source.tree.CompoundAssignmentTree node, java.lang.Void p) Enforces the following rules on compound assignments involving Unsigned and Signed types: Do not allow any Unsigned types or PolySigned types in {/=, %=} assignments.

Methods inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

checkAccess, checkArguments, checkArrayInitialization, checkConditionalPostcondition, checkConstructorInvocation, checkConstructorResult, checkContract, checkDefaultConstructor, checkExceptionParameter, checkExtendsImplements, checkFieldInvariantDeclarations, checkForAnnotatedJdk, checkMethodInvocability, checkMethodReferenceAsOverride, checkOverride, checkOverride, checkPostcondition, checkPreconditions, checkSuperConstructorCall, checkThisConstructorCall, checkThisOrSuperConstructorCall, checkThrownExpression, checkTypeArguments, checkTypecastRedundancy, checkTypecastSafety, checkVarargs, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheckEndDiagnostic, commonAssignmentCheckStartDiagnostic, createOverrideChecker, createTypeFactory, createTypeValidator, enclosingMemberSelect, enclosingStatement, getExceptionParameterLowerBoundAnnotations, getThrowUpperBoundAnnotations, getTypeFactory, isAccessAllowed, isTypeCastSafe, isValidUse, isValidUse, isValidUse, processClassTree, reportPurityErrors, scan, setRoot, shouldSkipUses, skipReceiverSubtypeCheck, testTypevarContainment, typeCheckVectorCopyIntoArgument, validateType, validateTypeOf, visitAnnotation, visitArrayAccess, visitAssignment, visitCatch, visitClass, visitCompilationUnit, visitConditionalExpression, visitEnhancedForLoop, visitIdentifier, visitInstanceOf, visitLambdaExpression, visitMemberReference, visitMethod, visitMethodInvocation, visitNewArray, visitNewClass, visitReturn, visitThrow, visitTypeCast, visitTypeParameter, visitUnary, visitVariable

Methods inherited from class org.checkerframework.framework.source.SourceVisitor

visit

Methods inherited from class com.sun.source.util.TreePathScanner

getCurrentPath, scan

Methods inherited from class com.sun.source.util.TreeScanner

reduce, scan, visitAnnotatedType, visitArrayType, visitAssert, visitBlock, visitBreak, visitCase, visitContinue, visitDoWhileLoop, visitEmptyStatement, visitErroneous, visitExports, visitExpressionStatement, visitForLoop, visitIf, visitImport, visitIntersectionType, visitLabeledStatement, visitLiteral, visitMemberSelect, visitModifiers, visitModule, visitOpens, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitPrimitiveType, visitProvides, visitRequires, visitSwitch, visitSynchronized, visitTry, visitUnionType, visitUses, visitWhileLoop, visitWildcard

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SignednessVisitor

public SignednessVisitor(BaseTypeChecker checker)

Method Detail

visitBinary

public java.lang.Void visitBinary(com.sun.source.tree.BinaryTree node,
                                  java.lang.Void p)

Enforces the following rules on binary operations involving Unsigned and Signed types:

• Do not allow any Unsigned types or PolySigned types in {/, %} operations.
• Do not allow signed right shift {>>} on an Unsigned type or a PolySigned type.
• Do not allow unsigned right shift {>>>} on a Signed type or a PolySigned type.
• Allow any left shift {<<}.
• Do not allow non-equality comparisons {<, <=, >, >=} on Unsigned types or PolySigned types.
• Do not allow the mixing of Signed and Unsigned types.

Specified by:

visitBinary in interface com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitBinary in class com.sun.source.util.TreeScanner<java.lang.Void,java.lang.Void>

visitCompoundAssignment

public java.lang.Void visitCompoundAssignment(com.sun.source.tree.CompoundAssignmentTree node,
                                              java.lang.Void p)

Enforces the following rules on compound assignments involving Unsigned and Signed types:

• Do not allow any Unsigned types or PolySigned types in {/=, %=} assignments.
• Do not allow signed right shift {>>=} to assign to an Unsigned type or a PolySigned type.
• Do not allow unsigned right shift {>>>=} to assign to a Signed type or a PolySigned type.
• Allow any left shift {<<=} assignment.
• Do not allow mixing of Signed and Unsigned types.

Specified by:

visitCompoundAssignment in interface com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitCompoundAssignment in class BaseTypeVisitor<SignednessAnnotatedTypeFactory>