Record Class Local<T extends Types.BNonVoid>

java.lang.Object
java.lang.Record
ghidra.pcode.emu.jit.gen.util.Local<T>
Type Parameters:
T - the (machine) type of the variable.
Record Components:
type - the type
name - the name
index - the index
public record Local<T extends Types.BNonVoid>(T extends Types.BNonVoid type, String name, int index) extends Record
The handle to a local variable

Direct use of the canonical constructor is not recommended. We may later hide this behind an interface.

The JVM <t>load and <t>store instructions all take an index argument. We would rather not have to keep track of indices, but instead wrap them in some named handle. These handles are generated by Scope.decl(BNonVoid, String), Methods.Def.param(ParamFunction, BNonVoid, String, Consumer), and Methods.Def.done(ObjDef, TRef, Consumer). For the most part, the user need not worry at all about indices, only types.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Local(T type, String name, int index)
    Creates an instance of a Local record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    index()
    Returns the value of the index record component.
    String
    name()
    Returns the value of the name record component.
    static <T extends Types.BNonVoid>
    Local<T>
    of(T type, String name, int index)
    Construct a local variable handle
    final String
    toString()
    Returns a string representation of this record class.
    T
    type()
    Returns the value of the type record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Local

      public Local(T type, String name, int index)
      Creates an instance of a Local record class.
      Parameters:
      type - the value for the type record component
      name - the value for the name record component
      index - the value for the index record component

  • Method Details

    • of

      public static <T extends Types.BNonVoid> Local<T> of(T type, String name, int index)
      Construct a local variable handle

      Direct use of this method is not recommended. It may be made private later.

      Type Parameters:
      T - the type of the variable
      Parameters:
      type - the type
      name - the name
      index - the index
      Returns:
      the handle

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • type

      public T type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • index

      public int index()
      Returns the value of the index record component.
      Returns:
      the value of the index record component