Package io.jawk.intermediate

Class Tuple

java.lang.Object

io.jawk.intermediate.Tuple

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Tuple.AddressTuple, Tuple.BooleanTuple, Tuple.ClassTuple, Tuple.CountTuple, Tuple.DereferenceTuple, Tuple.ExtensionTuple, Tuple.FunctionTuple, Tuple.LongTuple, Tuple.NoOperandTuple, Tuple.PushDoubleTuple, Tuple.PushLongTuple, Tuple.PushStringTuple, Tuple.RegexTuple, Tuple.VariableTuple

public abstract class Tuple
extends Object
implements Serializable

Represents one instruction in the tuple stream produced by AwkTuples. Concrete subclasses carry only the operands required by their opcode or opcode group.

Author:

Danny Daglas

See Also:

• AwkTuples
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Tuple.AddressTuple	Tuple for an address operand.
static final class	Tuple.BooleanTuple	Tuple for boolean operands.
static final class	Tuple.BuiltinVarTuple	Tuple for JRT-managed built-in variable operations.
static final class	Tuple.CallFunctionTuple	Tuple for function calls.
static final class	Tuple.ClassTuple	Tuple for a class check.
static final class	Tuple.CompoundAssignArrayTuple	Tuple for array compound assignments.
static final class	Tuple.CompoundAssignInputFieldTuple	Tuple for input-field compound assignments.
static final class	Tuple.CompoundAssignMapElementTuple	Tuple for stack-provided map element compound assignments.
static final class	Tuple.CompoundAssignTuple	Tuple for scalar compound assignments.
static final class	Tuple.CountAndAppendTuple	Tuple for print/printf redirection with an append flag.
static class	Tuple.CountTuple	Tuple for opcodes whose single operand is a count.
static final class	Tuple.DereferenceTuple	Tuple for variable dereference.
static final class	Tuple.ExtensionTuple	Tuple for extension function invocations.
static final class	Tuple.FunctionTuple	Tuple for function definitions.
static final class	Tuple.InputFieldTuple	Tuple for a constant input-field index.
static class	Tuple.LongTuple	Tuple for a long operand that is not interpreted by the tuple itself.
static class	Tuple.NoOperandTuple	Tuple for opcodes without operands.
static final class	Tuple.PushDoubleTuple	Tuple for a double literal.
static final class	Tuple.PushLongTuple	Tuple for a long literal.
static final class	Tuple.PushStringTuple	Tuple for a string literal.
static final class	Tuple.RegexTuple	Tuple for a precompiled literal regular expression.
static final class	Tuple.SubstitutionVariableTuple	Tuple for sub/gsub against variable-backed values.
static class	Tuple.VariableTuple	Tuple for variable offset/global operands.

Method Summary

Modifier and Type	Method	Description
Address	getAddress()	Returns this tuple's jump/call address, if it has one.
int	getLineNumber()	Returns the source line number associated with this tuple.
final Opcode	getOpcode()	Returns this tuple's opcode.
void	touch(List<Tuple> queue)	Resolves deferred operands and validates resolved addresses.

Methods inherited from class java.lang.Object

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

Method Details

getOpcode

public final Opcode getOpcode()

Returns this tuple's opcode.

Returns:

opcode executed by the AVM

getAddress

public Address getAddress()

Returns this tuple's jump/call address, if it has one.

Returns:

tuple address, or null

touch

public void touch(List<Tuple> queue)

Resolves deferred operands and validates resolved addresses.

Parameters:

queue - tuple queue used to validate address targets

getLineNumber

public int getLineNumber()

Returns the source line number associated with this tuple.

Returns:

source line number, or -1 when unknown