com.google.template.soy.base.internal

Class BaseUtils

java.lang.Object

com.google.template.soy.base.internal.BaseUtils

public class BaseUtils
extends Object

Base utilities for Soy code.

Important: Do not use outside of Soy code (treat as superpackage-private).

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOTTED_IDENT_RE Regular expression for a dotted identifier.
static String	IDENT_RE Regular expression for an identifier.

Method Summary

Modifier and Type	Method and Description
static void	appendHexEscape(StringBuilder out, int codePoint) Appends the Unicode hex escape sequence for the given code point (backslash + 'u' + 4 hex digits) to the given StringBuilder.
static String	convertToUpperUnderscore(String ident) Converts an identifier to upper-underscore format.
static void	ensureDirsExistInPath(String path) Ensures that the directories in the given path exist, creating them if necessary.
static String	escapeToSoyString(String value, boolean shouldEscapeToAscii, QuoteStyle quoteStyle) Builds a Soy string literal for this string value (including the surrounding single quotes).
static String	extractPartAfterLastDot(String dottedIdent) Gets the part after the last dot in a dotted identifier.
static boolean	isDottedIdentifier(String s) Determines whether the given string is a dotted identifier (e.g.
static boolean	isIdentifier(String s) Determines whether the given string is an identifier.
static boolean	isIdentifierWithLeadingDot(String s) Determines whether the given string is a dot followed by an identifier.

Methods inherited from class java.lang.Object

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

Field Detail

IDENT_RE

public static final String IDENT_RE

Regular expression for an identifier.

See Also:

Constant Field Values

DOTTED_IDENT_RE

public static final String DOTTED_IDENT_RE

Regular expression for a dotted identifier.

See Also:

Constant Field Values

Method Detail

ensureDirsExistInPath

public static void ensureDirsExistInPath(String path)

Ensures that the directories in the given path exist, creating them if necessary.

Note: If the path does not end with the separator char (slash in Linux), then the name at the end is assumed to be the file name, so directories are only created down to its parent.

Parameters:

path - The path for which to ensure directories exist.

isIdentifier

public static boolean isIdentifier(String s)

Determines whether the given string is an identifier.

An identifier must start with a letter or underscore and must only contain letters, digits, and underscores (i.e. it must match the regular expression [A-Za-z_][A-Za-z_0-9]*).

Parameters:

s - The string to check.

Returns:

True if the given string is an identifier.

isIdentifierWithLeadingDot

public static boolean isIdentifierWithLeadingDot(String s)

Determines whether the given string is a dot followed by an identifier.

Parameters:

s - The string to check.

Returns:

True if the given string is a dot followed by an identifier.

isDottedIdentifier

public static boolean isDottedIdentifier(String s)

Determines whether the given string is a dotted identifier (e.g. boo.foo0._goo). A dotted identifier is not required to have dots (i.e. a simple identifier qualifies as a dotted identifier).

Parameters:

s - The string to check.

Returns:

True if the given string is a dotted identifier (e.g. boo.foo0._goo).

extractPartAfterLastDot

public static String extractPartAfterLastDot(String dottedIdent)

Gets the part after the last dot in a dotted identifier. If there are no dots, returns the whole input string.

Important: The input must be a dotted identifier. This is not checked.

convertToUpperUnderscore

public static String convertToUpperUnderscore(String ident)

Converts an identifier to upper-underscore format. The identifier must start with a letter or underscore and must only contain letters, digits, and underscores (i.e. it must match the regular expression [A-Za-z_][A-Za-z_0-9]*).

Parameters:

ident - The identifier to convert.

Returns:

The identifier in upper-underscore format.

escapeToSoyString

public static String escapeToSoyString(String value,
                                       boolean shouldEscapeToAscii,
                                       QuoteStyle quoteStyle)

Builds a Soy string literal for this string value (including the surrounding single quotes). Note that Soy string syntax is a subset of JS string syntax, so the result should also be a valid JS string.

Adapted from StringUtil.javaScriptEscape().

Parameters:

value - The string value to escape.

shouldEscapeToAscii - Whether to escape non-ASCII characters as Unicode hex escapes (backslash + 'u' + 4 hex digits).

quoteStyle - whether or not to use double quotes

Returns:

A Soy string literal for this string value (including the surrounding quotes).

appendHexEscape

public static void appendHexEscape(StringBuilder out,
                                   int codePoint)

Appends the Unicode hex escape sequence for the given code point (backslash + 'u' + 4 hex digits) to the given StringBuilder.

Note: May append 2 escape sequences (surrogate pair) in the case of a supplementary character (outside the Unicode BMP).

Adapted from StringUtil.appendHexJavaScriptRepresentation().

Parameters:

out - The StringBuilder to append to.

codePoint - The Unicode code point whose hex escape sequence to append.