Package org.aspectj.tools.ajc

Class Main

java.lang.Object

org.aspectj.tools.ajc.Main

Direct Known Subclasses:

CompilerWrapper

public class Main
extends Object

Programmatic and command-line interface to AspectJ compiler. The compiler is an ICommand obtained by reflection. Not thread-safe. By default, messages are printed as they are emitted; info messages go to the output stream, and warnings and errors go to the error stream.

Clients can handle all messages by registering a holder:

 Main main = new Main();
 IMessageHolder holder = new MessageHandler();
 main.setHolder(holder);
 

Clients can get control after each command completes by installing a Runnable:

 main.setCompletionRunner(new Runnable() {..});
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Main.CommandController	controller for repeatable command delays until input or file changed or removed
static class	Main.LogModeMessagePrinter
static class	Main.MessagePrinter	interceptor IMessageHandler to print as we go.

Field Summary

Fields

Modifier and Type	Field	Description
protected ICommand	command
protected String	commandName	ReflectionFactory identifier for command (compiler)
protected Main.CommandController	controller	control iteration/continuation for command (compiler)
protected final MessageHandler	ourHandler	internally-set message sink
static final String	THROWN_PREFIX	Header used when rendering exceptions for users

Constructor Summary

Constructors

Constructor	Description
Main()

Method Summary

Modifier and Type	Method	Description
static int	bareMain(String[] args, boolean useSystemExit, List<String> fails, List<String> errors, List<String> warnings, List<String> infos, List<String> usages)	Convenience method to run ajc and collect String lists of messages.
protected static void	fail(IMessageHandler handler, String message, Throwable thrown)	convenience API to make fail messages (without MessageUtils's fail prefix)
IMessageHolder	getHolder()
MessageHandler	getMessageHandler()
static void	main(String[] args)
protected void	outMessage(String message)	Messages to the user
void	quit()	call this to stop after the next iteration of incremental compile
static String	renderExceptionForUser(Throwable thrown)
protected boolean	report(boolean pass, IMessageHolder holder)	Report results from a (possibly-incremental) compile run.
void	run(String[] args, IMessageHolder holder)	Run without using System.exit(..), putting all messages in holder: ERROR: compiler error WARNING: compiler warning FAIL: command error (bad arguments, exception thrown) This handles incremental behavior: If args include "-incremental", repeat for every input char until 'q' is entered.
void	runMain(String[] args, boolean useSystemExit)	Run without throwing exceptions, but optionally using System.exit(int).
void	setCommand(ICommand command)
void	setCompletionRunner(Runnable runner)	Install a Runnable to be invoked synchronously after each compile completes.
void	setHolder(IMessageHolder holder)	Set holder to be passed all messages.
protected void	systemExit()	Call System.exit(int) with values derived from the number of failures/aborts or errors in messages.

Methods inherited from class java.lang.Object

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

Field Details

THROWN_PREFIX

public static final String THROWN_PREFIX

Header used when rendering exceptions for users

controller

protected Main.CommandController controller

control iteration/continuation for command (compiler)

commandName

protected String commandName

ReflectionFactory identifier for command (compiler)

command

protected ICommand command

ourHandler

protected final MessageHandler ourHandler

internally-set message sink

Constructor Details

Main

public Main()

Method Details

main

public static void main(String[] args)
                 throws IOException

Parameters:

args - the String[] of command-line arguments

Throws:

IOException

bareMain

public static int bareMain(String[] args,
 boolean useSystemExit,
 List<String> fails,
 List<String> errors,
 List<String> warnings,
 List<String> infos,
 List<String> usages)

Convenience method to run ajc and collect String lists of messages. This can be reflectively invoked with the List collecting parameters supplied by a parent class loader. The String messages take the same form as command-line messages. This method does not catch unchecked exceptions thrown by the compiler.

Parameters:

args - the String[] args to pass to the compiler

useSystemExit - if true and errors, return System.exit(errs)

fails - the List sink, if any, for String failure (or worse) messages

errors - the List sink, if any, for String error messages

warnings - the List sink, if any, for String warning messages

infos - the List sink, if any, for String info messages

usages - the List sink, if any, for String usage messages

Returns:

number of messages reported with level ERROR or above

renderExceptionForUser

public static String renderExceptionForUser(Throwable thrown)

Returns:

String rendering throwable as compiler error for user/console, including information on how to report as a bug.

Throws:

NullPointerException - if thrown is null

getMessageHandler

public MessageHandler getMessageHandler()

setCommand

public void setCommand(ICommand command)

runMain

public void runMain(String[] args,
 boolean useSystemExit)

Run without throwing exceptions, but optionally using System.exit(int). This sets up a message handler which emits messages immediately, so report(boolean, IMessageHolder) only reports the total number of errors or warnings.

Parameters:

args - the compiler command line

useSystemExit - if true, use System.exit(int) to complete unless one of the args is -noExit, and signal result (0 = no exceptions/error, <0 = exceptions, >0 = compiler errors). Note: While some shells like Windows cmd.exe can correctly print negative exit codes via echo %errorlevel%", UNIX shells like Bash interpret them as positive byte values modulo 256. E.g., exit code -1 will be printed as 127 using echo $?.

run

public void run(String[] args,
 IMessageHolder holder)

Run without using System.exit(..), putting all messages in holder:

• ERROR: compiler error
• WARNING: compiler warning
• FAIL: command error (bad arguments, exception thrown)

This handles incremental behavior:

• If args include "-incremental", repeat for every input char until 'q' is entered.
• If args include "-incrementalTagFile {file}", repeat every time we detect that {file} modification time has changed.
• Either way, list files recompiled each time if args includes "-verbose".
• Exit when the commmand/compiler throws any Throwable.

When complete, this contains all the messages of the final run of the command and/or any FAIL messages produced in running the command, including any Throwable thrown by the command itself.

Parameters:

args - the String[] command line for the compiler

holder - the MessageHandler sink for messages.

quit

public void quit()

call this to stop after the next iteration of incremental compile

setHolder

public void setHolder(IMessageHolder holder)

Set holder to be passed all messages. When holder is set, messages will not be printed by default.

Parameters:

holder - the IMessageHolder sink for all messages (use null to restore default behavior)

getHolder

public IMessageHolder getHolder()

setCompletionRunner

public void setCompletionRunner(Runnable runner)

Install a Runnable to be invoked synchronously after each compile completes.

Parameters:

runner - the Runnable to invoke - null to disable

systemExit

protected void systemExit()

Call System.exit(int) with values derived from the number of failures/aborts or errors in messages.

outMessage

protected void outMessage(String message)

Messages to the user

report

protected boolean report(boolean pass,
 IMessageHolder holder)

Report results from a (possibly-incremental) compile run. This delegates to any reportHandler or otherwise prints summary counts of errors/warnings to System.err (if any errors) or System.out (if only warnings). WARNING: this silently ignores other messages like FAIL, but clears the handler of all messages when returning true. XXX false This implementation ignores the pass parameter but clears the holder after reporting on the assumption messages were handled/printed already. (ignoring UnsupportedOperationException from holder.clearMessages()).

Parameters:

pass - true result of the command

holder - IMessageHolder with messages from the command

Returns:

false if the process should abort

fail

protected static void fail(IMessageHandler handler,
 String message,
 Throwable thrown)

convenience API to make fail messages (without MessageUtils's fail prefix)