org.antlr.v4.runtime.tree

Class Trees

java.lang.Object

org.antlr.v4.runtime.tree.Trees

public class Trees
extends java.lang.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, java.util.List<? super ParseTree> nodes)
static java.util.List<ParseTree>	descendants(ParseTree t)
static java.util.List<ParseTree>	findAllNodes(ParseTree t, int index, boolean findTokens)
static java.util.Collection<ParseTree>	findAllRuleNodes(ParseTree t, int ruleIndex)
static java.util.Collection<ParseTree>	findAllTokenNodes(ParseTree t, int ttype)
static java.util.List<? extends Tree>	getAncestors(Tree t) Return a list of all ancestors of this node.
static java.util.List<Tree>	getChildren(Tree t) Return ordered list of all children of this node
static java.lang.String	getNodeText(Tree t, java.util.List<java.lang.String> ruleNames)
static java.lang.String	getNodeText(Tree t, Parser recog)
static java.lang.String	getPS(Tree t, java.util.List<java.lang.String> ruleNames)
static java.lang.String	getPS(Tree t, java.util.List<java.lang.String> ruleNames, java.lang.String fontName, int fontSize)
static java.lang.String	toStringTree(Tree t) Print out a whole tree in LISP form.
static java.lang.String	toStringTree(Tree t, java.util.List<java.lang.String> ruleNames) Print out a whole tree in LISP form.
static java.lang.String	toStringTree(Tree t, Parser recog) Print out a whole tree in LISP form.
static void	writePS(Tree t, java.util.List<java.lang.String> ruleNames, java.lang.String fileName)
static void	writePS(Tree t, java.util.List<java.lang.String> ruleNames, java.lang.String fileName, java.lang.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 java.lang.String getPS(Tree t,
                     java.util.List<java.lang.String> ruleNames,
                     java.lang.String fontName,
                     int fontSize)

getPS

public static java.lang.String getPS(Tree t,
                     java.util.List<java.lang.String> ruleNames)

writePS

public static void writePS(Tree t,
           java.util.List<java.lang.String> ruleNames,
           java.lang.String fileName,
           java.lang.String fontName,
           int fontSize)
                    throws java.io.IOException

Throws:

java.io.IOException

writePS

public static void writePS(Tree t,
           java.util.List<java.lang.String> ruleNames,
           java.lang.String fileName)
                    throws java.io.IOException

Throws:

java.io.IOException

toStringTree

public static java.lang.String toStringTree(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 java.lang.String toStringTree(Tree t,
                            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 java.lang.String toStringTree(Tree t,
                            java.util.List<java.lang.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 java.lang.String getNodeText(Tree t,
                           Parser recog)

getNodeText

public static java.lang.String getNodeText(Tree t,
                           java.util.List<java.lang.String> ruleNames)

getChildren

public static java.util.List<Tree> getChildren(Tree t)

Return ordered list of all children of this node

getAncestors

public static java.util.List<? extends Tree> getAncestors(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 java.util.Collection<ParseTree> findAllTokenNodes(ParseTree t,
                                                int ttype)

findAllRuleNodes

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

findAllNodes

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

_findAllNodes

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

descendants

public static java.util.List<ParseTree> descendants(ParseTree t)