org.serversass

Class Generator

java.lang.Object

org.serversass.Generator

public class Generator
extends Object

Generates CSS code from one or more SASS stylesheets.

A subclass can be created to override resolve(String) to change the way SASS files are resolved (The default is to use the classpath). Also warn(String) and debug(String) can be overridden to process messages which are generated while processing the code.

The resulting css code can be obtained by calling the toString() method.

Field Summary

Fields

Modifier and Type	Field and Description
protected File	baseDir
protected Map<String,Section>	extensibleSections
protected Set<String>	importedSheets
protected Map<String,Section>	mediaQueries
protected Map<String,Mixin>	mixins
protected Scope	scope
protected List<Section>	sections

Constructor Summary

Constructors

Constructor and Description
Generator() Generates a new Generator without a directory used for lookups.
Generator(File baseDir) Generates a new Generator using the given directory for lookups.

Method Summary

Modifier and Type	Method and Description
void	compile() Compiles the parsed sources.
protected void	compileMixins(Section section)
void	debug(String message) Contains a message which might be helpful in development systems but are generally not of great interest in production systems.
Expression	evaluateFunction(FunctionCall call) Evaluates the given function.
void	generate(Output out) Generates the final output into the given parameter.
void	importStylesheet(String sheet) Instructs the generator to include a scss file.
void	importStylesheet(Stylesheet sheet) Imports an already parsed stylesheet.
protected Stylesheet	resolve(String sheet) Resolves a given name into a template.
protected InputStream	resolveIntoStream(String sheet) Resolves the given file name into an InputStream
String	toString()
void	warn(String message) Called to signal a warning, like an invalid operation or parse errors in a source file.

Methods inherited from class java.lang.Object

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

Field Detail

importedSheets

protected Set<String> importedSheets

sections

protected List<Section> sections

extensibleSections

protected Map<String,Section> extensibleSections

mediaQueries

protected Map<String,Section> mediaQueries

mixins

protected Map<String,Mixin> mixins

scope

protected Scope scope

baseDir

protected File baseDir

Constructor Detail

Generator

public Generator()

Generates a new Generator without a directory used for lookups.

This generator will resolve all imports using the classpath.

Generator

public Generator(File baseDir)

Generates a new Generator using the given directory for lookups.

This generator will resolve all imports using the given directory or the classpath.

Parameters:

baseDir - the directory with contains the imports

Method Detail

warn

public void warn(String message)

Called to signal a warning, like an invalid operation or parse errors in a source file.

By default all messages are discarded.

Parameters:

message - the message which is reported

debug

public void debug(String message)

Contains a message which might be helpful in development systems but are generally not of great interest in production systems.

Parameters:

message - the message which is reported

resolve

protected Stylesheet resolve(String sheet)

Resolves a given name into a template.

By default the classloader is used to resolve the template. Also .scss or _ are added as post-/prefix if required.

Parameters:

sheet - the name of the file to resolve

Returns:

the resolved stylesheet or null if the file is not found

resolveIntoStream

protected InputStream resolveIntoStream(String sheet)
                                 throws IOException

Resolves the given file name into an InputStream

Parameters:

sheet - the file to resolve (already cleaned up by replacing \ with / and appending .scss if necessary).

Returns:

an InputStream for the resolved data or null to indicate that the resource cannot be found

Throws:

IOException - in case of an error while resolving or reading the contents

importStylesheet

public void importStylesheet(String sheet)

Instructs the generator to include a scss file. This is also used to load the initial file.

Parameters:

sheet - the scss file to load.

importStylesheet

public void importStylesheet(Stylesheet sheet)

Imports an already parsed stylesheet.

Parameters:

sheet - the stylesheet to import

compile

public void compile()

Compiles the parsed sources.

This will evaluate all @mixin and @extends statements and evaluate all expressions. Needs to be called before the sources are retrieved via toString().

compileMixins

protected void compileMixins(Section section)

toString

public String toString()

Overrides:

toString in class Object

generate

public void generate(Output out)
              throws IOException

Generates the final output into the given parameter.

Parameters:

out - the target for the generated output

Throws:

IOException - in case of an io error in the underlying writer

evaluateFunction

public Expression evaluateFunction(FunctionCall call)

Evaluates the given function.

Can be overridden by subclasses. If no matching function is found, the raw sources are output to handle url('..') etc.

Parameters:

call - the function to evaluate

Returns:

the result of the evaluation