Package com.google.javascript.jscomp

Class SourceFile

java.lang.Object
com.google.javascript.jscomp.SourceFile
All Implemented Interfaces:
StaticSourceFile
public final class SourceFile extends Object implements StaticSourceFile
An abstract representation of a source file that provides access to language-neutral features.

The source file can be loaded from various locations, such as from disk or from a preloaded string. Loading is done as lazily as possible to minimize IO delays and memory cost of source text.

  • Method Details

    • isStubSourceFileForAlreadyProvidedInput

      public boolean isStubSourceFileForAlreadyProvidedInput()

    • getLineOffset

      public int getLineOffset(int lineno)
      Description copied from interface: StaticSourceFile
      Returns the offset of the given line number relative to the file start. Line number should be 1-based.

      If the source file doesn't have line information, it should return Integer.MIN_VALUE. The negative offsets will make it more obvious what happened.

      Specified by:
      getLineOffset in interface StaticSourceFile
      Parameters:
      lineno - the line of the input to get the absolute offset of.
      Returns:
      the absolute offset of the start of the provided line.

    • getCode

      public final String getCode() throws IOException
      Gets all the code in this source file.
      Throws:
      IOException

    • getCodeReader

      public Reader getCodeReader() throws IOException
      Gets a reader for the code in this source file.
      Throws:
      IOException

    • getOriginalPath

      @InlineMe(replacement="this.getName()") @Deprecated public String getOriginalPath()
      Deprecated.
      alias of getName(). Use that instead

    • clearCachedSource

      public void clearCachedSource()
      For SourceFile types which cache source code that can be regenerated easily, flush the cache.

      We maintain the cache mostly to speed up generating source when displaying error messages, so dumping the file contents after the compile is a fine thing to do.

    • getName

      public String getName()
      Returns a unique name for the source file.

      This name is not required to be an actual file path on disk.

      Specified by:
      getName in interface StaticSourceFile

    • getKind

      public StaticSourceFile.SourceKind getKind()
      Returns the source kind.
      Specified by:
      getKind in interface StaticSourceFile

    • setKind

      public void setKind(StaticSourceFile.SourceKind kind)
      Sets the source kind.

    • isClosureUnawareCode

      public boolean isClosureUnawareCode()
      Description copied from interface: StaticSourceFile
      Whether this source file contains code that should be optimized using a minimal set of known-safe optimizations. In particular, code in this StaticSourceFile is unlikely to be well-typed (or have types annotated at all), and is likely written by someone unaware of the limitations of this compiler.
      Specified by:
      isClosureUnawareCode in interface StaticSourceFile

    • markAsClosureUnawareCode

      public void markAsClosureUnawareCode()

    • getLineOfOffset

      public int getLineOfOffset(int offset)
      Description copied from interface: StaticSourceFile
      Gets the 1-based line number of the given source offset.
      Specified by:
      getLineOfOffset in interface StaticSourceFile
      Parameters:
      offset - An absolute file offset.
      Returns:
      The 1-based line number of that offset. The behavior is undefined if this offset does not exist in the source file.

    • getColumnOfOffset

      public int getColumnOfOffset(int offset)
      Description copied from interface: StaticSourceFile
      Gets the 0-based column number of the given source offset.
      Specified by:
      getColumnOfOffset in interface StaticSourceFile
      Parameters:
      offset - An absolute file offset.
      Returns:
      The 0-based column number of that offset. The behavior is undefined if this offset does not exist in the source file.

    • getLine

      public @Nullable String getLine(int lineNumber)
      Gets the source line for the indicated line number.
      Parameters:
      lineNumber - the line number, 1 being the first line of the file.
      Returns:
      The line indicated. Does not include the newline at the end of the file. Returns null if it does not exist, or if there was an IO exception.

    • getLines

      public @Nullable Region getLines(int lineNumber, int length)
      Gets the source lines starting at `lineNumber` and continuing until `length`. Omits any trailing newlines.
      Parameters:
      lineNumber - the line number, 1 being the first line of the file.
      length - the number of characters desired, starting at the 0th character of the specified line. If negative or 0, returns a single line.
      Returns:
      The line(s) indicated. Returns null if it does not exist or if there was an IO exception.

    • getRegion

      public @Nullable Region getRegion(int lineNumber)
      Get a region around the indicated line number. The exact definition of a region is implementation specific, but it must contain the line indicated by the line number. A region must not start or end by a carriage return.
      Parameters:
      lineNumber - the line number, 1 being the first line of the file.
      Returns:
      The line indicated. Returns null if it does not exist, or if there was an IO exception.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • fromZipFile

      public static List<SourceFile> fromZipFile(String zipName, Charset inputCharset) throws IOException
      Throws:
      IOException

    • fromZipInput

      public static List<SourceFile> fromZipInput(String zipName, InputStream input, Charset inputCharset) throws IOException
      Throws:
      IOException

    • fromFile

      public static SourceFile fromFile(String fileName, Charset charset)

    • fromFile

      public static SourceFile fromFile(String fileName)

    • fromPath

      public static SourceFile fromPath(Path path, Charset charset)

    • fromCode

      public static SourceFile fromCode(String fileName, String code, StaticSourceFile.SourceKind kind)

    • fromCode

      public static SourceFile fromCode(String fileName, String code)

    • stubSourceFile

      public static SourceFile stubSourceFile(String fileName, StaticSourceFile.SourceKind kind)
      Returns a stub SourceFile with the given name and kind. It is used when the actual sources are provided via TypedASTs to stage2 and stage3.

    • restoreCachedStateFrom

      public void restoreCachedStateFrom(com.google.javascript.jscomp.serialization.SourceFileProto protoSourceFile)
      Reconciles serialized state in a SourceFileProto with the existing state in this file.

      This should be called whenever initializing a compilation based on TypedAST protos. For these compilations, the compiler initalization methods require creating SourceFiles before deserializing TypedAST protos, so we sometimes get two copies of the same SourceFile.)

    • fromProto

      public static SourceFile fromProto(com.google.javascript.jscomp.serialization.SourceFileProto protoSourceFile)

    • builder

      public static SourceFile.Builder builder()
      Create a new builder for source files.

    • getProto

      public com.google.javascript.jscomp.serialization.SourceFileProto getProto()