JRuby Base 10.0.0.0 · org.jruby.ir.passes.CompilerPass

Modifier and Type	Field and Description
pack-priv static final Logger	LOG
private static final List<Class<? extends CompilerPass>>	NO_DEPENDENCIES

Access	Constructor and Description
public	CompilerPass()

Method Summary

Modifier and Type	Method and Description
public static CompilerPass	createPassInstance(Class<? extends CompilerPass> passClass)
public static CompilerPass	createPassInstance(String passClassName)
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public abstract Object	execute(FullInterpreterContext is the FullInterpreterContext to run this pass on fic, Object... is the data supplied to this pass to use to execute the pass dependencyData) Meat of an individual pass.
public List<Class<? extends CompilerPass>>	getDependencies()
public abstract String	getLabel() What is the user-friendly name of this compiler pass
public static List<CompilerPass>	getPassesFromString(String passList, String defaultPassList)
public String	getShortLabel() Shorter label
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	Returns: true if invalidation succeeded, false otherwise. invalidate(FullInterpreterContext is where the pass stores its data. fic) 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.
private Object	makeSureDependencyHasRunOnce(Class<? extends CompilerPass> passClass, FullInterpreterContext fic, boolean childScope)
public Object	Returns: data or null if it needs to be run previouslyRun(FullInterpreterContext fic) If this pass has been previous run, then return the data from that last run.
protected Object	run(FullInterpreterContext fic, boolean force, boolean childScope)
public Object	run(FullInterpreterContext fic, boolean force)
public Object	run(FullInterpreterContext fic)

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

LOG	back to summary
pack-priv static final Logger LOG

NO_DEPENDENCIES	back to summary
private static final List<Class<? extends CompilerPass>> NO_DEPENDENCIES

CompilerPass	back to summary
public CompilerPass()

Method Detail

createPassInstance	back to summary
public static CompilerPass createPassInstance(Class<? extends CompilerPass> passClass)

createPassInstance	back to summary
public static CompilerPass createPassInstance(String passClassName)

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

execute	back to summary
public abstract Object execute(FullInterpreterContext fic, Object... dependencyData) Meat of an individual pass. run will call this after dependency resolution. Parameters fic:FullInterpreterContext is the FullInterpreterContext to run this pass on dependencyData:Object[] is the data supplied to this pass to use to execute the pass

execute

back to summary

public abstract Object execute(FullInterpreterContext fic, Object... dependencyData)

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

Parameters

fic:FullInterpreterContext: is the FullInterpreterContext to run this pass on
dependencyData:Object[]: is the data supplied to this pass to use to execute the pass

getDependencies	back to summary
public List<Class<? extends CompilerPass>> getDependencies()

getLabel	back to summary
public abstract String getLabel() What is the user-friendly name of this compiler pass

getPassesFromString	back to summary
public static List<CompilerPass> getPassesFromString(String passList, String defaultPassList)

getShortLabel	back to summary
public String getShortLabel() Shorter label

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

invalidate	back to summary
public boolean invalidate(FullInterpreterContext fic) 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 fic:FullInterpreterContext is where the pass stores its data. Returns:boolean true if invalidation succeeded, false otherwise.

invalidate

back to summary

public boolean invalidate(FullInterpreterContext fic)

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

fic:FullInterpreterContext: is where the pass stores its data.

Returns:boolean

true if invalidation succeeded, false otherwise.

makeSureDependencyHasRunOnce	back to summary
private Object makeSureDependencyHasRunOnce(Class<? extends CompilerPass> passClass, FullInterpreterContext fic, boolean childScope)

previouslyRun	back to summary
public Object previouslyRun(FullInterpreterContext fic) If this pass has been previous run, then return the data from that last run. Specific scopes can override this behavior. Returns:Object data or null if it needs to be run

previouslyRun

back to summary

public Object previouslyRun(FullInterpreterContext fic)

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

Returns:Object: data or null if it needs to be run

run	back to summary
protected Object run(FullInterpreterContext fic, boolean force, boolean childScope)

run	back to summary
public Object run(FullInterpreterContext fic, boolean force)

run	back to summary
public Object run(FullInterpreterContext fic)

public abstract Class CompilerPass

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail