org.antlr.v4.runtime.tree

Class Trees

java.lang.Object

org.antlr.v4.runtime.tree.Trees

public class Trees
extends Object

A set of utility routines useful for all kinds of ANTLR trees.

Method Summary

Methods

Modifier and Type	Method and Description
static void	_findAllNodes(ParseTree t, int index, boolean findTokens, List<? super ParseTree> nodes)
static List<ParseTree>	descendants(ParseTree t)
static List<ParseTree>	findAllNodes(ParseTree t, int index, boolean findTokens)
static Collection<ParseTree>	findAllRuleNodes(ParseTree t, int ruleIndex)
static Collection<ParseTree>	findAllTokenNodes(ParseTree t, int ttype)
static List<? extends Tree>	getAncestors(Tree t) Return a list of all ancestors of this node.
static List<Tree>	getChildren(Tree t) Return ordered list of all children of this node
static String	getNodeText(Tree t, List<String> ruleNames)
static String	getNodeText(Tree t, Parser recog)
static String	getPS(Tree t, List<String> ruleNames)
static String	getPS(Tree t, List<String> ruleNames, String fontName, int fontSize)
static String	toStringTree(Tree t) Print out a whole tree in LISP form.
static String	toStringTree(Tree t, List<String> ruleNames) Print out a whole tree in LISP form.
static String	toStringTree(Tree t, Parser recog) Print out a whole tree in LISP form.
static void	writePS(Tree t, List<String> ruleNames, String fileName)
static void	writePS(Tree t, List<String> ruleNames, String fileName, String fontName, int fontSize)

Methods inherited from class java.lang.Object

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

Method Detail

getPS

public static String getPS(Tree t,
           @Nullable
           List<String> ruleNames,
           String fontName,
           int fontSize)

getPS

public static String getPS(Tree t,
           @Nullable
           List<String> ruleNames)

writePS

public static void writePS(Tree t,
           @Nullable
           List<String> ruleNames,
           String fileName,
           String fontName,
           int fontSize)
                    throws IOException

Throws:

IOException

writePS

public static void writePS(Tree t,
           @Nullable
           List<String> ruleNames,
           String fileName)
                    throws IOException

Throws:

IOException

toStringTree

public static String toStringTree(@NotNull
                  Tree t)

Print out a whole tree in LISP form. getNodeText(org.antlr.v4.runtime.tree.Tree, org.antlr.v4.runtime.Parser) is used on the node payloads to get the text for the nodes. Detect parse trees and extract data appropriately.

toStringTree

public static String toStringTree(@NotNull
                  Tree t,
                  @Nullable
                  Parser recog)

Print out a whole tree in LISP form. getNodeText(org.antlr.v4.runtime.tree.Tree, org.antlr.v4.runtime.Parser) is used on the node payloads to get the text for the nodes. Detect parse trees and extract data appropriately.

toStringTree

public static String toStringTree(@NotNull
                  Tree t,
                  @Nullable
                  List<String> ruleNames)

Print out a whole tree in LISP form. getNodeText(org.antlr.v4.runtime.tree.Tree, org.antlr.v4.runtime.Parser) is used on the node payloads to get the text for the nodes. Detect parse trees and extract data appropriately.

getNodeText

public static String getNodeText(@NotNull
                 Tree t,
                 @Nullable
                 Parser recog)

getNodeText

public static String getNodeText(@NotNull
                 Tree t,
                 @Nullable
                 List<String> ruleNames)

getChildren

public static List<Tree> getChildren(Tree t)

Return ordered list of all children of this node

getAncestors

@NotNull
public static List<? extends Tree> getAncestors(@NotNull
                                        Tree t)

Return a list of all ancestors of this node. The first node of list is the root and the last is the parent of this node.

findAllTokenNodes

public static Collection<ParseTree> findAllTokenNodes(ParseTree t,
                                      int ttype)

findAllRuleNodes

public static Collection<ParseTree> findAllRuleNodes(ParseTree t,
                                     int ruleIndex)

findAllNodes

public static List<ParseTree> findAllNodes(ParseTree t,
                           int index,
                           boolean findTokens)

_findAllNodes

public static void _findAllNodes(ParseTree t,
                 int index,
                 boolean findTokens,
                 List<? super ParseTree> nodes)

descendants

public static List<ParseTree> descendants(ParseTree t)