com.google.javascript.rhino.jstype.ArrowType Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of closure-compiler Show documentation
Closure Compiler is a JavaScript optimizing compiler. It parses your JavaScript, analyzes it, removes dead code and rewrites and minimizes what's left. It also checks syntax, variable references, and types, and warns about common JavaScript pitfalls. It is used in many of Google's JavaScript apps, including Gmail, Google Web Search, Google Maps, and Google Docs.
There is a newer version: v20240317
Show newest version
/*
 *
 * ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Rhino code, released
 * May 6, 1999.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1997-1999
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Bob Jervis
 *   Google Inc.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * the GNU General Public License Version 2 or later (the "GPL"), in which
 * case the provisions of the GPL are applicable instead of those above. If
 * you wish to allow use of your version of this file only under the terms of
 * the GPL and not to allow others to use your version of this file under the
 * MPL, indicate your decision by deleting the provisions above and replacing
 * them with the notice and other provisions required by the GPL. If you do
 * not delete the provisions above, a recipient may use your version of this
 * file under either the MPL or the GPL.
 *
 * ***** END LICENSE BLOCK ***** */

package com.google.javascript.rhino.jstype;

import static com.google.javascript.rhino.jstype.JSTypeNative.UNKNOWN_TYPE;

import com.google.common.annotations.GwtIncompatible;
import com.google.common.collect.ImmutableList;
import com.google.javascript.rhino.ErrorReporter;
import com.google.javascript.rhino.jstype.FunctionType.Parameter;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.util.List;
import java.util.Objects;
import javax.annotation.Nullable;

/**
 * Models a "bare" function type: from some parameter types to a return type.
 *
 * JavaScript functions include more things like properties, type of THIS, etc, and are modeled
 * by {@link FunctionType}.
 */
final class ArrowType extends JSType {
  private static final long serialVersionUID = 1L;

  private static final JSTypeClass TYPE_CLASS = JSTypeClass.ARROW;

  // non-final for custom deserialization.
  private transient ImmutableList parameterList;
  private JSType returnType;

  // Whether the return type is inferred.
  final boolean returnTypeInferred;

  ArrowType(
      JSTypeRegistry registry,
      @Nullable List parameters,
      @Nullable JSType returnType,
      boolean returnTypeInferred) {
    super(registry);

    this.parameterList =
        parameters == null
            ? registry.createParametersWithVarArgs(getNativeType(UNKNOWN_TYPE))
            : ImmutableList.copyOf(parameters);
    this.returnType = returnType == null ? getNativeType(UNKNOWN_TYPE) : returnType;
    this.returnTypeInferred = returnTypeInferred;

    registry.getResolver().resolveIfClosed(this, TYPE_CLASS);
  }

  @Override
  JSTypeClass getTypeClass() {
    return TYPE_CLASS;
  }

  @Override
  int recursionUnsafeHashCode() {
    int hashCode = Objects.hashCode(returnType);
    for (Parameter param : parameterList) {
      hashCode = hashCode * 31 + Objects.hashCode(param.getJSType());
    }
    return hashCode;
  }

  public JSType getReturnType() {
    return this.returnType;
  }

  ImmutableList getParameterList() {
    return parameterList;
  }

  @Override
  public JSType getLeastSupertype(JSType that) {
    throw new UnsupportedOperationException();
  }

  @Override
  public JSType getGreatestSubtype(JSType that) {
    throw new UnsupportedOperationException();
  }

  @Override
  public TernaryValue testForEquality(JSType that) {
    throw new UnsupportedOperationException();
  }

  @Override
  public  T visit(Visitor visitor) {
    throw new UnsupportedOperationException();
  }

  @Override  T visit(RelationshipVisitor visitor, JSType that) {
    throw new UnsupportedOperationException();
  }

  @Override
  public BooleanLiteralSet getPossibleToBooleanOutcomes() {
    return BooleanLiteralSet.TRUE;
  }

  @Override
  JSType resolveInternal(ErrorReporter reporter) {
    returnType = safeResolve(returnType, reporter);
    for (Parameter param : parameterList) {
      param.getJSType().resolve(reporter);
    }

    return this;
  }

  boolean hasUnknownParamsOrReturn() {
    for (Parameter param : parameterList) {
      JSType type = param.getJSType();
      if (type.isUnknownType()) {
        return true;
      }
    }

    return returnType == null || returnType.isUnknownType();
  }

  @Override
  void appendTo(TypeStringBuilder sb) {
    sb.append("[ArrowType]");
  }

  @Override
  public boolean hasAnyTemplateTypesInternal() {
    return returnType.hasAnyTemplateTypes() || hasTemplatedParameterType();
  }

  private boolean hasTemplatedParameterType() {
    for (Parameter param : parameterList) {
      JSType type = param.getJSType();
      if (type.hasAnyTemplateTypes()) {
        return true;
      }
    }
    return false;
  }

  @GwtIncompatible("ObjectOutputStream")
  private void writeObject(ObjectOutputStream stream) throws IOException {
    stream.defaultWriteObject();
    // we ran into ClassCastExceptions trying to serialize ImmutableList, probably related to
    // https://github.com/google/guava/issues/1554..
    Parameter[] parameters = this.parameterList.toArray(new Parameter[0]);
    stream.writeObject(parameters);
  }

  @GwtIncompatible("ObjectInputStream")
  private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException {
    stream.defaultReadObject();
    Parameter[] parameters = (Parameter[]) stream.readObject();
    this.parameterList = ImmutableList.copyOf(parameters);
  }
}