public class

JUtil

extends Object
java.lang.Object
   ↳ com.pnfsoftware.jeb.core.units.code.java.JUtil

Class Overview

Collection of utility methods to manipulate IJavaElement.

Summary

Public Constructors
JUtil()
Public Methods
static boolean canThrow(IJavaStatement stm)
static IJavaLabel checkIfGoto(IJavaStatement stm)
Check that the statement is a simple "if(...) { goto x; }" and if so, returns "x"
static IJavaElement findParent(IJavaElement root, IJavaElement elt)
Retrieve the parent of an AST element (or first parent, if the element is reusable and has potentially multiple parents).
static String generate(IJavaElement elt)
static IJavaStatement getFirstRealStatement(IJavaBlock b, int i)
This convenience method attempts to determine the next "real" statement to be executed in the block, starting at the provided index 'i'.
static IJavaLabel getGotoLabel(IJavaStatement stm)
static List<IJavaStatement> getGotos(IJavaLabel targetLabel, List<IJavaStatement> flatlist)
static IJavaIdentifier getIdentifier(IJavaExpression e)
static List<IJavaIdentifier> getIdentifiers(IJavaElement e)
static IJavaExpression getMonitorEnter(IJavaStatement stm)
static IJavaExpression getMonitorExit(IJavaStatement stm)
static IJavaConstant getNegatedConstant(IJavaConstant cst, IJavaConstantFactory factory)
Get the negated value of a constant, if possible.
static IJavaExpression getSimplePredicate(IJavaPredicate p)
static String getStringConstant(IJavaElement e)
static IJavaIdentifier getVarLike(IJavaExpression e)
Detect: x, (int)x
static boolean isClassMethodField(IJavaElement e)
static boolean isDeclarationOrDefinition(IJavaStatement stm)
Determine whether the statement defines an identifier.
static boolean isGotoTo(IJavaStatement stm, IJavaLabel target)
Check that the statement is a "goto target;"
static boolean isIdentOrDefinition(IJavaElement e, IJavaIdentifier ident)
Determine whether the elements is the provided identifier or a simple definition of the identifier.
static boolean isIf(IJavaStatement stm)
Determine whether a statement is a simple if: if(...){...}.
static boolean isIfElse(IJavaStatement stm)
Determine whether a statement is like: if(...){...}else{...} which is the if-statement with 2 blocks: the main case block and the default block.
static IJavaLabel isIfGoto(IJavaStatement stm)
Determine if the provided statement is like if(COND){goto LABEL;} and if so, return the label.
static boolean isIfNoElse(IJavaStatement stm)
Determine whether a statement is like: if(...){ }[else if(...){}]*

ie, the if-block can have multiple case-blocks but NO default 'else' block

static boolean isImmOrVarLike(IJavaExpression e)
Detect: 1, x, (int)x
static boolean isIntegerConstant(IJavaElement e, int expected)
static boolean isMonitorExit(IJavaElement stm)
static boolean isMonitorExit(IJavaElement stm, IJavaExpression expectedLock)
static boolean isNonCompoundFlowBreaker(IJavaStatement stm)
Determine whether the provided statement is a return, throw, goto, break, or continue.
static boolean isOrContainsLabel(IJavaStatement stm)
Recursively determine if the statement is or contains a Label.
static boolean isStringConstant(IJavaElement e)
static boolean isThrow(IJavaStatement stm, IJavaExpression expectedThrown)
static IJavaExpression isThrowLike(IJavaStatement stm, List<IJavaStatement> flatlist)
static IJavaCatchBlock isTryCatchall(IJavaBlock b, int i)
static int removeStatementsDeep(IJavaBlock b, Predicate<IJavaStatement> checker)
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public JUtil ()

Public Methods

public static boolean canThrow (IJavaStatement stm)

public static IJavaLabel checkIfGoto (IJavaStatement stm)

Check that the statement is a simple "if(...) { goto x; }" and if so, returns "x"

Parameters
stm statement to check
Returns
  • the label or null

public static IJavaElement findParent (IJavaElement root, IJavaElement elt)

Retrieve the parent of an AST element (or first parent, if the element is reusable and has potentially multiple parents).

Parameters
root a root element, typically, an IJavaClass
elt the element for which the first parent is to be found
Returns
  • the parent or null

public static String generate (IJavaElement elt)

public static IJavaStatement getFirstRealStatement (IJavaBlock b, int i)

This convenience method attempts to determine the next "real" statement to be executed in the block, starting at the provided index 'i'.

This method can only go "deeper" (forward). It cannot go "up", which would require keeping track of parents. Use a PStmManager to do that.

Important: Label statements are not skipped over. This method skips over:

  • the "do {" part of a do-while block
  • the "while(true) {" part of a while block
  • the "if(true) {" part of a conditional statement
  • the "try {" part of a try-catch block

Parameters
b current block
i current statement index in the block
Returns
  • the statement, or null if none were found

public static IJavaLabel getGotoLabel (IJavaStatement stm)

public static List<IJavaStatement> getGotos (IJavaLabel targetLabel, List<IJavaStatement> flatlist)

public static IJavaIdentifier getIdentifier (IJavaExpression e)

public static List<IJavaIdentifier> getIdentifiers (IJavaElement e)

public static IJavaExpression getMonitorEnter (IJavaStatement stm)

public static IJavaExpression getMonitorExit (IJavaStatement stm)

public static IJavaConstant getNegatedConstant (IJavaConstant cst, IJavaConstantFactory factory)

Get the negated value of a constant, if possible.

Parameters
cst a constant
factory constant factory
Returns
  • null if the negative value cannot be represented (e.g., constant type no fitting) or is the same as the provided constant

public static IJavaExpression getSimplePredicate (IJavaPredicate p)

public static String getStringConstant (IJavaElement e)

public static IJavaIdentifier getVarLike (IJavaExpression e)

Detect: x, (int)x

Returns
  • x or null

public static boolean isClassMethodField (IJavaElement e)

public static boolean isDeclarationOrDefinition (IJavaStatement stm)

Determine whether the statement defines an identifier.

Currently, definitions should only be found in four types of statements:
- pure decl: "int x;"
- decl + init: "int x = 0;"
- in top-level Method elements (NOT CHECKED HERE)
- in compound Try elements (NOT CHECKED HERE)

public static boolean isGotoTo (IJavaStatement stm, IJavaLabel target)

Check that the statement is a "goto target;"

Parameters
stm the statement
target the target

public static boolean isIdentOrDefinition (IJavaElement e, IJavaIdentifier ident)

Determine whether the elements is the provided identifier or a simple definition of the identifier.

public static boolean isIf (IJavaStatement stm)

Determine whether a statement is a simple if: if(...){...}.

public static boolean isIfElse (IJavaStatement stm)

Determine whether a statement is like: if(...){...}else{...} which is the if-statement with 2 blocks: the main case block and the default block.

public static IJavaLabel isIfGoto (IJavaStatement stm)

Determine if the provided statement is like if(COND){goto LABEL;} and if so, return the label.

public static boolean isIfNoElse (IJavaStatement stm)

Determine whether a statement is like: if(...){ }[else if(...){}]*

ie, the if-block can have multiple case-blocks but NO default 'else' block

public static boolean isImmOrVarLike (IJavaExpression e)

Detect: 1, x, (int)x

Returns
  • true or false

public static boolean isIntegerConstant (IJavaElement e, int expected)

public static boolean isMonitorExit (IJavaElement stm)

public static boolean isMonitorExit (IJavaElement stm, IJavaExpression expectedLock)

Parameters
expectedLock optional

public static boolean isNonCompoundFlowBreaker (IJavaStatement stm)

Determine whether the provided statement is a return, throw, goto, break, or continue.

public static boolean isOrContainsLabel (IJavaStatement stm)

Recursively determine if the statement is or contains a Label. Can be called for any statement, including compound statements.

public static boolean isStringConstant (IJavaElement e)

public static boolean isThrow (IJavaStatement stm, IJavaExpression expectedThrown)

public static IJavaExpression isThrowLike (IJavaStatement stm, List<IJavaStatement> flatlist)

Parameters
stm a statement, that we want to be a THROW or a GOTO-THROW
Returns
  • on success, the THROWN expression; else, null

public static IJavaCatchBlock isTryCatchall (IJavaBlock b, int i)

Returns
  • the catch-all block or null

public static int removeStatementsDeep (IJavaBlock b, Predicate<IJavaStatement> checker)