Save This Page
Home » freemarker-2.3.13 » freemarker.core » [javadoc | source]
    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 value;
   61       private TemplateElement interpolatedOutput;
   62       
   63       StringLiteral(String value) {
   64           this.value = value;
   65       }
   66       
   67       void checkInterpolation() throws ParseException {
   68           if (value.length() > 3 && (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               try {
   75                   interpolatedOutput = parser.FreeMarkerText();
   76               }
   77               catch(ParseException e) {
   78                   e.setTemplateName(getTemplate().getName());
   79                   throw e;
   80               }
   81               this.constantValue = null;
   82           }
   83       }
   84       
   85       TemplateModel _getAsTemplateModel(Environment env) throws TemplateException {
   86           return new SimpleScalar(getStringValue(env));
   87       }
   88   
   89       public String getAsString() {
   90           return value;
   91       }
   92       
   93       String getStringValue(Environment env) throws TemplateException {
   94           if (interpolatedOutput == null) {
   95               return value;
   96           } 
   97           else {
   98               TemplateExceptionHandler teh = env.getTemplateExceptionHandler();
   99               env.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);
  100               try {
  101                  return env.renderElementToString(interpolatedOutput);
  102               }
  103               catch (IOException ioe) {
  104                   throw new TemplateException(ioe, env);
  105               }
  106               finally {
  107                   env.setTemplateExceptionHandler(teh);
  108               }
  109           }
  110       }
  111   
  112       public String getCanonicalForm() {
  113   //        return "\"" + StringUtil.FTLStringLiteralEnc(value) + "\""; 
  114           return "\"" + escapeString(value) + "\"";
  115       }
  116       
  117       boolean isLiteral() {
  118           return interpolatedOutput == null;
  119       }
  120   
  121       Expression _deepClone(String name, Expression subst) {
  122           StringLiteral cloned = new StringLiteral(value);
  123           cloned.interpolatedOutput = this.interpolatedOutput;
  124           return cloned;
  125       }
  126   
  127       static private String escapeString(String s) {
  128           if (s.indexOf('"') == -1) {
  129               return s;
  130           }
  131           java.util.StringTokenizer st = new java.util.StringTokenizer(s, "\"", true);
  132           StringBuffer buf = new StringBuffer();
  133           while (st.hasMoreTokens()) {
  134               String tok = st.nextToken();
  135               if (tok.equals("\"")) {
  136                   buf.append('\\');
  137               }
  138               buf.append(tok);
  139           }
  140           return buf.toString();
  141       }
  142   }

Save This Page
Home » freemarker-2.3.13 » freemarker.core » [javadoc | source]