Package ghidra.app.decompiler

Class ClangToken

java.lang.Object

ghidra.app.decompiler.ClangToken

All Implemented Interfaces:

ClangNode

Direct Known Subclasses:

ClangBreak, ClangCommentToken, ClangFieldToken, ClangFuncNameToken, ClangLabelToken, ClangOpToken, ClangSyntaxToken, ClangTypeToken, ClangVariableToken

public class ClangToken
extends Object
implements ClangNode

Class representing a C code language token May contain links back to pcode object

Field Summary

Fields

Modifier and Type	Field	Description
static final int	COMMENT_COLOR
static final int	CONST_COLOR
static final int	DEFAULT_COLOR
static final int	ERROR_COLOR
static final int	FUNCTION_COLOR
static final int	GLOBAL_COLOR
static final int	KEYWORD_COLOR
static final int	MAX_COLOR
static final int	PARAMETER_COLOR
static final int	SPECIAL_COLOR
static final int	TYPE_COLOR
static final int	VARIABLE_COLOR

Constructor Summary

Constructors

Constructor	Description
ClangToken(ClangNode par)
ClangToken(ClangNode par, String txt)
ClangToken(ClangNode par, String txt, int color)

Method Summary

Modifier and Type	Method	Description
static ClangToken	buildSpacer(ClangNode par, int indent, String indentStr)
static ClangToken	buildToken(int node, ClangNode par, Decoder decoder, PcodeFactory pfactory)
ClangNode	Child(int i)
void	decode(Decoder decoder, PcodeFactory pfactory)
void	flatten(List<ClangNode> list)
ClangFunction	getClangFunction()
Color	getHighlight()
HighVariable	getHighVariable()	Get the high-level variable associate with this token or null otherwise
ClangLine	getLineParent()
Address	getMaxAddress()
Address	getMinAddress()
PcodeOp	getPcodeOp()	Many tokens directly represent a pcode operator in the data-flow
int	getSyntaxType()
String	getText()
Varnode	getVarnode()	Many tokens directly represent a variable in the data-flow
boolean	isMatchingToken()
boolean	isVariableRef()
int	numChildren()
ClangNode	Parent()
void	setHighlight(Color val)
void	setLineParent(ClangLine line)
void	setMatchingToken(boolean matchingToken)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

KEYWORD_COLOR

public static final int KEYWORD_COLOR

See Also:

• Constant Field Values

COMMENT_COLOR

public static final int COMMENT_COLOR

See Also:

• Constant Field Values

TYPE_COLOR

public static final int TYPE_COLOR

See Also:

• Constant Field Values

FUNCTION_COLOR

public static final int FUNCTION_COLOR

See Also:

• Constant Field Values

VARIABLE_COLOR

public static final int VARIABLE_COLOR

See Also:

• Constant Field Values

CONST_COLOR

public static final int CONST_COLOR

See Also:

• Constant Field Values

PARAMETER_COLOR

public static final int PARAMETER_COLOR

See Also:

• Constant Field Values

GLOBAL_COLOR

public static final int GLOBAL_COLOR

See Also:

• Constant Field Values

DEFAULT_COLOR

public static final int DEFAULT_COLOR

See Also:

• Constant Field Values

ERROR_COLOR

public static final int ERROR_COLOR

See Also:

• Constant Field Values

SPECIAL_COLOR

public static final int SPECIAL_COLOR

See Also:

• Constant Field Values

MAX_COLOR

public static final int MAX_COLOR

See Also:

• Constant Field Values

Constructor Details

ClangToken

public ClangToken(ClangNode par)

ClangToken

public ClangToken(ClangNode par,
 String txt)

ClangToken

public ClangToken(ClangNode par,
 String txt,
 int color)

Method Details

Parent

public ClangNode Parent()

Specified by:

Parent in interface ClangNode

getLineParent

public ClangLine getLineParent()

setLineParent

public void setLineParent(ClangLine line)

getMinAddress

public Address getMinAddress()

Specified by:

getMinAddress in interface ClangNode

getMaxAddress

public Address getMaxAddress()

Specified by:

getMaxAddress in interface ClangNode

numChildren

public int numChildren()

Specified by:

numChildren in interface ClangNode

Child

public ClangNode Child(int i)

Specified by:

Child in interface ClangNode

getClangFunction

public ClangFunction getClangFunction()

Specified by:

getClangFunction in interface ClangNode

setHighlight

public void setHighlight(Color val)

Specified by:

setHighlight in interface ClangNode

getHighlight

public Color getHighlight()

setMatchingToken

public void setMatchingToken(boolean matchingToken)

isMatchingToken

public boolean isMatchingToken()

isVariableRef

public boolean isVariableRef()

getSyntaxType

public int getSyntaxType()

getText

public String getText()

decode

public void decode(Decoder decoder,
 PcodeFactory pfactory)
            throws DecoderException

Throws:

DecoderException

flatten

public void flatten(List<ClangNode> list)

Specified by:

flatten in interface ClangNode

buildToken

public static ClangToken buildToken(int node,
 ClangNode par,
 Decoder decoder,
 PcodeFactory pfactory)
                             throws DecoderException

Throws:

DecoderException

buildSpacer

public static ClangToken buildSpacer(ClangNode par,
 int indent,
 String indentStr)

toString

public String toString()

Overrides:

toString in class Object

getHighVariable

public HighVariable getHighVariable()

Get the high-level variable associate with this token or null otherwise

Returns:

HighVariable

getVarnode

public Varnode getVarnode()

Many tokens directly represent a variable in the data-flow

Returns:

the variable (Varnode) associated with this token or null

getPcodeOp

public PcodeOp getPcodeOp()

Many tokens directly represent a pcode operator in the data-flow

Returns:

the operation (PcodeOp) associated with this token or null