Package com.pnfsoftware.jeb.core.units.code.asm.processor

Class AbstractInstructionOperandList

java.lang.Object

com.pnfsoftware.jeb.core.units.code.asm.processor.AbstractInstructionOperandGeneric

com.pnfsoftware.jeb.core.units.code.asm.processor.AbstractInstructionOperandList

All Implemented Interfaces:

IInstructionOperandGeneric, IInstructionOperandList, IInstructionOperandRegisterBased, IInstructionOperandSized, IInstructionOperand

@Ser
public abstract class AbstractInstructionOperandList
extends AbstractInstructionOperandGeneric
implements IInstructionOperandList

Reference implementation for IInstructionOperandList.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FLAG_MASK	Reserved inner space for mask.
static final int	NO_FLAG	represent no flag
static final int	SEPARATOR_COLON	: separator
static final int	SEPARATOR_COMMA	, separator
static final int	SEPARATOR_HYPHEN	- separator
static final int	SEPARATOR_SEMI_COLON	; separator
static final int	SEPARATOR_SPACE	" " separator
static final int	SEPARATOR_SURROUND_SPACE	" " before and after a separator
static final int	SURROUND_BRACES	{} container
static final int	SURROUND_BRACKETS	[] container
static final int	SURROUND_CHEVRONS	<> container
static final int	SURROUND_DOUBLE_QUOTES	"" container
static final int	SURROUND_PARENTHESES	() container
static final int	SURROUND_QUOTES	'' container
static final int	SURROUND_SPACES	"" container
static final int	USER_DEFINED_1	Reserved value for Child classes
static final int	USER_DEFINED_2	Reserved value for child classes.
static final int	USER_DEFINED_3	Reserved value for child classes.
static final int	USER_DEFINED_4	Reserved value for child classes.
static final int	USER_DEFINED_5	Reserved value for child classes.
static final int	USER_DEFINED_6	Reserved value for child classes.
static final int	USER_DEFINED_7	Reserved value for child classes.
static final int	USER_DEFINED_8	Reserved value for child classes.

Fields inherited from class com.pnfsoftware.jeb.core.units.code.asm.processor.AbstractInstructionOperandGeneric

bitsize, type, value

Fields inherited from interface com.pnfsoftware.jeb.core.units.code.asm.processor.IInstructionOperandGeneric

TYPE_ADDR, TYPE_ALIAS, TYPE_CMA, TYPE_IMM, TYPE_LIST, TYPE_MEMIMM, TYPE_MEMREG, TYPE_REG, TYPE_RELADDR, TYPE_SIMM, TYPE_USER_1

Constructor Summary

Constructors

Constructor	Description
AbstractInstructionOperandList(int type, int size, long value, int flags, IInstructionOperandGeneric... operands)	Create an operand list.
AbstractInstructionOperandList(int size, long value, int flags, IInstructionOperandGeneric... operands)	Create an operand list.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
protected CharSequence	formatOperand(IInstruction insn, long address)
int	getFlags()	Retrieve the formatting flags.
IInstructionOperand[]	getOperands()	Get the list of operands represented by this operand.
String	getPrefix(IInstruction insn)	Get the optional prefix to be prepended to the formatted operand.
String	getSeparator()	Retrieve the separator of the elements of the list
String	getSuffix(IInstruction insn)	Get the optional suffix to be appended to the formatted operand.
int	hashCode()
IInstructionOperandGeneric	merge(long address)	Attempt to merge parameter list to 1 parameter.

Methods inherited from class com.pnfsoftware.jeb.core.units.code.asm.processor.AbstractInstructionOperandGeneric

format, getAlias, getOperandBitsize, getOperandType, getOperandValue, getOperandValue, innerFormat, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pnfsoftware.jeb.core.units.code.IInstructionOperand

format

Methods inherited from interface com.pnfsoftware.jeb.core.units.code.asm.processor.IInstructionOperandGeneric

getAlias, getOperandType, getOperandValue, getOperandValue, isImmediate, isRegister

Methods inherited from interface com.pnfsoftware.jeb.core.units.code.asm.processor.IInstructionOperandRegisterBased

getRegisterName

Methods inherited from interface com.pnfsoftware.jeb.core.units.code.asm.processor.IInstructionOperandSized

getOperandBitsize

Field Details

NO_FLAG

public static final int NO_FLAG

represent no flag

See Also:

• Constant Field Values

SURROUND_BRACKETS

public static final int SURROUND_BRACKETS

[] container

See Also:

• Constant Field Values

SURROUND_BRACES

public static final int SURROUND_BRACES

{} container

See Also:

• Constant Field Values

SURROUND_PARENTHESES

public static final int SURROUND_PARENTHESES

() container

See Also:

• Constant Field Values

SURROUND_CHEVRONS

public static final int SURROUND_CHEVRONS

<> container

See Also:

• Constant Field Values

SURROUND_QUOTES

public static final int SURROUND_QUOTES

'' container

See Also:

• Constant Field Values

SURROUND_DOUBLE_QUOTES

public static final int SURROUND_DOUBLE_QUOTES

"" container

See Also:

• Constant Field Values

SURROUND_SPACES

public static final int SURROUND_SPACES

"" container

See Also:

• Constant Field Values

SEPARATOR_SPACE

public static final int SEPARATOR_SPACE

" " separator

See Also:

• Constant Field Values

SEPARATOR_COMMA

public static final int SEPARATOR_COMMA

, separator

See Also:

• Constant Field Values

SEPARATOR_COLON

public static final int SEPARATOR_COLON

: separator

See Also:

• Constant Field Values

SEPARATOR_SEMI_COLON

public static final int SEPARATOR_SEMI_COLON

; separator

See Also:

• Constant Field Values

SEPARATOR_HYPHEN

public static final int SEPARATOR_HYPHEN

- separator

See Also:

• Constant Field Values

SEPARATOR_SURROUND_SPACE

public static final int SEPARATOR_SURROUND_SPACE

" " before and after a separator

See Also:

• Constant Field Values

USER_DEFINED_1

public static final int USER_DEFINED_1

Reserved value for Child classes

See Also:

• Constant Field Values

USER_DEFINED_2

public static final int USER_DEFINED_2

Reserved value for child classes.

See Also:

• Constant Field Values

USER_DEFINED_3

public static final int USER_DEFINED_3

Reserved value for child classes.

See Also:

• Constant Field Values

USER_DEFINED_4

public static final int USER_DEFINED_4

Reserved value for child classes.

See Also:

• Constant Field Values

USER_DEFINED_5

public static final int USER_DEFINED_5

Reserved value for child classes.

See Also:

• Constant Field Values

USER_DEFINED_6

public static final int USER_DEFINED_6

Reserved value for child classes.

See Also:

• Constant Field Values

USER_DEFINED_7

public static final int USER_DEFINED_7

Reserved value for child classes.

See Also:

• Constant Field Values

USER_DEFINED_8

public static final int USER_DEFINED_8

Reserved value for child classes.

See Also:

• Constant Field Values

FLAG_MASK

public static final int FLAG_MASK

Reserved inner space for mask. Concrete children can have bigger space

See Also:

• Constant Field Values

Constructor Details

AbstractInstructionOperandList

public AbstractInstructionOperandList(int size,
 long value,
 int flags,
 IInstructionOperandGeneric... operands)

Create an operand list.

Parameters:

size - size of the operand

value - internal value, can be 0 if unnecessary

flags - used to format the operand list : this concerns separator as well as container.
For example: BRACKETS | COMMA | SPACE will generate a list [el1, el2, el3]

operands - list of operands

AbstractInstructionOperandList

public AbstractInstructionOperandList(int type,
 int size,
 long value,
 int flags,
 IInstructionOperandGeneric... operands)

Create an operand list.

Parameters:

type - operand type

size - size of the operand

value - internal value, can be 0 if unnecessary

flags - formatting flags

operands - list of operands

Method Details

formatOperand

protected CharSequence formatOperand(IInstruction insn,
 long address)

Overrides:

formatOperand in class AbstractInstructionOperandGeneric

getPrefix

public String getPrefix(IInstruction insn)

Description copied from interface: IInstructionOperandGeneric

Get the optional prefix to be prepended to the formatted operand.

Specified by:

getPrefix in interface IInstructionOperandGeneric

Overrides:

getPrefix in class AbstractInstructionOperandGeneric

Parameters:

insn - instruction containing this operand

Returns:

optional prefix

getSuffix

public String getSuffix(IInstruction insn)

Description copied from interface: IInstructionOperandGeneric

Get the optional suffix to be appended to the formatted operand.

Specified by:

getSuffix in interface IInstructionOperandGeneric

Overrides:

getSuffix in class AbstractInstructionOperandGeneric

Parameters:

insn - instruction containing this operand

Returns:

optional suffix

getOperands

public IInstructionOperand[] getOperands()

Description copied from interface: IInstructionOperandList

Get the list of operands represented by this operand.

Specified by:

getOperands in interface IInstructionOperandList

Returns:

operands in the list

getFlags

public int getFlags()

Retrieve the formatting flags.

Returns:

formatting flags

getSeparator

public String getSeparator()

Description copied from interface: IInstructionOperandList

Retrieve the separator of the elements of the list

Specified by:

getSeparator in interface IInstructionOperandList

Returns:

element separator

merge

public IInstructionOperandGeneric merge(long address)

Description copied from interface: IInstructionOperandList

Attempt to merge parameter list to 1 parameter. When not possible, this method will return null. Otherwise, the returned value can be considered as equivalent to the list. For example 0x45, 0 defined for a right shift is equivalent to 0x22, PC+4 is equivalent to its absolute address.

Specified by:

merge in interface IInstructionOperandList

Parameters:

address - instruction address

Returns:

merged operand, or null if the list cannot be merged

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractInstructionOperandGeneric

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractInstructionOperandGeneric