Package gw.internal.gosu.template

Class TemplateGenerator

java.lang.Object

gw.internal.gosu.template.TemplateGenerator

All Implemented Interfaces:

ITemplateGenerator

public class TemplateGenerator
extends java.lang.Object
implements ITemplateGenerator

A template generator employing Gosu.

Works much like JSP -- uses <% script %> for scriptlets and <%= expr %> for expressions. Also supports JSP comments like this: <%-- comment here --%>

Templates can be any type e.g., XML, HTML, text, whatever.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TemplateGenerator.LockedDownSymbol
private class	TemplateGenerator.RuntimeData

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	_bStringLiteralTemplate
private ISymbolTable	_compileTimeSymbolTable
private ContextInferenceManager	_ctxInferenceMgr
private boolean	_disableAlternative
private java.lang.String	_fqn
private boolean	_hasOwnSymbolScope
private java.util.List<ISymbol>	_params
private Program	_program
private java.lang.String	_scriptStr
private IType	_supertype
private boolean	_useStudioEditorParser
static java.lang.String	ALTERNATE_EXPRESSION_BEGIN
static int	ALTERNATE_EXPRESSION_BEGIN_LEN
static java.lang.String	ALTERNATE_EXPRESSION_END
static int	ALTERNATE_EXPRESSION_END_LEN
static java.lang.String	COMMENT_BEGIN
static int	COMMENT_BEGIN_LEN
static java.lang.String	COMMENT_END
static int	COMMENT_END_LEN
static char	DECLARATION_SUFFIX
static char	DIRECTIVE_SUFFIX
static char	ESCAPED_ALTERNATE_EXPRESSION_BEGIN_CHAR
static char	ESCAPED_SCRIPTLET_BEGIN_CHAR
static char	ESCAPED_SCRIPTLET_MARKER
static char	EXPRESSION_SUFFIX
private static java.lang.ThreadLocal<Stack<TemplateGenerator.RuntimeData>>	g_runtimeData
static java.lang.String	GS_TEMPLATE
static java.lang.String	GS_TEMPLATE_PARSED
static LockingLazyVar<ISymbol>	PRINT_CONTENT_SYMBOL
static LockingLazyVar<ISymbol>	PRINT_RANGE_SYMBOL
static java.lang.String	SCRIPTLET_BEGIN
static int	SCRIPTLET_BEGIN_LEN
static java.lang.String	SCRIPTLET_END
static int	SCRIPTLET_END_LEN
static int	SUBSTR_CHUNKSIZE
static java.lang.String	TEMPLATE_LINE_NUMBER

Fields inherited from interface gw.lang.parser.template.ITemplateGenerator

PRINT_COMPRESSED_METHOD, PRINT_METHOD, PRINT_RANGE_METHOD

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TemplateGenerator(java.io.Reader reader)	WARNING: This will consume the reader and close it!

Method Summary

Modifier and Type	Method	Description
private void	addExpression(java.lang.StringBuilder strTarget, java.lang.String strExpression, int iLineNumber)
private void	addRefText(java.lang.StringBuilder sbTarget, int iStart, int iEnd)
private void	addScriptlet(java.lang.StringBuilder strTarget, java.lang.String strScript, int iLineNumber)
private void	addStaticSymbols(ISymbolTable symbolTable, GosuParser parser, IGosuClassInternal supertype)
private void	addText(java.lang.StringBuilder strTarget, java.lang.String strText)
void	compile(ISymbolTable symTable)
void	compile(Stack<IScriptPartId> scriptPartIdStack, ISymbolTable symTable, java.util.Map<java.lang.String,java.util.List<IFunctionSymbol>> dfsDeclByName, ITypeUsesMap typeUsesMap, Stack<BlockExpression> blocks, ContextInferenceManager ctxInferenceMgr)
private Program	compile(Stack<IScriptPartId> scriptPartIdStack, java.lang.String strCompiledSource, ISymbolTable symbolTable, java.util.Map<java.lang.String,java.util.List<IFunctionSymbol>> dfsDeclByName, ITypeUsesMap typeUsesMap, Stack<BlockExpression> blocks, ContextInferenceManager ctxInferenceMgr)
private void	compileIfNotCompiled()
private java.lang.String	escapeForGosuStringLiteral(java.lang.String strText)
void	execute(java.io.Writer writer, ISymbolTable symbolTable)
void	execute(java.io.Writer writer, StringEscaper escaper, ISymbolTable symTable)
private IExternalSymbolMap	extractExternalSymbols(ISymbolTable compileTimeSymbolTable, ISymbolTable runtimeSymbolTable)
static void	generateTemplate(java.io.Reader readerTemplate, java.io.Writer writerOut, ISymbolTable symTable)	Generates a template of any format having embedded Gosu.
static void	generateTemplate(java.io.Reader readerTemplate, java.io.Writer writerOut, ISymbolTable symTable, boolean strict)	Generates a template of any format having embedded Gosu.
private int	getColumnForIndex(java.lang.String strSource, int iIndex)
java.lang.String	getFullyQualifiedTypeName()
java.util.List<ISymbol>	getParameters()
Program	getProgram()
private static TemplateGenerator.RuntimeData	getRuntimeData()
java.lang.String	getSource()
IType	getSuperType()
static TemplateGenerator	getTemplate(java.io.Reader readerTemplate)
static TemplateGenerator	getTemplate(java.io.Reader readerTemplate, java.lang.String fullyQualifiedName)
java.util.List<TemplateParseException>	getTemplateSyntaxProblems()
private int	ignoreTrailingLineSeparator(java.lang.String strSource, int iIndex)
boolean	isForStringLiteral()
boolean	isValid()
private static void	popRuntimeData()
static void	printContent(java.lang.String strContent, boolean escape)	For internal use only!!
static void	printRange(int iStart, int iEnd)
private void	processDirective(java.lang.String strScript, int lineNumber, int column, int offset)
private static void	pushRuntimeData(TemplateGenerator.RuntimeData pair)
private void	putSymbols(ISymbolTable symTable, java.util.HashMap<java.lang.String,ISymbol> externalSymbolsMap)
void	setContextInferenceManager(ContextInferenceManager ctxInferenceMgr)
void	setDisableAlternative(boolean disableAlternative)
void	setForStringLiteral(boolean bForStringLiteralTemplate)
private void	setFqn(java.lang.String fullyQualifiedName)
private void	setHasOwnSymbolScope(boolean hasSymbolScope)
void	setUseStudioEditorParser(boolean useStudioEditorParser)
java.lang.String	toString()
private java.lang.String	transformTemplate(java.lang.String strSource, java.util.List<TemplateParseException> exceptions)
void	verify(IGosuParser parser)
private IProgram	verify(IGosuParser parser, boolean bDoNotThrowParseResultException)
void	verify(IGosuParser parser, java.util.Map<java.lang.String,java.util.List<IFunctionSymbol>> dfsDeclByName, ITypeUsesMap typeUsesMap)
private IProgram	verify(IGosuParser parser, java.util.Map<java.lang.String,java.util.List<IFunctionSymbol>> dfsDeclByName, ITypeUsesMap typeUsesMap, boolean bDoNotThrowParseResultsException)

Methods inherited from class java.lang.Object

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

Field Detail

GS_TEMPLATE

public static final java.lang.String GS_TEMPLATE

See Also:

Constant Field Values

GS_TEMPLATE_PARSED

public static final java.lang.String GS_TEMPLATE_PARSED

See Also:

Constant Field Values

SCRIPTLET_BEGIN

public static final java.lang.String SCRIPTLET_BEGIN

See Also:

Constant Field Values

SCRIPTLET_END

public static final java.lang.String SCRIPTLET_END

See Also:

Constant Field Values

EXPRESSION_SUFFIX

public static final char EXPRESSION_SUFFIX

See Also:

Constant Field Values

DECLARATION_SUFFIX

public static final char DECLARATION_SUFFIX

See Also:

Constant Field Values

DIRECTIVE_SUFFIX

public static final char DIRECTIVE_SUFFIX

See Also:

Constant Field Values

COMMENT_BEGIN

public static final java.lang.String COMMENT_BEGIN

See Also:

Constant Field Values

COMMENT_END

public static final java.lang.String COMMENT_END

See Also:

Constant Field Values

ALTERNATE_EXPRESSION_BEGIN

public static final java.lang.String ALTERNATE_EXPRESSION_BEGIN

See Also:

Constant Field Values

ALTERNATE_EXPRESSION_END

public static final java.lang.String ALTERNATE_EXPRESSION_END

See Also:

Constant Field Values

ESCAPED_SCRIPTLET_MARKER

public static final char ESCAPED_SCRIPTLET_MARKER

See Also:

Constant Field Values

ESCAPED_SCRIPTLET_BEGIN_CHAR

public static final char ESCAPED_SCRIPTLET_BEGIN_CHAR

See Also:

Constant Field Values

ESCAPED_ALTERNATE_EXPRESSION_BEGIN_CHAR

public static final char ESCAPED_ALTERNATE_EXPRESSION_BEGIN_CHAR

See Also:

Constant Field Values

SCRIPTLET_BEGIN_LEN

public static final int SCRIPTLET_BEGIN_LEN

SCRIPTLET_END_LEN

public static final int SCRIPTLET_END_LEN

COMMENT_BEGIN_LEN

public static final int COMMENT_BEGIN_LEN

COMMENT_END_LEN

public static final int COMMENT_END_LEN

ALTERNATE_EXPRESSION_BEGIN_LEN

public static final int ALTERNATE_EXPRESSION_BEGIN_LEN

ALTERNATE_EXPRESSION_END_LEN

public static final int ALTERNATE_EXPRESSION_END_LEN

PRINT_CONTENT_SYMBOL

public static final LockingLazyVar<ISymbol> PRINT_CONTENT_SYMBOL

PRINT_RANGE_SYMBOL

public static final LockingLazyVar<ISymbol> PRINT_RANGE_SYMBOL

TEMPLATE_LINE_NUMBER

public static final java.lang.String TEMPLATE_LINE_NUMBER

See Also:

Constant Field Values

g_runtimeData

private static java.lang.ThreadLocal<Stack<TemplateGenerator.RuntimeData>> g_runtimeData

SUBSTR_CHUNKSIZE

public static final int SUBSTR_CHUNKSIZE

See Also:

Constant Field Values

_fqn

private java.lang.String _fqn

_scriptStr

private java.lang.String _scriptStr

_params

private java.util.List<ISymbol> _params

_program

private Program _program

_compileTimeSymbolTable

private ISymbolTable _compileTimeSymbolTable

_supertype

private IType _supertype

_useStudioEditorParser

private boolean _useStudioEditorParser

_disableAlternative

private boolean _disableAlternative

_hasOwnSymbolScope

private boolean _hasOwnSymbolScope

_ctxInferenceMgr

private ContextInferenceManager _ctxInferenceMgr

_bStringLiteralTemplate

private boolean _bStringLiteralTemplate

Constructor Detail

TemplateGenerator

private TemplateGenerator(java.io.Reader reader)

WARNING: This will consume the reader and close it!

Parameters:

reader - the reader containing the template

Method Detail

generateTemplate

public static void generateTemplate(java.io.Reader readerTemplate,
                                    java.io.Writer writerOut,
                                    ISymbolTable symTable)
                             throws TemplateParseException

Generates a template of any format having embedded Gosu.

Parameters:

readerTemplate - The source of the template.

writerOut - Where the output should go.

symTable - The symbol table to use.

Throws:

TemplateParseException - on execution exception

generateTemplate

public static void generateTemplate(java.io.Reader readerTemplate,
                                    java.io.Writer writerOut,
                                    ISymbolTable symTable,
                                    boolean strict)
                             throws TemplateParseException

Generates a template of any format having embedded Gosu.

Parameters:

readerTemplate - The source of the template.

writerOut - Where the output should go.

symTable - The symbol table to use.

strict - whether to allow althernative template

Throws:

TemplateParseException - on execution exception

getTemplate

public static TemplateGenerator getTemplate(java.io.Reader readerTemplate)

getTemplate

public static TemplateGenerator getTemplate(java.io.Reader readerTemplate,
                                            java.lang.String fullyQualifiedName)

setHasOwnSymbolScope

private void setHasOwnSymbolScope(boolean hasSymbolScope)

getProgram

public Program getProgram()

Specified by:

getProgram in interface ITemplateGenerator

getRuntimeData

private static TemplateGenerator.RuntimeData getRuntimeData()

pushRuntimeData

private static void pushRuntimeData(TemplateGenerator.RuntimeData pair)

popRuntimeData

private static void popRuntimeData()

execute

public void execute(java.io.Writer writer,
                    ISymbolTable symbolTable)
             throws TemplateParseException

Specified by:

execute in interface ITemplateGenerator

Throws:

TemplateParseException

execute

public void execute(java.io.Writer writer,
                    StringEscaper escaper,
                    ISymbolTable symTable)
             throws TemplateParseException

Specified by:

execute in interface ITemplateGenerator

Throws:

TemplateParseException

compile

public void compile(ISymbolTable symTable)
             throws TemplateParseException

Specified by:

compile in interface ITemplateGenerator

Throws:

TemplateParseException

compile

public void compile(Stack<IScriptPartId> scriptPartIdStack,
                    ISymbolTable symTable,
                    java.util.Map<java.lang.String,java.util.List<IFunctionSymbol>> dfsDeclByName,
                    ITypeUsesMap typeUsesMap,
                    Stack<BlockExpression> blocks,
                    ContextInferenceManager ctxInferenceMgr)
             throws TemplateParseException

Throws:

TemplateParseException

compile

private Program compile(Stack<IScriptPartId> scriptPartIdStack,
                        java.lang.String strCompiledSource,
                        ISymbolTable symbolTable,
                        java.util.Map<java.lang.String,java.util.List<IFunctionSymbol>> dfsDeclByName,
                        ITypeUsesMap typeUsesMap,
                        Stack<BlockExpression> blocks,
                        ContextInferenceManager ctxInferenceMgr)
                 throws ParseResultsException

Returns:

the program to execute

Throws:

ParseException

ParseResultsException

addStaticSymbols

private void addStaticSymbols(ISymbolTable symbolTable,
                              GosuParser parser,
                              IGosuClassInternal supertype)

verify

public void verify(IGosuParser parser,
                   java.util.Map<java.lang.String,java.util.List<IFunctionSymbol>> dfsDeclByName,
                   ITypeUsesMap typeUsesMap)
            throws ParseResultsException

Throws:

ParseResultsException

verify

private IProgram verify(IGosuParser parser,
                        java.util.Map<java.lang.String,java.util.List<IFunctionSymbol>> dfsDeclByName,
                        ITypeUsesMap typeUsesMap,
                        boolean bDoNotThrowParseResultsException)
                 throws ParseResultsException

Throws:

ParseResultsException

verify

public void verify(IGosuParser parser)
            throws ParseResultsException

Specified by:

verify in interface ITemplateGenerator

Throws:

ParseResultsException

verify

private IProgram verify(IGosuParser parser,
                        boolean bDoNotThrowParseResultException)
                 throws ParseResultsException

Throws:

ParseResultsException

getTemplateSyntaxProblems

public java.util.List<TemplateParseException> getTemplateSyntaxProblems()

Specified by:

getTemplateSyntaxProblems in interface ITemplateGenerator

transformTemplate

private java.lang.String transformTemplate(java.lang.String strSource,
                                           java.util.List<TemplateParseException> exceptions)

ignoreTrailingLineSeparator

private int ignoreTrailingLineSeparator(java.lang.String strSource,
                                        int iIndex)

processDirective

private void processDirective(java.lang.String strScript,
                              int lineNumber,
                              int column,
                              int offset)
                       throws TemplateParseException

Throws:

TemplateParseException

addText

private void addText(java.lang.StringBuilder strTarget,
                     java.lang.String strText)

addRefText

private void addRefText(java.lang.StringBuilder sbTarget,
                        int iStart,
                        int iEnd)

addExpression

private void addExpression(java.lang.StringBuilder strTarget,
                           java.lang.String strExpression,
                           int iLineNumber)

addScriptlet

private void addScriptlet(java.lang.StringBuilder strTarget,
                          java.lang.String strScript,
                          int iLineNumber)

escapeForGosuStringLiteral

private java.lang.String escapeForGosuStringLiteral(java.lang.String strText)

getColumnForIndex

private int getColumnForIndex(java.lang.String strSource,
                              int iIndex)

printContent

public static void printContent(java.lang.String strContent,
                                boolean escape)

For internal use only!!

printRange

public static void printRange(int iStart,
                              int iEnd)

setDisableAlternative

public void setDisableAlternative(boolean disableAlternative)

setContextInferenceManager

public void setContextInferenceManager(ContextInferenceManager ctxInferenceMgr)

setForStringLiteral

public void setForStringLiteral(boolean bForStringLiteralTemplate)

isForStringLiteral

public boolean isForStringLiteral()

isValid

public boolean isValid()

Specified by:

isValid in interface ITemplateGenerator

setFqn

private void setFqn(java.lang.String fullyQualifiedName)

getFullyQualifiedTypeName

public java.lang.String getFullyQualifiedTypeName()

Specified by:

getFullyQualifiedTypeName in interface ITemplateGenerator

getParameters

public java.util.List<ISymbol> getParameters()

Specified by:

getParameters in interface ITemplateGenerator

compileIfNotCompiled

private void compileIfNotCompiled()

getSuperType

public IType getSuperType()

Specified by:

getSuperType in interface ITemplateGenerator

setUseStudioEditorParser

public void setUseStudioEditorParser(boolean useStudioEditorParser)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getSource

public java.lang.String getSource()

Specified by:

getSource in interface ITemplateGenerator

extractExternalSymbols

private IExternalSymbolMap extractExternalSymbols(ISymbolTable compileTimeSymbolTable,
                                                  ISymbolTable runtimeSymbolTable)

putSymbols

private void putSymbols(ISymbolTable symTable,
                        java.util.HashMap<java.lang.String,ISymbol> externalSymbolsMap)