2021SC@SDUSC
目录
TransformBlock.java
源码分析
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package freemarker.core;
import java.io.IOException;
import java.lang.ref.Reference;
import java.lang.ref.SoftReference;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import freemarker.template.EmptyMap;
import freemarker.template.TemplateException;
import freemarker.template.TemplateModel;
import freemarker.template.TemplateTransformModel;
//包含嵌套块的模板元素根据T的一个实例进行转换 TemplateTransformModel
final class TransformBlock extends TemplateElement {
private Expression transformExpression;
Map namedArgs;
private transient volatile SoftReference/*List<Map.Entry<String,Expression>>*/ sortedNamedArgsCache;
//使用给定的转换创建新的TransformBlock
TransformBlock(Expression transformExpression,
Map namedArgs,
TemplateElements children) {
this.transformExpression = transformExpression;
this.namedArgs = namedArgs;
setChildren(children);
}
@Override
TemplateElement[] accept(Environment env)
throws TemplateException, IOException {
TemplateTransformModel ttm = env.getTransform(transformExpression);
if (ttm != null) {
Map args;
if (namedArgs != null && !namedArgs.isEmpty()) {
args = new HashMap();
for (Iterator it = namedArgs.entrySet().iterator(); it.hasNext(); ) {
Map.Entry entry = (Map.Entry) it.next();
String key = (String) entry.getKey();
Expression valueExp = (Expression) entry.getValue();
TemplateModel value = valueExp.eval(env);
args.put(key, value);
}
} else {
args = EmptyMap.instance;
}
env.visitAndTransform(getChildBuffer(), ttm, args);
} else {
TemplateModel tm = transformExpression.eval(env);
throw new UnexpectedTypeException(
transformExpression, tm,
"transform", new Class[] { TemplateTransformModel.class }, env);
}
return null;
}
@Override
protected String dump(boolean canonical) {
StringBuilder sb = new StringBuilder();
if (canonical) sb.append('<');
sb.append(getNodeTypeSymbol());
sb.append(' ');
sb.append(transformExpression);
if (namedArgs != null) {
for (Iterator it = getSortedNamedArgs().iterator(); it.hasNext(); ) {
Map.Entry entry = (Map.Entry) it.next();
sb.append(' ');
sb.append(entry.getKey());
sb.append('=');
_MessageUtil.appendExpressionAsUntearable(sb, (Expression) entry.getValue());
}
}
if (canonical) {
sb.append(">");
sb.append(getChildrenCanonicalForm());
sb.append("</").append(getNodeTypeSymbol()).append('>');
}
return sb.toString();
}
@Override
String getNodeTypeSymbol() {
return "#transform";
}
@Override
int getParameterCount() {
return 1/*nameExp*/ + (namedArgs != null ? namedArgs.size() * 2 : 0);
}
@Override
Object getParameterValue(int idx) {
if (idx == 0) {
return transformExpression;
} else if (namedArgs != null && idx - 1 < namedArgs.size() * 2) {
Map.Entry namedArg = (Map.Entry) getSortedNamedArgs().get((idx - 1) / 2);
return (idx - 1) % 2 == 0 ? namedArg.getKey() : namedArg.getValue();
} else {
throw new IndexOutOfBoundsException();
}
}
@Override
ParameterRole getParameterRole(int idx) {
if (idx == 0) {
return ParameterRole.CALLEE;
} else if (idx - 1 < namedArgs.size() * 2) {
return (idx - 1) % 2 == 0 ? ParameterRole.ARGUMENT_NAME : ParameterRole.ARGUMENT_VALUE;
} else {
throw new IndexOutOfBoundsException();
}
}
//按源代码顺序返回指定参数;它不适合在模板执行期间使用
private List/*<Map.Entry<String, Expression>>*/ getSortedNamedArgs() {
Reference ref = sortedNamedArgsCache;
if (ref != null) {
List res = (List) ref.get();
if (res != null) return res;
}
List res = MiscUtil.sortMapOfExpressions(namedArgs);
sortedNamedArgsCache = new SoftReference(res);
return res;
}
@Override
boolean isNestedBlockRepeater() {
return false;
}
@Override
boolean isShownInStackTrace() {
return true;
}
}
TokenMgrError.java
源码分析
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package freemarker.core;
import freemarker.template.Template;
/**
* Exception thrown on lower (lexical) level parsing errors. Shouldn't reach normal FreeMarker users, as FreeMarker
* usually catches this and wraps it into a {@link ParseException}.
*
* This is a modified version of file generated by JavaCC from FTL.jj.
* You can modify this class to customize the error reporting mechanisms so long as the public interface
* remains compatible with the original.
*
* @see ParseException
*/
public class TokenMgrError extends Error {
/*
* Ordinals for various reasons why an Error of this type can be thrown.
*/
/**
* Lexical error occurred.
*/
static final int LEXICAL_ERROR = 0;
/**
* An attempt was made to create a second instance of a static token manager.
*/
static final int STATIC_LEXER_ERROR = 1;
/**
* Tried to change to an invalid lexical state.
*/
static final int INVALID_LEXICAL_STATE = 2;
/**
* Detected (and bailed out of) an infinite loop in the token manager.
*/
static final int LOOP_DETECTED = 3;
/**
* Indicates the reason why the exception is thrown. It will have
* one of the above 4 values.
*/
int errorCode;
private String detail;
private Integer lineNumber, columnNumber;
private Integer endLineNumber, endColumnNumber;
//用空格(或unicode转义)替换不可打印的字符.在给定字符串中的等价
protected static final String addEscapes(String str) {
StringBuilder retval = new StringBuilder();
char ch;
for (int i = 0; i < str.length(); i++) {
switch (str.charAt(i))
{
case 0 :
continue;
case '\b':
retval.append("\\b");
continue;
case '\t':
retval.append("\\t");
continue;
case '\n':
retval.append("\\n");
continue;
case '\f':
retval.append("\\f");
continue;
case '\r':
retval.append("\\r");
continue;
case '\"':
retval.append("\\\"");
continue;
case '\'':
retval.append("\\\'");
continue;
case '\\':
retval.append("\\\\");
continue;
default:
if ((ch = str.charAt(i)) < 0x20 || ch > 0x7e) {
String s = "0000" + Integer.toString(ch, 16);
retval.append("\\u" + s.substring(s.length() - 4, s.length()));
} else {
retval.append(ch);
}
continue;
}
}
return retval.toString();
}
//方法引发错误时,返回该错误的详细消息,令牌管理器指示词法错误。
protected static String LexicalError(boolean EOFSeen, int lexState, int errorLine, int error