Package com.google.javascript.jscomp

Class CompilerInput

  • All Implemented Interfaces:
    DependencyInfo, SourceAst, java.io.Serializable
    public class CompilerInput
extends DependencyInfo.Base
implements SourceAst
    A class for the internal representation of an input to the compiler. Wraps a SourceAst and maintain state such as module for the input and whether the input is an extern. Also calculates provided and required types.
    See Also:
    Serialized Form

    • Constructor Detail

      • CompilerInput

        public CompilerInput​(SourceAst ast)

      • CompilerInput

        public CompilerInput​(SourceAst ast,
                     boolean isExtern)

      • CompilerInput

        public CompilerInput​(SourceAst ast,
                     java.lang.String inputId,
                     boolean isExtern)

      • CompilerInput

        public CompilerInput​(SourceAst ast,
                     InputId inputId,
                     boolean isExtern)

      • CompilerInput

        public CompilerInput​(SourceFile file)

      • CompilerInput

        public CompilerInput​(SourceFile file,
                     boolean isExtern)

    • Method Detail

      • getInputId

        public InputId getInputId()
        Returns a name for this input. Must be unique across all inputs.
        Specified by:
        getInputId in interface SourceAst
        Returns:
        The input id associated with this AST

      • getName

        public java.lang.String getName()
        Returns a name for this input. Must be unique across all inputs.
        Specified by:
        getName in interface DependencyInfo

      • getPathRelativeToClosureBase

        public java.lang.String getPathRelativeToClosureBase()
        Gets the path relative to closure-base, if one is available.
        Specified by:
        getPathRelativeToClosureBase in interface DependencyInfo

      • getAstRoot

        public Node getAstRoot​(AbstractCompiler compiler)
        Description copied from interface: SourceAst
        Gets the root node of the AST for the source file this represents. The AST is lazily instantiated and cached. This node is always non-null, even in the case of parse errors.
        Specified by:
        getAstRoot in interface SourceAst

      • clearAst

        public void clearAst()
        Description copied from interface: SourceAst
        Removes any references to root node of the AST. If it is requested again, another parse will be performed. This method is needed to allow the ASTs to be garbage collected if the inputs are still around after compilation.
        Specified by:
        clearAst in interface SourceAst

      • setSourceFile

        public void setSourceFile​(SourceFile file)
        Description copied from interface: SourceAst
        Sets the source file the generated AST represents. This can be called after deserializing if access to the source file is needed. If a different file is provided than that with which this was created, an IllegalStateException will be thrown.
        Specified by:
        setSourceFile in interface SourceAst

      • setCompiler

        public void setCompiler​(AbstractCompiler compiler)
        Sets an abstract compiler for doing parsing.

      • getTypeRequires

        public com.google.common.collect.ImmutableList<java.lang.String> getTypeRequires()
        Description copied from interface: DependencyInfo
        Gets the symbols type-required by this file (i.e. for typechecking only).
        Specified by:
        getTypeRequires in interface DependencyInfo

      • getProvides

        public com.google.common.collect.ImmutableList<java.lang.String> getProvides()
        Gets a list of types provided by this input.
        Specified by:
        getProvides in interface DependencyInfo

      • addProvide

        public void addProvide​(java.lang.String provide)
        Registers a type that this input defines. Includes both explicitly declared namespaces via goog.provide and goog.module calls as well as implicit namespaces provided by module rewriting.

      • addOrderedRequire

        public boolean addOrderedRequire​(DependencyInfo.Require require)
        Registers a type that this input depends on in the order seen in the file.

      • getDynamicRequires

        public com.google.common.collect.ImmutableList<java.lang.String> getDynamicRequires()
        Returns the types that this input dynamically depends on in the order seen in the file. The returned types were loaded dynamically so while they are part of the dependency graph, they do not need sorted before this input.

      • addDynamicRequire

        public boolean addDynamicRequire​(java.lang.String require)
        Registers a type that this input depends on in the order seen in the file. The type was loaded dynamically so while it is part of the dependency graph, it does not need sorted before this input.

      • setHasFullParseDependencyInfo

        public void setHasFullParseDependencyInfo​(boolean hasFullParseDependencyInfo)

      • addRequire

        public void addRequire​(DependencyInfo.Require require)
        Registers a type that this input depends on.

      • getCode

        public java.lang.String getCode()
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • getModule

        public JSModule getModule()
        Returns the module to which the input belongs.

      • setModule

        public void setModule​(JSModule module)
        Sets the module to which the input belongs.

      • isExtern

        public boolean isExtern()

      • getLineOffset

        public int getLineOffset​(int lineno)

      • getNumLines

        public int getNumLines()
        Returns:
        The number of lines in this input.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getLoadFlags

        public com.google.common.collect.ImmutableMap<java.lang.String,​java.lang.String> getLoadFlags()
        Description copied from interface: DependencyInfo
        Gets the loading information for this file.
        Specified by:
        getLoadFlags in interface DependencyInfo