terp - the ANT Tasks
v1.3.337

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

java.lang.Object
  extended by com.codemesh.terp.ant.compiler.AbstractCompilerOption<C>
      extended by com.codemesh.terp.ant.compiler.BooleanCompilerOption<CppCompiler>
          extended by com.codemesh.terp.ant.compiler.cpp.ProfileOption
All Implemented Interfaces:
CompilerOption<CppCompiler>

public class ProfileOption
extends BooleanCompilerOption<CppCompiler>

Specifies whether to add profiler instrumentation. The default profiling tool is "gprof".


Field Summary
static java.lang.String TOOL_GPROF
          The value indicating that the profiling tool is gprof.
static java.lang.String TOOL_PROF
          The value indicating that the profiling tool is prof.
 
Constructor Summary
ProfileOption()
           
 
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.
 void setTool(java.lang.String tool)
          Set the tool used for profiling.
 
Methods inherited from class com.codemesh.terp.ant.compiler.BooleanCompilerOption
getValue, isEnabled, setValue
 
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
 

Field Detail

TOOL_GPROF

public static final java.lang.String TOOL_GPROF
The value indicating that the profiling tool is gprof.

See Also:
Constant Field Values

TOOL_PROF

public static final java.lang.String TOOL_PROF
The value indicating that the profiling tool is prof.

See Also:
Constant Field Values
Constructor Detail

ProfileOption

public ProfileOption()
Method Detail

setTool

public void setTool(java.lang.String tool)
Set the tool used for profiling. Expected values are "prof" or "gprof", but other values are allowed if they are supported by the option.

Parameters:
tool - the tool.

addCommands

public void addCommands(java.util.List<java.lang.String> commandList,
                        CppCompiler compiler,
                        CompilerPhase phase)
Description copied from interface: CompilerOption
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.

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)
Description copied from interface: CompilerOption
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.

Parameters:
compiler - the compiler for which we're asking.
phase - the compiler phase we're executing.
Returns:

terp - the ANT Tasks
v1.3.337

Copyright © 2008-2016 by Codemesh, Inc. All Rights Reserved.