Package ghidra.program.util

Class FunctionRepeatableCommentFieldLocation

java.lang.Object

ghidra.program.util.ProgramLocation

ghidra.program.util.FunctionLocation

ghidra.program.util.FunctionRepeatableCommentFieldLocation

All Implemented Interfaces:

java.lang.Comparable<ProgramLocation>

public class FunctionRepeatableCommentFieldLocation
extends FunctionLocation

The FunctionRepeatableCommentFieldLocation class provides specific information about the Function Repeatable Comment field within a program location.

Field Summary

Fields inherited from class ghidra.program.util.FunctionLocation

functionAddr

Fields inherited from class ghidra.program.util.ProgramLocation

addr, program, refAddr

Constructor Summary

Constructors

Constructor	Description
FunctionRepeatableCommentFieldLocation()	Default constructor needed for restoring a program location from XML
FunctionRepeatableCommentFieldLocation(Program program, Address locationAddr, Address functionAddr, java.lang.String[] comment, int row, int charOffset)	Construct a new FunctionRepeatableCommentFieldLocation object.
FunctionRepeatableCommentFieldLocation(Program program, Address functionAddr, java.lang.String[] comment, int row, int col)	Construct a new FunctionRepeatableCommentFieldLocation object.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String[]	getComment()	Return the function comment string at this location.
int	hashCode()
void	restoreState(Program p, SaveState obj)	Restore this function location using the given program and save state object.
void	saveState(SaveState obj)	Save this function location to the given save state object.

Methods inherited from class ghidra.program.util.FunctionLocation

getFunctionAddress, isValid, toString

Methods inherited from class ghidra.program.util.ProgramLocation

compareAddr, compareTo, getAddress, getByteAddress, getCharOffset, getColumn, getComponentPath, getLocation, getProgram, getRefAddress, getRow

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionRepeatableCommentFieldLocation

public FunctionRepeatableCommentFieldLocation(Program program,
                                              Address locationAddr,
                                              Address functionAddr,
                                              java.lang.String[] comment,
                                              int row,
                                              int charOffset)

Construct a new FunctionRepeatableCommentFieldLocation object.

Parameters:

program - the program of the location

locationAddr - the address of the listing location (i.e., referent code unit)

functionAddr - the function address

comment - the function comment array String at this location.

row - row number (index into the comment array)

charOffset - character position within the comment, indexed by row

FunctionRepeatableCommentFieldLocation

public FunctionRepeatableCommentFieldLocation(Program program,
                                              Address functionAddr,
                                              java.lang.String[] comment,
                                              int row,
                                              int col)

Construct a new FunctionRepeatableCommentFieldLocation object.

Parameters:

program - the program of the location

functionAddr - the function address (must not be an EXTERNAL function)

comment - the function comment array String at this location.

row - row number (index into the comment array)

col - character position within the comment, indexed by row

FunctionRepeatableCommentFieldLocation

public FunctionRepeatableCommentFieldLocation()

Default constructor needed for restoring a program location from XML

Method Detail

getComment

public java.lang.String[] getComment()

Return the function comment string at this location.

hashCode

public int hashCode()

Overrides:

hashCode in class ProgramLocation

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class FunctionLocation

See Also:

Object.equals(java.lang.Object)

saveState

public void saveState(SaveState obj)

Description copied from class: FunctionLocation

Save this function location to the given save state object.

Overrides:

saveState in class FunctionLocation

Parameters:

obj - the save state object for saving the location

restoreState

public void restoreState(Program p,
                         SaveState obj)

Description copied from class: FunctionLocation

Restore this function location using the given program and save state object.

Overrides:

restoreState in class FunctionLocation

Parameters:

p - the program containing the function location

obj - the save state object for saving the location