Package org.robovm.compiler.plugin

Class AbstractCompilerPlugin

java.lang.Object

org.robovm.compiler.plugin.Plugin

org.robovm.compiler.plugin.CompilerPlugin

org.robovm.compiler.plugin.AbstractCompilerPlugin

Direct Known Subclasses:

AnnotationImplPlugin, BuildGarbageCollectorPlugin, ByteBufferJava9ApiPlugin, DebugInformationPlugin, InterfaceBuilderClassesPlugin, LambdaPlugin, ObjCBlockPlugin, ObjCMemberPlugin, ObjCProtocolProxyPlugin, ObjCProtocolToObjCObjectPlugin, StringConcatRewriterPlugin

public abstract class AbstractCompilerPlugin
extends CompilerPlugin

Abstract implementation for CompilerPlugin with empty implementations for all methods.

Constructor Summary

Constructors

Constructor	Description
AbstractCompilerPlugin()

Method Summary

Modifier and Type	Method	Description
void	afterClass(Config config, Clazz clazz, ModuleBuilder moduleBuilder)	Called after a class has been compiled to LLVM bitcode but before it is converted into machine code.
void	afterClassDependenciesResolved(Config config, Clazz clazz)	Called after dependencies resolved and added to the list.
void	afterLinker(Config config, File executable)	Called just before Linker is invoked.
void	afterMethod(Config config, Clazz clazz, soot.SootMethod method, ModuleBuilder moduleBuilder, Function function)	Called after a method has been compiled to LLVM bitcode but before it is converted into machine code.
void	afterObjectFile(Config config, Clazz clazz, File objectFile, ObjectFile objectFileData)	Called after the object file of a class has been compiled to an object file.
void	beforeClass(Config config, Clazz clazz, ModuleBuilder moduleBuilder)	Called just before a class is about to be compiled.
void	beforeConfig(Config.Builder builder, Config config)	Called before the Config for a compilation is built.
void	beforeLinker(Config config, Linker linker, Set<Clazz> classes)	Called just before Linker is invoked.
void	beforeMethod(Config config, Clazz clazz, soot.SootMethod method, ModuleBuilder moduleBuilder)	Called just before a method is about to be compiled.
PluginArguments	getArguments()	Returns the plugin's prefix arguments to be parsed from XML or the command line
void	helloClass(Config config, Clazz clazz)	Called just before a class is about to be compiled.

Methods inherited from class org.robovm.compiler.plugin.Plugin

argumentValue, argumentValue, argumentValue, parseArguments

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractCompilerPlugin

public AbstractCompilerPlugin()

Method Details

getArguments

public PluginArguments getArguments()

Description copied from class: Plugin

Returns the plugin's prefix arguments to be parsed from XML or the command line

Specified by:

getArguments in class Plugin

beforeConfig

public void beforeConfig(Config.Builder builder,
Config config)
                  throws IOException

Description copied from class: CompilerPlugin

Called before the Config for a compilation is built. Allows the plugin to modify the compiler configuration. NOTE: Some properties of the passed Config may not have been set at the time of the call to this method.

Specified by:

beforeConfig in class CompilerPlugin

Parameters:

builder - the Config.Builder

config - the not yet built Config. Can be used to get configuration set on the Config.Builder so far.

Throws:

IOException

helloClass

public void helloClass(Config config,
Clazz clazz)

Description copied from class: CompilerPlugin

Called just before a class is about to be compiled. Modifications to the underlying SootClass (Clazz.getSootClass()) are not allowed this stage. Used to allow plugins to evaluate class before modification

Overrides:

helloClass in class CompilerPlugin

Parameters:

config - the current Config.

clazz - the Clazz being compiled.

beforeClass

public void beforeClass(Config config,
Clazz clazz,
ModuleBuilder moduleBuilder)
                 throws IOException

Description copied from class: CompilerPlugin

Called just before a class is about to be compiled. Modifications to the underlying SootClass (Clazz.getSootClass()) should be done at this stage.

Specified by:

beforeClass in class CompilerPlugin

Parameters:

config - the current Config.

clazz - the Clazz being compiled.

moduleBuilder - the ModuleBuilder holding the generated bitcode.

Throws:

IOException

beforeMethod

public void beforeMethod(Config config,
Clazz clazz,
soot.SootMethod method,
ModuleBuilder moduleBuilder)
                  throws IOException

Description copied from class: CompilerPlugin

Called just before a method is about to be compiled. Modifications to the underlying SootMethod should be done at this stage.

Specified by:

beforeMethod in class CompilerPlugin

Parameters:

config - the current Config.

clazz - the Clazz being compiled.

method - the method being compiled.

moduleBuilder - the ModuleBuilder holding the generated bitcode.

Throws:

IOException

afterClass

public void afterClass(Config config,
Clazz clazz,
ModuleBuilder moduleBuilder)
                throws IOException

Description copied from class: CompilerPlugin

Called after a class has been compiled to LLVM bitcode but before it is converted into machine code.

Specified by:

afterClass in class CompilerPlugin

Parameters:

config - the current Config.

clazz - the Clazz being compiled.

moduleBuilder - the ModuleBuilder holding the generated bitcode.

Throws:

IOException

afterMethod

public void afterMethod(Config config,
Clazz clazz,
soot.SootMethod method,
ModuleBuilder moduleBuilder,
Function function)
                 throws IOException

Description copied from class: CompilerPlugin

Called after a method has been compiled to LLVM bitcode but before it is converted into machine code.

Specified by:

afterMethod in class CompilerPlugin

Parameters:

config - the current Config.

clazz - the Clazz being compiled.

method - the method being compiled.

moduleBuilder - the ModuleBuilder holding the generated bitcode.

function - the function corresponding to the method.

Throws:

IOException

afterClassDependenciesResolved

public void afterClassDependenciesResolved(Config config,
Clazz clazz)

Description copied from class: CompilerPlugin

Called after dependencies resolved and added to the list. It is the moment when all work with clazz is finished (machine code generation pending) and all associated resources might be released

Specified by:

afterClassDependenciesResolved in class CompilerPlugin

Parameters:

config - the current Config

clazz - the Clazz being compiled

afterObjectFile

public void afterObjectFile(Config config,
Clazz clazz,
File objectFile,
ObjectFile objectFileData)
                     throws IOException

Description copied from class: CompilerPlugin

Called after the object file of a class has been compiled to an object file.

Specified by:

afterObjectFile in class CompilerPlugin

Parameters:

config - the current Config

clazz - the Clazz being compiled

objectFile - the object file

objectFileData - LLVM read object file data

Throws:

IOException

beforeLinker

public void beforeLinker(Config config,
Linker linker,
Set<Clazz> classes)
                  throws IOException

Description copied from class: CompilerPlugin

Called just before Linker is invoked.

Specified by:

beforeLinker in class CompilerPlugin

Parameters:

config - the current Config

linker - the Linker instance.

classes - the classes that will be linked.

Throws:

IOException

afterLinker

public void afterLinker(Config config,
File executable)
                 throws IOException

Description copied from class: CompilerPlugin

Called just before Linker is invoked.

Specified by:

afterLinker in class CompilerPlugin

Parameters:

config - the current Config

executable - the binary

Throws:

IOException