freemarker.core.BuiltinVariable Maven / Gradle / Ivy
Go to download
FreeMarker is a "template engine"; a generic tool to generate text output based on templates.
/*
* Copyright (c) 2003 The Visigoth Software Society. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowledgement:
* "This product includes software developed by the
* Visigoth Software Society (http://www.visigoths.org/)."
* Alternately, this acknowledgement may appear in the software itself,
* if and wherever such third-party acknowledgements normally appear.
*
* 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
* project contributors may be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [email protected].
*
* 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
* nor may "FreeMarker" or "Visigoth" appear in their names
* without prior written permission of the Visigoth Software Society.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Visigoth Software Society. For more
* information on the Visigoth Software Society, please see
* http://www.visigoths.org/
*/
package freemarker.core;
import freemarker.template.*;
/**
* A reference to a built-in identifier, such as .root
*/
final class BuiltinVariable extends Expression {
static final String NAMESPACE = "namespace";
static final String MAIN = "main";
static final String GLOBALS = "globals";
static final String LOCALS = "locals";
static final String DATA_MODEL = "data_model";
static final String LANG = "lang";
static final String LOCALE = "locale";
static final String CURRENT_NODE = "current_node";
static final String NODE = "node";
static final String PASS = "pass";
static final String VARS = "vars";
static final String VERSION = "version";
static final String ERROR = "error";
static final String OUTPUT_ENCODING = "output_encoding";
static final String URL_ESCAPING_CHARSET = "url_escaping_charset";
private final String name;
BuiltinVariable(String name) throws ParseException {
name = name.intern();
this.name = name;
if (name != NAMESPACE
&& name != MAIN
&& name != GLOBALS
&& name != LOCALS
&& name != LANG
&& name != LOCALE
&& name != DATA_MODEL
&& name != CURRENT_NODE
&& name != NODE
&& name != PASS
&& name != VARS
&& name != VERSION
&& name != OUTPUT_ENCODING
&& name != URL_ESCAPING_CHARSET
&& name != ERROR)
{
throw new ParseException("Unknown built-in variable: " + name, this);
}
}
TemplateModel _getAsTemplateModel(Environment env) throws TemplateException {
if (name == NAMESPACE) {
return env.getCurrentNamespace();
}
if (name == MAIN) {
return env.getMainNamespace();
}
if (name == GLOBALS) {
return env.getGlobalVariables();
}
if (name == LOCALS) {
return env.getCurrentMacroContext().getLocals();
}
if (name == DATA_MODEL) {
return env.getDataModel();
}
if (name == VARS) {
return new VarsHash(env);
}
if (name == LOCALE) {
return new SimpleScalar(env.getLocale().toString());
}
if (name == LANG) {
return new SimpleScalar(env.getLocale().getLanguage());
}
if (name == CURRENT_NODE || name == NODE) {
return env.getCurrentVisitorNode();
}
if (name == PASS) {
return Macro.DO_NOTHING_MACRO;
}
if (name == VERSION) {
return new SimpleScalar(Configuration.getVersionNumber());
}
if (name == OUTPUT_ENCODING) {
String s = env.getOutputEncoding();
return s != null ? new SimpleScalar(s) : null;
}
if (name == URL_ESCAPING_CHARSET) {
String s = env.getURLEscapingCharset();
return s != null ? new SimpleScalar(s) : null;
}
if (name == ERROR) {
return new SimpleScalar(env.getCurrentRecoveredErrorMesssage());
}
throw new TemplateException("Invalid built-in variable: " + this, env);
}
public String toString() {
return "." + name;
}
public String getCanonicalForm() {
return "." + name;
}
boolean isLiteral() {
return false;
}
Expression _deepClone(String name, Expression subst) {
return this;
}
static class VarsHash implements TemplateHashModel {
Environment env;
VarsHash(Environment env) {
this.env = env;
}
public TemplateModel get(String key) throws TemplateModelException {
return env.getVariable(key);
}
public boolean isEmpty() {
return false;
}
}
}