Package org.mozilla.javascript.ast
Class AstRoot
- java.lang.Object
-
public class AstRoot extends ScriptNode
Node for the root of a parse tree. It contains the statements and functions in the script, and a list ofCommentnodes associated with the script as a whole. Node type isToken.SCRIPT.Note that the tree itself does not store errors. To collect the parse errors and warnings, pass an
ErrorReporterto theParservia theCompilerEnvirons.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.mozilla.javascript.ast.AstNode
AstNode.DebugPrintVisitor, AstNode.PositionComparator
-
Nested classes/interfaces inherited from class org.mozilla.javascript.Node
Node.NodeIterator
-
-
Field Summary
-
Fields inherited from class org.mozilla.javascript.ast.Scope
parentScope, symbolTable, top
-
Fields inherited from class org.mozilla.javascript.ast.AstNode
inlineComment, length, parent, position
-
Fields inherited from class org.mozilla.javascript.Node
ARROW_FUNCTION_PROP, ATTRIBUTE_FLAG, BOTH, CASEARRAY_PROP, CATCH_SCOPE_PROP, CONTROL_BLOCK_PROP, DECR_FLAG, DESCENDANTS_FLAG, DESTRUCTURING_ARRAY_LENGTH, DESTRUCTURING_NAMES, DESTRUCTURING_PARAMS, DIRECTCALL_PROP, END_DROPS_OFF, END_RETURNS, END_RETURNS_VALUE, END_UNREACHED, END_YIELDS, EXPRESSION_CLOSURE_PROP, first, FUNCTION_PROP, GENERATOR_END_PROP, INCRDECR_PROP, ISNUMBER_PROP, JSDOC_PROP, LABEL_ID_PROP, last, LAST_PROP, LEFT, lineno, LOCAL_BLOCK_PROP, LOCAL_PROP, MEMBER_TYPE_PROP, NAME_PROP, next, NON_SPECIALCALL, OBJECT_IDS_PROP, PARENTHESIZED_PROP, POST_FLAG, PROPERTY_FLAG, propListHead, REGEXP_PROP, RIGHT, SHORTHAND_PROPERTY_NAME, SKIP_INDEXES_PROP, SPECIALCALL_EVAL, SPECIALCALL_PROP, SPECIALCALL_WITH, TARGETBLOCK_PROP, TEMPLATE_LITERAL_PROP, TRAILING_COMMA, type, VARIABLE_PROP
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddComment(Comment comment)Add a comment to the comment set.voidcheckParentLinks()Debugging function to check that the parser has set the parent link for every node in the tree.java.lang.StringdebugPrint()A debug-printer that includes comments (at the end).java.util.SortedSet<Comment>getComments()Returns comment setvoidsetComments(java.util.SortedSet<Comment> comments)Sets comment list, and updates the parent of each entry to point to this node.java.lang.StringtoSource(int depth)Emits source code for this node.voidvisitAll(NodeVisitor visitor)Visits the AST nodes, then the comment nodes.voidvisitComments(NodeVisitor visitor)Visits the comment nodes in the order they appear in the source code.-
Methods inherited from class org.mozilla.javascript.ast.ScriptNode
addFunction, addRegExp, addTemplateLiteral, flattenSymbolTable, getBaseLineno, getCompilerData, getEncodedSource, getEncodedSourceEnd, getEncodedSourceStart, getEndLineno, getFunctionCount, getFunctionNode, getFunctions, getIndexForNameNode, getNextTempName, getParamAndVarConst, getParamAndVarCount, getParamAndVarNames, getParamCount, getParamOrVarName, getRegexpCount, getRegexpFlags, getRegexpString, getSourceName, getSymbols, getTemplateLiteralCount, getTemplateLiteralStrings, hasRestParameter, isInStrictMode, setBaseLineno, setCompilerData, setEncodedSource, setEncodedSourceBounds, setEncodedSourceEnd, setEncodedSourceStart, setEndLineno, setInStrictMode, setSourceName, setSymbols, visit
-
Methods inherited from class org.mozilla.javascript.ast.Scope
addChildScope, clearParentScope, getChildScopes, getDefiningScope, getParentScope, getStatements, getSymbol, getSymbolTable, getTop, joinScopes, putSymbol, replaceWith, setParentScope, setSymbolTable, setTop, splitScope
-
Methods inherited from class org.mozilla.javascript.ast.Jump
getContinue, getDefault, getFinally, getJumpStatement, getLoop, setContinue, setDefault, setFinally, setJumpStatement, setLoop
-
Methods inherited from class org.mozilla.javascript.ast.AstNode
addChild, assertNotNull, codeBug, compareTo, depth, getAbsolutePosition, getAstRoot, getEnclosingFunction, getEnclosingScope, getInlineComment, getLength, getLineno, getParent, getPosition, hasSideEffects, makeIndent, operatorToString, printList, setBounds, setInlineComment, setLength, setParent, setPosition, setRelative, shortName, toSource
-
Methods inherited from class org.mozilla.javascript.Node
addChildAfter, addChildBefore, addChildrenToBack, addChildrenToFront, addChildToBack, addChildToFront, getBigInt, getChildBefore, getDouble, getExistingIntProp, getFirstChild, getIntProp, getJsDoc, getJsDocNode, getLastChild, getLastSibling, getNext, getProp, getScope, getString, getType, hasChildren, hasConsistentReturnUsage, iterator, labelId, labelId, newNumber, newString, newString, newTarget, putIntProp, putProp, removeChild, removeChildren, removeProp, replaceChild, replaceChildAfter, resetTargets, setBigInt, setDouble, setJsDocNode, setLineno, setScope, setString, setType, toString, toStringTree
-
-
-
-
Method Detail
-
getComments
public java.util.SortedSet<Comment> getComments()
Returns comment set- Returns:
- comment set, sorted by start position. Can be
null.
-
setComments
public void setComments(java.util.SortedSet<Comment> comments)
Sets comment list, and updates the parent of each entry to point to this node. Replaces any existing comments.- Parameters:
comments- comment list. can benull.
-
addComment
public void addComment(Comment comment)
Add a comment to the comment set.- Parameters:
comment- the comment node.- Throws:
java.lang.IllegalArgumentException- if comment isnull
-
visitComments
public void visitComments(NodeVisitor visitor)
Visits the comment nodes in the order they appear in the source code. The comments are not visited by theScriptNode.visit(org.mozilla.javascript.ast.NodeVisitor)function - you must use this function to visit them.- Parameters:
visitor- the callback object. It is passed each comment node. The return value is ignored.
-
visitAll
public void visitAll(NodeVisitor visitor)
Visits the AST nodes, then the comment nodes. This method is equivalent to callingScriptNode.visit(org.mozilla.javascript.ast.NodeVisitor), thenvisitComments(org.mozilla.javascript.ast.NodeVisitor). The return value is ignored while visiting comment nodes.- Parameters:
visitor- the callback object.
-
toSource
public java.lang.String toSource(int depth)
Description copied from class:AstNodeEmits source code for this node. Callee is responsible for calling this function recursively on children, incrementing indent as appropriate.Note: if the parser was in error-recovery mode, some AST nodes may have
nullchildren that are expected to be non-nullwhen no errors are present. In this situation, the behavior of thetoSourcemethod is undefined:toSourceimplementations may assume that the AST node is error-free, since it is intended to be invoked only at runtime after a successful parse.
-
debugPrint
public java.lang.String debugPrint()
A debug-printer that includes comments (at the end).- Overrides:
debugPrintin classAstNode- Returns:
- a very verbose indented printout of the tree. The format of each line is: abs-pos name position length [identifier]
-
checkParentLinks
public void checkParentLinks()
Debugging function to check that the parser has set the parent link for every node in the tree.- Throws:
java.lang.IllegalStateException- if a parent link is missing
-
-