soot.JastAddJ

Class NumericLiteral

java.lang.Object

beaver.Symbol

soot.JastAddJ.ASTNode<ASTNode>

soot.JastAddJ.Expr

soot.JastAddJ.PrimaryExpr

soot.JastAddJ.Literal

soot.JastAddJ.NumericLiteral

All Implemented Interfaces:

Cloneable, Iterable<ASTNode>

Direct Known Subclasses:

DoubleLiteral, FloatingPointLiteral, IntegerLiteral, LongLiteral

public class NumericLiteral
extends Literal
implements Cloneable

A NumericLiteral is a raw literal, produced by the parser. NumericLiterals are rewritten to the best matching concrete numeric literal kind, or IllegalLiteral.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BINARY
static int	DECIMAL
protected String	digits The trimmed digits.
static int	HEXADECIMAL
protected int	kind The literal kind tells which kind of literal it is; it's either a DECIMAL, HEXADECIMAL, OCTAL or BINARY literal.
static int	OCTAL
protected boolean	type_computed
protected TypeDecl	type_value

Fields inherited from class soot.JastAddJ.Literal

constant_computed, constant_value, LITERALend, LITERALstart, tokenString_LITERAL

Fields inherited from class soot.JastAddJ.Expr

false_label_computed, false_label_value, true_label_computed, true_label_value

Fields inherited from class soot.JastAddJ.ASTNode

children, generatedWithCacheCycle, generatedWithCircularEnabled, generatedWithComponentCheck, in$Circle, is$Final, numChildren, parent, PRIMITIVE_PACKAGE_NAME, state

Fields inherited from class beaver.Symbol

end, id, start, value

Constructor Summary

Constructors

Constructor and Description
NumericLiteral()
NumericLiteral(String p0)
NumericLiteral(Symbol p0)

Method Summary

Modifier and Type	Method and Description
NumericLiteral	clone()
NumericLiteral	copy()
void	flushCache()
void	flushCollectionCache()
NumericLiteral	fullCopy() Create a deep copy of the AST subtree at this node.
String	getDigits() Get the trimmed digits of this literal, excluding underscore, prefix and suffix.
int	getKind() The literal kind tells which kind of literal it is; it's either a DECIMAL, HEXADECIMAL, OCTAL or BINARY literal.
String	getLITERAL() Retrieves the value for the lexeme LITERAL.
int	getRadix() Get the radix of this literal.
void	init$Children() Initializes the child array to the correct size.
boolean	isBinary()
boolean	isDecimal()
boolean	isHex()
boolean	isNegative()
boolean	isOctal()
boolean	mayHaveRewrite()
boolean	needsRewrite() Utility attribute for literal rewriting.
protected int	numChildren()
Literal	parse() Parse a literal.
long	parseLong() This is a refactored version of Literal.parseLong which supports binary literals.
long	parseLongBinary() Parse a binary long literal.
long	parseLongDecimal() Parse an octal long literal.
long	parseLongHexadecimal() Parse a hexadecimal long literal.
long	parseLongOctal() Parse an octal long literal.
ASTNode	rewriteTo()
void	setDigits(String digits) Sets the trimmed digits of this literal.
void	setKind(int kind) Sets the literal kind.
void	setLITERAL(String value) Replaces the lexeme LITERAL.
void	setLITERAL(Symbol symbol) JastAdd-internal setter for lexeme LITERAL using the Beaver parser.
TypeDecl	type() The type of a NumericLiteral is undefined.

Methods inherited from class soot.JastAddJ.Literal

asEscape, buildBooleanLiteral, buildDoubleLiteral, buildFloatLiteral, buildIntegerLiteral, buildLongLiteral, buildStringLiteral, constant, dumpString, escape, isConstant, toString

Methods inherited from class soot.JastAddJ.Expr

addDependencyIfNeeded, applicableAndAccessible, assignConvertedType, canBeFalse, canBeTrue, chooseConstructor, collectTypesToHierarchy, condition_false_label, condition_true_label, emitBooleanCondition, emitEvalBranch, emitStore, enclosingBodyDecl, enclosingStmt, eval, false_label, hasNextAccess, hasPackage, hasParentDot, hasQualifiedPackage, hostPackage, hostType, inExtendsOrImplements, inStaticContext, isArrayAccess, isClassAccess, isDAafter, isDAafterFalse, isDAafterTrue, isDAbefore, isDest, isDUafter, isDUafterFalse, isDUafterTrue, isDUbefore, isEnumConstant, isFalse, isFieldAccess, isIncOrDec, isLeftChildOfDot, isMethodAccess, isPackageAccess, isPositive, isRightChildOfDot, isSource, isSuperAccess, isSuperConstructorAccess, isThisAccess, isTrue, isTypeAccess, isUnknown, isVariable, isVariable, keepAccessibleFields, keepAccessibleTypes, lookupMethod, lookupType, lookupType, lookupVariable, mayAccess, methodHost, modifiedInScope, mostSpecific, mostSpecificConstructor, nameType, nextAccess, packageName, parentDot, qualifiedLookupType, qualifiedLookupVariable, qualifiesAccess, refined_BooleanExpressions_Expr_emitEvalBranch, representableIn, staticContextQualifier, throwTypes, true_label, typeBoolean, typeByte, typeChar, typeDouble, typeFloat, typeInt, typeLong, typeName, typeNull, typeShort, typeString, typeVoid, unknownType, varDecl

Methods inherited from class soot.JastAddJ.ASTNode

accessControl, addAttributes, addChild, addsIndentationLevel, asImmediate, asLocal, asLocal, asRValue, beginExceptionRange, branchTarget, checkDUeverywhere, checkEnum, checkUncheckedConversion, checkWarnings, clearLocations, cloneSubtree, collectBranches, collectEnclosingVariables, collectErrors, collectExceptions, collectFinally, collectTypesToSignatures, compilationUnit, Define_Annotation_lookupAnnotation, Define_ArrayList_exceptionRanges, Define_ASTNode_enclosingBlock, Define_BodyDecl_enclosingBodyDecl, Define_boolean_enclosedByExceptionHandler, Define_boolean_handlesException, Define_boolean_hasPackage, Define_boolean_inExplicitConstructorInvocation, Define_boolean_inExtendsOrImplements, Define_boolean_inhModifiedInScope, Define_boolean_insideLoop, Define_boolean_insideSwitch, Define_boolean_inStaticContext, Define_boolean_isAnonymous, Define_boolean_isAnonymousDecl, Define_boolean_isCatchParam, Define_boolean_isConstructorParameter, Define_boolean_isDAbefore, Define_boolean_isDest, Define_boolean_isDUbefore, Define_boolean_isExceptionHandlerParameter, Define_boolean_isExplicitGenericConstructorAccess, Define_boolean_isIncOrDec, Define_boolean_isLocalClass, Define_boolean_isMemberType, Define_boolean_isMethodParameter, Define_boolean_isNestedType, Define_boolean_isSource, Define_boolean_mayBeAbstract, Define_boolean_mayBeFinal, Define_boolean_mayBeNative, Define_boolean_mayBePrivate, Define_boolean_mayBeProtected, Define_boolean_mayBePublic, Define_boolean_mayBeStatic, Define_boolean_mayBeStrictfp, Define_boolean_mayBeSynchronized, Define_boolean_mayBeTransient, Define_boolean_mayBeVolatile, Define_boolean_mayUseAnnotationTarget, Define_boolean_reachable, Define_boolean_reachableCatchClause, Define_boolean_reportUnreachable, Define_boolean_resourcePreviouslyDeclared, Define_boolean_variableArityValid, Define_boolean_withinDeprecatedAnnotation, Define_boolean_withinSuppressWarnings, Define_Case_bind, Define_CatchClause_catchClause, Define_ClassInstanceExpr_getClassInstanceExpr, Define_Collection_lookupConstructor, Define_Collection_lookupMethod, Define_Collection_lookupSuperConstructor, Define_Collection_TypeDecl__caughtExceptions, Define_CompilationUnit_compilationUnit, Define_ConstructorDecl_constructorDecl, Define_ConstructorDecl_unknownConstructor, Define_ElementValue_lookupElementTypeValue, Define_Expr_nestedScope, Define_GLBType_lookupGLBType, Define_int_localNum, Define_LabeledStmt_lookupLabel, Define_LUBType_lookupLUBType, Define_MethodDecl_unknownMethod, Define_NameType_nameType, Define_SimpleSet_allImportedTypes, Define_SimpleSet_lookupType, Define_SimpleSet_lookupVariable, Define_soot_jimple_Stmt_condition_false_label, Define_soot_jimple_Stmt_condition_true_label, Define_String_hostPackage, Define_String_methodHost, Define_String_packageName, Define_String_typeDeclIndent, Define_TypeDecl_assignConvertedType, Define_TypeDecl_componentType, Define_TypeDecl_declType, Define_TypeDecl_enclosingAnnotationDecl, Define_TypeDecl_enclosingInstance, Define_TypeDecl_enclosingType, Define_TypeDecl_expectedType, Define_TypeDecl_genericDecl, Define_TypeDecl_hostType, Define_TypeDecl_lookupType, Define_TypeDecl_lookupWildcardExtends, Define_TypeDecl_lookupWildcardSuper, Define_TypeDecl_returnType, Define_TypeDecl_superType, Define_TypeDecl_switchType, Define_TypeDecl_typeBoolean, Define_TypeDecl_typeByte, Define_TypeDecl_typeChar, Define_TypeDecl_typeCloneable, Define_TypeDecl_typeDouble, Define_TypeDecl_typeError, Define_TypeDecl_typeException, Define_TypeDecl_typeFloat, Define_TypeDecl_typeInt, Define_TypeDecl_typeLong, Define_TypeDecl_typeNull, Define_TypeDecl_typeNullPointerException, Define_TypeDecl_typeObject, Define_TypeDecl_typeRuntimeException, Define_TypeDecl_typeSerializable, Define_TypeDecl_typeShort, Define_TypeDecl_typeString, Define_TypeDecl_typeThrowable, Define_TypeDecl_typeVoid, Define_TypeDecl_typeWildcard, Define_TypeDecl_unknownType, Define_Variable_unknownField, Define_VariableScope_outerScope, definesLabel, definiteAssignment, dumpTree, dumpTree, dumpTreeNoRewrite, dumpTreeNoRewrite, duringAnnotations, duringAnonymousClasses, duringBoundNames, duringDU, duringEnums, duringGenericTypeVariables, duringImplicitConstructor, duringLiterals, duringNameResolution, duringSyntacticClassification, duringVariableDeclarationTransformation, emitConstant, end, endExceptionRange, error, errorPrefix, exceptionHandling, extractIndent, extractSingleType, flushCaches, getChild, getChildNoTransform, getIndexOfChild, getNumChild, getNumChildNoTransform, getParent, in$Circle, in$Circle, indent, insertChild, is$Final, is$Final, isDescendantTo, isStringAdd, iterator, jimplify1phase1, jimplify1phase2, jimplify2, jimplify2, lineNumber, location, nameCheck, newLabel, options, putSimpleSetElement, reachedException, removeChild, removeInstanceMethods, removeInstanceVariables, replace, setChild, setEnd, setLocation, setParent, setStart, sourceFile, start, state, toString, transformation, transformEnumConstructors, typeCheck, unassignedEverywhere, usesTypeVariable, varChildIndex, varChildIndex, warning, warningPrefix, with

Methods inherited from class beaver.Symbol

getColumn, getEnd, getId, getLine, getStart, makePosition

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DECIMAL

public static final int DECIMAL

See Also:

Constant Field Values

HEXADECIMAL

public static final int HEXADECIMAL

See Also:

Constant Field Values

OCTAL

public static final int OCTAL

See Also:

Constant Field Values

BINARY

public static final int BINARY

See Also:

Constant Field Values

digits

protected String digits

The trimmed digits.

kind

protected int kind

The literal kind tells which kind of literal it is; it's either a DECIMAL, HEXADECIMAL, OCTAL or BINARY literal.

type_computed

protected boolean type_computed

type_value

protected TypeDecl type_value

Constructor Detail

NumericLiteral

public NumericLiteral()

NumericLiteral

public NumericLiteral(String p0)

NumericLiteral

public NumericLiteral(Symbol p0)

Method Detail

flushCache

public void flushCache()

Overrides:

flushCache in class Literal

flushCollectionCache

public void flushCollectionCache()

Overrides:

flushCollectionCache in class Literal

clone

public NumericLiteral clone()
                     throws CloneNotSupportedException

Overrides:

clone in class Literal

Throws:

CloneNotSupportedException

copy

public NumericLiteral copy()

Overrides:

copy in class ASTNode<ASTNode>

fullCopy

public NumericLiteral fullCopy()

Create a deep copy of the AST subtree at this node. The copy is dangling, i.e. has no parent.

Overrides:

fullCopy in class ASTNode<ASTNode>

Returns:

dangling copy of the subtree at this node

setDigits

public void setDigits(String digits)

Sets the trimmed digits of this literal.

setKind

public void setKind(int kind)

Sets the literal kind.

parse

public Literal parse()

Parse a literal. If there is a syntax error in the literal, an IllegalLiteral will be returned.

init$Children

public void init$Children()

Initializes the child array to the correct size. Initializes List and Opt nta children.

Overrides:

init$Children in class Literal

numChildren

protected int numChildren()

Overrides:

numChildren in class Literal

mayHaveRewrite

public boolean mayHaveRewrite()

Overrides:

mayHaveRewrite in class Literal

setLITERAL

public void setLITERAL(String value)

Replaces the lexeme LITERAL.

Overrides:

setLITERAL in class Literal

Parameters:

value - The new value for the lexeme LITERAL.

setLITERAL

public void setLITERAL(Symbol symbol)

JastAdd-internal setter for lexeme LITERAL using the Beaver parser.

Overrides:

setLITERAL in class Literal

getLITERAL

public String getLITERAL()

Retrieves the value for the lexeme LITERAL.

Overrides:

getLITERAL in class Literal

Returns:

The value for the lexeme LITERAL.

parseLong

public long parseLong()

This is a refactored version of Literal.parseLong which supports binary literals. This version of parseLong is implemented as an attribute rather than a static method. Perhaps some slight performance boost could be gained from keeping it static, but with the loss of declarative- and ReRAGness. There exists only a parseLong, and not a parseInteger. Parsing of regular integer literals works the same, but with stricter bounds requirements on the resulting parsed value.

parseLongHexadecimal

public long parseLongHexadecimal()

Parse a hexadecimal long literal.

Throws:

NumberFormatException - if the literal is too large.

parseLongOctal

public long parseLongOctal()

Parse an octal long literal.

Throws:

NumberFormatException - if the literal is too large.

parseLongBinary

public long parseLongBinary()

Parse a binary long literal.

Throws:

NumberFormatException - if the literal is too large.

parseLongDecimal

public long parseLongDecimal()

Parse an octal long literal.

Throws:

NumberFormatException - if the literal is too large.

needsRewrite

public boolean needsRewrite()

Utility attribute for literal rewriting. Any of the NumericLiteral subclasses have already been rewritten and/or parsed, and should not be rewritten again.

Returns:

true if this literal is a "raw", not-yet-parsed NumericLiteral

isNegative

public boolean isNegative()

getDigits

public String getDigits()

Get the trimmed digits of this literal, excluding underscore, prefix and suffix.

getKind

public int getKind()

The literal kind tells which kind of literal it is; it's either a DECIMAL, HEXADECIMAL, OCTAL or BINARY literal.

getRadix

public int getRadix()

Get the radix of this literal.

Returns:

16 (hex), 10 (decimal), 8 (octal) or 2 (binary)

isDecimal

public boolean isDecimal()

Returns:

true if the literal is a decimal literal

isHex

public boolean isHex()

Returns:

true if the literal is a hexadecimal literal

isOctal

public boolean isOctal()

Returns:

true if the literal is an octal literal

isBinary

public boolean isBinary()

Returns:

true if the literal is a binary literal

type

public TypeDecl type()

The type of a NumericLiteral is undefined. The literal must be parsed before it can have a type.

Specified by:

type in class Expr

rewriteTo

public ASTNode rewriteTo()

Overrides:

rewriteTo in class Literal