Package ghidra.app.decompiler.component

Class TokenHighlights

java.lang.Object

ghidra.app.decompiler.component.TokenHighlights

All Implemented Interfaces:

java.lang.Iterable<HighlightToken>

public class TokenHighlights
extends java.lang.Object
implements java.lang.Iterable<HighlightToken>

A simple class to manage HighlightTokens used to create highlights in the Decompiler. This class allows clients to access highlights either by a ClangToken or a HighlightToken.

Constructor Summary

Constructors

Constructor	Description
TokenHighlights()

Method Summary

Modifier and Type	Method	Description
void	add(HighlightToken t)	Adds the given highlight to this container
void	clear()	Removes all highlights from this container
boolean	contains(ClangToken t)	Returns true if this class has a highlight for the given token
java.util.Map<java.lang.String,java.awt.Color>	copyHighlightsByName()
HighlightToken	get(ClangToken t)	Gets the current highlight for the given token
java.util.Set<HighlightToken>	getHighlightsByFunction(Function f)	Returns all highlights for the given function
boolean	isEmpty()	Returns true if there are not highlights
java.util.Iterator<HighlightToken>	iterator()
void	remove(ClangToken t)	Removes the highlight for the given token
java.util.Set<HighlightToken>	removeHighlightsByFunction(Function function)	Removes all highlights associated with the given function
int	size()	Returns the number of highlights
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TokenHighlights

public TokenHighlights()

Method Detail

copyHighlightsByName

public java.util.Map<java.lang.String,java.awt.Color> copyHighlightsByName()

isEmpty

public boolean isEmpty()

Returns true if there are not highlights

Returns:

true if there are not highlights

size

public int size()

Returns the number of highlights

Returns:

the number of highlights

add

public void add(HighlightToken t)

Adds the given highlight to this container

Parameters:

t - the highlight

get

public HighlightToken get(ClangToken t)

Gets the current highlight for the given token

Parameters:

t - the token

Returns:

the highlight

getHighlightsByFunction

public java.util.Set<HighlightToken> getHighlightsByFunction(Function f)

Returns all highlights for the given function

Parameters:

f - the function

Returns:

the highlights

contains

public boolean contains(ClangToken t)

Returns true if this class has a highlight for the given token

Parameters:

t - the token

Returns:

true if this class has a highlight for the given token

clear

public void clear()

Removes all highlights from this container

remove

public void remove(ClangToken t)

Removes the highlight for the given token

Parameters:

t - the token

removeHighlightsByFunction

public java.util.Set<HighlightToken> removeHighlightsByFunction(Function function)

Removes all highlights associated with the given function

Parameters:

function - the function

Returns:

the removed highlights; empty if no highlights existed

iterator

public java.util.Iterator<HighlightToken> iterator()

Specified by:

iterator in interface java.lang.Iterable<HighlightToken>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object