UnsupportedFeatureReporter.java

/*
 * Copyright 2015 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.jbcsrc;

import com.google.template.soy.error.ErrorReporter;
import com.google.template.soy.error.SoyErrorKind;
import com.google.template.soy.exprtree.AbstractExprNodeVisitor;
import com.google.template.soy.exprtree.ExprNode;
import com.google.template.soy.exprtree.ExprNode.ParentExprNode;
import com.google.template.soy.exprtree.ExprRootNode;
import com.google.template.soy.exprtree.VarDefn;
import com.google.template.soy.exprtree.VarRefNode;
import com.google.template.soy.soytree.AbstractSoyNodeVisitor;
import com.google.template.soy.soytree.AutoescapeMode;
import com.google.template.soy.soytree.NamespaceDeclaration;
import com.google.template.soy.soytree.SoyFileNode;
import com.google.template.soy.soytree.SoyNode;
import com.google.template.soy.soytree.SoyNode.ExprHolderNode;
import com.google.template.soy.soytree.SoyNode.ParentSoyNode;

/** A visitor that scans for features not supported by jbcsrc and reports errors for them. */
final class UnsupportedFeatureReporter {
  private final SoyNodeVisitor errorChecker;
  private final ErrorReporter errorReporter;

  UnsupportedFeatureReporter(ErrorReporter errorReporter) {
    this.errorReporter = errorReporter;
    this.errorChecker = new SoyNodeVisitor();
  }

  void check(SoyNode node) {
    errorChecker.exec(node);
  }

  private class SoyNodeVisitor extends AbstractSoyNodeVisitor<Void> {
    final ExprNodeVisitor exprVisitor;

    SoyNodeVisitor() {
      this.exprVisitor = new ExprNodeVisitor();
    }

    @Override
    protected void visitSoyFileNode(SoyFileNode node) {
      super.visitSoyFileNode(node);
      NamespaceDeclaration namespaceDeclaration = node.getNamespaceDeclaration();
      if (namespaceDeclaration.getDefaultAutoescapeMode() != AutoescapeMode.STRICT) {
        errorReporter.report(
            namespaceDeclaration.getAutoescapeModeLocation(),
            SoyErrorKind.of("jbcsrc only supports strict autoescape templates, found : ''{0}''"),
            namespaceDeclaration.getDefaultAutoescapeMode());
      }
    }

    @Override
    protected void visitSoyNode(SoyNode node) {
      if (node instanceof ParentSoyNode<?>) {
        visitChildren((ParentSoyNode<?>) node);
      }
      if (node instanceof ExprHolderNode) {
        for (ExprRootNode expr : ((ExprHolderNode) node).getExprList()) {
          exprVisitor.exec(expr);
        }
      }
    }
  }

  private class ExprNodeVisitor extends AbstractExprNodeVisitor<Void> {

    @Override
    protected final void visitVarRefNode(VarRefNode node) {
      VarDefn defn = node.getDefnDecl();
      switch (defn.kind()) {
        case IJ_PARAM:
        case LOCAL_VAR:
        case PARAM:
          break;
        case UNDECLARED:
          errorReporter.report(
              node.getSourceLocation(),
              SoyErrorKind.of("jbcsrc does not support undeclared template params"));
          break;
        default:
          throw new AssertionError();
      }
    }

    @Override
    protected void visitExprNode(ExprNode node) {
      if (node instanceof ParentExprNode) {
        visitChildren((ParentExprNode) node);
      }
    }
  }
}