com.google.javascript.jscomp.PassConfig Maven / Gradle / Ivy
Show all versions of closure-compiler-unshaded Show documentation
/*
* 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.collect.Iterables;
import com.google.javascript.jscomp.graph.GraphvizGraph;
import com.google.javascript.jscomp.graph.LinkedDirectedGraph;
/** Pass factories and meta-data for native Compiler passes. */
public abstract class PassConfig {
// Used by the subclasses.
protected final CompilerOptions options;
public PassConfig(CompilerOptions options) {
this.options = options;
}
/**
* Gets additional checking passes that are run always, even in "whitespace only" mode. For very
* specific cases where processing is required even in a mode which is intended not to have any
* processing - specifically introduced to support goog.module() usage.
*/
protected PassListBuilder getWhitespaceOnlyPasses() {
return new PassListBuilder(options);
}
/** Gets the transpilation passes */
protected PassListBuilder getTranspileOnlyPasses() {
return new PassListBuilder(options);
}
/**
* Gets the checking passes to run.
*
* Checking passes revolve around emitting warnings and errors. They also may include
* pre-processor passes needed to do error analysis more effectively.
*
*
Clients that only want to analyze code (like IDEs) and not emit code will only run checks
* and not optimizations.
*/
protected abstract PassListBuilder getChecks();
/**
* Gets the optimization passes to run.
*
*
Optimization passes revolve around producing smaller and faster code. They should always run
* after checking passes.
*/
protected abstract PassListBuilder getOptimizations();
/**
* Gets the finalization passes to run.
*
*
Finalization passes include the injection of locale-specific code and converting the AST to
* its final form for output.
*/
protected abstract PassListBuilder getFinalizations();
/** Gets a graph of the passes run. For debugging. */
GraphvizGraph getPassGraph() {
LinkedDirectedGraph graph = LinkedDirectedGraph.createWithoutAnnotations();
Iterable allPasses =
Iterables.concat(getChecks().build(), getOptimizations().build());
String lastPass = null;
String loopStart = null;
for (PassFactory pass : allPasses) {
String passName = pass.getName();
int i = 1;
while (graph.hasNode(passName)) {
passName = pass.getName() + (i++);
}
graph.createNode(passName);
if (loopStart == null && pass.isRunInFixedPointLoop()) {
loopStart = passName;
} else if (loopStart != null && !pass.isRunInFixedPointLoop()) {
graph.connect(lastPass, "loop", loopStart);
loopStart = null;
}
if (lastPass != null) {
graph.connect(lastPass, "", passName);
}
lastPass = passName;
}
return graph;
}
/** Find the first pass provider that does not have a delegate. */
final PassConfig getBasePassConfig() {
PassConfig current = this;
while (current instanceof PassConfigDelegate) {
current = ((PassConfigDelegate) current).delegate;
}
return current;
}
/** An implementation of PassConfig that just proxies all its method calls into an inner class. */
public static class PassConfigDelegate extends PassConfig {
private final PassConfig delegate;
protected PassConfigDelegate(PassConfig delegate) {
super(delegate.options);
this.delegate = delegate;
}
@Override
protected PassListBuilder getWhitespaceOnlyPasses() {
return delegate.getWhitespaceOnlyPasses();
}
@Override
protected PassListBuilder getChecks() {
return delegate.getChecks();
}
@Override
protected PassListBuilder getOptimizations() {
return delegate.getOptimizations();
}
@Override
protected PassListBuilder getFinalizations() {
return delegate.getFinalizations();
}
@Override
protected PassListBuilder getTranspileOnlyPasses() {
return delegate.getTranspileOnlyPasses();
}
}
}