com.github.maven_nar.cpptasks.compiler

Class CommandLineCompiler

java.lang.Object

com.github.maven_nar.cpptasks.compiler.AbstractProcessor

com.github.maven_nar.cpptasks.compiler.AbstractCompiler

com.github.maven_nar.cpptasks.compiler.CommandLineCompiler

All Implemented Interfaces:

Compiler, Processor, Cloneable

Direct Known Subclasses:

BorlandResourceCompiler, CommandLineCCompiler, CommandLineFortranCompiler, MetaObjectCompiler, MsvcMessageCompiler, MsvcMIDLCompiler, MsvcResourceCompiler, OpenWatcomCompiler, PrecompilingCommandLineCompiler, UserInterfaceCompiler, WindresResourceCompiler, XpidlCompiler

public abstract class CommandLineCompiler
extends AbstractCompiler

An abstract Compiler implementation which uses an external program to perform the compile.

Author:

Adam Murdoch

Field Summary

Fields inherited from class com.github.maven_nar.cpptasks.compiler.AbstractCompiler

objDir, workDir

Fields inherited from class com.github.maven_nar.cpptasks.compiler.AbstractProcessor

DEFAULT_DISCARD_BID, DEFAULT_PROCESS_BID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommandLineCompiler(String command, String identifierArg, String[] sourceExtensions, String[] headerExtensions, String outputSuffix, boolean libtool, CommandLineCompiler libtoolCompiler, boolean newEnvironment, org.apache.tools.ant.types.Environment env)

Method Summary

Modifier and Type	Method and Description
protected abstract void	addImpliedArgs(Vector<String> args, boolean debug, boolean multithreaded, boolean exceptions, LinkType linkType, Boolean rtti, OptimizationEnum optimization)
protected void	addIncludes(String baseDirPath, File[] includeDirs, Vector<String> args, Vector<String> relativeArgs, StringBuffer includePathId, boolean isSystem) Adds command-line arguments for include directories.
protected abstract void	addWarningSwitch(Vector<String> args, int warnings)
protected void	buildDefineArguments(CompilerDef[] defs, Vector<String> args)
void	compile(CCTask task, File outputDir, String[] sourceFiles, String[] args, String[] endArgs, boolean relentless, CommandLineCompilerConfiguration config, ProgressMonitor monitor) Compiles a source file.
protected CompilerConfiguration	createConfiguration(CCTask task, LinkType linkType, ProcessorDef[] baseDefs, CompilerDef specificDef, TargetDef targetPlatform, VersionInfo versionInfo)
protected int	getArgumentCountPerInputFile()
protected String	getCommand()
String	getCommandWithPath(CommandLineCompilerConfiguration config)
protected abstract void	getDefineSwitch(StringBuffer buffer, String define, String value)
protected abstract File[]	getEnvironmentIncludePath()
String	getIdentifier() Retrieve an identifier that identifies the specific version of the compiler.
protected abstract String	getIncludeDirSwitch(String source)
protected String	getIncludeDirSwitch(String source, boolean isSystem) Added by Darren Sargent 22Oct2008 Returns the include dir switch value.
protected String	getInputFileArgument(File outputDir, String filename, int index)
protected boolean	getLibtool()
CommandLineCompiler	getLibtoolCompiler() Obtains the same compiler, but with libtool set Default behavior is to ignore libtool
abstract int	getMaximumCommandLength()
protected int	getMaximumInputFilesPerCommand()
String[]	getOutputFileNames(String inputFile, VersionInfo versionInfo) Output file name (no path components) corresponding to source file
protected int	getTotalArgumentLengthForInputFile(File outputDir, String inputFile) Get total command line length due to the input file.
protected abstract void	getUndefineSwitch(StringBuffer buffer, String define)
protected int	runCommand(CCTask task, File workingDir, String[] cmdline) This method is exposed so test classes can overload and test the arguments without actually spawning the compiler
protected void	setCommand(String command)

Methods inherited from class com.github.maven_nar.cpptasks.compiler.AbstractCompiler

canParse, createConfiguration, createParser, getBaseOutputName, getOutputSuffix, parseIncludes, resolveInclude, setObjDir, setWorkDir

Methods inherited from class com.github.maven_nar.cpptasks.compiler.AbstractProcessor

bid, changeEnvironment, clone, getHeaderExtensions, getIdentifier, getOSArch, getOSName, getSourceExtensions, isDarwin, isWindows, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.maven_nar.cpptasks.compiler.Processor

bid, changeEnvironment, getLinker

Constructor Detail

CommandLineCompiler

protected CommandLineCompiler(String command,
                              String identifierArg,
                              String[] sourceExtensions,
                              String[] headerExtensions,
                              String outputSuffix,
                              boolean libtool,
                              CommandLineCompiler libtoolCompiler,
                              boolean newEnvironment,
                              org.apache.tools.ant.types.Environment env)

Method Detail

addImpliedArgs

protected abstract void addImpliedArgs(Vector<String> args,
                                       boolean debug,
                                       boolean multithreaded,
                                       boolean exceptions,
                                       LinkType linkType,
                                       Boolean rtti,
                                       OptimizationEnum optimization)

addIncludes

protected void addIncludes(String baseDirPath,
                           File[] includeDirs,
                           Vector<String> args,
                           Vector<String> relativeArgs,
                           StringBuffer includePathId,
                           boolean isSystem)

Adds command-line arguments for include directories. If relativeArgs is not null will add corresponding relative paths include switches to that vector (for use in building a configuration identifier that is consistent between machines).

Parameters:

baseDirPath - Base directory path.

includeDirs - Array of include directory paths

args - Vector of command line arguments used to execute the task

relativeArgs - Vector of command line arguments used to build the configuration identifier

addWarningSwitch

protected abstract void addWarningSwitch(Vector<String> args,
                                         int warnings)

buildDefineArguments

protected void buildDefineArguments(CompilerDef[] defs,
                                    Vector<String> args)

getOutputFileNames

public String[] getOutputFileNames(String inputFile,
                                   VersionInfo versionInfo)

Description copied from interface: Processor

Output file name (no path components) corresponding to source file

Specified by:

getOutputFileNames in interface Processor

Overrides:

getOutputFileNames in class AbstractCompiler

Parameters:

inputFile - input file

Returns:

output file name or null if no output file or name not determined by input file

compile

public void compile(CCTask task,
                    File outputDir,
                    String[] sourceFiles,
                    String[] args,
                    String[] endArgs,
                    boolean relentless,
                    CommandLineCompilerConfiguration config,
                    ProgressMonitor monitor)
             throws org.apache.tools.ant.BuildException

Compiles a source file.

Throws:

org.apache.tools.ant.BuildException

createConfiguration

protected CompilerConfiguration createConfiguration(CCTask task,
                                                    LinkType linkType,
                                                    ProcessorDef[] baseDefs,
                                                    CompilerDef specificDef,
                                                    TargetDef targetPlatform,
                                                    VersionInfo versionInfo)

Specified by:

createConfiguration in class AbstractCompiler

getArgumentCountPerInputFile

protected int getArgumentCountPerInputFile()

getCommand

protected final String getCommand()

getCommandWithPath

public String getCommandWithPath(CommandLineCompilerConfiguration config)

getDefineSwitch

protected abstract void getDefineSwitch(StringBuffer buffer,
                                        String define,
                                        String value)

getEnvironmentIncludePath

protected abstract File[] getEnvironmentIncludePath()

getIdentifier

public String getIdentifier()

Description copied from interface: Processor

Retrieve an identifier that identifies the specific version of the compiler. Compilers with the same identifier should produce the same output files for the same input files and command line switches.

Specified by:

getIdentifier in interface Processor

Specified by:

getIdentifier in class AbstractProcessor

getIncludeDirSwitch

protected abstract String getIncludeDirSwitch(String source)

getIncludeDirSwitch

protected String getIncludeDirSwitch(String source,
                                     boolean isSystem)

Added by Darren Sargent 22Oct2008 Returns the include dir switch value. Default implementation doesn't treat system includes specially, for compilers which don't care.

Parameters:

source - the given source value.

isSystem - "true" if this is a system include path

Returns:

the include dir switch value.

getInputFileArgument

protected String getInputFileArgument(File outputDir,
                                      String filename,
                                      int index)

getLibtool

protected final boolean getLibtool()

getLibtoolCompiler

public final CommandLineCompiler getLibtoolCompiler()

Obtains the same compiler, but with libtool set Default behavior is to ignore libtool

getMaximumCommandLength

public abstract int getMaximumCommandLength()

getMaximumInputFilesPerCommand

protected int getMaximumInputFilesPerCommand()

getTotalArgumentLengthForInputFile

protected int getTotalArgumentLengthForInputFile(File outputDir,
                                                 String inputFile)

Get total command line length due to the input file.

Parameters:

outputDir - File output directory

inputFile - String input file

Returns:

int characters added to command line for the input file.

getUndefineSwitch

protected abstract void getUndefineSwitch(StringBuffer buffer,
                                          String define)

runCommand

protected int runCommand(CCTask task,
                         File workingDir,
                         String[] cmdline)
                  throws org.apache.tools.ant.BuildException

This method is exposed so test classes can overload and test the arguments without actually spawning the compiler

Throws:

org.apache.tools.ant.BuildException

setCommand

protected final void setCommand(String command)