/*
* Copyright (c) 2003 The Visigoth Software Society. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowledgement:
* "This product includes software developed by the
* Visigoth Software Society (http://www.visigoths.org/)."
* Alternately, this acknowledgement may appear in the software itself,
* if and wherever such third-party acknowledgements normally appear.
*
* 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
* project contributors may be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact visigoths@visigoths.org.
*
* 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
* nor may "FreeMarker" or "Visigoth" appear in their names
* without prior written permission of the Visigoth Software Society.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Visigoth Software Society. For more
* information on the Visigoth Software Society, please see
* http://www.visigoths.org/
*/
package freemarker.core;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import freemarker.template.SimpleNumber;
import freemarker.template.TemplateBooleanModel;
import freemarker.template.TemplateCollectionModel;
import freemarker.template.TemplateException;
import freemarker.template.TemplateModel;
import freemarker.template.TemplateModelIterator;
import freemarker.template.TemplateSequenceModel;
/**
* An instruction that processes a list or foreach block
*/
final class IteratorBlock extends TemplateElement {
private Expression listExpression;
private String indexName;
private boolean isForEach;
/**
* @param listExpression a variable referring to a sequence or collection
* @param indexName an arbitrary index variable name
* @param nestedBlock the nestedBlock to iterate over
*/
IteratorBlock(Expression listExpression,
String indexName,
TemplateElement nestedBlock,
boolean isForEach)
{
this.listExpression = listExpression;
this.indexName = indexName;
this.isForEach = isForEach;
this.nestedBlock = nestedBlock;
}
void accept(Environment env) throws TemplateException, IOException
{
TemplateModel baseModel = listExpression.getAsTemplateModel(env);
if (baseModel == null) {
if (env.isClassicCompatible()) {
// Classic behavior of simply ignoring null references.
return;
}
assertNonNull(baseModel, listExpression, env);
}
env.visit(new Context(baseModel));
}
public String getCanonicalForm() {
if (isForEach) {
StringBuffer buf = new StringBuffer("<#foreach ");
buf.append(indexName);
buf.append(" in ");
buf.append(listExpression.getCanonicalForm());
buf.append(">");
if (nestedBlock != null) {
buf.append(nestedBlock.getCanonicalForm());
}
buf.append("</#foreach>");
return buf.toString();
}
else {
StringBuffer buf = new StringBuffer("<#list ");
buf.append(listExpression.getCanonicalForm());
buf.append(" as ");
buf.append(indexName);
buf.append(">");
if (nestedBlock != null) {
buf.append(nestedBlock.getCanonicalForm());
}
buf.append("</#list>");
return buf.toString();
}
}
public String getDescription() {
if (isForEach) {
return "foreach " + indexName + " in " + listExpression;
}
else {
return "list " + listExpression + " as " + indexName;
}
}
/**
* A helper class that holds the context of the loop.
*/
class Context implements LocalContext {
private boolean hasNext;
private TemplateModel loopVar;
private int index;
private Collection variableNames = null;
private TemplateModel list;
Context(TemplateModel list) {
this.list = list;
}
void runLoop(Environment env) throws TemplateException, IOException {
if (list instanceof TemplateCollectionModel) {
TemplateCollectionModel baseListModel = (TemplateCollectionModel)list;
TemplateModelIterator it = baseListModel.iterator();
hasNext = it.hasNext();
while (hasNext) {
loopVar = it.next();
hasNext = it.hasNext();
if (nestedBlock != null) {
env.visit(nestedBlock);
}
index++;
}
}
else if (list instanceof TemplateSequenceModel) {
TemplateSequenceModel tsm = (TemplateSequenceModel) list;
int size = tsm.size();
for (index =0; index <size; index++) {
loopVar = tsm.get(index);
hasNext = (size > index +1);
if (nestedBlock != null) {
env.visit(nestedBlock);
}
}
}
else if (env.isClassicCompatible()) {
loopVar = list;
if (nestedBlock != null) {
env.visit(nestedBlock);
}
}
else {
throw invalidTypeException(list, listExpression, env, "collection or sequence");
}
}
public TemplateModel getLocalVariable(String name) {
if (name.startsWith(indexName)) {
switch(name.length() - indexName.length()) {
case 0:
return loopVar;
case 6:
if(name.endsWith("_index")) {
return new SimpleNumber(index);
}
break;
case 9:
if(name.endsWith("_has_next")) {
return hasNext ? TemplateBooleanModel.TRUE : TemplateBooleanModel.FALSE;
}
break;
}
}
return null;
}
public Collection getLocalVariableNames() {
if(variableNames == null) {
variableNames = new ArrayList(3);
variableNames.add(indexName);
variableNames.add(indexName + "_index");
variableNames.add(indexName + "_has_next");
}
return variableNames;
}
}
}