wyc.util

Class AbstractProjectCommand<T>

java.lang.Object

wyc.util.AbstractProjectCommand<T>

All Implemented Interfaces:

wycc.lang.Command<T>, wycc.lang.Feature, wycc.lang.Feature.Configurable

Direct Known Subclasses:

Compile, Decompile, Run

public abstract class AbstractProjectCommand<T>
extends Object
implements wycc.lang.Command<T>

Provides an abstract command from which other commands for controlling the Whiley compiler can be derived. Specifically, this class handles all the issues related to managing the various project roots, etc.

Author:

David J. Pearce

Nested Class Summary

Nested classes/interfaces inherited from interface wycc.lang.Feature

wycc.lang.Feature.Configurable, wycc.lang.Feature.ConfigurationError

Field Summary

Fields

Modifier and Type	Field and Description
protected wycc.util.Logger	logger The logger used for logging system events
wyfs.lang.Content.Registry	registry The master project content type registry.
protected wyfs.util.DirectoryRoot	whileydir The location in which whiley source files a located, or null if not specified.
protected ArrayList<wyfs.lang.Path.Root>	whileypath The whiley path identifies additional items (i.e.
protected wyfs.lang.Path.Root	wyaldir The location in which wyal source files are stored, or null if not specified.
protected wyfs.lang.Path.Root	wycsdir The location in which wycs binary files are stored, or null if not specified.
protected wyfs.util.DirectoryRoot	wyildir The location in which wyil binary files are stored, or null if not specified.

Constructor Summary

Constructors

Constructor and Description
AbstractProjectCommand(wyfs.lang.Content.Registry registry, wycc.util.Logger logger) Construct a new instance of this command.

Method Summary

Modifier and Type	Method and Description
protected void	addBootpath(List<wyfs.lang.Path.Root> roots) Initialise the bootpath for use with the compiler.
String	describe(String option)
protected void	finaliseConfiguration() Finalise the given configuration to ensure it is an consistent state.
Object	get(String name)
protected wyfs.lang.Path.Root	getAbstractRoot(wyfs.lang.Path.Root dir) Construct a root which is either virtual or corresponds to a physical directory.
protected wyfs.util.DirectoryRoot	getDirectoryRoot(wyfs.util.DirectoryRoot dir, wyfs.util.DirectoryRoot defaulT) Construct a root which must correspond to a physical directory.
String[]	getOptions()
protected wybs.util.StdProject	initialiseProject() Construct a new temporary project.
void	set(String option, Object value)
void	setWhileydir(File dir)
void	setWhileypath(String paths)
void	setWyaldir(File dir)
void	setWyildir(File dir)

Methods inherited from class java.lang.Object

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

Methods inherited from interface wycc.lang.Command

execute, getDescription, getName

Field Detail

registry

public final wyfs.lang.Content.Registry registry

The master project content type registry. This is needed for the build system to determine the content type of files it finds on the file system.

whileypath

protected ArrayList<wyfs.lang.Path.Root> whileypath

The whiley path identifies additional items (i.e. libraries or directories) which the compiler uses to resolve symbols (e.g. module names, functions, etc).

whileydir

protected wyfs.util.DirectoryRoot whileydir

The location in which whiley source files a located, or null if not specified. The default value is the current directory.

wyildir

protected wyfs.util.DirectoryRoot wyildir

The location in which wyil binary files are stored, or null if not specified.

wyaldir

protected wyfs.lang.Path.Root wyaldir

The location in which wyal source files are stored, or null if not specified.

wycsdir

protected wyfs.lang.Path.Root wycsdir

The location in which wycs binary files are stored, or null if not specified.

logger

protected wycc.util.Logger logger

The logger used for logging system events

Constructor Detail

AbstractProjectCommand

public AbstractProjectCommand(wyfs.lang.Content.Registry registry,
                              wycc.util.Logger logger)

Construct a new instance of this command.

Parameters:

registry - The content registry being used to match files to content types.

Throws:

IOException

Method Detail

getOptions

public String[] getOptions()

Specified by:

getOptions in interface wycc.lang.Feature.Configurable

describe

public String describe(String option)

Specified by:

describe in interface wycc.lang.Feature.Configurable

set

public void set(String option,
                Object value)
         throws wycc.lang.Feature.ConfigurationError

Specified by:

set in interface wycc.lang.Feature.Configurable

Throws:

wycc.lang.Feature.ConfigurationError

get

public Object get(String name)

Specified by:

get in interface wycc.lang.Feature.Configurable

setWhileypath

public void setWhileypath(String paths)
                   throws IOException

Throws:

IOException

setWhileydir

public void setWhileydir(File dir)
                  throws IOException

Throws:

IOException

setWyildir

public void setWyildir(File dir)
                throws IOException

Throws:

IOException

setWyaldir

public void setWyaldir(File dir)
                throws IOException

Throws:

IOException

initialiseProject

protected wybs.util.StdProject initialiseProject()
                                          throws IOException

Construct a new temporary project. This project is temporary because it only exists for the life of an execution of this command.

Returns:

Throws:

IOException

finaliseConfiguration

protected void finaliseConfiguration()
                              throws IOException

Finalise the given configuration to ensure it is an consistent state. This means, in particular, that roots which have not been defined by the user are created as necessary.

Throws:

IOException

addBootpath

protected void addBootpath(List<wyfs.lang.Path.Root> roots)
                    throws IOException

Initialise the bootpath for use with the compiler. The bootpath basically identifies the location of the standard library for automatic inclusion into the whileypath.

Parameters:

roots -

Throws:

IOException

getDirectoryRoot

protected wyfs.util.DirectoryRoot getDirectoryRoot(wyfs.util.DirectoryRoot dir,
                                                   wyfs.util.DirectoryRoot defaulT)
                                            throws IOException

Construct a root which must correspond to a physical directory.

Throws:

IOException

getAbstractRoot

protected wyfs.lang.Path.Root getAbstractRoot(wyfs.lang.Path.Root dir)
                                       throws IOException

Construct a root which is either virtual or corresponds to a physical directory.

Throws:

IOException