net.covers1624.coffeegrinder.bytecode.insns

Class LocalVariable

java.lang.Object

net.covers1624.coffeegrinder.bytecode.Instruction

net.covers1624.coffeegrinder.bytecode.insns.LocalVariable

All Implemented Interfaces:

net.covers1624.quack.util.Copyable<Instruction>

Direct Known Subclasses:

ParameterVariable

public class LocalVariable
extends Instruction

Represents a variable within a Method.

Created by covers1624 on 23/2/21.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocalVariable.VariableKind

Field Summary

Fields inherited from class net.covers1624.coffeegrinder.bytecode.Instruction

opcode

Constructor Summary

Constructors

Constructor and Description
LocalVariable(LocalVariable.VariableKind kind, AType type, java.lang.String name)
LocalVariable(LocalVariable.VariableKind kind, AType type, @Nullable java.lang.String genericSignature, int index, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
<R,C> R	accept(InsnVisitor<R,C> visitor, C ctx) Pass this Instruction through the supplied InsnVisitor.
void	addReference(LocalReference insn)
AnnotationSupplier	getAnnotationSupplier()
EnumBitSet<InstructionFlag>	getDirectFlags() Any direct flags for this Instruction.
@Nullable java.lang.String	getGenericSignature()
int	getIndex()
LocalVariable.VariableKind	getKind()
int	getLoadCount() The number of instructions currently referencing this variable which read from it.
java.lang.String	getName()
int	getReferenceCount() Gets the total number of references this variable has.
java.util.List<LocalReference>	getReferences()
AType	getResultType() Gets the stack type of the value produced by this Instruction.
int	getStoreCount() The number of instructions currently referencing this variable which write to it.
int	getSubId()
AType	getType()
java.lang.String	getUniqueName()
boolean	isDead() If this variable can be considered dead.
boolean	isSynthetic()
void	removeReference(LocalReference insn)
void	setAnnotationSupplier(AnnotationSupplier annotationSupplier)
void	setGenericSignature(@Nullable java.lang.String genericSignature)
void	setName(java.lang.String name)
void	setSubId(int subId)
void	setSynthetic(boolean synthetic)
void	setType(AType type)

Methods inherited from class net.covers1624.coffeegrinder.bytecode.Instruction

accept, addRef, ancestorsOfType, computeFlags, copy, descendantsMatching, descendantsOfType, descendantsToList, descendantsToListWhere, descendantsWhere, firstAncestorOfType, getBytecodeOffset, getChildren, getDescendants, getFirstChild, getFirstChildOrNull, getFlags, getLastChild, getLastChildOrNull, getNextSibling, getNextSiblingOrNull, getParent, getParentOrNull, getPrevSibling, getPrevSiblingOrNull, getSourceLine, getTag, hasDirectFlag, hasFlag, insertAfter, insertBefore, invalidateFlags, isConnected, isDescendantOf, onChildModified, onConnected, onDisconnected, releaseRef, remove, replaceWith, setBytecodeOffset, setOffsets, setSourceLine, setTag, toString, toString, withOffsets

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalVariable

public LocalVariable(LocalVariable.VariableKind kind,
                     AType type,
                     java.lang.String name)

LocalVariable

public LocalVariable(LocalVariable.VariableKind kind,
                     AType type,
                     @Nullable
                     @Nullable java.lang.String genericSignature,
                     int index,
                     java.lang.String name)

Method Detail

addReference

public void addReference(LocalReference insn)

removeReference

public void removeReference(LocalReference insn)

getDirectFlags

public EnumBitSet<InstructionFlag> getDirectFlags()

Description copied from class: Instruction

Any direct flags for this Instruction.

The return value should be cached statically inside the Instruction impl.

Specified by:

getDirectFlags in class Instruction

Returns:

An EnumBitSet representing the flags.

See Also:

Instruction.getFlags()

accept

public <R,C> R accept(InsnVisitor<R,C> visitor,
                      C ctx)

Description copied from class: Instruction

Pass this Instruction through the supplied InsnVisitor.

Specified by:

accept in class Instruction

Parameters:

visitor - The InsnVisitor.

ctx - The context.

Returns:

The return result from the InsnVisitor.

getResultType

public AType getResultType()

Description copied from class: Instruction

Gets the stack type of the value produced by this Instruction.

Specified by:

getResultType in class Instruction

Returns:

The AType.

getKind

public LocalVariable.VariableKind getKind()

getGenericSignature

@Nullable
public @Nullable java.lang.String getGenericSignature()

getType

public AType getType()

getIndex

public int getIndex()

getName

public java.lang.String getName()

getSubId

public int getSubId()

getReferences

public java.util.List<LocalReference> getReferences()

isSynthetic

public boolean isSynthetic()

getAnnotationSupplier

public AnnotationSupplier getAnnotationSupplier()

setGenericSignature

public void setGenericSignature(@Nullable
                                @Nullable java.lang.String genericSignature)

setType

public void setType(AType type)

setName

public void setName(java.lang.String name)

setSubId

public void setSubId(int subId)

setSynthetic

public void setSynthetic(boolean synthetic)

setAnnotationSupplier

public void setAnnotationSupplier(AnnotationSupplier annotationSupplier)

getLoadCount

public int getLoadCount()

The number of instructions currently referencing this variable which read from it.

Returns:

The number of read references.

getStoreCount

public int getStoreCount()

The number of instructions currently referencing this variable which write to it.

Returns:

The number of write references.

getReferenceCount

public int getReferenceCount()

Gets the total number of references this variable has.

Returns:

The number of references.

isDead

public boolean isDead()

If this variable can be considered dead.

A variable is considered dead if: 1, It is not a parameter. 2, The variable has no stores.

Returns:

If the variable is dead.

getUniqueName

public java.lang.String getUniqueName()