001: /*
002: * Copyright (c) 2003 The Visigoth Software Society. All rights
003: * reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions
007: * are met:
008: *
009: * 1. Redistributions of source code must retain the above copyright
010: * notice, this list of conditions and the following disclaimer.
011: *
012: * 2. Redistributions in binary form must reproduce the above copyright
013: * notice, this list of conditions and the following disclaimer in
014: * the documentation and/or other materials provided with the
015: * distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowledgement:
019: * "This product includes software developed by the
020: * Visigoth Software Society (http://www.visigoths.org/)."
021: * Alternately, this acknowledgement may appear in the software itself,
022: * if and wherever such third-party acknowledgements normally appear.
023: *
024: * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
025: * project contributors may be used to endorse or promote products derived
026: * from this software without prior written permission. For written
027: * permission, please contact visigoths@visigoths.org.
028: *
029: * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
030: * nor may "FreeMarker" or "Visigoth" appear in their names
031: * without prior written permission of the Visigoth Software Society.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of the Visigoth Software Society. For more
049: * information on the Visigoth Software Society, please see
050: * http://www.visigoths.org/
051: */
052:
053: package freemarker.core;
054:
055: import java.io.IOException;
056: import java.io.StringWriter;
057: import java.io.Writer;
058: import java.util.Map;
059:
060: import freemarker.template.SimpleScalar;
061: import freemarker.template.TemplateException;
062: import freemarker.template.TemplateModel;
063: import freemarker.template.TemplateTransformModel;
064:
065: /**
066: * @version $Id: BlockAssignment.java,v 1.4 2004/07/07 21:11:12 szegedia Exp $
067: */
068: final class BlockAssignment extends TemplateElement {
069:
070: private final String varName;
071: private final Expression namespaceExp;
072: private final int scope;
073:
074: BlockAssignment(TemplateElement nestedBlock, String varName,
075: int scope, Expression namespaceExp) {
076: this .nestedBlock = nestedBlock;
077: this .varName = varName;
078: this .namespaceExp = namespaceExp;
079: this .scope = scope;
080: }
081:
082: void accept(Environment env) throws TemplateException, IOException {
083: if (nestedBlock != null) {
084: env.visit(nestedBlock, new CaptureOutput(env), null);
085: }
086: }
087:
088: private class CaptureOutput implements TemplateTransformModel {
089: private final Environment env;
090: private final Environment.Namespace fnsModel;
091:
092: CaptureOutput(Environment env) throws TemplateException {
093: this .env = env;
094: TemplateModel nsModel = null;
095: if (namespaceExp != null) {
096: nsModel = namespaceExp.getAsTemplateModel(env);
097: if (!(nsModel instanceof Environment.Namespace)) {
098: throw new TemplateException(
099: "namespace parameter does not specify "
100: + "a namespace. It is a "
101: + nsModel.getClass().getName(), env);
102: }
103: }
104: fnsModel = (Environment.Namespace) nsModel;
105: }
106:
107: public Writer getWriter(Writer out, Map args) {
108: return new StringWriter() {
109: public void close() {
110: SimpleScalar result = new SimpleScalar(toString());
111: switch (scope) {
112: case Assignment.NAMESPACE: {
113: if (fnsModel != null) {
114: fnsModel.put(varName, result);
115: } else {
116: env.setVariable(varName, result);
117: }
118: break;
119: }
120: case Assignment.LOCAL: {
121: env.setLocalVariable(varName, result);
122: break;
123: }
124: case Assignment.GLOBAL: {
125: env.setGlobalVariable(varName, result);
126: break;
127: }
128: }
129: }
130: };
131: }
132: }
133:
134: public String getCanonicalForm() {
135: String key;
136: switch (scope) {
137: case Assignment.LOCAL: {
138: key = "local";
139: break;
140: }
141: case Assignment.GLOBAL: {
142: key = "global";
143: break;
144: }
145: default: {
146: key = "assign";
147: break;
148: }
149: }
150: return "<#"
151: + key
152: + " "
153: + varName
154: + (namespaceExp != null ? " in "
155: + namespaceExp.getCanonicalForm() : "") + ">"
156: + nestedBlock.getCanonicalForm() + "</#" + key + ">";
157: }
158:
159: public String getDescription() {
160: return "block assignment to variable: " + varName;
161: }
162:
163: boolean isIgnorable() {
164: return false;
165: }
166: }
|