CallParamValueNode.java

/*
 * Copyright 2008 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.soytree;

import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.template.soy.base.SourceLocation;
import com.google.template.soy.basetree.CopyState;
import com.google.template.soy.error.ErrorReporter;
import com.google.template.soy.error.ErrorReporter.Checkpoint;
import com.google.template.soy.error.SoyErrorKind;
import com.google.template.soy.exprtree.ExprRootNode;
import com.google.template.soy.exprtree.IntegerNode;
import com.google.template.soy.soytree.SoyNode.ExprHolderNode;

/**
 * Node representing a 'param' with a value expression.
 *
 * <p>Important: Do not use outside of Soy code (treat as superpackage-private).
 *
 */
public final class CallParamValueNode extends CallParamNode implements ExprHolderNode {

  private static final SoyErrorKind SELF_ENDING_TAG_WITHOUT_VALUE =
      SoyErrorKind.of(
          "A ''param'' tag should be self-ending (with a trailing ''/'') if and only if "
              + "it also contains a value (invalid tag is '{'param {0} /'}').");
  private static final SoyErrorKind SELF_ENDING_TAG_WITH_KIND_ATTRIBUTE =
      SoyErrorKind.of(
          "The ''kind'' attribute is not allowed on self-ending ''param'' tags "
              + "(invalid tag is '{'param {0} /'}').");

  /** The param key. */
  private final String key;

  /** The parsed expression for the param value. */
  private final ExprRootNode valueExpr;

  private CallParamValueNode(
      int id,
      SourceLocation sourceLocation,
      String key,
      ExprRootNode valueExpr,
      String commandText) {
    super(id, sourceLocation, commandText);
    this.key = Preconditions.checkNotNull(key);
    this.valueExpr = Preconditions.checkNotNull(valueExpr);
  }

  /**
   * Copy constructor.
   *
   * @param orig The node to copy.
   */
  private CallParamValueNode(CallParamValueNode orig, CopyState copyState) {
    super(orig, copyState);
    this.key = orig.key;
    this.valueExpr = orig.valueExpr.copy(copyState);
  }

  @Override
  public Kind getKind() {
    return Kind.CALL_PARAM_VALUE_NODE;
  }

  @Override
  public String getKey() {
    return key;
  }

  /** Returns the expression text for the param value. */
  public String getExprText() {
    return valueExpr.toSourceString();
  }

  /** Returns the parsed expression for the param value. */
  public ExprRootNode getExpr() {
    return valueExpr;
  }

  @Override
  public String getTagString() {
    return buildTagStringHelper(true);
  }

  @Override
  public ImmutableList<ExprRootNode> getExprList() {
    return ImmutableList.of(valueExpr);
  }

  @Override
  public CallParamValueNode copy(CopyState copyState) {
    return new CallParamValueNode(this, copyState);
  }

  public static final class Builder extends CallParamNode.Builder {

    private static CallParamValueNode error() {
      return new CallParamValueNode(
          -1,
          SourceLocation.UNKNOWN,
          "error",
          new ExprRootNode(new IntegerNode(1, SourceLocation.UNKNOWN)),
          "error: error");
    }

    public Builder(int id, CommandTextParseResult parseResult, SourceLocation sourceLocation) {
      super(id, parseResult, sourceLocation);
    }

    public CallParamValueNode build(Checkpoint checkpoint, ErrorReporter errorReporter) {
      if (parseResult.valueExpr == null) {
        errorReporter.report(
            sourceLocation, SELF_ENDING_TAG_WITHOUT_VALUE, parseResult.originalCommantText);
      }

      if (parseResult.contentKind != null) {
        errorReporter.report(
            sourceLocation, SELF_ENDING_TAG_WITH_KIND_ATTRIBUTE, parseResult.originalCommantText);
      }

      if (errorReporter.errorsSince(checkpoint)) {
        return error();
      }

      return new CallParamValueNode(
          id,
          sourceLocation,
          parseResult.key,
          parseResult.valueExpr,
          parseResult.originalCommantText);
    }
  }
}