KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > core > StringLiteral


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 import java.io.*;
57
58 final class StringLiteral extends Expression implements TemplateScalarModel {
59     
60     private final String JavaDoc value;
61     private TemplateElement interpolatedOutput;
62     
63     StringLiteral(String JavaDoc value) {
64         this.value = value;
65     }
66     
67     void checkInterpolation() throws ParseException {
68         if (value.indexOf("${") >= 0 || value.indexOf("#{") >= 0) {
69             SimpleCharStream scs = new SimpleCharStream(new StringReader(value), beginLine, beginColumn+1, value.length());
70             FMParserTokenManager token_source = new FMParserTokenManager(scs);
71             token_source.onlyTextOutput = true;
72             FMParser parser = new FMParser(token_source);
73             parser.template = getTemplate();
74             interpolatedOutput = parser.FreeMarkerText();
75             this.constantValue = null;
76         }
77     }
78     
79     TemplateModel _getAsTemplateModel(Environment env) throws TemplateException {
80         return new SimpleScalar(getStringValue(env));
81     }
82
83     public String JavaDoc getAsString() {
84         return value;
85     }
86     
87     String JavaDoc getStringValue(Environment env) throws TemplateException {
88         if (interpolatedOutput == null) {
89             return value;
90         }
91         else {
92             TemplateExceptionHandler teh = env.getTemplateExceptionHandler();
93             env.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);
94             try {
95                return env.renderElementToString(interpolatedOutput);
96             }
97             catch (IOException ioe) {
98                 throw new TemplateException(ioe, env);
99             }
100             finally {
101                 env.setTemplateExceptionHandler(teh);
102             }
103         }
104     }
105
106     public String JavaDoc getCanonicalForm() {
107 // return "\"" + StringUtil.FTLStringLiteralEnc(value) + "\"";
108
return "\"" + escapeString(value) + "\"";
109     }
110     
111     boolean isLiteral() {
112         return interpolatedOutput == null;
113     }
114
115     Expression _deepClone(String JavaDoc name, Expression subst) {
116         StringLiteral cloned = new StringLiteral(value);
117         cloned.interpolatedOutput = this.interpolatedOutput;
118         return cloned;
119     }
120
121     static private String JavaDoc escapeString(String JavaDoc s) {
122         if (s.indexOf('"') == -1) {
123             return s;
124         }
125         java.util.StringTokenizer JavaDoc st = new java.util.StringTokenizer JavaDoc(s, "\"", true);
126         StringBuffer JavaDoc buf = new StringBuffer JavaDoc();
127         while (st.hasMoreTokens()) {
128             String JavaDoc tok = st.nextToken();
129             if (tok.equals("\"")) {
130                 buf.append('\\');
131             }
132             buf.append(tok);
133         }
134         return buf.toString();
135     }
136 }
137
Popular Tags