Package com.google.common.css.compiler.passes

Interface GssSourceMapGenerator

All Known Implementing Classes:

DefaultGssSourceMapGenerator, NullGssSourceMapGenerator

public interface GssSourceMapGenerator

Interface to collect and generate source map for CssNode in Gss compiler.

Method Summary

Modifier and Type	Method	Description
void	appendOutputTo(Appendable out, String name)	Appends the generated source map to out.
void	endSourceMapping(CssNode node, int endLine, int endCharIndex)	Finishes the source mapping for the given node at the current position.
void	setSourceRoot(String path)	A prefix to be added to the beginning of each source file name.
void	startSourceMapping(CssNode node, int startLine, int startCharIndex)	Starts the source mapping for the given node at the current position.

Method Details

appendOutputTo

void appendOutputTo(Appendable out,
 String name)
             throws IOException

Appends the generated source map to out.

Parameters:

out - an Appendable object to append the output on

name - filename to be written inside the source map (not the filename where writes at)

Throws:

IOException

startSourceMapping

void startSourceMapping(CssNode node,
 int startLine,
 int startCharIndex)

Starts the source mapping for the given node at the current position. This is intended to be called before the node is written to the buffer.

Parameters:

node - the CssNode to be processed

startLine - the first character's line number once it starts writing output

startCharIndex - the first character's character index once it starts writing output

endSourceMapping

void endSourceMapping(CssNode node,
 int endLine,
 int endCharIndex)

Finishes the source mapping for the given node at the current position. This is intended to be called immediately after the whole node is written to the buffer.

Parameters:

node - the CssNode to be processed

endLine - the last character's line number when it ends writing output

endCharIndex - the last character's character index when it ends writing output or one less than the corresponding startCharIndex if a source mapping is empty.

setSourceRoot

void setSourceRoot(String path)

A prefix to be added to the beginning of each source file name. Debuggers expect (prefix + sourceName) to be a URL for loading the source code.

Parameters:

path - The URL prefix to save in the sourcemap file.