com.google.javascript.jscomp.Result Maven / Gradle / Ivy

/*
 * Copyright 2009 The Closure Compiler Authors.
 *
 * 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.javascript.jscomp;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import java.util.Map;
import java.util.Set;

/**
 * Compilation results
 */
public class Result {
  public final boolean success;
  public final ImmutableList errors;
  public final ImmutableList warnings;

  public final VariableMap variableMap;
  public final VariableMap propertyMap;
  public final VariableMap namedAnonFunctionMap;
  public final VariableMap stringMap;
  public final VariableMap instrumentationMappings;
  public final SourceMap sourceMap;
  public final Map cssNames;
  public final String externExport;
  public final String idGeneratorMap;
  public final Set transpiledFiles;

  Result(
      ImmutableList errors,
      ImmutableList warnings,
      VariableMap variableMap,
      VariableMap propertyMap,
      VariableMap namedAnonFunctionMap,
      VariableMap stringMap,
      VariableMap instrumentationMappings,
      SourceMap sourceMap,
      String externExport,
      Map cssNames,
      String idGeneratorMap,
      Set transpiledFiles) {
    this.success = errors.isEmpty();
    this.errors  = errors;
    this.warnings = warnings;
    this.variableMap = variableMap;
    this.propertyMap = propertyMap;
    this.namedAnonFunctionMap = namedAnonFunctionMap;
    this.stringMap = stringMap;
    this.instrumentationMappings = instrumentationMappings;
    this.sourceMap = sourceMap;
    this.externExport = externExport;
    this.cssNames = cssNames;
    this.idGeneratorMap = idGeneratorMap;
    this.transpiledFiles = transpiledFiles;
  }

  @VisibleForTesting
  @Deprecated
  public Result(
      ImmutableList errors,
      ImmutableList warnings,
      VariableMap variableMap,
      VariableMap propertyMap,
      VariableMap namedAnonFunctionMap,
      SourceMap sourceMap,
      String externExport) {
    this(
        errors,
        warnings,
        variableMap,
        propertyMap,
        namedAnonFunctionMap,
        /* stringMap= */ null,
        /* instrumentationMappings= */ null,
        sourceMap,
        externExport,
        /* cssNames= */ null,
        /* idGeneratorMap= */ null,
        /* transpiledFiles= */ null);
  }

  /**
   * Returns an almost empty result that is used for multistage compilation.
   *
   * For multistage compilations, Result for stage1 only cares about errors and warnings. It is
   * unnecessary to write all of other results in the disk.
   */
  public static Result createResultForStage1(Result result) {
    VariableMap emptyVariableMap = new VariableMap(ImmutableMap.of());
    return new Result(
        /* errors= */ result.errors,
        /* warnings= */ result.warnings,
        /* variableMap= */ emptyVariableMap,
        /* propertyMap= */ emptyVariableMap,
        /* namedAnonFunctionMap= */ emptyVariableMap,
        /* stringMap= */ null,
        /* instrumentationMappings= */ emptyVariableMap,
        /* sourceMap= */ null,
        /* externExport= */ "",
        /* cssNames= */ null,
        /* idGeneratorMap= */ null,
        /* transpiledFiles= */ null);
  }
}