com.github.maven_nar.cpptasks.compiler
Class CommandLineLinker

java.lang.Object
  com.github.maven_nar.cpptasks.compiler.AbstractProcessor
      com.github.maven_nar.cpptasks.compiler.AbstractLinker
          com.github.maven_nar.cpptasks.compiler.CommandLineLinker

All Implemented Interfaces:

Linker, Processor, Cloneable

Direct Known Subclasses:

AbstractArLibrarian, AbstractLdLinker, ADSLibrarian, ADSLinker, BorlandLibrarian, BorlandLinker, C89Linker, ClxxLibrarian, ClxxLinker, CompaqVisualFortranLibrarian, DevStudioCompatibleLibrarian, DevStudioCompatibleLinker, IccLinker, OpenWatcomLibrarian, OpenWatcomLinker, OS390Linker

public abstract class CommandLineLinker
extends AbstractLinker

An abstract Linker implementation that performs the link via an external command.

Author:

Adam Murdoch

Field Summary

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

DEFAULT_DISCARD_BID, DEFAULT_PROCESS_BID

Constructor Summary

CommandLineLinker(String command, String identifierArg, String[] extensions, String[] ignoredExtensions, String outputSuffix, boolean isLibtool, CommandLineLinker libtoolLinker)
Creates a comand line linker invocation

Method Summary

protected void	addBase(CCTask task, long base, Vector args)
protected void	addEntry(CCTask task, String entry, Vector args)
protected void	addFixed(CCTask task, Boolean fixed, Vector args)
protected void	addImpliedArgs(CCTask task, boolean debug, LinkType linkType, Vector args)
protected void	addIncremental(CCTask task, boolean incremental, Vector args)
protected String[]	addLibrarySets(CCTask task, LibrarySet[] libsets, Vector preargs, Vector midargs, Vector endargs)
protected void	addMap(CCTask task, boolean map, Vector args)
protected void	addStack(CCTask task, int stack, Vector args)
protected LinkerConfiguration	createConfiguration(CCTask task, LinkType linkType, ProcessorDef[] baseDefs, LinkerDef specificDef, TargetDef targetPlatform, VersionInfo versionInfo)
protected String	decorateLinkerOption(StringBuffer buf, String arg) Allows drived linker to decorate linker option.
protected String	getCommand()
protected abstract String	getCommandFileSwitch(String commandFile)
String	getCommandWithPath(CommandLineLinkerConfiguration config)
String	getIdentifier() Retrieve an identifier that identifies the specific version of the compiler.
CommandLineLinker	getLibtoolLinker()
protected abstract int	getMaximumCommandLength()
String[]	getOutputFileNames(String baseName, VersionInfo versionInfo) Output file name (no path components) corresponding to source file
protected String[]	getOutputFileSwitch(CCTask task, String outputFile)
protected abstract String[]	getOutputFileSwitch(String outputFile)
protected String	getStartupObject(LinkType linkType)
void	link(CCTask task, File outputFile, String[] sourceFiles, CommandLineLinkerConfiguration config) Performs a link using a command line linker
protected String[]	prepareArguments(CCTask task, String outputDir, String outputFile, String[] sourceFiles, CommandLineLinkerConfiguration config) Prepares argument list for exec command.
protected String	prepareFilename(StringBuffer buf, String outputDir, String sourceFile) Processes filename into argument form
protected String[]	prepareResponseFile(File outputFile, String[] args) Prepares argument list to execute the linker using a response file.
protected String	quoteFilename(StringBuffer buf, String filename)
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.AbstractLinker

addVersionFiles, bid, changeEnvironment, createConfiguration, getLibraryKey

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

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.Linker

getLibraryPath, getLibraryPatterns, getLinker, isCaseSensitive

Constructor Detail

CommandLineLinker

public CommandLineLinker(String command,
                         String identifierArg,
                         String[] extensions,
                         String[] ignoredExtensions,
                         String outputSuffix,
                         boolean isLibtool,
                         CommandLineLinker libtoolLinker)

Creates a comand line linker invocation

Method Detail

addBase

protected void addBase(CCTask task,
                       long base,
                       Vector args)

addFixed

protected void addFixed(CCTask task,
                        Boolean fixed,
                        Vector args)

addImpliedArgs

protected void addImpliedArgs(CCTask task,
                              boolean debug,
                              LinkType linkType,
                              Vector args)

addIncremental

protected void addIncremental(CCTask task,
                              boolean incremental,
                              Vector args)

addLibrarySets

protected String[] addLibrarySets(CCTask task,
                                  LibrarySet[] libsets,
                                  Vector preargs,
                                  Vector midargs,
                                  Vector endargs)

addMap

protected void addMap(CCTask task,
                      boolean map,
                      Vector args)

addStack

protected void addStack(CCTask task,
                        int stack,
                        Vector args)

addEntry

protected void addEntry(CCTask task,
                        String entry,
                        Vector args)

createConfiguration

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

Specified by:

createConfiguration in class AbstractLinker

decorateLinkerOption

protected String decorateLinkerOption(StringBuffer buf,
                                      String arg)

Allows drived linker to decorate linker option. Override by GccLinker to prepend a "-Wl," to pass option to through gcc to linker.

Parameters:

buf - buffer that may be used and abused in the decoration process, must not be null.

arg - linker argument

getCommand

protected final String getCommand()

getCommandFileSwitch

protected abstract String getCommandFileSwitch(String commandFile)

getCommandWithPath

public String getCommandWithPath(CommandLineLinkerConfiguration config)

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

getLibtoolLinker

public final CommandLineLinker getLibtoolLinker()

getMaximumCommandLength

protected abstract int getMaximumCommandLength()

getOutputFileNames

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

Description copied from interface: Processor

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

Specified by:

getOutputFileNames in interface Processor

Specified by:

getOutputFileNames in class AbstractLinker

Parameters:

baseName - input file

Returns:

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

getOutputFileSwitch

protected String[] getOutputFileSwitch(CCTask task,
                                       String outputFile)

getOutputFileSwitch

protected abstract String[] getOutputFileSwitch(String outputFile)

getStartupObject

protected String getStartupObject(LinkType linkType)

link

public void link(CCTask task,
                 File outputFile,
                 String[] sourceFiles,
                 CommandLineLinkerConfiguration config)
          throws org.apache.tools.ant.BuildException

Performs a link using a command line linker

Throws:

org.apache.tools.ant.BuildException

prepareArguments

protected String[] prepareArguments(CCTask task,
                                    String outputDir,
                                    String outputFile,
                                    String[] sourceFiles,
                                    CommandLineLinkerConfiguration config)

Prepares argument list for exec command. Will return null if command line would exceed allowable command line buffer.

Parameters:

task - compilation task.

outputFile - linker output file

sourceFiles - linker input files (.obj, .o, .res)

config - linker configuration

Returns:

arguments for runTask

prepareFilename

protected String prepareFilename(StringBuffer buf,
                                 String outputDir,
                                 String sourceFile)

Processes filename into argument form

prepareResponseFile

protected String[] prepareResponseFile(File outputFile,
                                       String[] args)
                                throws IOException

Prepares argument list to execute the linker using a response file.

Parameters:

outputFile - linker output file

args - output of prepareArguments

Returns:

arguments for runTask

Throws:

IOException

quoteFilename

protected String quoteFilename(StringBuffer buf,
                               String filename)

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)