com.google.debugging.sourcemap

Class SourceMapGeneratorV3

java.lang.Object

com.google.debugging.sourcemap.SourceMapGeneratorV3

All Implemented Interfaces:

SourceMapGenerator

public final class SourceMapGeneratorV3
extends Object
implements SourceMapGenerator

GWT compatible no-op replacement for SourceMapGeneratorV3

Constructor Summary

Constructors

Constructor and Description
SourceMapGeneratorV3()

Method Summary

Modifier and Type	Method and Description
void	addMapping(String sourceName, String symbolName, FilePosition sourceStartPosition, FilePosition outputStartPosition, FilePosition outputEndPosition) Adds a mapping for the given node.
void	appendIndexMapTo(Appendable out, String name, List<SourceMapSection> sections) Appends the index source map to the given buffer.
void	appendTo(Appendable out, String name) Appends the source map to the given buffer.
void	reset() Resets the source map for reuse.
void	setStartingPosition(int offsetLine, int offsetIndex) Sets the source code that exists in the buffer for which the generated code is being generated.
void	setWrapperPrefix(String prefix) Sets the prefix used for wrapping the generated source file before it is written.
void	validate(boolean validate) Whether to perform additional validation on the source map.

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceMapGeneratorV3

public SourceMapGeneratorV3()

Method Detail

appendTo

public void appendTo(Appendable out,
                     String name)
              throws IOException

Description copied from interface: SourceMapGenerator

Appends the source map to the given buffer.

Specified by:

appendTo in interface SourceMapGenerator

Parameters:

out - The stream to which the map will be appended.

name - The name of the generated source file that this source map represents.

Throws:

IOException

appendIndexMapTo

public void appendIndexMapTo(Appendable out,
                             String name,
                             List<SourceMapSection> sections)
                      throws IOException

Description copied from interface: SourceMapGenerator

Appends the index source map to the given buffer.

Specified by:

appendIndexMapTo in interface SourceMapGenerator

Parameters:

out - The stream to which the map will be appended.

name - The name of the generated source file that this source map represents.

sections - An ordered list of map sections to include in the index.

Throws:

IOException

reset

public void reset()

Description copied from interface: SourceMapGenerator

Resets the source map for reuse. A reset needs to be called between each generated output file.

Specified by:

reset in interface SourceMapGenerator

addMapping

public void addMapping(String sourceName,
                       String symbolName,
                       FilePosition sourceStartPosition,
                       FilePosition outputStartPosition,
                       FilePosition outputEndPosition)

Description copied from interface: SourceMapGenerator

Adds a mapping for the given node. Mappings must be added in order.

Specified by:

addMapping in interface SourceMapGenerator

Parameters:

sourceName - The file name to use in the generate source map to represent this source.

symbolName - The symbol name associated with this position in the source map.

sourceStartPosition - The starting position in the original source for represented range outputStartPosition to outputEndPosition in the generated file.

outputStartPosition - The position on the starting line

outputEndPosition - The position on the ending line.

setWrapperPrefix

public void setWrapperPrefix(String prefix)

Description copied from interface: SourceMapGenerator

Sets the prefix used for wrapping the generated source file before it is written. This ensures that the source map is adjusted for the change in character offsets.

Specified by:

setWrapperPrefix in interface SourceMapGenerator

Parameters:

prefix - The prefix that is added before the generated source code.

setStartingPosition

public void setStartingPosition(int offsetLine,
                                int offsetIndex)

Description copied from interface: SourceMapGenerator

Sets the source code that exists in the buffer for which the generated code is being generated. This ensures that the source map accurately reflects the fact that the source is being appended to an existing buffer and as such, does not start at line 0, position 0 but rather some other line and position.

Specified by:

setStartingPosition in interface SourceMapGenerator

Parameters:

offsetLine - The index of the current line being printed.

offsetIndex - The column index of the current character being printed.

validate

public void validate(boolean validate)

Description copied from interface: SourceMapGenerator

Whether to perform additional validation on the source map.

Specified by:

validate in interface SourceMapGenerator