Package ghidra.app.plugin.assembler.sleigh.symbol

Class AssemblyStringTerminal

java.lang.Object

ghidra.app.plugin.assembler.sleigh.symbol.AssemblySymbol

ghidra.app.plugin.assembler.sleigh.symbol.AssemblyTerminal

ghidra.app.plugin.assembler.sleigh.symbol.AssemblyStringTerminal

All Implemented Interfaces:

java.lang.Comparable<AssemblySymbol>

public class AssemblyStringTerminal
extends AssemblyTerminal

A terminal that accepts only a particular string

Field Summary

Fields

Change	Modifier and Type	Field	Description
NEW	protected java.lang.String	str

Fields inherited from class ghidra.app.plugin.assembler.sleigh.symbol.AssemblySymbol

name

Constructor Summary

Constructors

Change	Constructor	Description
AssemblyStringTerminal(java.lang.String str)	Construct a terminal that accepts only the given string

Method Summary

Change	Modifier and Type	Method	Description
	java.util.Collection<java.lang.String>	getSuggestions(java.lang.String got, java.util.Map<java.lang.String,java.lang.Long> labels)	Provide a collection of strings that this terminal would have accepted
	java.util.Collection<AssemblyParseToken>	match(java.lang.String buffer, int pos, AssemblyGrammar grammar, java.util.Map<java.lang.String,java.lang.Long> labels)	Attempt to match a token from the input buffer starting at a given position
	boolean	takesOperandIndex()	Check if this symbol consumes an operand index of its constructor
	java.lang.String	toString()

Methods inherited from class ghidra.app.plugin.assembler.sleigh.symbol.AssemblySymbol

compareTo, equals, getName, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

str NEW

protected final java.lang.String str

Constructor Detail

AssemblyStringTerminal

public AssemblyStringTerminal(java.lang.String str)

Construct a terminal that accepts only the given string

Parameters:

str - the string to accept

Method Detail

toString

public java.lang.String toString()

Specified by:

toString in class AssemblySymbol

match

public java.util.Collection<AssemblyParseToken> match(java.lang.String buffer,
                                                      int pos,
                                                      AssemblyGrammar grammar,
                                                      java.util.Map<java.lang.String,java.lang.Long> labels)

Description copied from class: AssemblyTerminal

Attempt to match a token from the input buffer starting at a given position

Specified by:

match in class AssemblyTerminal

Parameters:

buffer - the input buffer

pos - the cursor position in the buffer

grammar - the grammar containing this terminal

labels - the program labels, if applicable

Returns:

the matched token, or null

getSuggestions

public java.util.Collection<java.lang.String> getSuggestions(java.lang.String got,
                                                             java.util.Map<java.lang.String,java.lang.Long> labels)

Description copied from class: AssemblyTerminal

Provide a collection of strings that this terminal would have accepted

Specified by:

getSuggestions in class AssemblyTerminal

Parameters:

got - the remaining contents of the input buffer

labels - the program labels, if applicable

Returns:

a, possibly empty, collection of suggestions

takesOperandIndex

public boolean takesOperandIndex()

Description copied from class: AssemblySymbol

Check if this symbol consumes an operand index of its constructor

Overrides:

takesOperandIndex in class AssemblySymbol

Returns:

true if the symbol represents an operand