com.google.template.soy.shared.internal

Class AbstractGenerateSoyEscapingDirectiveCode

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

com.google.template.soy.shared.internal.AbstractGenerateSoyEscapingDirectiveCode

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

GeneratePySanitizeEscapingDirectiveCode, GenerateSoyUtilsEscapingDirectiveCode

@ParametersAreNonnullByDefault
public abstract class AbstractGenerateSoyEscapingDirectiveCode
extends org.apache.tools.ant.Task

Abstract class for generating code relied upon by escaping directives.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractGenerateSoyEscapingDirectiveCode.FileRef A file reference like <input path="foo.txt"/>.
static class	AbstractGenerateSoyEscapingDirectiveCode.FunctionNamePredicate A wrapper around a library function name predicate like <libdefined name="goog.*"/>.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.common.base.Predicate<String>	availableIdentifiers Matches functions available in the environment in which output will be run including things like EscapingConventions.CrossLanguageStringXform.getLangFunctionNames(com.google.template.soy.shared.internal.EscapingConventions.EscapingLanguage).

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
AbstractGenerateSoyEscapingDirectiveCode()

Method Summary

Modifier and Type	Method and Description
void	addConfiguredLibdefined(AbstractGenerateSoyEscapingDirectiveCode.FunctionNamePredicate p) Called reflectively when Ant sees <libdefined>.
protected void	configure(String[] args) Setup method to read arguments and setup initial configuration.
protected abstract String	convertFromJavaRegex(Pattern javaPattern) Converts the given pattern from a Java Pattern syntax to the language specific syntax.
AbstractGenerateSoyEscapingDirectiveCode.FileRef	createInput() Called reflectively when Ant sees <input> to specify a file that uses the generated helper functions.
AbstractGenerateSoyEscapingDirectiveCode.FileRef	createOutput() Called reflectively when Ant sees <output> to specify the file that should receive the output.
protected abstract String	escapeOutputString(String input) Escape a generated string being outputted based on the current language being generated.
void	execute() Called to actually build the output by Ant.
protected abstract void	generateCharacterMapSignature(StringBuilder outputCode, String mapName) Generate the signature to a map object to hold character mapping.
protected abstract void	generateCommonConstants(StringBuilder outputCode) Generate common constants used elsewhere by the utility.
protected abstract void	generateFilter(StringBuilder outputCode, String name, String filter) Generate the constant to store the given filter regular expression.
protected abstract void	generateHelperFunction(StringBuilder outputCode, DirectiveDigest digest) Generate the helper function to execute the escaping, filtering, and replacing.
protected abstract void	generateMatcher(StringBuilder outputCode, String name, String matcher) Generate the constant to store the given matcher regular expression.
protected void	generatePrefix(StringBuilder outputCode) Generate any prefix needed to precede the escapers.
protected abstract void	generateReplacerFunction(StringBuilder outputCode, String mapName) Generate the function to handle replacement of a given character.
com.google.common.base.Predicate<String>	getAvailableIdentifiers() A matcher for functions available in the environment in which output will be run including things like EscapingConventions.CrossLanguageStringXform.getLangFunctionNames(com.google.template.soy.shared.internal.EscapingConventions.EscapingLanguage).
protected abstract EscapingConventions.EscapingLanguage	getLanguage() Get the language being generated here.
protected abstract String	getLineCommentSyntax() Return the syntax for starting a one line comment.
protected abstract String	getLineEndSyntax() Return the syntax for ending a line.
protected abstract String	getRegexEnd() Return the syntax for ending a regex string.
protected abstract String	getRegexStart() Return the syntax for starting a regex string.
protected abstract void	useExistingLibraryFunction(StringBuilder outputCode, String identifier, String existingFunction) Use an existing library function to execute the escaping, filtering, and replacing.
protected void	writeStringLiteral(String value, StringBuilder out) Appends a string literal with the given value onto the given buffer.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Field Detail

availableIdentifiers

protected com.google.common.base.Predicate<String> availableIdentifiers

Matches functions available in the environment in which output will be run including things like EscapingConventions.CrossLanguageStringXform.getLangFunctionNames(com.google.template.soy.shared.internal.EscapingConventions.EscapingLanguage).

Constructor Detail

AbstractGenerateSoyEscapingDirectiveCode

public AbstractGenerateSoyEscapingDirectiveCode()

Method Detail

getAvailableIdentifiers

public com.google.common.base.Predicate<String> getAvailableIdentifiers()

A matcher for functions available in the environment in which output will be run including things like EscapingConventions.CrossLanguageStringXform.getLangFunctionNames(com.google.template.soy.shared.internal.EscapingConventions.EscapingLanguage).

createInput

public AbstractGenerateSoyEscapingDirectiveCode.FileRef createInput()

Called reflectively when Ant sees <input> to specify a file that uses the generated helper functions.

createOutput

public AbstractGenerateSoyEscapingDirectiveCode.FileRef createOutput()

Called reflectively when Ant sees <output> to specify the file that should receive the output.

addConfiguredLibdefined

public void addConfiguredLibdefined(AbstractGenerateSoyEscapingDirectiveCode.FunctionNamePredicate p)

Called reflectively when Ant sees <libdefined>.

configure

protected void configure(String[] args)
                  throws IOException

Setup method to read arguments and setup initial configuration.

Parameters:

args - Main method input arguments.

Throws:

IOException

execute

public void execute()

Called to actually build the output by Ant.

Overrides:

execute in class org.apache.tools.ant.Task

writeStringLiteral

protected void writeStringLiteral(String value,
                                  StringBuilder out)

Appends a string literal with the given value onto the given buffer.

getLanguage

protected abstract EscapingConventions.EscapingLanguage getLanguage()

Get the language being generated here.

Returns:

The language being generated.

getLineCommentSyntax

protected abstract String getLineCommentSyntax()

Return the syntax for starting a one line comment.

Returns:

The syntax for starting a one line comment.

getLineEndSyntax

protected abstract String getLineEndSyntax()

Return the syntax for ending a line.

Returns:

The syntax for ending a line.

getRegexStart

protected abstract String getRegexStart()

Return the syntax for starting a regex string.

Returns:

The syntax for starting a regex string.

getRegexEnd

protected abstract String getRegexEnd()

Return the syntax for ending a regex string.

Returns:

The syntax for ending a regex string.

escapeOutputString

protected abstract String escapeOutputString(String input)

Escape a generated string being outputted based on the current language being generated.

Returns:

The input string escaped for the current output language.

convertFromJavaRegex

protected abstract String convertFromJavaRegex(Pattern javaPattern)

Converts the given pattern from a Java Pattern syntax to the language specific syntax.

Parameters:

javaPattern - The Java regular expression to convert.

Returns:

A string representing the given pattern syntax in the specific language.

generatePrefix

protected void generatePrefix(StringBuilder outputCode)

Generate any prefix needed to precede the escapers. This may include library imports and other similar setup tasks.

Parameters:

outputCode - The StringBuilder where generated code should be appended.

generateCharacterMapSignature

protected abstract void generateCharacterMapSignature(StringBuilder outputCode,
                                                      String mapName)

Generate the signature to a map object to hold character mapping. All necessary comments and variable declarations should be included in the signature. The map assignment will be appended to the signature.

For example. In Javascript the following should be returned:

   /**
    * Maps characters to the escaped versions for the named escape directives.\n")
    * @type {Object}\n")
    * @private\n")
    *\/
     soy.esc.$$ESCAPE_MAP_FOR_<NAME>_
 

Parameters:

outputCode - The StringBuilder where generated code should be appended.

mapName - The name of this map.

generateMatcher

protected abstract void generateMatcher(StringBuilder outputCode,
                                        String name,
                                        String matcher)

Generate the constant to store the given matcher regular expression.

Parameters:

outputCode - The StringBuilder where generated code should be appended.

name - The name of the current matcher.

matcher - The regular expression string.

generateFilter

protected abstract void generateFilter(StringBuilder outputCode,
                                       String name,
                                       String filter)

Generate the constant to store the given filter regular expression.

Parameters:

outputCode - The StringBuilder where generated code should be appended.

name - The name of the current filter.

filter - The regular expression string.

generateReplacerFunction

protected abstract void generateReplacerFunction(StringBuilder outputCode,
                                                 String mapName)

Generate the function to handle replacement of a given character.

Parameters:

outputCode - The StringBuilder where generated code should be appended.

mapName - The name of the map to use for replacement.

useExistingLibraryFunction

protected abstract void useExistingLibraryFunction(StringBuilder outputCode,
                                                   String identifier,
                                                   String existingFunction)

Use an existing library function to execute the escaping, filtering, and replacing.

Parameters:

outputCode - The StringBuilder where generated code should be appended.

identifier - The identifier of the escape directive.

existingFunction - The existing function to reuse.

generateHelperFunction

protected abstract void generateHelperFunction(StringBuilder outputCode,
                                               DirectiveDigest digest)

Generate the helper function to execute the escaping, filtering, and replacing.

Parameters:

outputCode - The StringBuilder where generated code should be appended.

digest - The DirectiveDigest which contains the appropriate patterns and replacer keys.

generateCommonConstants

protected abstract void generateCommonConstants(StringBuilder outputCode)

Generate common constants used elsewhere by the utility.

Parameters:

outputCode - The StringBuilder where generated code should be appended.