com.google.javascript.jscomp

Class ExternExportsPass

java.lang.Object

com.google.javascript.jscomp.NodeTraversal.AbstractPostOrderCallback

com.google.javascript.jscomp.ExternExportsPass

All Implemented Interfaces:

CompilerPass, NodeTraversal.Callback

final class ExternExportsPass
extends NodeTraversal.AbstractPostOrderCallback
implements CompilerPass

Creates an externs file containing all exported symbols and properties for later consumption.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ExternExportsPass.Export
private class	ExternExportsPass.PropertyExport A property export.
private class	ExternExportsPass.SymbolExport A symbol export.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<java.lang.String>	alreadyExportedPaths A list of exported paths.
private AbstractCompiler	compiler The parent compiler.
private java.util.Map<java.lang.String,Node>	definitionMap A map of all assigns to their parent nodes.
private java.util.List<java.lang.String>	exportPropertyFunctionNames A list of function names used to export properties.
private java.util.List<ExternExportsPass.Export>	exports The exports found.
private java.util.List<java.lang.String>	exportSymbolFunctionNames A list of function names used to export symbols.
private Node	externsRoot The AST root which holds the externs generated.
private java.util.Map<java.lang.String,java.lang.String>	mappedPaths A mapping of internal paths to exported paths.

Constructor Summary

Constructors

Constructor and Description
ExternExportsPass(AbstractCompiler compiler) Creates an instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getGeneratedExterns() Returns the generated externs.
private void	handleExportDefinition(NodeTraversal t, Node definitionNode)
private void	handlePropertyExportCall(Node parent)
private void	handleSymbolExportCall(Node parent)
private void	initExportMethods()
void	process(Node externs, Node root) Process the JS with root node root.
void	visit(NodeTraversal t, Node n, Node parent) Visits a node in postorder (after its children have been visited).

Methods inherited from class com.google.javascript.jscomp.NodeTraversal.AbstractPostOrderCallback

shouldTraverse

Methods inherited from class java.lang.Object

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

Field Detail

exports

private final java.util.List<ExternExportsPass.Export> exports

The exports found.

definitionMap

private final java.util.Map<java.lang.String,Node> definitionMap

A map of all assigns to their parent nodes.

compiler

private final AbstractCompiler compiler

The parent compiler.

externsRoot

private final Node externsRoot

The AST root which holds the externs generated.

mappedPaths

private final java.util.Map<java.lang.String,java.lang.String> mappedPaths

A mapping of internal paths to exported paths.

alreadyExportedPaths

private final java.util.Set<java.lang.String> alreadyExportedPaths

A list of exported paths.

exportSymbolFunctionNames

private java.util.List<java.lang.String> exportSymbolFunctionNames

A list of function names used to export symbols.

exportPropertyFunctionNames

private java.util.List<java.lang.String> exportPropertyFunctionNames

A list of function names used to export properties.

Constructor Detail

ExternExportsPass

ExternExportsPass(AbstractCompiler compiler)

Creates an instance.

Method Detail

initExportMethods

private void initExportMethods()

process

public void process(Node externs,
                    Node root)

Description copied from interface: CompilerPass

Process the JS with root node root. Can modify the contents of each Node tree

Specified by:

process in interface CompilerPass

Parameters:

externs - Top of external JS tree

root - Top of JS tree

getGeneratedExterns

public java.lang.String getGeneratedExterns()

Returns the generated externs.

visit

public void visit(NodeTraversal t,
                  Node n,
                  Node parent)

Description copied from interface: NodeTraversal.Callback

Visits a node in postorder (after its children have been visited). A node is visited only if all its parents should be traversed (NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node)).

Implementations can have side effects (e.g. modifying the parse tree).

Specified by:

visit in interface NodeTraversal.Callback

handleSymbolExportCall

private void handleSymbolExportCall(Node parent)

handlePropertyExportCall

private void handlePropertyExportCall(Node parent)

handleExportDefinition

private void handleExportDefinition(NodeTraversal t,
                                    Node definitionNode)