org.stringtemplate.v4.compiler

Class CompiledST

java.lang.Object

org.stringtemplate.v4.compiler.CompiledST

public class CompiledST
extends Object

The result of compiling an ST. Contains all the bytecode instructions, string table, bytecode address to source code map, and other bookkeeping info. It's the implementation of an ST you might say. All instances of the same template share a single implementation (ST.impl field).

Field Summary

Fields

Modifier and Type	Field and Description
org.antlr.runtime.tree.CommonTree	ast How do we interpret syntax of template? (debug only)
int	codeSize
Map<String,FormalArgument>	formalArguments
boolean	hasFormalArgs
List<CompiledST>	implicitlyDefinedTemplates A list of all regions and subtemplates.
byte[]	instrs
boolean	isAnonSubtemplate
boolean	isRegion Does this template come from a <@region>...<@end> embedded in another template?
String	name
STGroup	nativeGroup The group that physically defines this ST definition.
int	numberOfArgsWithDefaultValues
String	prefix Every template knows where it is relative to the group that loaded it.
ST.RegionType	regionDefType If someone refs <@r()> in template t, an implicit @t.r() ::= "" is defined, but you can overwrite this def by defining your own.
Interval[]	sourceMap
String[]	strings
String	template The original, immutable pattern (not really used again after initial "compilation").
org.antlr.runtime.Token	templateDefStartToken The token that begins template definition; could be <@r> of region.
org.antlr.runtime.TokenStream	tokens Overall token stream for template (debug only).

Constructor Summary

Constructors

Constructor and Description
CompiledST()

Method Summary

Methods

Modifier and Type	Method and Description
void	addArg(FormalArgument a) Used by ST.add(java.lang.String, java.lang.Object) to add args one by one without turning on full formal args definition signal.
void	addImplicitlyDefinedTemplate(CompiledST sub)
void	defineArgDefaultValueTemplates(STGroup group)
void	defineFormalArgs(List<FormalArgument> args)
void	defineImplicitlyDefinedTemplates(STGroup group)
String	disasm()
void	dump()
Interval	getTemplateRange()
String	getTemplateSource()
String	instrs()

Methods inherited from class java.lang.Object

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

Field Detail

name

public String name

prefix

public String prefix

Every template knows where it is relative to the group that loaded it. The prefix is the relative path from the root. "/prefix/name" is the fully qualified name of this template. All calls to STGroup.getInstanceOf(java.lang.String) calls must use fully qualified names. A "/" is added to the front if you don't specify one. Template references within template code, however, uses relative names, unless of course the name starts with "/".

This has nothing to do with the outer filesystem path to the group dir or group file.

We set this as we load/compile the template.

Always ends with "/".

template

public String template

The original, immutable pattern (not really used again after initial "compilation"). Useful for debugging. Even for subtemplates, this is entire overall template.

templateDefStartToken

public org.antlr.runtime.Token templateDefStartToken

The token that begins template definition; could be <@r> of region.

tokens

public org.antlr.runtime.TokenStream tokens

Overall token stream for template (debug only).

ast

public org.antlr.runtime.tree.CommonTree ast

How do we interpret syntax of template? (debug only)

formalArguments

public Map<String,FormalArgument> formalArguments

hasFormalArgs

public boolean hasFormalArgs

numberOfArgsWithDefaultValues

public int numberOfArgsWithDefaultValues

implicitlyDefinedTemplates

public List<CompiledST> implicitlyDefinedTemplates

A list of all regions and subtemplates.

nativeGroup

public STGroup nativeGroup

The group that physically defines this ST definition. We use it to initiate interpretation via ST.toString(). From there, it becomes field Interpreter.group and is fixed until rendering completes.

isRegion

public boolean isRegion

Does this template come from a <@region>...<@end> embedded in another template?

regionDefType

public ST.RegionType regionDefType

If someone refs <@r()> in template t, an implicit

@t.r() ::= ""

is defined, but you can overwrite this def by defining your own. We need to prevent more than one manual def though. Between this var and isRegion we can determine these cases.

isAnonSubtemplate

public boolean isAnonSubtemplate

strings

public String[] strings

instrs

public byte[] instrs

codeSize

public int codeSize

sourceMap

public Interval[] sourceMap

Constructor Detail

CompiledST

public CompiledST()

Method Detail

addImplicitlyDefinedTemplate

public void addImplicitlyDefinedTemplate(CompiledST sub)

defineArgDefaultValueTemplates

public void defineArgDefaultValueTemplates(STGroup group)

defineFormalArgs

public void defineFormalArgs(List<FormalArgument> args)

addArg

public void addArg(FormalArgument a)

Used by ST.add(java.lang.String, java.lang.Object) to add args one by one without turning on full formal args definition signal.

defineImplicitlyDefinedTemplates

public void defineImplicitlyDefinedTemplates(STGroup group)

getTemplateSource

public String getTemplateSource()

getTemplateRange

public Interval getTemplateRange()

instrs

public String instrs()

dump

public void dump()

disasm

public String disasm()