/*
* Copyright 2014 Attila Szegedi, Daniel Dekany, Jonathan Revusky
*
* Licensed 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.TemplateDirectiveModel;
import freemarker.template.TemplateException;
import freemarker.template.TemplateModel;
import freemarker.template.TemplateTransformModel;
/**
* An element for the unified macro/transform syntax.
*/
final class UnifiedCall extends TemplateElement {
private Expression nameExp;
private Map namedArgs;
private List positionalArgs, bodyParameterNames;
boolean legacySyntax;
private transient volatile SoftReference/*List<Map.Entry<String,Expression>>*/ sortedNamedArgsCache;
UnifiedCall(Expression nameExp,
Map namedArgs,
TemplateElement nestedBlock,
List bodyParameterNames)
{
this.nameExp = nameExp;
this.namedArgs = namedArgs;
this.nestedBlock = nestedBlock;
this.bodyParameterNames = bodyParameterNames;
}
UnifiedCall(Expression nameExp,
List positionalArgs,
TemplateElement nestedBlock,
List bodyParameterNames)
{
this.nameExp = nameExp;
this.positionalArgs = positionalArgs;
if (nestedBlock == TextBlock.EMPTY_BLOCK) {
nestedBlock = null;
}
this.nestedBlock = nestedBlock;
this.bodyParameterNames = bodyParameterNames;
}
void accept(Environment env) throws TemplateException, IOException {
TemplateModel tm = nameExp.eval(env);
if (tm == Macro.DO_NOTHING_MACRO) return; // shortcut here.
if (tm instanceof Macro) {
Macro macro = (Macro) tm;
if (macro.isFunction && !legacySyntax) {
throw new _MiscTemplateException(env, new Object[] {
"Routine ", new _DelayedJQuote(macro.getName()), " is a function, not a directive. "
+ "Functions can only be called from expressions, like in ${f()}, ${x + f()} or ",
"<@someDirective someParam=f() />", "." });
}
env.visit(macro, namedArgs, positionalArgs, bodyParameterNames,
nestedBlock);
}
else {
boolean isDirectiveModel = tm instanceof TemplateDirectiveModel;
if (isDirectiveModel || tm instanceof TemplateTransformModel) {
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;
}
if(isDirectiveModel) {
env.visit(nestedBlock, (TemplateDirectiveModel) tm, args,
bodyParameterNames);
}
else {
env.visitAndTransform(nestedBlock, (TemplateTransformModel) tm, args);
}
}
else if (tm == null) {
throw InvalidReferenceException.getInstance(nameExp, env);
} else {
throw new NonUserDefinedDirectiveLikeException(nameExp, tm, env);
}
}
}
protected String dump(boolean canonical) {
StringBuffer sb = new StringBuffer();
if (canonical) sb.append('<');
sb.append('@');
MessageUtil.appendExpressionAsUntearable(sb, nameExp);
boolean nameIsInParen = sb.charAt(sb.length() - 1) == ')';
if (positionalArgs != null) {
for (int i=0; i < positionalArgs.size(); i++) {
Expression argExp = (Expression) positionalArgs.get(i);
if (i != 0) {
sb.append(',');
}
sb.append(' ');
sb.append(argExp.getCanonicalForm());
}
} else {
List entries = getSortedNamedArgs();
for (int i = 0; i < entries.size(); i++) {
Map.Entry entry = (Map.Entry) entries.get(i);
Expression argExp = (Expression) entry.getValue();
sb.append(' ');
sb.append(entry.getKey());
sb.append('=');
MessageUtil.appendExpressionAsUntearable(sb, argExp);
}
}
if (canonical) {
if (nestedBlock == null) {
sb.append("/>");
}
else {
sb.append('>');
sb.append(nestedBlock.getCanonicalForm());
sb.append("</@");
if (!nameIsInParen
&& (nameExp instanceof Identifier
|| (nameExp instanceof Dot && ((Dot) nameExp).onlyHasIdentifiers()))) {
sb.append(nameExp.getCanonicalForm());
}
sb.append('>');
}
}
return sb.toString();
}
String getNodeTypeSymbol() {
return "@";
}
int getParameterCount() {
return 1/*nameExp*/
+ (positionalArgs != null ? positionalArgs.size() : 0)
+ (namedArgs != null ? namedArgs.size() * 2 : 0)
+ (bodyParameterNames != null ? bodyParameterNames.size() : 0);
}
Object getParameterValue(int idx) {
if (idx == 0) {
return nameExp;
} else {
int base = 1;
final int positionalArgsSize = positionalArgs != null ? positionalArgs.size() : 0;
if (idx - base < positionalArgsSize) {
return positionalArgs.get(idx - base);
} else {
base += positionalArgsSize;
final int namedArgsSize = namedArgs != null ? namedArgs.size() : 0;
if (idx - base < namedArgsSize * 2) {
Map.Entry namedArg = (Map.Entry) getSortedNamedArgs().get((idx - base) / 2);
return (idx - base) % 2 == 0 ? namedArg.getKey() : namedArg.getValue();
} else {
base += namedArgsSize * 2;
final int bodyParameterNamesSize = bodyParameterNames != null ? bodyParameterNames.size() : 0;
if (idx - base < bodyParameterNamesSize) {
return bodyParameterNames.get(idx - base);
} else {
throw new IndexOutOfBoundsException();
}
}
}
}
}
ParameterRole getParameterRole(int idx) {
if (idx == 0) {
return ParameterRole.CALLEE;
} else {
int base = 1;
final int positionalArgsSize = positionalArgs != null ? positionalArgs.size() : 0;
if (idx - base < positionalArgsSize) {
return ParameterRole.ARGUMENT_VALUE;
} else {
base += positionalArgsSize;
final int namedArgsSize = namedArgs != null ? namedArgs.size() : 0;
if (idx - base < namedArgsSize * 2) {
return (idx - base) % 2 == 0 ? ParameterRole.ARGUMENT_NAME : ParameterRole.ARGUMENT_VALUE;
} else {
base += namedArgsSize * 2;
final int bodyParameterNamesSize = bodyParameterNames != null ? bodyParameterNames.size() : 0;
if (idx - base < bodyParameterNamesSize) {
return ParameterRole.TARGET_LOOP_VARIABLE;
} else {
throw new IndexOutOfBoundsException();
}
}
}
}
}
/**
* Returns the named args by source-code order; it's not meant to be used during template execution, too slow for
* that!
*/
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;
}
/*
//REVISIT
boolean heedsOpeningWhitespace() {
return nestedBlock == null;
}
//REVISIT
boolean heedsTrailingWhitespace() {
return nestedBlock == null;
}*/
}