Package com.google.javascript.jscomp

Class ClosureCodingConvention

java.lang.Object

com.google.javascript.jscomp.CodingConventions.Proxy

com.google.javascript.jscomp.ClosureCodingConvention

All Implemented Interfaces:

CodingConvention, java.io.Serializable

@Immutable
public final class ClosureCodingConvention
extends CodingConventions.Proxy

This describes the Closure-specific JavaScript coding conventions.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.javascript.jscomp.CodingConvention

CodingConvention.AssertionFunctionLookup, CodingConvention.AssertionFunctionSpec, CodingConvention.Bind, CodingConvention.Cache, CodingConvention.DelegateRelationship, CodingConvention.ObjectLiteralCast, CodingConvention.SubclassRelationship, CodingConvention.SubclassType

Field Summary

Fields inherited from class com.google.javascript.jscomp.CodingConventions.Proxy

nextConvention

Constructor Summary

Constructors

Constructor	Description
ClosureCodingConvention()
ClosureCodingConvention(CodingConvention wrapped)

Method Summary

Modifier and Type	Method	Description
void	applySingletonGetter(NominalTypeBuilder classType, FunctionType getterType)	In many JS libraries, the function that adds a singleton getter to a class adds properties to the class.
void	applySubclassRelationship(NominalTypeBuilder parent, NominalTypeBuilder child, CodingConvention.SubclassType type)	Closure's goog.inherits adds a superClass_ property to the subclass, and a constructor property.
CodingConvention.Cache	describeCachingCall(Node node)	Builds a CodingConvention.Cache instance from the given call node and returns that instance, or null if the Node does not resemble a cache utility call.
CodingConvention.Bind	describeFunctionBind(Node n, boolean callerChecksTypes, boolean iCheckTypes)	A Bind instance or null.
java.lang.String	extractClassNameIfProvide(Node node, Node parent)	Extracts X from goog.provide('X'), if the applied Node is goog.
java.lang.String	extractClassNameIfRequire(Node node, Node parent)	Extracts X from goog.require('X'), if the applied Node is goog.
boolean	extractIsModuleFile(Node node, Node parent)	Convenience method for determining if the node indicates the file is a "module" file (a file whose top level symbols are not in global scope).
java.lang.String	getAbstractMethodName()	Function name for abstract methods.
com.google.common.collect.ImmutableCollection<CodingConvention.AssertionFunctionSpec>	getAssertionFunctions()	Returns the set of AssertionFunction.
CodingConvention.SubclassRelationship	getClassesDefinedByCall(Node callNode)	Checks if the given method defines a subclass relationship, and if it does, returns information on that relationship.
java.lang.String	getExportPropertyFunction()	Use closure's implementation.
java.lang.String	getExportSymbolFunction()	Use closure's implementation.
java.lang.String	getGlobalObject()	Gets the name of the global object.
com.google.common.collect.ImmutableCollection<java.lang.String>	getIndirectlyDeclaredProperties()	Gets a collection of all properties that are defined indirectly on global objects.
CodingConvention.ObjectLiteralCast	getObjectLiteralCast(Node callNode)	Checks if the given method performs a object literal cast, and if it does, returns information on the cast.
java.lang.String	getSingletonGetterClassName(Node callNode)	Checks if the given method defines a singleton getter, and if it does, returns the name of the class with the singleton getter.
java.util.List<java.lang.String>	identifyTypeDeclarationCall(Node n)	Checks if the given CALL node is forward-declaring any types, and returns the name of the types if it is.
boolean	isAliasingGlobalThis(Node n)	Whether this statement is creating an alias of the global object
boolean	isClassFactoryCall(Node callNode)	Checks if the given method is a call to a class factory, such a factory returns a unique class.
boolean	isFunctionCallThatAlwaysThrows(Node n)	Used by CheckMissingReturn.
boolean	isPrivate(java.lang.String name)	Checks whether a name should be considered private.
boolean	isPropertyRenameFunction(java.lang.String name)	Whether this CALL function is returning the string name for a property, but allows renaming.
boolean	isPropertyTestFunction(Node call)	Whether this CALL function is testing for the existence of a property.
boolean	isSuperClassReference(java.lang.String propertyName)	Returns true if passed a string referring to the superclass.

Methods inherited from class com.google.javascript.jscomp.CodingConventions.Proxy

applyDelegateRelationship, blockRenamingForProperty, checkForCallingConventionDefinitions, defineDelegateProxyPrototypeProperties, describeFunctionBind, getDelegateRelationship, getDelegateSuperclassName, getPackageName, hasPrivacyConvention, isConstant, isConstantKey, isExported, isExported, isInlinableFunction, isOptionalParameter, isPrototypeAlias, isValidEnumKey, isVarArgsParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

ClosureCodingConvention

public ClosureCodingConvention()

ClosureCodingConvention

public ClosureCodingConvention(CodingConvention wrapped)

Method Detail

applySubclassRelationship

public void applySubclassRelationship(NominalTypeBuilder parent,
                                      NominalTypeBuilder child,
                                      CodingConvention.SubclassType type)

Closure's goog.inherits adds a superClass_ property to the subclass, and a constructor property.

Specified by:

applySubclassRelationship in interface CodingConvention

Overrides:

applySubclassRelationship in class CodingConventions.Proxy

getClassesDefinedByCall

public CodingConvention.SubclassRelationship getClassesDefinedByCall(Node callNode)

Checks if the given method defines a subclass relationship, and if it does, returns information on that relationship. By default, always returns null. Meant to be overridden by subclasses.

Understands several different inheritance patterns that occur in Google code (various uses of inherits and mixin).

Specified by:

getClassesDefinedByCall in interface CodingConvention

Overrides:

getClassesDefinedByCall in class CodingConventions.Proxy

Parameters:

callNode - A CALL node.

isClassFactoryCall

public boolean isClassFactoryCall(Node callNode)

Description copied from interface: CodingConvention

Checks if the given method is a call to a class factory, such a factory returns a unique class.

Specified by:

isClassFactoryCall in interface CodingConvention

Overrides:

isClassFactoryCall in class CodingConventions.Proxy

Parameters:

callNode - A CALL node.

isSuperClassReference

public boolean isSuperClassReference(java.lang.String propertyName)

Description copied from interface: CodingConvention

Returns true if passed a string referring to the superclass. The string will usually be from the string node at the right of a GETPROP, e.g. this.superClass_.

Specified by:

isSuperClassReference in interface CodingConvention

Overrides:

isSuperClassReference in class CodingConventions.Proxy

extractIsModuleFile

public boolean extractIsModuleFile(Node node,
                                   Node parent)

Description copied from interface: CodingConvention

Convenience method for determining if the node indicates the file is a "module" file (a file whose top level symbols are not in global scope).

Specified by:

extractIsModuleFile in interface CodingConvention

Overrides:

extractIsModuleFile in class CodingConventions.Proxy

Returns:

Whether the node indicates that the file represents a "module", a file whose top level declarations are not in global scope.

extractClassNameIfProvide

public java.lang.String extractClassNameIfProvide(Node node,
                                                  Node parent)

Extracts X from goog.provide('X'), if the applied Node is goog.

Specified by:

extractClassNameIfProvide in interface CodingConvention

Overrides:

extractClassNameIfProvide in class CodingConventions.Proxy

Returns:

The extracted class name, or null.

extractClassNameIfRequire

public java.lang.String extractClassNameIfRequire(Node node,
                                                  Node parent)

Extracts X from goog.require('X'), if the applied Node is goog.

Specified by:

extractClassNameIfRequire in interface CodingConvention

Overrides:

extractClassNameIfRequire in class CodingConventions.Proxy

Returns:

The extracted class name, or null.

getExportPropertyFunction

public java.lang.String getExportPropertyFunction()

Use closure's implementation.

Specified by:

getExportPropertyFunction in interface CodingConvention

Overrides:

getExportPropertyFunction in class CodingConventions.Proxy

Returns:

closure's function name for exporting properties.

getExportSymbolFunction

public java.lang.String getExportSymbolFunction()

Use closure's implementation.

Specified by:

getExportSymbolFunction in interface CodingConvention

Overrides:

getExportSymbolFunction in class CodingConventions.Proxy

Returns:

closure's function name for exporting symbols.

identifyTypeDeclarationCall

public java.util.List<java.lang.String> identifyTypeDeclarationCall(Node n)

Description copied from interface: CodingConvention

Checks if the given CALL node is forward-declaring any types, and returns the name of the types if it is.

Specified by:

identifyTypeDeclarationCall in interface CodingConvention

Overrides:

identifyTypeDeclarationCall in class CodingConventions.Proxy

getAbstractMethodName

public java.lang.String getAbstractMethodName()

Description copied from interface: CodingConvention

Function name for abstract methods. An abstract method can be assigned to an interface method instead of an function expression in order to avoid linter warnings produced by assigning a function without a return value where a return value is expected.

Specified by:

getAbstractMethodName in interface CodingConvention

Overrides:

getAbstractMethodName in class CodingConventions.Proxy

Returns:

function name.

getSingletonGetterClassName

public java.lang.String getSingletonGetterClassName(Node callNode)

Description copied from interface: CodingConvention

Checks if the given method defines a singleton getter, and if it does, returns the name of the class with the singleton getter. By default, always returns null. Meant to be overridden by subclasses. addSingletonGetter needs a coding convention because in the general case, it can't be inlined. The function inliner sees that it creates an alias to the given class in an inner closure, and bails out.

Specified by:

getSingletonGetterClassName in interface CodingConvention

Overrides:

getSingletonGetterClassName in class CodingConventions.Proxy

Parameters:

callNode - A CALL node.

applySingletonGetter

public void applySingletonGetter(NominalTypeBuilder classType,
                                 FunctionType getterType)

Description copied from interface: CodingConvention

In many JS libraries, the function that adds a singleton getter to a class adds properties to the class.

Specified by:

applySingletonGetter in interface CodingConvention

Overrides:

applySingletonGetter in class CodingConventions.Proxy

getGlobalObject

public java.lang.String getGlobalObject()

Description copied from interface: CodingConvention

Gets the name of the global object.

Specified by:

getGlobalObject in interface CodingConvention

Overrides:

getGlobalObject in class CodingConventions.Proxy

isAliasingGlobalThis

public boolean isAliasingGlobalThis(Node n)

Description copied from interface: CodingConvention

Whether this statement is creating an alias of the global object

Specified by:

isAliasingGlobalThis in interface CodingConvention

Overrides:

isAliasingGlobalThis in class CodingConventions.Proxy

isPropertyTestFunction

public boolean isPropertyTestFunction(Node call)

Description copied from interface: CodingConvention

Whether this CALL function is testing for the existence of a property.

Specified by:

isPropertyTestFunction in interface CodingConvention

Overrides:

isPropertyTestFunction in class CodingConventions.Proxy

isPropertyRenameFunction

public boolean isPropertyRenameFunction(java.lang.String name)

Description copied from interface: CodingConvention

Whether this CALL function is returning the string name for a property, but allows renaming.

Specified by:

isPropertyRenameFunction in interface CodingConvention

Overrides:

isPropertyRenameFunction in class CodingConventions.Proxy

isFunctionCallThatAlwaysThrows

public boolean isFunctionCallThatAlwaysThrows(Node n)

Description copied from interface: CodingConvention

Used by CheckMissingReturn. When a function call always throws an error, it can be the last stm of a block and we don't warn about missing return.

Specified by:

isFunctionCallThatAlwaysThrows in interface CodingConvention

Overrides:

isFunctionCallThatAlwaysThrows in class CodingConventions.Proxy

getObjectLiteralCast

public CodingConvention.ObjectLiteralCast getObjectLiteralCast(Node callNode)

Description copied from interface: CodingConvention

Checks if the given method performs a object literal cast, and if it does, returns information on the cast. By default, always returns null. Meant to be overridden by subclasses.

Specified by:

getObjectLiteralCast in interface CodingConvention

Overrides:

getObjectLiteralCast in class CodingConventions.Proxy

Parameters:

callNode - A CALL node.

isPrivate

public boolean isPrivate(java.lang.String name)

Description copied from interface: CodingConvention

Checks whether a name should be considered private. Private global variables and functions can only be referenced within the source file in which they are declared. Private properties and methods should only be accessed by the class that defines them.

Specified by:

isPrivate in interface CodingConvention

Overrides:

isPrivate in class CodingConventions.Proxy

Parameters:

name - The name of a global variable or function, or a method or property.

Returns:

true if the name should be considered private.

getAssertionFunctions

public com.google.common.collect.ImmutableCollection<CodingConvention.AssertionFunctionSpec> getAssertionFunctions()

Description copied from interface: CodingConvention

Returns the set of AssertionFunction.

Specified by:

getAssertionFunctions in interface CodingConvention

Overrides:

getAssertionFunctions in class CodingConventions.Proxy

describeFunctionBind

public CodingConvention.Bind describeFunctionBind(Node n,
                                                  boolean callerChecksTypes,
                                                  boolean iCheckTypes)

Description copied from interface: CodingConvention

A Bind instance or null.

When seeing an expression exp1.bind(recv, arg1, ...); we only know that it's a function bind if exp1 has type function. W/out type info, exp1 has certainly a function type only if it's a function literal.

If type checking has already happened, exp1's type is attached to the AST node. When iCheckTypes is true, describeFunctionBind looks for that type.

Specified by:

describeFunctionBind in interface CodingConvention

Overrides:

describeFunctionBind in class CodingConventions.Proxy

callerChecksTypes - Trust that the caller of this method has verified that the bound node has a function type.

iCheckTypes - Check that the bound node has a function type.

describeCachingCall

public CodingConvention.Cache describeCachingCall(Node node)

Description copied from interface: CodingConvention

Builds a CodingConvention.Cache instance from the given call node and returns that instance, or null if the Node does not resemble a cache utility call.

This should match calls to a cache utility method. This type of node is specially considered for side-effects since conventionally storing something on a cache object would be seen as a side-effect.

Specified by:

describeCachingCall in interface CodingConvention

Overrides:

describeCachingCall in class CodingConventions.Proxy

getIndirectlyDeclaredProperties

public com.google.common.collect.ImmutableCollection<java.lang.String> getIndirectlyDeclaredProperties()

Description copied from interface: CodingConvention

Gets a collection of all properties that are defined indirectly on global objects. (For example, Closure defines superClass_ in the goog.inherits call).

Specified by:

getIndirectlyDeclaredProperties in interface CodingConvention

Overrides:

getIndirectlyDeclaredProperties in class CodingConventions.Proxy