com.google.javascript.jscomp.lint

Class CheckNullableReturn

java.lang.Object

com.google.javascript.jscomp.lint.CheckNullableReturn

All Implemented Interfaces:

CompilerPass, HotSwapCompilerPass, NodeTraversal.Callback

public final class CheckNullableReturn
extends java.lang.Object
implements HotSwapCompilerPass, NodeTraversal.Callback

Checks when a function is annotated as returning {SomeType} (nullable) but actually always returns {!SomeType}, i.e. never returns null.

Field Summary

Fields

Modifier and Type	Field and Description
static DiagnosticType	NULLABLE_RETURN
static DiagnosticType	NULLABLE_RETURN_WITH_NAME

Constructor Summary

Constructors

Constructor and Description
CheckNullableReturn(AbstractCompiler compiler)

Method Summary

Modifier and Type	Method and Description
static boolean	canReturnNull(ControlFlowGraph<Node> graph)
static boolean	hasReturnDeclaredNullable(Node n)
void	hotSwapScript(Node scriptRoot, Node originalRoot) Process the JS with root node root.
void	process(Node externs, Node root) Process the JS with root node root.
boolean	shouldTraverse(NodeTraversal nodeTraversal, Node n, Node parent) Visits a node in preorder (before its children) and decides whether its children should be traversed.
void	visit(NodeTraversal t, Node n, Node parent) Visits a node in postorder (after its children).

Methods inherited from class java.lang.Object

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

Field Detail

NULLABLE_RETURN

public static final DiagnosticType NULLABLE_RETURN

NULLABLE_RETURN_WITH_NAME

public static final DiagnosticType NULLABLE_RETURN_WITH_NAME

Constructor Detail

CheckNullableReturn

public CheckNullableReturn(AbstractCompiler compiler)

Method Detail

hasReturnDeclaredNullable

public static boolean hasReturnDeclaredNullable(Node n)

visit

public void visit(NodeTraversal t,
                  Node n,
                  Node parent)

Description copied from interface: NodeTraversal.Callback

Visits a node in postorder (after its children). A node is visited in postorder iff NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node) returned true for its parent. In particular, the root node is never visited in postorder.

Siblings are always visited left-to-right.

Implementations can have side-effects (e.g. modify the parse tree). Removing the current node is legal, but removing or reordering nodes above the current node may cause nodes to be visited twice or not at all.

Specified by:

visit in interface NodeTraversal.Callback

Parameters:

t - The current traversal.

n - The current node.

parent - The parent of the current node.

canReturnNull

public static boolean canReturnNull(ControlFlowGraph<Node> graph)

Returns:

True if the given ControlFlowGraph could return null.

shouldTraverse

public boolean shouldTraverse(NodeTraversal nodeTraversal,
                              Node n,
                              Node parent)

Description copied from interface: NodeTraversal.Callback

Visits a node in preorder (before its children) and decides whether its children should be traversed. If the children should be traversed, they will be visited by NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node) in preorder and by NodeTraversal.Callback.visit(NodeTraversal, Node, Node) in postorder.

Siblings are always visited left-to-right.

Implementations can have side-effects (e.g. modify the parse tree). Removing the current node is legal, but removing or reordering nodes above the current node may cause nodes to be visited twice or not at all.

Specified by:

shouldTraverse in interface NodeTraversal.Callback

Parameters:

nodeTraversal - The current traversal.

n - The current node.

parent - The parent of the current node.

Returns:

whether the children of this node should be visited

process

public void process(Node externs,
                    Node root)

Description copied from interface: CompilerPass

Process the JS with root node root. Can modify the contents of each Node tree

Specified by:

process in interface CompilerPass

Parameters:

externs - Top of external JS tree

root - Top of JS tree

hotSwapScript

public void hotSwapScript(Node scriptRoot,
                          Node originalRoot)

Description copied from interface: HotSwapCompilerPass

Process the JS with root node root. This is supposed to be significantly faster compared to corresponding full-compiler passes.

Specified by:

hotSwapScript in interface HotSwapCompilerPass

Parameters:

scriptRoot - Root node corresponding to the file that is modified, should be of type Token.SCRIPT.

originalRoot - Root node corresponding to the original version of the file that is modified. Should be of type token.SCRIPT.