.. java:import:: fr.inria.tapenade.analysis ReachAnalyzer

.. java:import:: fr.inria.tapenade.analysis ADActivityAnalyzer

.. java:import:: fr.inria.tapenade.analysis ADTBRAnalyzer

.. java:import:: fr.inria.tapenade.analysis MultithreadAnalyzer

.. java:import:: fr.inria.tapenade.analysis ActivityPattern

.. java:import:: fr.inria.tapenade.analysis DepsAnalyzer

.. java:import:: fr.inria.tapenade.analysis DiffLivenessAnalyzer

.. java:import:: fr.inria.tapenade.analysis ReqExplicit

.. java:import:: fr.inria.tapenade.differentiation CallGraphDifferentiator

.. java:import:: fr.inria.tapenade.frontend GeneralLibReader

.. java:import:: fr.inria.tapenade.frontend Parser

.. java:import:: fr.inria.tapenade.frontend TreeProtocol

.. java:import:: fr.inria.tapenade.gui TapenadeFrame

.. java:import:: fr.inria.tapenade.ir2tree TreeGen

.. java:import:: fr.inria.tapenade.prettyprint CDecompiler

.. java:import:: fr.inria.tapenade.prettyprint CallGraphDisplayer

.. java:import:: fr.inria.tapenade.prettyprint Decompiler

.. java:import:: fr.inria.tapenade.prettyprint DotDecompiler

.. java:import:: fr.inria.tapenade.prettyprint FortranDecompiler

.. java:import:: fr.inria.tapenade.prettyprint HtmlPrinter

.. java:import:: fr.inria.tapenade.prettyprint TextPrinter

.. java:import:: fr.inria.tapenade.representation Block

.. java:import:: fr.inria.tapenade.representation CStuff

.. java:import:: fr.inria.tapenade.representation CallGraph

.. java:import:: fr.inria.tapenade.representation DiffPattern

.. java:import:: fr.inria.tapenade.representation DiffRoot

.. java:import:: fr.inria.tapenade.representation Directive

.. java:import:: fr.inria.tapenade.representation FlowGraphBuilder

.. java:import:: fr.inria.tapenade.representation FortranStuff

.. java:import:: fr.inria.tapenade.representation ILUtils

.. java:import:: fr.inria.tapenade.representation Instruction

.. java:import:: fr.inria.tapenade.representation MPIcallInfo

.. java:import:: fr.inria.tapenade.representation MixedLanguageInfos

.. java:import:: fr.inria.tapenade.representation PositionAndMessage

.. java:import:: fr.inria.tapenade.representation SymbolDecl

.. java:import:: fr.inria.tapenade.representation SymbolTable

.. java:import:: fr.inria.tapenade.representation SymbolTableConstants

.. java:import:: fr.inria.tapenade.representation TapEnv

.. java:import:: fr.inria.tapenade.representation TapList

.. java:import:: fr.inria.tapenade.representation Unit

.. java:import:: fr.inria.tapenade.utils Chrono

.. java:import:: fr.inria.tapenade.utils ILLang

.. java:import:: fr.inria.tapenade.utils TapIntList

.. java:import:: fr.inria.tapenade.utils TapPair

.. java:import:: fr.inria.tapenade.utils TapTriplet

.. java:import:: fr.inria.tapenade.utils ToBool

.. java:import:: fr.inria.tapenade.utils Tree

.. java:import:: java.io BufferedInputStream

.. java:import:: java.io BufferedOutputStream

.. java:import:: java.io BufferedReader

.. java:import:: java.io File

.. java:import:: java.io FileNotFoundException

.. java:import:: java.io FileReader

.. java:import:: java.io IOException

.. java:import:: java.io InputStream

.. java:import:: java.io OutputStream

.. java:import:: java.io PrintStream

.. java:import:: java.io PrintWriter

.. java:import:: java.util Enumeration

.. java:import:: java.util StringTokenizer

.. java:import:: java.util.zip ZipEntry

.. java:import:: java.util.zip ZipFile

Tapenade
========

.. java:package:: fr.inria.tapenade.toplevel
   :noindex:

.. java:type:: public final class Tapenade

   Top class for Tapenade. Contains the "main" method.

Fields
------
TAPENADE_GEN_HTML_DIR
^^^^^^^^^^^^^^^^^^^^^

.. java:field:: protected static final String TAPENADE_GEN_HTML_DIR
   :outertype: Tapenade

TAPENADE_SERVLET_OUTPUT_DIR
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. java:field:: protected static final String TAPENADE_SERVLET_OUTPUT_DIR
   :outertype: Tapenade

diffRoots
^^^^^^^^^

.. java:field:: protected TapList<DiffRoot> diffRoots
   :outertype: Tapenade

   Hatted TapList of DiffRoot objects. The hat itself is used as a pointer to the current "diffRoot" of interest, so that isolated "-vars" or "-outvars" arguments will affect this current "diffRoot" defined by a previous "-root" option.

dumpFileName
^^^^^^^^^^^^

.. java:field:: protected String dumpFileName
   :outertype: Tapenade

htmlMessageFileName
^^^^^^^^^^^^^^^^^^^

.. java:field:: protected String htmlMessageFileName
   :outertype: Tapenade

textMessageFileName
^^^^^^^^^^^^^^^^^^^

.. java:field:: protected String textMessageFileName
   :outertype: Tapenade

Constructors
------------
Tapenade
^^^^^^^^

.. java:constructor:: protected Tapenade(int fileLang, String aliParser, int diffmode, String webAppRoot, String absoluteDirectory, String clientDirectory, String[] inputfilenames, String libDirectory, String headFunction, String activevariables, String usefulvariables, boolean multiDirDiffMode)
   :outertype: Tapenade

   Creation of one "Tapenade" for the servlet.

Methods
-------
analyzeFile
^^^^^^^^^^^

.. java:method:: protected boolean analyzeFile() throws IOException
   :outertype: Tapenade

cssDir
^^^^^^

.. java:method:: protected String cssDir()
   :outertype: Tapenade

   :return: Html css directory for html output.

diffCallGraph
^^^^^^^^^^^^^

.. java:method:: protected CallGraph diffCallGraph()
   :outertype: Tapenade

dumpDataFlow
^^^^^^^^^^^^

.. java:method:: public void dumpDataFlow()
   :outertype: Tapenade

   Dump the static data-flow info on each Unit for dumpUnitNames

dumpZones
^^^^^^^^^

.. java:method:: public void dumpZones()
   :outertype: Tapenade

   Dump the zones of each SymbolTable for dumpUnitNames

extractFiles
^^^^^^^^^^^^

.. java:method:: protected static String[] extractFiles(String directory, String filename)
   :outertype: Tapenade

   Extracts files contained in an archive file.

   :param directory: directory containing archive file.
   :param filename: archive file name (with .zip or .jar suffix).
   :return: file names contained in archive file.

generateListInputFiles
^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public static TapList<TapPair<String, Integer>> generateListInputFiles(String[] fnames, int[] flanguages)
   :outertype: Tapenade

getTransformedSourceUnits
^^^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: protected TapList<Unit> getTransformedSourceUnits(TapList<TapPair<Unit, TapList<Unit>>> differentiationAssociations)
   :outertype: Tapenade

   Collect the source CallGraph Units that have at least one differentiated counterpart.

main
^^^^

.. java:method:: public static void main(String[] args)
   :outertype: Tapenade

   Called by bin/tapenade shell script.

   :param args: provided by user.

origCallGraph
^^^^^^^^^^^^^

.. java:method:: protected CallGraph origCallGraph()
   :outertype: Tapenade

   When differentiating, holds the CallGraph of the original, non differentiated code.

parseFiles
^^^^^^^^^^

.. java:method:: public static void parseFiles(boolean addDirectory, String directory, TapList<TapPair<String, Integer>> inputFiles, CallGraph origCallGraph, TapList<String> includeDirs, int defaultFormat, boolean parseOpenMP) throws IOException
   :outertype: Tapenade

   Parses all the source files into the given CallGraph.

   :param addDirectory: if true. localInputFileNames are in directory.
   :param directory: directory.
   :param inputFiles: TapList of pairs of full path of input files and their inputlanguages.
   :param origCallGraph: current callGraph.
   :param includeDirs: include directories.
   :param parseOpenMP: OpenMP option for fortran parser.
   :throws IOException: if an input error is detected.

preProcess
^^^^^^^^^^

.. java:method:: public static CallGraph preProcess(String[] files)
   :outertype: Tapenade