com.google.template.soy.passes

Class PassManager

java.lang.Object

com.google.template.soy.passes.PassManager

public final class PassManager
extends Object

Configures all compiler passes.

This arranges all compiler passes into four phases.

• The single file passes. This includes AST rewriting passes such as HtmlRewritePass and RewriteGendersPass and other kinds of validation that doesn't require information about the full file set.
• Cross template checking passes. This includes AST validation passes like the CheckVisibilityPass. Passes should run here if they need to check the relationships between templates.
• The autoescaper. This runs in its own special phase because it can do special things like create synthetic templates and add them to the tree
• Simplification passes. This includes tree simplification passes like the optimizer. These should run last so that they can simplify code generated by any earlier pass.

The reason things have been divided in this way is partially to create consistency and also to enable other compiler features. For example, for in process (server side) compilation we can cache the results of the single file passes to speed up edit-refresh flows. Also, theoretically, we could run the single file passes for each file in parallel.

A note on ordering. There is no real structure to the ordering of the passes beyond what is documented in comments. Many passes do rely on running before/after a different pass (e.g. ResolveExpressionTypesVisitor needs to run after ResolveNamesPass), but there isn't any dependency system in place.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PassManager.Builder A builder for configuring the pass manager.

Method Summary

Modifier and Type	Method and Description
void	runSingleFilePasses(SoyFileNode file, IdGenerator nodeIdGen)
TemplateRegistry	runWholeFilesetPasses(SoyFileSetNode soyTree) Runs all the fileset passes including the autoescaper and optimization passes if configured.

Methods inherited from class java.lang.Object

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

Method Detail

runSingleFilePasses

public void runSingleFilePasses(SoyFileNode file,
                                IdGenerator nodeIdGen)

runWholeFilesetPasses

@CheckReturnValue
public TemplateRegistry runWholeFilesetPasses(SoyFileSetNode soyTree)

Runs all the fileset passes including the autoescaper and optimization passes if configured.

Returns:

a fully populated TemplateRegistry