com.google.javascript.jscomp

Interface SourceExcerptProvider

All Known Implementing Classes:

AbstractCompiler, Compiler, SimpleSourceExcerptProvider

public interface SourceExcerptProvider

A source excerpt provider is responsible for building source code excerpt of specific locations, such as a specific line or a region around a given line number.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SourceExcerptProvider.ExcerptFormatter A excerpt formatter is responsible of formatting source excerpts.
static class	SourceExcerptProvider.SourceExcerpt Source excerpt variety.

Method Summary

Modifier and Type	Method and Description
String	getSourceLine(String sourceName, int lineNumber) Get the line indicated by the line number.
Mapping.OriginalMapping	getSourceMapping(String sourceName, int lineNumber, int columnNumber) If the source file is associated with an inputSourceMap, does a lookup for the original file position based on this source map.
Region	getSourceRegion(String sourceName, int lineNumber) Get a region around the indicated line number.

Method Detail

getSourceLine

String getSourceLine(String sourceName,
                     int lineNumber)

Get the line indicated by the line number. This call will return only the specific line.

Parameters:

lineNumber - the line number, 1 being the first line of the file

Returns:

the line indicated, or null if it does not exist

getSourceRegion

Region getSourceRegion(String sourceName,
                       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 region around the line number indicated, or null if it does not exist

getSourceMapping

Mapping.OriginalMapping getSourceMapping(String sourceName,
                                         int lineNumber,
                                         int columnNumber)

If the source file is associated with an inputSourceMap, does a lookup for the original file position based on this source map.