com.google.javascript.jscomp

Class JSModuleGraph

java.lang.Object

com.google.javascript.jscomp.JSModuleGraph

All Implemented Interfaces:

java.io.Serializable

public final class JSModuleGraph
extends java.lang.Object
implements java.io.Serializable

A JSModule dependency graph that assigns a depth to each module and can answer depth-related queries about them. For the purposes of this class, a module's depth is defined as the number of hops in the longest (non cyclic) path from the module to a module with no dependencies.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JSModuleGraph.MissingModuleException Another exception class
protected static class	JSModuleGraph.ModuleDependenceException Exception class for declaring when the modules being fed into a JSModuleGraph as input aren't in dependence order, and so can't be processed for caching of various dependency-related queries.

Constructor Summary

Constructors

Constructor and Description
JSModuleGraph(JSModule[] modulesInDepOrder) Creates a module graph from a list of modules in dependency order.
JSModuleGraph(java.util.List<JSModule> modulesInDepOrder) Creates a module graph from a list of modules in dependency order.

Method Summary

Modifier and Type	Method and Description
void	breakThisGraphSoItsModulesCanBeReused() Deprecated. Fix the tests that use this.
boolean	dependsOn(JSModule src, JSModule m) Determines whether this module depends on a given module.
JSModule	getDeepestCommonDependencyInclusive(java.util.Collection<JSModule> modules) Returns the deepest common dependency of the given modules.
JSModule	getDeepestCommonDependencyInclusive(JSModule m1, JSModule m2) Finds the deepest common dependency of two modules, including the modules themselves.
JSModule	getSmallestCoveringSubtree(JSModule parentTree, java.util.BitSet dependentModules) Finds the module with the fewest transitive dependents on which all of the given modules depend and that is a subtree of the given parent module tree.
java.util.List<CompilerInput>	manageDependencies(DependencyOptions depOptions, java.util.List<CompilerInput> inputs) Apply the dependency options to the list of sources, returning a new source list re-ordering and dropping files as necessary.
java.util.List<CompilerInput>	manageDependencies(java.util.List<ModuleIdentifier> entryPoints, java.util.List<CompilerInput> inputs) Applies a DependencyOptions in "dependency sorting" and "dependency pruning" mode to the given list of inputs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JSModuleGraph

public JSModuleGraph(JSModule[] modulesInDepOrder)

Creates a module graph from a list of modules in dependency order.

JSModuleGraph

public JSModuleGraph(java.util.List<JSModule> modulesInDepOrder)

Creates a module graph from a list of modules in dependency order.

Method Detail

breakThisGraphSoItsModulesCanBeReused

@Deprecated
public void breakThisGraphSoItsModulesCanBeReused()

Deprecated. Fix the tests that use this.

This only exists as a temprorary workaround.

dependsOn

public boolean dependsOn(JSModule src,
                         JSModule m)

Determines whether this module depends on a given module. Note that a module never depends on itself, as that dependency would be cyclic.

getSmallestCoveringSubtree

public JSModule getSmallestCoveringSubtree(JSModule parentTree,
                                           java.util.BitSet dependentModules)

Finds the module with the fewest transitive dependents on which all of the given modules depend and that is a subtree of the given parent module tree.

If no such subtree can be found, the parent module is returned.

If multiple candidates have the same number of dependents, the module farthest down in the total ordering of modules will be chosen.

Parameters:

parentTree - module on which the result must depend

dependentModules - indices of modules to consider

Returns:

A module on which all of the argument modules depend

getDeepestCommonDependencyInclusive

public JSModule getDeepestCommonDependencyInclusive(JSModule m1,
                                                    JSModule m2)

Finds the deepest common dependency of two modules, including the modules themselves.

Parameters:

m1 - A module in this graph

m2 - A module in this graph

Returns:

The deepest common dep of m1 and m2, or null if they have no common dependencies

getDeepestCommonDependencyInclusive

public JSModule getDeepestCommonDependencyInclusive(java.util.Collection<JSModule> modules)

Returns the deepest common dependency of the given modules.

manageDependencies

public java.util.List<CompilerInput> manageDependencies(java.util.List<ModuleIdentifier> entryPoints,
                                                        java.util.List<CompilerInput> inputs)
                                                 throws JSModuleGraph.MissingModuleException,
                                                        SortedDependencies.MissingProvideException

Applies a DependencyOptions in "dependency sorting" and "dependency pruning" mode to the given list of inputs. Returns a new list with the files sorted and removed. This module graph will be updated to reflect the new list. If you need more fine-grained dependency management, you should create your own DependencyOptions and call manageDependencies(DependencyOptions, List<CompilerInput>).

Parameters:

entryPoints - The entry points into the program. Expressed as JS symbols.

inputs - The original list of sources. Used to ensure that the sort is stable.

Throws:

SortedDependencies.MissingProvideException - if an entry point was not provided by any of the inputs.

JSModuleGraph.MissingModuleException

See Also:

for more info on how this works.

manageDependencies

public java.util.List<CompilerInput> manageDependencies(DependencyOptions depOptions,
                                                        java.util.List<CompilerInput> inputs)
                                                 throws SortedDependencies.MissingProvideException,
                                                        JSModuleGraph.MissingModuleException

Apply the dependency options to the list of sources, returning a new source list re-ordering and dropping files as necessary. This module graph will be updated to reflect the new list.

Parameters:

inputs - The original list of sources. Used to ensure that the sort is stable.

Throws:

SortedDependencies.MissingProvideException - if an entry point was not provided by any of the inputs.

JSModuleGraph.MissingModuleException

See Also:

for more info on how this works.