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 /*
54 * 22 October 1999: This class added by Holger Arendt.
55 */
56
57 package freemarker.core;
58
59 import java.util.ArrayList;
60 import java.util.List;
61 import java.io.Writer;
62 import freemarker.template;
63 import java.io.IOException;
64
65
66 /**
67 * A unary operator that calls a TemplateMethodModel. It associates with the
68 * <tt>Identifier</tt> or <tt>Dot</tt> to its left.
69 */
70 final class MethodCall extends Expression {
71
72 private final Expression target;
73 private final ListLiteral arguments;
74
75 MethodCall(Expression target, ArrayList arguments) {
76 this(target, new ListLiteral(arguments));
77 }
78
79 private MethodCall(Expression target, ListLiteral arguments) {
80 this.target = target;
81 this.arguments = arguments;
82 }
83
84 TemplateModel _getAsTemplateModel(Environment env) throws TemplateException
85 {
86 TemplateModel targetModel = target.getAsTemplateModel(env);
87 if (targetModel instanceof TemplateMethodModel) {
88 TemplateMethodModel targetMethod = (TemplateMethodModel)targetModel;
89 List argumentStrings =
90 targetMethod instanceof TemplateMethodModelEx
91 ? arguments.getModelList(env)
92 : arguments.getValueList(env);
93 Object result = targetMethod.exec(argumentStrings);
94 return env.getObjectWrapper().wrap(result);
95 }
96 else if (targetModel instanceof Macro) {
97 Macro func = (Macro) targetModel;
98 env.setLastReturnValue(null);
99 if (!func.isFunction) {
100 throw new TemplateException("A macro cannot be called in an expression.", env);
101 }
102 Writer prevOut = env.getOut();
103 try {
104 env.setOut(Environment.NULL_WRITER);
105 env.visit(func, null, arguments.values, null, null);
106 } catch (IOException ioe) {
107 throw new InternalError("This should be impossible.");
108 } finally {
109 env.setOut(prevOut);
110 }
111 return env.getLastReturnValue();
112 }
113 else {
114 throw invalidTypeException(targetModel, target, env, "method");
115 }
116 }
117
118 public String getCanonicalForm() {
119 StringBuffer buf = new StringBuffer();
120 buf.append(target.getCanonicalForm());
121 buf.append("(");
122 String list = arguments.getCanonicalForm();
123 buf.append(list.substring(1, list.length() -1));
124 buf.append(")");
125 return buf.toString();
126 }
127
128 TemplateModel getConstantValue() {
129 return null;
130 }
131
132 boolean isLiteral() {
133 return false;
134 }
135
136 Expression _deepClone(String name, Expression subst) {
137 return new MethodCall(target.deepClone(name, subst), (ListLiteral)arguments.deepClone(name, subst));
138 }
139
140 }