Class TokenHighlights

java.lang.Object
ghidra.app.decompiler.component.TokenHighlights
All Implemented Interfaces:
Iterable<HighlightToken>

public class TokenHighlights extends Object implements 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 Details

    • TokenHighlights

      public TokenHighlights()
  • Method Details

    • copyHighlightsByName

      public Map<String,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
    • 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
    • iterator

      public Iterator<HighlightToken> iterator()
      Specified by:
      iterator in interface Iterable<HighlightToken>
    • toString

      public String toString()
      Overrides:
      toString in class Object