TapEnv¶

public final class TapEnv¶: Environment containing parameters useful during Tapenade analysis.

Fields¶

ADJ_DEBUG¶

public static final int ADJ_DEBUG¶: Adjoint debug mode of differentiated program.

BETTERMESSAGESTYLE¶

protected static final boolean BETTERMESSAGESTYLE¶

BYTE_SIZE¶

protected static final int BYTE_SIZE¶: Default size of a byte.

C¶

public static final int C¶: The “language” of files written in C.

CHAR_SIZE¶

protected static final int CHAR_SIZE¶: Default size of a char.

CPLUSPLUS¶

public static final int CPLUSPLUS¶: The “language” of files written in C++.

CPLUSPLUS_FAMILY¶

public static final int CPLUSPLUS_FAMILY¶

CPLUSPLUS_PARSER_NB_ARGS¶

public static final int CPLUSPLUS_PARSER_NB_ARGS¶

CUDA¶

public static final int CUDA¶: The “language” of files written in C Cuda

C_FAMILY¶

public static final int C_FAMILY¶

FORTRAN¶

public static final int FORTRAN¶: The “language” of files written in FORTRAN (77 or 90 or up).

FORTRAN2003¶

public static final int FORTRAN2003¶: The “language” of files written in FORTRAN2003 or up.

FORTRAN90¶

public static final int FORTRAN90¶: The “language” of files written in FORTRAN90 or up.

FORTRAN_FAMILY¶

public static final int FORTRAN_FAMILY¶

INCLUDE¶

public static final int INCLUDE¶: A “language” indicating that the file is an include file.

JAR¶

public static final int JAR¶: A “language” indicating that a file is a JAR.

MAC_CPP_COMMAND¶

public static final String MAC_CPP_COMMAND¶: The default, standard cpp preprocessor for MacOS.

MAX_DIFF_SORTS¶

public static final int MAX_DIFF_SORTS¶: The max number of differemtiation “sorts”, Currently 5 is enough, for e.g. functions F_FWD, F_BWD, F_B, F_D, or for variables vd, vb, (alternative)vb0…

MIXED¶

public static final int MIXED¶: A “language” for mixtures of different languages.

MSG_ALWAYS¶

public static final int MSG_ALWAYS¶: Message level.

MSG_DEFAULT¶

public static final int MSG_DEFAULT¶

MSG_ERROR¶

public static final int MSG_ERROR¶

MSG_SEVERE¶

public static final int MSG_SEVERE¶

MSG_TRACE¶

public static final int MSG_TRACE¶

MSG_WARN¶

public static final int MSG_WARN¶

NEXT_TREE¶

public static final int NEXT_TREE¶

NO_DEBUG¶

public static final int NO_DEBUG¶: No debug of differentiated program.

NO_POSITION¶

public static final int NO_POSITION¶

POINTER_SIZE¶

protected static final int POINTER_SIZE¶: Default size of a pointer.

REAL_SIZE¶

protected static final int REAL_SIZE¶: Default size of a float.

STD_CPP_COMMAND¶

public static final String STD_CPP_COMMAND¶: The default, standard cpp preprocessor.

TANGENT_MODE¶

protected static final int TANGENT_MODE¶

TGT_DEBUG¶

public static final int TGT_DEBUG¶: Tangent debug mode of differentiated program.

UNDEFINED¶

public static final int UNDEFINED¶: The “undefined” file language.

UNDEFINEDSIZE¶

public static final String UNDEFINEDSIZE¶

bootstrapCss¶

public static final String bootstrapCss¶: tapenade -html with https://getbootstrap.com/ style sheet.

tapenadeCss¶

public static final String tapenadeCss¶: tapenade -html style sheet.

Methods¶

activeMark¶

public static String activeMark()¶

Returns: character used to show active subtrees in ILUtils.toString().

adActivityAnalyzer¶

public static final ADActivityAnalyzer adActivityAnalyzer()¶

adTbrAnalyzer¶

public static final ADTBRAnalyzer adTbrAnalyzer()¶

addMessageAnnotation¶

public static final void addMessageAnnotation(Tree tree, String displayMessage)¶

addMixedLanguageInfos¶

public static final void addMixedLanguageInfos(MixedLanguageInfos infos)¶

addOptionsString¶

public static final void addOptionsString(String options)¶

alreadyDiffInclude¶

public static final boolean alreadyDiffInclude(String includeFileName)¶

assocAddressDiffSuffix¶

public static final String assocAddressDiffSuffix()¶

assocAddressDiffTypesUnit¶

public static final Unit assocAddressDiffTypesUnit(int language)¶

assocAddressValueSuffix¶

public static final String assocAddressValueSuffix()¶

associationByAddress¶

public static final boolean associationByAddress()¶

checkAndUpdateTapEnvInclude¶

public static final boolean checkAndUpdateTapEnvInclude(Tree tree)¶

closeOutputStream¶

public static final void closeOutputStream()¶: Close the current OutputStream that was used for all Strings printed and all messages emitted through this TapEnv.

commandWarning¶

public static final void commandWarning(int inverseSeverity, String message)¶: Message that indicates an inconsistency in the command sent to Tapenade.

commentStart¶

public static final String commentStart(int language)¶

Returns: the string that starts line comments in the given language.

curOutputStream¶

public static final OutputStream curOutputStream()¶

currentIncludeInstruction¶

public static final Instruction currentIncludeInstruction()¶

currentParsedFile¶

public static final String currentParsedFile()¶

currentTranslationUnitSymbolTable¶

public static final SymbolTable currentTranslationUnitSymbolTable()¶

debugADMM¶

public static final boolean debugADMM()¶

debugActivity¶

public static final boolean debugActivity()¶

debugAdMode¶

public static final int debugAdMode()¶

Debug mode of differentiated programs.

Returns: debug mode.

decrTraceIndent¶

public static final void decrTraceIndent(int delta)¶

depsAnalyzer¶

public static final DepsAnalyzer depsAnalyzer()¶

diffKind¶

public static final int diffKind()¶

diffLivenessAnalyzer¶

public static final DiffLivenessAnalyzer diffLivenessAnalyzer()¶

diffReplica¶

public static final int diffReplica()¶

differentiateIncludeName¶

public static final String differentiateIncludeName(String includeName, String suffix)¶

disambigNewName¶

public static final String disambigNewName(String name)¶: Add a unique counter to a new variable “name”, so as to be able to recognize it, e.g. with sed.

doActivity¶

public static final boolean doActivity()¶

doMPI¶

public static final boolean doMPI()¶

doOpenMP¶

public static final boolean doOpenMP()¶

doOpenMPZ3¶

public static final boolean doOpenMPZ3()¶

doRecompute¶

public static final boolean doRecompute()¶

doTBR¶

public static final boolean doTBR()¶

doUsefulness¶

public static final boolean doUsefulness()¶

dumpBoolMatrixOnTrace¶

public static final void dumpBoolMatrixOnTrace(BoolMatrix boolMatrix, int[] rowMap, int[] colMap)¶: Prints a dump of a BoolMatrix on the traceOutputStream, knowing its row and column Maps.

dumpBoolVector¶

public static final void dumpBoolVector(BoolVector boolVector, int[] map, String mapName)¶: Prints in detail the contents of “boolVector”, using the given map, onto this.curOutputStream.

dumpObject¶

public static final void dumpObject(Object object)¶: Prints in detail the contents of “object”, which must belong to this package, onto this.curOutputStream.

dumpOnTrace¶

public static final void dumpOnTrace(Object obj)¶: Prints a dump “obj” on the traceOutputStream. This method takes care of avoiding infinite looping in circular references.

dumpSymbolTableIfNew¶

protected static final void dumpSymbolTableIfNew(SymbolTable symbolTable, int indent)¶

duplicableUnitNames¶

public static final TapList<String> duplicableUnitNames()¶

enclosingIncludeIsEmptyOr¶

public static final boolean enclosingIncludeIsEmptyOr(Tree includeTree)¶: Checks that “includeTree”, which must be an “end-of-include” annotation tree, actually matches the next enclosing include in the current “includeFiles” (or there is no next enclosing include).

exitingBackToInclude¶

public static final boolean exitingBackToInclude(String includeFileName)¶

extendReplica¶

public static final String extendReplica(String str, int replicaRank)¶: Extends the given String with something to distinguish its replicas. Replicas are introduced by option “-diffReplica N”

extendStringWithSuffix¶

public static final String extendStringWithSuffix(String str, String suffix)¶: Extends a string with a suffix. If Suffix contains “%”, this “%” stands for the original string.

fileError¶

public static final void fileError(Tree tree, String message)¶: Message that indicates a defect in the files (e.g. type-checking, aliasing, irreducible loops, etc…).

fileWarning¶

public static final void fileWarning(int inverseSeverity, int position, String message)¶: Message that indicates a defect in the files (e.g. type-checking, aliasing, irreducible loops, etc…).

fileWarning¶

public static final void fileWarning(int inverseSeverity, Tree tree, String message)¶: Message that indicates a defect in the files (e.g. type-checking, aliasing, irreducible loops, etc…).

filterIncludeFileName¶

public static final String filterIncludeFileName(String includeFileName, boolean withCapsule, boolean mustExist)¶

get¶

public static TapEnvForThread get()¶

getAllMessages¶

public static final TapList<PositionAndMessage> getAllMessages(CallGraph origCallGraph, CallGraph diffCallGraph, TapList<Unit> transformedUnits, boolean showMessagesOfAllUnits)¶

Returns: the list of all messages (of type PositionAndMessage) that have been emitted about the given “origCallGraph” and also possibly about its differentiated “diffCallGraph”.

getAssocAddressIndex¶

public static final int getAssocAddressIndex(int language)¶

getDiffIncludeName¶

public static final String getDiffIncludeName(String includeFileName)¶

getExtension¶

public static final String getExtension(String filename)¶

Get suffix of file.

Parameters

filename – full file name.

Returns

suffix of filename

getIncludeTree¶

public static final Tree getIncludeTree(Tree includeTree)¶

getNewPushPopNumber¶

public static final int getNewPushPopNumber()¶

Returns: a new free number to identify matching PUSH/POP’s.

getSeenSymbolTableShortName¶

public static final String getSeenSymbolTableShortName(SymbolTable symbolTable)¶

Retrieves the short name of a SymbolTable that has already been printed.

Returns: null if not already printed.

getSetDiffIncludeInfo¶

public static final TapTriplet<String, String, Tree> getSetDiffIncludeInfo(String includeFileName)¶

inIncludeFile¶

public static final boolean inIncludeFile()¶

inOutAnalyzer¶

public static final InOutAnalyzer inOutAnalyzer()¶

inStdCIncludeFile¶

public static final boolean inStdCIncludeFile()¶

Returns: True if we are inside a C standard include file.

includeDirs¶

public static final TapList<String> includeDirs()¶

includeFileStack¶

public static final TapList<String> includeFileStack()¶

incrTraceIndent¶

public static final void incrTraceIndent(int delta)¶

indent¶

public static final void indent(int indent)¶: Prints “indent” white spaces onto this TapEnv’s current OutputStream.

indentOnTrace¶

public static final void indentOnTrace(int amount)¶: Prints indentation on the traceOutputStream.

indentOnTrace¶

public static final void indentOnTrace()¶

indentPrint¶

public static final void indentPrint(int indent, String str)¶: Prints “indent” white spaces, then String “str”, onto this TapEnv’s current OutputStream.

indentPrintln¶

public static final void indentPrintln(int indent, String str)¶: Prints “indent” white spaces, then String “str”, then newline, onto this TapEnv’s current OutputStream.

indentprintOnTrace¶

public static final void indentprintOnTrace(String str)¶: Same as printOnTrace(), but indents first.

indentprintlnOnTrace¶

public static final void indentprintlnOnTrace(String str)¶: Same as printlnOnTrace(), but indents first.

indentprintlnOnTrace¶

public static final void indentprintlnOnTrace()¶: Same as printlnOnTrace(), but indents first.

initializeSourceMessageCorrespondence¶

public static final void initializeSourceMessageCorrespondence()¶: Reset counters for source-message correspondence.

inputLanguage¶

public static final int inputLanguage()¶

Returns: the given input language of the current source code.

isC¶

public static final boolean isC(int language)¶

Parameters

language – integer value.

Returns

true when the given language family is C (C, Cuda, C++…).

isCPlusPlus¶

public static final boolean isCPlusPlus(int language)¶

Parameters

language – integer value.

Returns

true when the given language C++.

isCexactly¶

public static final boolean isCexactly(int language)¶

isDiffIncludeFileName¶

public static final boolean isDiffIncludeFileName(String includeFileName)¶

isDistribVersion¶

public static final boolean isDistribVersion()¶

Returns: true when this is a distribution version.

isFortran¶

public static final boolean isFortran(int language)¶

Parameters

language – integer value.

Returns

true when the given language is Fortran.

isFortran2003¶

public static final boolean isFortran2003(int language)¶

Parameters

language – integer value.

Returns

true when the given language is Fortran 2003 or higher.

isFortran9x¶

public static final boolean isFortran9x(int language)¶

Parameters

language – integer value.

Returns

true when the given language is Fortran 90 or higher.

isServlet¶

public static boolean isServlet()¶

A marker to distinguish “servlet” Tapenade from standard “command-line” Tapenade.

Returns: true if Tapenade is used as a web server, else false.

isStdCInclude¶

public static final boolean isStdCInclude(Instruction curInclude)¶

isStdIncludeName¶

public static final boolean isStdIncludeName(String includeName)¶

languageName¶

public static final String languageName(int lang)¶

Returns: the name of the programming language lang.

languages¶

public static final int languages(int i)¶

mixedLanguageInfos¶

public static final TapList<MixedLanguageInfos> mixedLanguageInfos()¶

Returns: a TapList (Language1 Language2 byReference_or_byResult bind_info_list).

modeIsAdjoint¶

public static final boolean modeIsAdjoint()¶

modeIsNoDiff¶

public static final boolean modeIsNoDiff()¶

modeIsOverloading¶

public static final boolean modeIsOverloading()¶

modeIsTangent¶

public static final boolean modeIsTangent()¶

msgLevel¶

public static final int msgLevel()¶

Returns: severity of shown messages.

multithreadAnalyzer¶

public static final MultithreadAnalyzer multithreadAnalyzer()¶

mustAdjoint¶

public static final boolean mustAdjoint()¶

mustContext¶

public static final boolean mustContext()¶

mustTangent¶

public static final boolean mustTangent()¶

optionsString¶

public static final String optionsString()¶

outputExtension¶

public static final String outputExtension(int lang)¶

Parameters

lang – the language

Returns

the language extension string.

outputLanguage¶

public static final int outputLanguage()¶

Returns: the wanted output language of the resulting code.

parserError¶

public static final void parserError(String message)¶: Message that indicates a parser error.

parserFileSeparator¶

public static final String parserFileSeparator()¶

Returns: The separator used in file names between directories and files e.g. “/”

pointerAnalyzer¶

public static final PointerAnalyzer pointerAnalyzer()¶

popIncludeFile¶

public static final String popIncludeFile()¶

popOutputStream¶

public static final void popOutputStream()¶: Pop back to the previous current OutputStream for all Strings printed and all messages emitted through this TapEnv.

popRelatedUnit¶

public static final void popRelatedUnit()¶

print¶

public static final void print(String str)¶

Prints String “str” onto this TapEnv’s current OutputStream, i.e. either the top of the stack of pushed OutputStream’s, or System.out. Used in printOnTrace, printOnDump, dump methods.

Parameters

str – String to print.

Throws

java.io.IOException – if an output error is detected.

printOnDump¶

public static final void printOnDump(String str)¶: Prints “str” (non-null please) on the dumpOutputStream.

printOnTrace¶

public static final void printOnTrace(int level, String str)¶

When the “level” of the given message “str” is under trace threshold (traceLevel), prints “str” then newline, on the traceOutputStream.

Parameters

level – this message level e.g. 5:topmost, 10:one phase, 15:one phase on one Unit…
str – the message to print (must not be null)

printOnTrace¶

public static final void printOnTrace(String str)¶: Prints “str” (non-null please) on the traceOutputStream.

println¶

public static final void println(String str)¶

println to avoid system dependent “string\n” or string concatenation “string” + “\n”.

Throws

java.io.IOException – if an output error is detected.

println¶

public static final void println()¶

printlnMappedBoolVector¶

public static final void printlnMappedBoolVector(String text, BoolVector boolVector, int[] map, String mapName)¶: Prints in detail the contents of data-flow info “boolVector” onto this.curOutputStream, prefixed with the given description “text” and a description “mapName” of its map “map”.

printlnMappedBoolVectorWithDiffPtr¶

public static final void printlnMappedBoolVectorWithDiffPtr(String text, TapPair<BoolVector, BoolVector> boolVectorPair, int[] map, String mapName, int[] ptrMap, String ptrMapName)¶: Prints in detail the contents of data-flow info “boolVectorPair” onto this.curOutputStream, prefixed with the given description “text”. We assume boolVectorPair is a pair of data-flow info, first part on standard zones following “map”, second part on pointer zones following ptrMap. The second part is needed e.g in diffLiveness or TBR analyses, and stands for differentiated pointers.

printlnMappedBoolVectorWithDiffPtr¶

public static final void printlnMappedBoolVectorWithDiffPtr(String text, BoolVector boolVector, int[] map, String mapName, BoolVector ptrBoolVector, int[] ptrMap, String ptrMapName)¶: Same as printlnMappedBoolVectorWithDiffPtr(TapPair,…), but the two BoolVectors are passed individually

printlnOnTrace¶

public static final void printlnOnTrace(int level, String str)¶

When the “level” of the given message “str” is under trace threshold (traceLevel), prints “str” on the traceOutputStream.

Parameters

level – this message level e.g. 5:topmost, 10:one phase, 15:one phase on one Unit…
str – the message to print (must not be null)

printlnOnTrace¶

public static final void printlnOnTrace(int level)¶

printlnOnTrace¶

public static final void printlnOnTrace(String str)¶: Prints “str” then newline on the traceOutputStream.

printlnOnTrace¶

public static final void printlnOnTrace()¶

profile¶

public static final boolean profile()¶

pushIncludeFile¶

public static final void pushIncludeFile(String includeFileName)¶

pushOutputStream¶

public static final void pushOutputStream(OutputStream newOutputStream)¶: Push the given “newOutputStream” as the new current OutputStream for all Strings printed and all messages emitted through this TapEnv.

pushRelatedUnit¶

public static final void pushRelatedUnit(Unit unit)¶

relatedArrow¶

public static final CallArrow relatedArrow()¶

relatedLanguage¶

public static final int relatedLanguage()¶

relatedLanguageIsC¶

public static final boolean relatedLanguageIsC()¶

Returns: True if the language of the related Unit or SymbolTable is C.

relatedLanguageIsCPLUSPLUS¶

public static final boolean relatedLanguageIsCPLUSPLUS()¶

Returns: True if the language of the related Unit or SymbolTable is C++.

relatedLanguageIsFortran¶

public static final boolean relatedLanguageIsFortran()¶

Returns: True if the language of the related Unit or SymbolTable is Fortran.

relatedLanguageIsFortran77¶

public static final boolean relatedLanguageIsFortran77()¶

Returns: True if the language of the related Unit or SymbolTable is Fortran77.

relatedLanguageIsFortran9x¶

public static final boolean relatedLanguageIsFortran9x()¶

Returns: True if the related language is Fortran90 or higher.

relatedUnit¶

public static final Unit relatedUnit()¶

Returns: this TapEnv’s “current” Unit, used to attach all messages emitted, and also to know the particular programming language, sometimes incurring limitations.

removeDeadControl¶

public static final boolean removeDeadControl()¶

removeDeadPrimal¶

public static final boolean removeDeadPrimal()¶

reqExplicitAnalyzer¶

public static final ReqExplicit reqExplicitAnalyzer()¶

reqXMark¶

public static String reqXMark()¶

Returns: character used to show reqexplicit subtrees in ILUtils.toString().

resetIncludeManager¶

public static final void resetIncludeManager()¶: Say that we are no longer in an include file.

resetPushPopNumber¶

public static final void resetPushPopNumber()¶: reset to zero the next number to identify matching PUSH/POP’s.

resetRelatedUnit¶

public static final void resetRelatedUnit()¶: Reset this TapEnv’s “current” Unit to null.

resetSeenSymbolTables¶

public static final void resetSeenSymbolTables()¶: Resets the mechanism that ensures that a SymbolTable is printed only once.

sameFinalIncludeFile¶

public static final boolean sameFinalIncludeFile(String include1, String include2)¶

sameLanguageFamily¶

public static final boolean sameLanguageFamily(int lang1, int lang2)¶

Parameters

lang1 – integer.
lang2 – integer.

Returns

true when lang1 and lang2 are Fortran, or when lang1 and lang2 are C (or C++).

saveAllMessagesAsHTML¶

public static final void saveAllMessagesAsHTML(TapList<PositionAndMessage> msgs, String msgFileName, String cssDir, String htmlDirectory, String outputFileName, boolean hasGlobalDeclarations, String preprocessSuffix)¶: Save all messages as a HTML file named “msgFileName”.

saveAllMessagesAsText¶

public static final void saveAllMessagesAsText(TapList<PositionAndMessage> msgs, String msgFileName)¶: Save all messages as a text file named “msgFileName”.

setADActivityAnalyzer¶

public static final void setADActivityAnalyzer(ADActivityAnalyzer analyzer)¶

setADTBRAnalyzer¶

public static final void setADTBRAnalyzer(ADTBRAnalyzer analyzer)¶

setActiveMark¶

public static void setActiveMark(String activeMark)¶: Set character used to show active subtrees in ILUtils.toString().

setAssocAddressDiffTypesUnit¶

public static final void setAssocAddressDiffTypesUnit(Unit unit)¶

setAssociationByAddress¶

public static final void setAssociationByAddress(boolean value)¶

setCurOutputStream¶

public static final void setCurOutputStream(OutputStream outStream)¶

setCurrentDirectory¶

public static final void setCurrentDirectory(String dir)¶: Set the current directory, used to look for include files set the rootDirectoryPath.

setCurrentIncludeInstruction¶

public static final void setCurrentIncludeInstruction(Instruction instruction)¶

setCurrentParsedFile¶

public static final void setCurrentParsedFile(String filename)¶

setCurrentTranslationUnitSymbolTable¶

public static final void setCurrentTranslationUnitSymbolTable(SymbolTable symbolTable)¶

setDebugADMM¶

public static final void setDebugADMM(boolean value)¶

setDebugActivity¶

public static final void setDebugActivity(boolean value)¶

setDebugAdMode¶

public static final void setDebugAdMode(int value)¶

Set debug mode of differentiated program.

Parameters

value – debug mode.

setDepsAnalyzer¶

public static final void setDepsAnalyzer(DepsAnalyzer analyzer)¶

setDiffKind¶

public static final void setDiffKind(int kind)¶

setDiffLivenessAnalyzer¶

public static final void setDiffLivenessAnalyzer(DiffLivenessAnalyzer analyzer)¶

setDistribVersion¶

public static void setDistribVersion(boolean value)¶

Initialize isDistribVersion.

Parameters

value – true for distribution.

setDoActivity¶

public static final void setDoActivity(boolean value)¶

setDoMPI¶

public static final void setDoMPI(boolean value)¶

setDoOpenMP¶

public static final void setDoOpenMP(boolean value)¶

setDoOpenMPZ3¶

public static final void setDoOpenMPZ3(boolean value)¶

setDoRecompute¶

public static final void setDoRecompute(boolean value)¶

setDoTBR¶

public static final void setDoTBR(boolean value)¶

setDoUsefulness¶

public static final void setDoUsefulness(boolean value)¶

setDuplicableUnitNames¶

public static final void setDuplicableUnitNames(TapList<String> unitNames)¶

setInIncludeFile¶

public static final Tree setInIncludeFile(Tree includeTree)¶

Say that we are in an include file, triggered by the given “includeTree”.

Returns: the includeTree, rewritten if necessary to be an op_include.

setInOutAnalyzer¶

public static final void setInOutAnalyzer(InOutAnalyzer analyzer)¶

setIncludeDirs¶

public static final void setIncludeDirs(TapList<String> includeList)¶

setInputLanguage¶

public static final void setInputLanguage(int lang)¶

setIsServlet¶

public static void setIsServlet()¶: Call during servlet initialization.

setLanguages¶

public static final void setLanguages(int rank, int lang)¶

setMixedLanguageInfos¶

public static final void setMixedLanguageInfos(TapList<MixedLanguageInfos> infos)¶

setModeAdjoint¶

public static final void setModeAdjoint()¶

setModeNoDiff¶

public static final void setModeNoDiff()¶: Set current differentiation mode to “PREPROCESS_NODE”.

setModeOverloading¶

public static final void setModeOverloading()¶

setModeTangent¶

public static final void setModeTangent()¶

setMsgLevel¶

public static final void setMsgLevel(int level)¶: Maximum inverse severity of shown messages. Messages with inverse severity above “msgLevel” are not shown.

setMultithreadAnalyzer¶

public static final void setMultithreadAnalyzer(MultithreadAnalyzer analyzer)¶

setMustAdjoint¶

public static final void setMustAdjoint(boolean value)¶

setMustContext¶

public static final void setMustContext(boolean value)¶

setMustTangent¶

public static final void setMustTangent(boolean value)¶

setOutputLanguage¶

public static final void setOutputLanguage(int lang)¶

setParserFileSeparator¶

public static final void setParserFileSeparator(String separator)¶: The separator used in file names between directories and files e.g. “/”

setPointerAnalyzer¶

public static final void setPointerAnalyzer(PointerAnalyzer analyzer)¶

setRelatedArrow¶

public static final void setRelatedArrow(CallArrow arrow)¶

setRelatedLanguage¶

public static final void setRelatedLanguage(int lang)¶

setRelatedLanguage¶

public static final void setRelatedLanguage(SymbolTable symbolTable)¶

setRelatedUnit¶

public static final void setRelatedUnit(Unit unit)¶

Set this TapEnv’s “current” Unit, used to attach all messages emitted, and also to know the particular programming language, sometimes incurring limitations.

Parameters

unit – current Unit.

setRemoveDeadControl¶

public static final void setRemoveDeadControl(boolean value)¶

setRemoveDeadPrimal¶

public static final void setRemoveDeadPrimal(boolean value)¶

setReqExplicitAnalyzer¶

public static final void setReqExplicitAnalyzer(ReqExplicit analyzer)¶

setReqXMark¶

public static void setReqXMark(String reqXMark)¶: Set character used to show reqexplicit subtrees in ILUtils.toString().

setSourceCodeCorrespondence¶

public static final void setSourceCodeCorrespondence(Tree source, Tree code, boolean forward, boolean backward)¶: Place a source-code correspondence between “source” and “code” trees for future display tools (e.g. html).

setSpareDiffReinitializations¶

public static final void setSpareDiffReinitializations(boolean value)¶

setTapenadeHome¶

public static void setTapenadeHome(String tapenadeDirectory)¶

Set tapenadeHome.

Parameters

tapenadeDirectory – $TAPENADE_HOME or System.getProperty(“user.dir”).

setTraceADDeps¶

public static final void setTraceADDeps(TapList<String> unitNames)¶

setTraceActivity¶

public static final void setTraceActivity(TapList<String> unitNames)¶

setTraceCurAnalysis¶

public static final void setTraceCurAnalysis(boolean value)¶

setTraceDeps¶

public static final void setTraceDeps(TapList<String> unitNames)¶

setTraceDiffLiveness¶

public static final void setTraceDiffLiveness(TapList<String> unitNames)¶

setTraceFlowGraphBuild¶

public static final void setTraceFlowGraphBuild(TapList<String> unitNames)¶

setTraceInOut¶

public static final void setTraceInOut(TapList<String> unitNames)¶

setTraceIndent¶

public static final void setTraceIndent(int amount)¶

setTraceInlineAnalysis¶

public static final void setTraceInlineAnalysis(boolean value)¶

setTraceInputIL¶

public static final void setTraceInputIL(boolean value)¶

setTraceLevel¶

public static final void setTraceLevel(int level)¶: Maximum trace detail level. Traces and Milestones with a detail level above “traceLevel” are not shown.

setTraceMultithread¶

public static final void setTraceMultithread(TapList<String> unitNames)¶

setTracePointer¶

public static final void setTracePointer(TapList<String> unitNames)¶

setTraceReqExplicit¶

public static final void setTraceReqExplicit(TapList<String> unitNames)¶

setTraceTBR¶

public static final void setTraceTBR(TapList<String> unitNames)¶

setTraceTypeCheckAnalysis¶

public static final void setTraceTypeCheckAnalysis(boolean value)¶

setUseSharpInclude¶

public static final void setUseSharpInclude(boolean useIt)¶

setValid¶

public static final void setValid(boolean value)¶

spareDiffReinitializations¶

public static final boolean spareDiffReinitializations()¶

str3¶

public static final String str3(int i)¶: Displays an integer on 3 characters, padding with white space if needed.

stringContainedIn¶

public static final boolean stringContainedIn(String str, String[] strings)¶

stripLanguageExtension¶

public static final String stripLanguageExtension(String fileName)¶

stripPath¶

public static final String stripPath(String completeFileName)¶

switchOnCombineDeclMessages¶

public static final void switchOnCombineDeclMessages(boolean onOff)¶

systemError¶

public static final void systemError(String message)¶: Message that indicates a problem with the system e.g. “file not found”.

systemWarning¶

public static final void systemWarning(int inverseSeverity, String message)¶: Message that indicates a problem with the system e.g. “file not found”.

tapenadeExit¶

public static final void tapenadeExit(int exitCode)¶

tapenadeHome¶

public static String tapenadeHome()¶

Returns: The $TAPENADE_HOME directory.

toolError¶

public static final void toolError(String message)¶: Message that indicates a serious error in Tapenade implementation.

toolWarning¶

public static final void toolWarning(int inverseSeverity, String message)¶

Message that indicates a problem with Tapenade implementation, but Tapenade will try to go on. e.g. “Unexpected operator” or “not yet implemented”.

Parameters

inverseSeverity – Indicates problem severity, from 0 (very serious) up (less and less serious). May also be -1, in which case the message is always shown.

traceADDeps¶

public static final TapList<String> traceADDeps()¶

traceActivity¶

public static final TapList<String> traceActivity()¶

traceCurAnalysis¶

public static final boolean traceCurAnalysis()¶: True when we want to trace the current analysis on-the-fly.

traceDeps¶

public static final TapList<String> traceDeps()¶

traceDiffLiveness¶

public static final TapList<String> traceDiffLiveness()¶

traceFlowGraphBuild¶

public static final TapList<String> traceFlowGraphBuild()¶

traceInOut¶

public static final TapList<String> traceInOut()¶

traceIndent¶

public static final int traceIndent()¶

traceInlineAnalysis¶

public static final boolean traceInlineAnalysis()¶

traceInputIL¶

public static final boolean traceInputIL()¶

traceMultithread¶

public static final TapList<String> traceMultithread()¶

tracePointer¶

public static final TapList<String> tracePointer()¶

traceReqExplicit¶

public static final TapList<String> traceReqExplicit()¶

traceTBR¶

public static final TapList<String> traceTBR()¶

traceThisCallArrow¶

public static final boolean traceThisCallArrow(CallArrow arrow)¶

traceTypeCheckAnalysis¶

public static final boolean traceTypeCheckAnalysis()¶

updateTapEnvInclude¶

public static final void updateTapEnvInclude(Tree tree)¶

useSharpInclude¶

public static final boolean useSharpInclude()¶

valid¶

public static final boolean valid()¶

warningFortran77WithFortran90Features¶

public static final void warningFortran77WithFortran90Features(Unit unit)¶