KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > core > BodyInstruction


1 /*
2  * Copyright (c) 2003 The Visigoth Software Society. All rights
3  * reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowledgement:
19  * "This product includes software developed by the
20  * Visigoth Software Society (http://www.visigoths.org/)."
21  * Alternately, this acknowledgement may appear in the software itself,
22  * if and wherever such third-party acknowledgements normally appear.
23  *
24  * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
25  * project contributors may be used to endorse or promote products derived
26  * from this software without prior written permission. For written
27  * permission, please contact visigoths@visigoths.org.
28  *
29  * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
30  * nor may "FreeMarker" or "Visigoth" appear in their names
31  * without prior written permission of the Visigoth Software Society.
32  *
33  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36  * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
37  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
39  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
40  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
41  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
42  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
43  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44  * SUCH DAMAGE.
45  * ====================================================================
46  *
47  * This software consists of voluntary contributions made by many
48  * individuals on behalf of the Visigoth Software Society. For more
49  * information on the Visigoth Software Society, please see
50  * http://www.visigoths.org/
51  */

52
53 package freemarker.core;
54
55 import java.io.IOException JavaDoc;
56 import java.util.*;
57 import freemarker.template.*;
58
59 /**
60  * An instruction that processes the nested block within a macro instruction.
61  * @author <a HREF="mailto:jon@revusky.com">Jonathan Revusky</a>
62  */

63 final class BodyInstruction extends TemplateElement {
64     
65     
66     private List bodyParameters;
67     
68     
69     BodyInstruction(List bodyParameters) {
70         this.bodyParameters = bodyParameters;
71     }
72     
73     List getBodyParameters() {
74         return bodyParameters;
75     }
76
77     /**
78      * There is actually a subtle but essential point in the code below.
79      * A macro operates in the context in which it is defined. However,
80      * a nested block within a macro instruction is defined in the
81      * context in which the macro was invoked. So, we actually need to
82      * temporarily switch the namespace and macro context back to
83      * what it was before macro invocation to implement this properly.
84      * I (JR) realized this thanks to some incisive comments from Daniel Dekany.
85      */

86     void accept(Environment env) throws IOException JavaDoc, TemplateException {
87         Context bodyContext = new Context(env);
88         env.visit(bodyContext);
89     }
90
91     public String JavaDoc getCanonicalForm() {
92         StringBuffer JavaDoc buf = new StringBuffer JavaDoc("<#nested");
93         if (bodyParameters != null) {
94             for (int i = 0; i<bodyParameters.size(); i++) {
95                 buf.append(' ');
96                 buf.append(bodyParameters.get(i));
97             }
98         }
99         buf.append('>');
100         return buf.toString();
101     }
102
103     public String JavaDoc getDescription() {
104         return "nested macro content";
105     }
106
107 /*
108     boolean heedsOpeningWhitespace() {
109         return true;
110     }
111
112     boolean heedsTrailingWhitespace() {
113         return true;
114     }
115 */

116     class Context implements LocalContext {
117         Macro.Context invokingMacroContext;
118         Environment.Namespace bodyVars;
119         
120         Context(Environment env) throws TemplateException {
121             invokingMacroContext = env.getCurrentMacroContext();
122             List bodyParameterNames = invokingMacroContext.bodyParameterNames;
123             if (bodyParameters != null) {
124                 for (int i=0; i<bodyParameters.size(); i++) {
125                     Expression exp = (Expression) bodyParameters.get(i);
126                     TemplateModel tm = exp.getAsTemplateModel(env);
127                     if (bodyParameterNames != null && i < bodyParameterNames.size()) {
128                         String JavaDoc bodyParameterName = (String JavaDoc) bodyParameterNames.get(i);
129                         if (bodyVars == null) {
130                             bodyVars = env.new Namespace();
131                         }
132                         bodyVars.put(bodyParameterName, tm);
133                     }
134                 }
135             }
136         }
137         
138         public TemplateModel getLocalVariable(String JavaDoc name) throws TemplateModelException {
139             return bodyVars == null ? null : bodyVars.get(name);
140         }
141         
142         public Set getLocalVariableNames() {
143             List bodyParameterNames = invokingMacroContext.bodyParameterNames;
144             if (bodyParameterNames == null) return Collections.EMPTY_SET;
145             return new HashSet(bodyParameterNames);
146         }
147     }
148 }
149
Popular Tags