org.jruby.ir.passes

Class CompilerPass

java.lang.Object

org.jruby.ir.passes.CompilerPass

Direct Known Subclasses:

AddCallProtocolInstructions, AddLocalVarLoadStoreInstructions, AddMissingInitsPass, DeadCodeElimination, DominatorTreeBuilder, EnsureTempsAssigned, LiveVariableAnalysis, LocalOptimizationPass, OptimizeDelegationPass, OptimizeDynScopesPass, UnboxingPass

public abstract class CompilerPass
extends java.lang.Object

A mechanism for executing code against an IRScope or transforming the IRScopes dependent data. A Compiler pass may or may not affect the state of an IRScope (possibly including any child IRScopes) and it may or may not depend on other compiler passes to execute first. For dependencies between compiler passes, getDependencies will return a list of all dependent passes. Those passes in turn will end up having their own dependencies. The order of execution is depth-first, but if the pass recognizes that the data it depends on already exists, then it does not run the pass. It will just return the existing data. If you want to guarantee (re)execution, then you should call invalidate().

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.List<java.lang.Class<? extends CompilerPass>>	NO_DEPENDENCIES

Constructor Summary

Constructors

Constructor and Description
CompilerPass()

Method Summary

Modifier and Type	Method and Description
static CompilerPass	createPassInstance(java.lang.Class<? extends CompilerPass> passClass)
static CompilerPass	createPassInstance(java.lang.String passClassName)
boolean	equals(java.lang.Object other)
abstract java.lang.Object	execute(IRScope scope, java.lang.Object... dependencyData) Meat of an individual pass.
java.util.List<java.lang.Class<? extends CompilerPass>>	getDependencies()
abstract java.lang.String	getLabel() What is the user-friendly name of this compiler pass
static java.util.List<CompilerPass>	getPassesFromString(java.lang.String passList, java.lang.String defaultPassList)
java.lang.String	getShortLabel() Shorter label
int	hashCode()
boolean	invalidate(IRScope scope) The data that this pass is responsible for will get invalidated so that if this pass is then executed it will generate new pass data.
java.lang.Object	previouslyRun(IRScope scope) If this pass has been previous run, then return the data from that last run.
java.lang.Object	run(IRScope scope)
java.lang.Object	run(IRScope scope, boolean force)
protected java.lang.Object	run(IRScope scope, boolean force, boolean childScope)

Methods inherited from class java.lang.Object

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

Field Detail

NO_DEPENDENCIES

protected static final java.util.List<java.lang.Class<? extends CompilerPass>> NO_DEPENDENCIES

Constructor Detail

CompilerPass

public CompilerPass()

Method Detail

getLabel

public abstract java.lang.String getLabel()

What is the user-friendly name of this compiler pass

getShortLabel

public java.lang.String getShortLabel()

Shorter label

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

execute

public abstract java.lang.Object execute(IRScope scope,
                                         java.lang.Object... dependencyData)

Meat of an individual pass. run will call this after dependency resolution.

Parameters:

scope - is the scope to run this pass on

dependencyData - is the data supplied to this pass to use to execute the pass

getDependencies

public java.util.List<java.lang.Class<? extends CompilerPass>> getDependencies()

previouslyRun

public java.lang.Object previouslyRun(IRScope scope)

If this pass has been previous run, then return the data from that last run. Specific scopes can override this behavior.

invalidate

public boolean invalidate(IRScope scope)

The data that this pass is responsible for will get invalidated so that if this pass is then executed it will generate new pass data. Note that some data will destructively manipulate dependent compiler pass data. In that case, the pass may wipe more than just it's data. In that case, an execute() should still rebuild everything fine because all compiler passes list their dependencies.

Parameters:

scope - is where the pass stores its data.

run

protected java.lang.Object run(IRScope scope,
                               boolean force,
                               boolean childScope)

run

public java.lang.Object run(IRScope scope,
                            boolean force)

run

public java.lang.Object run(IRScope scope)

createPassInstance

public static CompilerPass createPassInstance(java.lang.Class<? extends CompilerPass> passClass)

createPassInstance

public static CompilerPass createPassInstance(java.lang.String passClassName)

getPassesFromString

public static java.util.List<CompilerPass> getPassesFromString(java.lang.String passList,
                                                               java.lang.String defaultPassList)