/*
* Copyright 2012 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.template.soy.basicdirectives;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.template.soy.data.SoyData;
import com.google.template.soy.javasrc.restricted.JavaExpr;
import com.google.template.soy.javasrc.restricted.SoyJavaSrcPrintDirective;
import com.google.template.soy.jssrc.restricted.JsExpr;
import com.google.template.soy.jssrc.restricted.JsExprUtils;
import com.google.template.soy.jssrc.restricted.SoyJsSrcPrintDirective;
import com.google.template.soy.tofu.restricted.SoyAbstractTofuPrintDirective;
import java.util.List;
import java.util.Set;
import javax.inject.Inject;
import javax.inject.Singleton;
/**
* Internal-only directive indicating content is to be treated as plain text.
*
* Should never be used by users in its current state. This directive itself
* performs no escaping, though in the future, it may force autoescaping to
* re-escape the value.
*
* @author Garrett Boyer
*/
@Singleton
public class TextDirective extends SoyAbstractTofuPrintDirective
implements SoyJsSrcPrintDirective, SoyJavaSrcPrintDirective {
@Inject
public TextDirective() {}
@Override public String getName() {
return "|text";
}
@Override public Set<Integer> getValidArgsSizes() {
return ImmutableSet.of(0);
}
@Override public boolean shouldCancelAutoescape() {
// TODO: This simply indicates simply that the "blanket html-escape everything and its cousin"
// should not run, but eventually, it'd be nice for this to end up forcing the result to be
// re-escaped. For now, CheckEscapingSanityVisitor bans non-internal use of this.
return true;
}
@Override public SoyData apply(SoyData value, List<SoyData> args) {
// TODO: If this directive is opened up to users, this needs to coerce the value to a string.
return value;
}
@Override public JsExpr applyForJsSrc(JsExpr value, List<JsExpr> args) {
// Coerce to string, since sometimes this will be the root of an expression and will be used as
// a return value or let-block assignment.
return JsExprUtils.concatJsExprs(ImmutableList.of(new JsExpr("''", Integer.MAX_VALUE), value));
}
@Override public JavaExpr applyForJavaSrc(JavaExpr value, List<JavaExpr> args) {
// TODO: If this directive is opened up to users, this needs to coerce the value to a string.
return value;
}
}