com.google.javascript.jscomp

Class ClosureRewriteClass

java.lang.Object

com.google.javascript.jscomp.NodeTraversal.AbstractPostOrderCallback

com.google.javascript.jscomp.ClosureRewriteClass

All Implemented Interfaces:

CompilerPass, HotSwapCompilerPass, NodeTraversal.Callback

class ClosureRewriteClass
extends NodeTraversal.AbstractPostOrderCallback
implements HotSwapCompilerPass

Rewrites "goog.defineClass" into a form that is suitable for type checking and dead code elimination.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ClosureRewriteClass.ClassDefinition
private static class	ClosureRewriteClass.MemberDefinition

Field Summary

Fields

Modifier and Type	Field and Description
private AbstractCompiler	compiler
(package private) static DiagnosticType	GOOG_CLASS_CONSTRUCTOR_MISSING
(package private) static DiagnosticType	GOOG_CLASS_CONSTRUCTOR_NOT_VALID
(package private) static DiagnosticType	GOOG_CLASS_CONSTRUCTOR_ON_INTERFACE
(package private) static DiagnosticType	GOOG_CLASS_DESCRIPTOR_NOT_VALID
(package private) static DiagnosticType	GOOG_CLASS_ES6_ARROW_FUNCTION_NOT_SUPPORTED
(package private) static DiagnosticType	GOOG_CLASS_ES6_COMPUTED_PROP_NAMES_NOT_SUPPORTED
(package private) static DiagnosticType	GOOG_CLASS_ES6_SHORTHAND_ASSIGNMENT_NOT_SUPPORTED
(package private) static DiagnosticType	GOOG_CLASS_NG_INJECT_ON_CLASS
(package private) static DiagnosticType	GOOG_CLASS_STATICS_NOT_VALID
(package private) static DiagnosticType	GOOG_CLASS_SUPER_CLASS_NOT_VALID
(package private) static DiagnosticType	GOOG_CLASS_TARGET_INVALID
(package private) static DiagnosticType	GOOG_CLASS_UNEXPECTED_PARAMS
(package private) static java.lang.String	VIRTUAL_FILE

Constructor Summary

Constructors

Constructor and Description
ClosureRewriteClass(AbstractCompiler compiler)

Method Summary

Modifier and Type	Method and Description
private ClosureRewriteClass.ClassDefinition	extractClassDefinition(Node targetName, Node callNode) Validates the class definition and if valid, destructively extracts the class definition from the AST.
private static Node	extractProperty(Node objlit, java.lang.String keyName)
private static Node	fixupFreeCall(Node call)
private static Node	fixupSrcref(Node node)
void	hotSwapScript(Node scriptRoot, Node originalRoot) Process the JS with root node root.
private boolean	isContainedInGoogDefineClass(Node n)
private static boolean	isGoogDefineClass(Node value)
private static Node	maybeDetach(Node node)
private void	maybeRewriteClassDefinition(Node n)
private void	maybeRewriteClassDefinition(Node n, Node target, Node value)
private JSDocInfo	mergeJsDocFor(ClosureRewriteClass.ClassDefinition cls, Node associatedNode)
private static java.util.List<ClosureRewriteClass.MemberDefinition>	objectLitToList(Node objlit)
void	process(Node externs, Node root) Process the JS with root node root.
private void	reportErrorOnContext(Node parent)
private void	rewriteGoogDefineClass(Node exprRoot, ClosureRewriteClass.ClassDefinition cls)
private boolean	validateObjLit(Node objlit, Node parent)
private boolean	validateUsage(Node n)
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

GOOG_CLASS_TARGET_INVALID

static final DiagnosticType GOOG_CLASS_TARGET_INVALID

GOOG_CLASS_SUPER_CLASS_NOT_VALID

static final DiagnosticType GOOG_CLASS_SUPER_CLASS_NOT_VALID

GOOG_CLASS_DESCRIPTOR_NOT_VALID

static final DiagnosticType GOOG_CLASS_DESCRIPTOR_NOT_VALID

GOOG_CLASS_CONSTRUCTOR_MISSING

static final DiagnosticType GOOG_CLASS_CONSTRUCTOR_MISSING

GOOG_CLASS_CONSTRUCTOR_NOT_VALID

static final DiagnosticType GOOG_CLASS_CONSTRUCTOR_NOT_VALID

GOOG_CLASS_CONSTRUCTOR_ON_INTERFACE

static final DiagnosticType GOOG_CLASS_CONSTRUCTOR_ON_INTERFACE

GOOG_CLASS_STATICS_NOT_VALID

static final DiagnosticType GOOG_CLASS_STATICS_NOT_VALID

GOOG_CLASS_UNEXPECTED_PARAMS

static final DiagnosticType GOOG_CLASS_UNEXPECTED_PARAMS

GOOG_CLASS_ES6_COMPUTED_PROP_NAMES_NOT_SUPPORTED

static final DiagnosticType GOOG_CLASS_ES6_COMPUTED_PROP_NAMES_NOT_SUPPORTED

GOOG_CLASS_ES6_SHORTHAND_ASSIGNMENT_NOT_SUPPORTED

static final DiagnosticType GOOG_CLASS_ES6_SHORTHAND_ASSIGNMENT_NOT_SUPPORTED

GOOG_CLASS_ES6_ARROW_FUNCTION_NOT_SUPPORTED

static final DiagnosticType GOOG_CLASS_ES6_ARROW_FUNCTION_NOT_SUPPORTED

GOOG_CLASS_NG_INJECT_ON_CLASS

static final DiagnosticType GOOG_CLASS_NG_INJECT_ON_CLASS

compiler

private final AbstractCompiler compiler

VIRTUAL_FILE

static final java.lang.String VIRTUAL_FILE

See Also:

Constant Field Values

Constructor Detail

ClosureRewriteClass

public ClosureRewriteClass(AbstractCompiler compiler)

Method Detail

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

hotSwapScript

public void hotSwapScript(Node scriptRoot,
                          Node originalRoot)

Description copied from interface: HotSwapCompilerPass

Process the JS with root node root. This is supposed to be significantly faster compared to corresponding full-compiler passes.

Specified by:

hotSwapScript in interface HotSwapCompilerPass

Parameters:

scriptRoot - Root node corresponding to the file that is modified, should be of type Token.SCRIPT.

originalRoot - Root node corresponding to the original version of the file that is modified. Should be of type token.SCRIPT.

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

validateUsage

private boolean validateUsage(Node n)

isContainedInGoogDefineClass

private boolean isContainedInGoogDefineClass(Node n)

maybeRewriteClassDefinition

private void maybeRewriteClassDefinition(Node n)

maybeRewriteClassDefinition

private void maybeRewriteClassDefinition(Node n,
                                         Node target,
                                         Node value)

extractClassDefinition

private ClosureRewriteClass.ClassDefinition extractClassDefinition(Node targetName,
                                                                   Node callNode)

Validates the class definition and if valid, destructively extracts the class definition from the AST.

maybeDetach

private static Node maybeDetach(Node node)

validateObjLit

private boolean validateObjLit(Node objlit,
                               Node parent)

Parameters:

objlit - the object literal being checked.

parent - the parent of the object literal node

Returns:

false if the node is not an object literal, or if it contains any property that is neither unquoted plain property nor member function definition (ES6 feature)

reportErrorOnContext

private void reportErrorOnContext(Node parent)

extractProperty

private static Node extractProperty(Node objlit,
                                    java.lang.String keyName)

Returns:

The first property in the objlit that matches the key.

objectLitToList

private static java.util.List<ClosureRewriteClass.MemberDefinition> objectLitToList(Node objlit)

rewriteGoogDefineClass

private void rewriteGoogDefineClass(Node exprRoot,
                                    ClosureRewriteClass.ClassDefinition cls)

fixupSrcref

private static Node fixupSrcref(Node node)

fixupFreeCall

private static Node fixupFreeCall(Node call)

isGoogDefineClass

private static boolean isGoogDefineClass(Node value)

Returns:

Whether the call represents a class definition.

mergeJsDocFor

private JSDocInfo mergeJsDocFor(ClosureRewriteClass.ClassDefinition cls,
                                Node associatedNode)