com.google.javascript.jscomp

Class ExternExportsPass.Export

java.lang.Object

com.google.javascript.jscomp.ExternExportsPass.Export

Direct Known Subclasses:

ExternExportsPass.PropertyExport, ExternExportsPass.SymbolExport

Enclosing class:

ExternExportsPass

private abstract class ExternExportsPass.Export
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	symbolName
protected Node	value

Constructor Summary

Constructors

Constructor and Description
Export(java.lang.String symbolName, Node value)

Method Summary

Modifier and Type	Method and Description
(package private) void	appendExtern(java.lang.String path, Node valueToExport) Appends the exported function and all paths necessary for the path to be declared.
private void	appendPathDefinition(java.lang.String path, Node initializer)
private JSDocInfo	buildEmptyJSDoc()
private java.util.List<java.lang.String>	computePathPrefixes(java.lang.String path) Computes a list of the path prefixes constructed from the components of the path.
private Node	createExternFunction(Node exportedFunction) Given a function to export, create the empty function that will be put in the externs file.
private Node	createExternObjectLit(Node exportedObjectLit) Given an object literal to export, create an object lit with all its string properties.
(package private) void	generateExterns() Generates the externs representation of this export and appends it to the externsRoot AST.
(package private) abstract java.lang.String	getExportedPath() Returns the path exported by this export.
protected Node	getValue(Node qualifiedNameNode) If the given value is a qualified name which refers a function or object literal, the node is returned.

Methods inherited from class java.lang.Object

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

Field Detail

symbolName

protected final java.lang.String symbolName

value

protected final Node value

Constructor Detail

Export

Export(java.lang.String symbolName,
       Node value)

Method Detail

generateExterns

void generateExterns()

Generates the externs representation of this export and appends it to the externsRoot AST.

getExportedPath

abstract java.lang.String getExportedPath()

Returns the path exported by this export.

appendExtern

void appendExtern(java.lang.String path,
                  Node valueToExport)

Appends the exported function and all paths necessary for the path to be declared. For example, for a property "a.b.c", the initializers for paths "a", "a.b" will be appended (if they have not already) and a.b.c will be initialized with the exported version of the function:

 var a = {};
 a.b = {};
 a.b.c = function(x,y) { }
 

computePathPrefixes

private java.util.List<java.lang.String> computePathPrefixes(java.lang.String path)

Computes a list of the path prefixes constructed from the components of the path.

 E.g., if the path is:
      "a.b.c"
 then then path prefixes will be
    ["a","a.b","a.b.c"]:
 

appendPathDefinition

private void appendPathDefinition(java.lang.String path,
                                  Node initializer)

createExternFunction

private Node createExternFunction(Node exportedFunction)

Given a function to export, create the empty function that will be put in the externs file. This extern function should have the same type as the original function and the same parameter name but no function body. We create a warning here if the the function to export is missing parameter or return types.

buildEmptyJSDoc

private JSDocInfo buildEmptyJSDoc()

createExternObjectLit

private Node createExternObjectLit(Node exportedObjectLit)

Given an object literal to export, create an object lit with all its string properties. We don't care what the values of those properties are because they are not checked.

getValue

protected Node getValue(Node qualifiedNameNode)

If the given value is a qualified name which refers a function or object literal, the node is returned. Otherwise, null is returned.