com.codemesh.terp.ant.compiler.cpp
Class IncludeOption

java.lang.Object
  com.codemesh.terp.ant.compiler.AbstractCompilerOption<CppCompiler>
      com.codemesh.terp.ant.compiler.cpp.IncludeOption

All Implemented Interfaces:

CompilerOption<CppCompiler>, PreprocessorOption

public class IncludeOption
extends AbstractCompilerOption<CppCompiler>
implements PreprocessorOption

An option for setting a search paths for header files. This option supports both a path attribute and a nested path element. You can specify both, but you need to specify at least one to have this option be useful.

Constructor Summary

IncludeOption()

Method Summary

void	addCommands(java.util.List<java.lang.String> commandList, CppCompiler compiler, CompilerPhase phase) Adds the compiler switches repreesnted by this option to the list of switches.
boolean	appliesTo(CppCompiler compiler, CompilerPhase phase) Returns true if this compiler option applies to the given compiler and compiler phase.
org.apache.tools.ant.types.Path	createPath() Creates a nested path element that is added to the include path.
java.lang.String	getPath() Returns the configured include path.
void	setPath(java.lang.String path) Sets the include path.

Methods inherited from class com.codemesh.terp.ant.compiler.AbstractCompilerOption

expand, expand, getIf, getProject, getUnless, quoteIfNecessary, satisfies, setIf, setProject, setUnless

Methods inherited from class java.lang.Object

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

Constructor Detail

IncludeOption

public IncludeOption()

Method Detail

addCommands

public void addCommands(java.util.List<java.lang.String> commandList,
                        CppCompiler compiler,
                        CompilerPhase phase)

Adds the compiler switches repreesnted by this option to the list of switches. Some compiler options may result in more than one switch being added to a compiler invocation. Other compiler options may result in different options being added in different phases (compilation vs. linking) of the build.

This method is called by the compiler repeatedly with different values for the compiler phase to account for these possibilities.

Specified by:

addCommands in interface CompilerOption<CppCompiler>

Parameters:

commandList - the list to which the compiler switches represented by this option (if any) are added.

compiler - the compiler for which we're doing this.

phase - the compiler phase in wihch we're doing this.

appliesTo

public boolean appliesTo(CppCompiler compiler,
                         CompilerPhase phase)

Returns true if this compiler option applies to the given compiler and compiler phase. Not every option has switches to contribute for every compiler and every compilation phase. This method allows a quick, inexpensive check to filter out potentially more expensive calls later on.

Specified by:

appliesTo in interface CompilerOption<CppCompiler>

Parameters:

compiler - the compiler for which we're asking.

phase - the compiler phase we're executing.

Returns:

setPath

public void setPath(java.lang.String path)

Sets the include path.

Parameters:

path - the include path.

getPath

public java.lang.String getPath()

Returns the configured include path.

Returns:

the configured include path.

createPath

public org.apache.tools.ant.types.Path createPath()

Creates a nested path element that is added to the include path.

Returns:

the created path.