KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > core > ArithmeticExpression


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 freemarker.template.*;
56
57 /**
58  * An operator for arithmetic operations. Note that the + operator
59  * also does string concatenation for backward compatibility.
60  * @author <a HREF="mailto:jon@revusky.com">Jonathan Revusky</a>
61  */

62 final class ArithmeticExpression extends Expression {
63
64     static final int SUBSTRACTION = 0;
65     static final int MULTIPLICATION = 1;
66     static final int DIVISION = 2;
67     static final int MODULUS = 3;
68
69     private static final char[] OPERATORS = new char[] {'-','*','/','%'};
70
71     private final Expression left;
72     private final Expression right;
73     private final int operation;
74
75     ArithmeticExpression(Expression left, Expression right, int operation) {
76         this.left = left;
77         this.right = right;
78         this.operation = operation;
79     }
80
81     TemplateModel _getAsTemplateModel(Environment env) throws TemplateException
82     {
83         TemplateModel leftModel = left.getAsTemplateModel(env);
84         TemplateModel rightModel = right.getAsTemplateModel(env);
85         boolean leftIsNumber = (leftModel instanceof TemplateNumberModel);
86         boolean rightIsNumber = (rightModel instanceof TemplateNumberModel);
87         boolean bothNumbers = leftIsNumber && rightIsNumber;
88         if (!bothNumbers) {
89             String JavaDoc msg = "Error " + getStartLocation();
90             if (!leftIsNumber) {
91                 msg += "\nExpression " + left + " is not numerical";
92             }
93             if (!rightIsNumber) {
94                 msg += "\nExpression " + right + " is not numerical";
95             }
96             throw new NonNumericalException(msg, env);
97         }
98         Number JavaDoc first = EvaluationUtil.getNumber(leftModel, left, env);
99         Number JavaDoc second = EvaluationUtil.getNumber(rightModel, right, env);
100         ArithmeticEngine ae =
101             env != null
102                 ? env.getArithmeticEngine()
103                 : getTemplate().getArithmeticEngine();
104         switch (operation) {
105             case SUBSTRACTION :
106                 return new SimpleNumber(ae.subtract(first, second));
107             case MULTIPLICATION :
108                 return new SimpleNumber(ae.multiply(first, second));
109             case DIVISION :
110                 return new SimpleNumber(ae.divide(first, second));
111             case MODULUS :
112                 return new SimpleNumber(ae.modulus(first, second));
113             default:
114                 throw new TemplateException("unknown operation : " + operation, env);
115         }
116     }
117
118     public String JavaDoc getCanonicalForm() {
119         return left.getCanonicalForm() + ' ' + OPERATORS[operation] + ' ' + right.getCanonicalForm();
120     }
121     
122     boolean isLiteral() {
123         return constantValue != null || (left.isLiteral() && right.isLiteral());
124     }
125
126     Expression _deepClone(String JavaDoc name, Expression subst) {
127         return new ArithmeticExpression(left.deepClone(name, subst), right.deepClone(name, subst), operation);
128     }
129 }
130
Popular Tags