<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>FAUST compiler: doc.cpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>doc.cpp File Reference</h1>
<p>Implementation of documentation trees support and printing.
<a href="#_details">More...</a></p>
<code>#include <stdio.h></code><br/>
<code>#include <string.h></code><br/>
<code>#include <errno.h></code><br/>
<code>#include <sys/stat.h></code><br/>
<code>#include <time.h></code><br/>
<code>#include <algorithm></code><br/>
<code>#include <functional></code><br/>
<code>#include <iostream></code><br/>
<code>#include <fstream></code><br/>
<code>#include <sstream></code><br/>
<code>#include <map></code><br/>
<code>#include <string></code><br/>
<code>#include <vector></code><br/>
<code>#include "<a class="el" href="ppbox_8hh_source.html">ppbox.hh</a>"</code><br/>
<code>#include "<a class="el" href="prim2_8hh_source.html">prim2.hh</a>"</code><br/>
<code>#include "<a class="el" href="doc_8cpp_source.html">doc.hh</a>"</code><br/>
<code>#include "<a class="el" href="tlib_8hh_source.html">tlib.hh</a>"</code><br/>
<code>#include "<a class="el" href="eval_8hh_source.html">eval.hh</a>"</code><br/>
<code>#include "<a class="el" href="errormsg_8hh_source.html">errormsg.hh</a>"</code><br/>
<code>#include "<a class="el" href="sigprint_8hh_source.html">sigprint.hh</a>"</code><br/>
<code>#include "<a class="el" href="propagate_8hh_source.html">propagate.hh</a>"</code><br/>
<code>#include "<a class="el" href="enrobage_8hh_source.html">enrobage.hh</a>"</code><br/>
<code>#include "<a class="el" href="drawschema_8hh_source.html">drawschema.hh</a>"</code><br/>
<code>#include "<a class="el" href="names_8hh_source.html">names.hh</a>"</code><br/>
<code>#include "<a class="el" href="simplify_8hh_source.html">simplify.hh</a>"</code><br/>
<code>#include "<a class="el" href="privatise_8hh_source.html">privatise.hh</a>"</code><br/>
<code>#include "<a class="el" href="recursivness_8hh_source.html">recursivness.hh</a>"</code><br/>
<code>#include "<a class="el" href="sourcereader_8hh_source.html">sourcereader.hh</a>"</code><br/>
<code>#include <list></code><br/>
<code>#include "<a class="el" href="sigtyperules_8hh_source.html">sigtyperules.hh</a>"</code><br/>
<code>#include "<a class="el" href="occurences_8hh_source.html">occurences.hh</a>"</code><br/>
<code>#include "<a class="el" href="property_8hh_source.html">property.hh</a>"</code><br/>
<code>#include "<a class="el" href="signals_8hh_source.html">signals.hh</a>"</code><br/>
<code>#include "<a class="el" href="lateq_8hh_source.html">lateq.hh</a>"</code><br/>
<code>#include "<a class="el" href="Text_8hh_source.html">Text.hh</a>"</code><br/>
<code>#include "<a class="el" href="doc__Text_8hh_source.html">doc_Text.hh</a>"</code><br/>
<code>#include "<a class="el" href="description_8hh_source.html">description.hh</a>"</code><br/>
<code>#include "<a class="el" href="compatibility_8hh_source.html">compatibility.hh</a>"</code><br/>
<div class="dynheader">
Include dependency graph for doc.cpp:</div>
<div class="dynsection">
</div>
<div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dynsection">
</div>
<p><a href="doc_8cpp_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a55ee21aeba68dbe17ffd10e4fd626690">MAXIDCHARS</a> 5</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">max numbers (characters) to represent ids (e.g. for directories). <a href="#a55ee21aeba68dbe17ffd10e4fd626690"></a><br/></td></tr>
<tr><td colspan="2"><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <a class="el" href="doc_8cpp.html#a06fc87d81c62e9abb8790b6e5713c55bacd4a5f05b5182f1dd17c1dff36320e76">langEN</a>,
<a class="el" href="doc_8cpp.html#a06fc87d81c62e9abb8790b6e5713c55ba351b19daff41efb007e9e538a6729a5c">langFR</a>,
<a class="el" href="doc_8cpp.html#a06fc87d81c62e9abb8790b6e5713c55ba9dfea5c4f4879fd1e8ea0656f442cc59">langIT</a>
}</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a2ca219c50890ea7db162df03fcc9b799">printdocheader</a> (ostream &docout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print the dynamic visible header, in a LaTeX "tabular" environment. <a href="#a2ca219c50890ea7db162df03fcc9b799"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a06e9e0c3a7caa845483c8ced3afccf4d">printlatexheader</a> (istream &latexheader, ostream &docout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a static LaTeX header. <a href="#a06e9e0c3a7caa845483c8ced3afccf4d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a9ca06818fbc5569e6ba2beeb8c4ca38a">printfaustlistings</a> (ostream &docout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print listings of each Faust code ".dsp" files, calling the 'printfaustlisting' function. <a href="#a9ca06818fbc5569e6ba2beeb8c4ca38a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a9b7ec85e7bc000dc74a58a44b893a82d">printfaustlisting</a> (string &faustfile, ostream &docout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a listing of the Faust code, in a LaTeX "listing" environment. <a href="#a9b7ec85e7bc000dc74a58a44b893a82d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#aca5cd842cbf22e8d931752073744be45">printlatexfooter</a> (ostream &docout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print the static LaTeX footer. <a href="#aca5cd842cbf22e8d931752073744be45"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#abda5dcd1f0ce42df1ebd6896188db07c">printdoccontent</a> (const char *svgTopDir, const vector< <a class="el" href="classCTree.html">Tree</a> > &docVector, const string &faustversion, ostream &docout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Main documentator loop. <a href="#abda5dcd1f0ce42df1ebd6896188db07c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#aa8c8181fc55b942a887b1a7ad1bc8426">printfaustdocstamp</a> (const string &faustversion, ostream &docout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a "doc stamp" in the LaTeX document :</p>
<ul>
<li>the Faust version,</li>
<li>the date of doc compilation,</li>
<li>faust's web site URL. </li>
</ul>
<a href="#aa8c8181fc55b942a887b1a7ad1bc8426"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a9c0f85706b52c4c57bfe6f54875c3813">printDocEqn</a> (<a class="el" href="classLateq.html">Lateq</a> *ltq, ostream &docout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print doc equations, following the <a class="el" href="classLateq.html#a21dbc72f648ae58202a45996f5d5527e" title="Top-level method to print a whole set of compiled LaTeX formulas.">Lateq::println</a> method. <a href="#a9c0f85706b52c4c57bfe6f54875c3813"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a90774f58d14494c245c5003211c98a00">printDocDgm</a> (const <a class="el" href="classCTree.html">Tree</a> expr, const char *svgTopDir, ostream &docout, int i)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Doc diagrams handling. <a href="#a90774f58d14494c245c5003211c98a00"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#afa7596184f452ff056cbd6d0290b9dca">prepareDocEqns</a> (const vector< <a class="el" href="classCTree.html">Tree</a> > &docBoxes, vector< <a class="el" href="classLateq.html">Lateq</a> * > &docCompiledEqnsVector)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Caller function. <a href="#afa7596184f452ff056cbd6d0290b9dca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a8f96b34e1e673115ba649660bbf214eb">collectDocEqns</a> (const vector< <a class="el" href="classCTree.html">Tree</a> > &docBoxes, vector< <a class="el" href="classCTree.html">Tree</a> > &eqBoxes)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">step 0. Feed doceqnInfosVector. <a href="#a8f96b34e1e673115ba649660bbf214eb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a5682d0a758c84ec80d20145b83c6ce2f">mapEvalDocEqn</a> (const vector< <a class="el" href="classCTree.html">Tree</a> > &eqBoxes, const <a class="el" href="classCTree.html">Tree</a> &env, vector< <a class="el" href="classCTree.html">Tree</a> > &evalEqBoxes)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">step 1. Evaluate boxes. <a href="#a5682d0a758c84ec80d20145b83c6ce2f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a47ecfaa24354f79ef7b9b37c3ea0744d">mapGetEqName</a> (const vector< <a class="el" href="classCTree.html">Tree</a> > &evalEqBoxes, vector< string > &eqNames)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">step 2. Get boxes name. <a href="#a47ecfaa24354f79ef7b9b37c3ea0744d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a2b66e4aa1fc586d461378d44dce359de">calcEqnsNicknames</a> (const vector< string > &eqNames, vector< string > &eqNicknames)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">step 3. Calculate nicknames. <a href="#a2b66e4aa1fc586d461378d44dce359de"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#ad9ae7b77b222a446be950f6668e177a0">mapPrepareEqSig</a> (const vector< <a class="el" href="classCTree.html">Tree</a> > &evalEqBoxes, vector< int > &eqInputs, vector< int > &eqOutputs, vector< <a class="el" href="classCTree.html">Tree</a> > &eqSigs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">step 4&5. Propagate and prepare signals. <a href="#ad9ae7b77b222a446be950f6668e177a0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a84c0256c7510f01e97886d9174f05ff0">mapSetSigNickname</a> (const vector< string > &eqNicknames, const vector< int > &eqInputs, const vector< <a class="el" href="classCTree.html">Tree</a> > &eqSigs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">step 6. Set signals nicknames. <a href="#a84c0256c7510f01e97886d9174f05ff0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a3e31ebbced12828da219b955542cdc27">collectEqSigs</a> (const vector< <a class="el" href="classCTree.html">Tree</a> > &eqSigs, <a class="el" href="classCTree.html">Tree</a> &superEqList)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">step 7. Collect all signals in a superlist. <a href="#a3e31ebbced12828da219b955542cdc27"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a22864a1de755e55e1745d94835f4693e">annotateSuperList</a> (<a class="el" href="classDocCompiler.html">DocCompiler</a> *DC, <a class="el" href="classCTree.html">Tree</a> superEqList)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">step 8. Annotate superlist. <a href="#a22864a1de755e55e1745d94835f4693e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a8ea0ae61d941bbbebcd46d210d30356a">mapCompileDocEqnSigs</a> (const vector< <a class="el" href="classCTree.html">Tree</a> > &eqSigs, const vector< int > &eqInputs, const vector< int > &eqOutputs, <a class="el" href="classDocCompiler.html">DocCompiler</a> *DC, vector< <a class="el" href="classLateq.html">Lateq</a> * > &docCompiledEqnsVector)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">step 10. Compile equations. <a href="#a8ea0ae61d941bbbebcd46d210d30356a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a7347482365f605a414da25751bf1946f">calcNumberedName</a> (const char *base, int i)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Simply concat a string with a number in a "%03d" format. <a href="#a7347482365f605a414da25751bf1946f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a5ea5adac1568a1c91ea6f674a5eccef9">getBoxInputsAndOutputs</a> (const <a class="el" href="classCTree.html">Tree</a> t, int &numInputs, int &numOutputs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Just get the number of inputs and the number of outputs of a box. <a href="#a5ea5adac1568a1c91ea6f674a5eccef9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#abe0d6d1a67c5c2bd4e5cac7f6d021ca8">calcDocEqnInitial</a> (const string s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calculate an appropriate nickname for equations, from previous names. <a href="#abe0d6d1a67c5c2bd4e5cac7f6d021ca8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a3fb97c3dc5609c5e01797548c69ff295">initCompilationDate</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static struct tm * </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a0a871f44fa7d57075fcc6e7f835ba913">getCompilationDate</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#aa993eaaab62326b7ec82db3ac19d420c">cholddir</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Switch back to the previously stored current directory. <a href="#aa993eaaab62326b7ec82db3ac19d420c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a4ba32ce8ec678ffbdf068a4483543239">mkchdir</a> (const char *dirname)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new directory in the current one, then 'cd' into this new directory. <a href="#a4ba32ce8ec678ffbdf068a4483543239"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a39b3d8237212f926fd704b35fcb7becd">makedir</a> (const char *dirname)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new directory in the current one. <a href="#a39b3d8237212f926fd704b35fcb7becd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a93f175441540044bcefdcd1a8736d43b">getCurrentDir</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get current directory and store it in gCurrentDir. <a href="#a93f175441540044bcefdcd1a8736d43b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static istream * </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a56d99634f77c578d4704e016bfe61331">openArchFile</a> (const string &filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open architecture file. <a href="#a56d99634f77c578d4704e016bfe61331"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static char * </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a6fa98093fdea396358b0ea4e20e3821d">legalFileName</a> (const <a class="el" href="classCTree.html">Tree</a> t, int n, char *dst)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Transform the definition name property of tree <t> into a legal file name. <a href="#a6fa98093fdea396358b0ea4e20e3821d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a016b1cbb37d2aee62272c6c955e4e078">rmExternalDoubleQuotes</a> (const string &s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the leading and trailing double quotes of a string (but not those in the middle of the string). <a href="#a016b1cbb37d2aee62272c6c955e4e078"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a375460f577b0036b379b7fbba6c328ae">copyFaustSources</a> (const char *projname, const vector< string > &pathnames)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy all Faust source files into an 'src' subdirectory. <a href="#a375460f577b0036b379b7fbba6c328ae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCTree.html">Tree</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a3ef69c2f85a3c6ae95968d7563b4aff2">docTxt</a> (const char *name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#ad0b394e474b1e452e44de4b7e7dbb106">isDocTxt</a> (<a class="el" href="classCTree.html">Tree</a> t)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a9e03bef81fde4e2714cf8525d65eafe1">isDocTxt</a> (<a class="el" href="classCTree.html">Tree</a> t0, const char **str)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCTree.html">Tree</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a74f8c842c37fd8d9e01b397d79abe117">docEqn</a> (<a class="el" href="classCTree.html">Tree</a> x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a8f5e00372043167fc1d7fe12532a020e">isDocEqn</a> (<a class="el" href="classCTree.html">Tree</a> t, <a class="el" href="classCTree.html">Tree</a> &x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCTree.html">Tree</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#aa454efefb0dc22ade70352eee0fdb9ff">docDgm</a> (<a class="el" href="classCTree.html">Tree</a> x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#adb0333bf59f0c1891e28e6b21b3060a1">isDocDgm</a> (<a class="el" href="classCTree.html">Tree</a> t, <a class="el" href="classCTree.html">Tree</a> &x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCTree.html">Tree</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a8d813459bc7fcb5ceba9c07ca205d1f1">docNtc</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#ac6cfa5258d1a4a0c52d636615be62a50">isDocNtc</a> (<a class="el" href="classCTree.html">Tree</a> t)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCTree.html">Tree</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a6710f31a71806f69ac8cf5c7933c4fa6">docLst</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#ae3a40683ffbfc5c9a8af59be69241d40">isDocLst</a> (<a class="el" href="classCTree.html">Tree</a> t)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a8c5b3a35aaf051de7ed2a8e480a010f4">printDoc</a> (const char *projname, const char *docdev, const char *faustversion)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The entry point to generate faust doc files. <a href="#a8c5b3a35aaf051de7ed2a8e480a010f4"></a><br/></td></tr>
<tr><td colspan="2"><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCTree.html">Tree</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a52086e1c3e02821c4ce3f5a0626c2662">gExpandedDefList</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">map< <a class="el" href="classCTree.html">Tree</a>, set< <a class="el" href="classCTree.html">Tree</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#aaf647729deae314d35817ccb36f088e4">gMetaDataSet</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">map< string, string > </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#aa19e3a2853a131a2165ddead4a0e565d">gDocMetadatasStringMap</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a4741733b16ad8f554a8b5c0ca5045d14">gDetailsSwitch</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a88af9e6ad20008837e470be54b69437c">gStripDocSwitch</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a320fc936026f318a3fc46f47ef379713">gFaustDirectory</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a2529dab7cac84bd8f69c14ee8a3cbfe2">gFaustSuperDirectory</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a09fc40a224a32f929decbac5a21140ef">gFaustSuperSuperDirectory</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a1c0fac9c77fcd7f4e21daf398e9830de">gMasterDocument</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSourceReader.html">SourceReader</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#af59bae68e0652dd8c1ecbf661cbe8373">gReader</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a90baf99fd6ffa7248d895c7d33e0a8cf">gDocName</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Contains the filename for out documentation. <a href="#a90baf99fd6ffa7248d895c7d33e0a8cf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a1023cd82d29af98e7692cd9b7784e94e">gDocDevSuffix</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">".tex" (or .??? - used to choose output device). <a href="#a1023cd82d29af98e7692cd9b7784e94e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a0c91ed41a90a100a2570f4d993c6e16a">gCurrentDir</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Room to save current directory name. <a href="#a0c91ed41a90a100a2570f4d993c6e16a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const string </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#ac656ad6ba04fe2497fce8da01ae10a73">gLatexheaderfilename</a> = "latexheader.tex"</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="classCTree.html">Tree</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a7c306e8c82617863fda51d2c1158f5ab">gDocVector</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Contains <mdoc> parsed trees: DOCTXT, DOCEQN, DOCDGM. <a href="#a7c306e8c82617863fda51d2c1158f5ab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static struct tm </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#ae57fb3f71c6b5070eaf01b4c6837ff1b">gCompilationDate</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#ac83dd0bfbc11705a903a395da7bc0f7c">gDocLang</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSymbol.html">Sym</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a3ce37f9c0c4f9e071cc70dcf1f82e1f5">DOCTXT</a> = symbol ("DocTxt")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSymbol.html">Sym</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a4d2c444fea45c353d1efc09220d6d903">DOCEQN</a> = symbol ("DocEqn")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSymbol.html">Sym</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a7114bcd8618d179b0ad442ea7d2a9b8b">DOCDGM</a> = symbol ("DocDgm")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSymbol.html">Sym</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a46fd57f16ddd4d6b43b5a289cfa97339">DOCNTC</a> = symbol ("DocNtc")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSymbol.html">Sym</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8cpp.html#a5224d7cd7a847f4bc17652432c50fac0">DOCLST</a> = symbol ("DocLst")</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Implementation of documentation trees support and printing. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Karim Barkati and Yann Orlarey </dd></dl>
<dl class="version"><dt><b>Version:</b></dt><dd>1.0 </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2009 </dd></dl>
<p>Definition in file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="a55ee21aeba68dbe17ffd10e4fd626690"></a><!-- doxytag: member="doc.cpp::MAXIDCHARS" ref="a55ee21aeba68dbe17ffd10e4fd626690" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MAXIDCHARS 5</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>max numbers (characters) to represent ids (e.g. for directories). </p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00083">83</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00985">calcNumberedName()</a>, and <a class="el" href="doc_8cpp_source.html#l00829">printDocDgm()</a>.</p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="a06fc87d81c62e9abb8790b6e5713c55b"></a><!-- doxytag: member="doc.cpp::@0" ref="a06fc87d81c62e9abb8790b6e5713c55b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a06fc87d81c62e9abb8790b6e5713c55bacd4a5f05b5182f1dd17c1dff36320e76"></a><!-- doxytag: member="langEN" ref="a06fc87d81c62e9abb8790b6e5713c55bacd4a5f05b5182f1dd17c1dff36320e76" args="" -->langEN</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a06fc87d81c62e9abb8790b6e5713c55ba351b19daff41efb007e9e538a6729a5c"></a><!-- doxytag: member="langFR" ref="a06fc87d81c62e9abb8790b6e5713c55ba351b19daff41efb007e9e538a6729a5c" args="" -->langFR</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a06fc87d81c62e9abb8790b6e5713c55ba9dfea5c4f4879fd1e8ea0656f442cc59"></a><!-- doxytag: member="langIT" ref="a06fc87d81c62e9abb8790b6e5713c55ba9dfea5c4f4879fd1e8ea0656f442cc59" args="" -->langIT</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00112">112</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00112"></a>00112 { <a class="code" href="doc_8cpp.html#a06fc87d81c62e9abb8790b6e5713c55bacd4a5f05b5182f1dd17c1dff36320e76">langEN</a>, <a class="code" href="doc_8cpp.html#a06fc87d81c62e9abb8790b6e5713c55ba351b19daff41efb007e9e538a6729a5c">langFR</a>, <a class="code" href="doc_8cpp.html#a06fc87d81c62e9abb8790b6e5713c55ba9dfea5c4f4879fd1e8ea0656f442cc59">langIT</a> };
</pre></div></p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a22864a1de755e55e1745d94835f4693e"></a><!-- doxytag: member="doc.cpp::annotateSuperList" ref="a22864a1de755e55e1745d94835f4693e" args="(DocCompiler *DC, Tree superEqList)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void annotateSuperList </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDocCompiler.html">DocCompiler</a> * </td>
<td class="paramname"> <em>DC</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCTree.html">Tree</a> </td>
<td class="paramname"> <em>superEqList</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>step 8. Annotate superlist. </p>
<p>#8.</p>
<p>Annotate superEqList (to find candidate signals to be named later).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>DC</em> </td><td>The signals compiler. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>superEqList</em> </td><td>The super equations signal tree to annotate. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00719">719</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="doc__compile_8cpp_source.html#l00091">DocCompiler::annotate()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00505">prepareDocEqns()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00720"></a>00720 {
<a name="l00721"></a>00721 DC-><a class="code" href="classDocCompiler.html#aca50ec463d1edd5445f51783cb65ae76">annotate</a>(superEqList);
<a name="l00722"></a>00722 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="abe0d6d1a67c5c2bd4e5cac7f6d021ca8"></a><!-- doxytag: member="doc.cpp::calcDocEqnInitial" ref="abe0d6d1a67c5c2bd4e5cac7f6d021ca8" args="(const string s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static string calcDocEqnInitial </td>
<td>(</td>
<td class="paramtype">const string </td>
<td class="paramname"> <em>s</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Calculate an appropriate nickname for equations, from previous names. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>The</em> </td><td>string to parse. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Essentially returns the initial character, except "Y" for "process", and "Z" for unnamed equations. </dd></dl>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00770">770</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00605">calcEqnsNicknames()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00771"></a>00771 {
<a name="l00772"></a>00772 <span class="keywordtype">string</span> nn;
<a name="l00773"></a>00773 <span class="keywordflow">if</span>(s == <span class="stringliteral">"process"</span>)
<a name="l00774"></a>00774 nn = <span class="stringliteral">"Y"</span>;
<a name="l00775"></a>00775 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (s.substr(0,6) == <span class="stringliteral">"doceqn"</span>)
<a name="l00776"></a>00776 nn = <span class="stringliteral">"Z"</span>;
<a name="l00777"></a>00777 <span class="keywordflow">else</span>
<a name="l00778"></a>00778 nn += toupper(s[0]);
<a name="l00779"></a>00779 <span class="keywordflow">return</span> nn;
<a name="l00780"></a>00780 }
</pre></div></p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a2b66e4aa1fc586d461378d44dce359de"></a><!-- doxytag: member="doc.cpp::calcEqnsNicknames" ref="a2b66e4aa1fc586d461378d44dce359de" args="(const vector< string > &eqNames, vector< string > &eqNicknames)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void calcEqnsNicknames </td>
<td>(</td>
<td class="paramtype">const vector< string > & </td>
<td class="paramname"> <em>eqNames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vector< string > & </td>
<td class="paramname"> <em>eqNicknames</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>step 3. Calculate nicknames. </p>
<p>#3.</p>
<p>Calculate a nickname for each equation and store it.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>eqNames</em> </td><td>Equations names to parse. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>eqNicknames</em> </td><td>The place to store calculated nicknames.</td></tr>
</table>
</dd>
</dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Should check unicity : check whether several names share the same initial, or else capture consonants for example. </dd></dl>
<p><p>Check duplicates </p>
</p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00605">605</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="doc_8cpp_source.html#l00770">calcDocEqnInitial()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00505">prepareDocEqns()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00606"></a>00606 {
<a name="l00607"></a>00607 <span class="comment">//cerr << "###\n# Documentator : calcEqnsNicknames" << endl;</span>
<a name="l00608"></a>00608
<a name="l00609"></a>00609 vector<string> v;
<a name="l00610"></a>00610
<a name="l00611"></a>00611 <span class="keywordflow">for</span>( vector<string>::const_iterator eq = eqNames.begin(); eq < eqNames.end(); eq++ ) {
<a name="l00612"></a>00612 <span class="keywordtype">string</span> init = <a class="code" href="doc_8cpp.html#abe0d6d1a67c5c2bd4e5cac7f6d021ca8" title="Calculate an appropriate nickname for equations, from previous names.">calcDocEqnInitial</a>(*eq);
<a name="l00613"></a>00613 v.push_back(init);
<a name="l00615"></a>00615 <span class="comment">// for( vector<string>::iterator it = v.begin(); it < v.end()-1; ++it ) {</span>
<a name="l00616"></a>00616 <span class="comment">// if (init == *it) {</span>
<a name="l00617"></a>00617 <span class="comment">// //cerr << "!! Warning Documentator : calcEqnsNicknames : duplicates \"" << init << "\"" << endl;</span>
<a name="l00618"></a>00618 <span class="comment">// }</span>
<a name="l00619"></a>00619 <span class="comment">// }</span>
<a name="l00620"></a>00620 eqNicknames.push_back(init);
<a name="l00621"></a>00621 }
<a name="l00622"></a>00622
<a name="l00623"></a>00623 <span class="comment">// for( vector<string>::const_iterator eq = eqNames.begin(); eq < eqNames.end(); eq++ ) {</span>
<a name="l00624"></a>00624 <span class="comment">// int c = 0;</span>
<a name="l00625"></a>00625 <span class="comment">// c = count_if(eqNames.begin(), eqNames.end(), bind2nd(equal_to<string>(), *eq));</span>
<a name="l00626"></a>00626 <span class="comment">// if (c > 0) { </span>
<a name="l00627"></a>00627 <span class="comment">// cerr << "- Duplicate nickname !! " << *eq << endl; </span>
<a name="l00628"></a>00628 <span class="comment">// } else {</span>
<a name="l00629"></a>00629 <span class="comment">// cerr << "(no duplicate) " << *eq << endl;</span>
<a name="l00630"></a>00630 <span class="comment">// }</span>
<a name="l00631"></a>00631 <span class="comment">// }</span>
<a name="l00632"></a>00632
<a name="l00633"></a>00633 <span class="comment">//cerr << "Documentator : end of calcEqnsNicknames\n---" << endl;</span>
<a name="l00634"></a>00634 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a7347482365f605a414da25751bf1946f"></a><!-- doxytag: member="doc.cpp::calcNumberedName" ref="a7347482365f605a414da25751bf1946f" args="(const char *base, int i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static string calcNumberedName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>base</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Simply concat a string with a number in a "%03d" format. </p>
<p>The number has MAXIDCHARS characters. </p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00985">985</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="doc_8cpp_source.html#l00083">MAXIDCHARS</a>, and <a class="el" href="Text_8cpp_source.html#l00060">subst()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00575">mapGetEqName()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00986"></a>00986 {
<a name="l00987"></a>00987 <span class="keywordtype">char</span> nb[<a class="code" href="doc_8cpp.html#a55ee21aeba68dbe17ffd10e4fd626690" title="max numbers (characters) to represent ids (e.g. for directories).">MAXIDCHARS</a>+1];
<a name="l00988"></a>00988 sprintf(nb, <span class="stringliteral">"%03d"</span>, i);
<a name="l00989"></a>00989 <span class="keywordflow">return</span> <a class="code" href="Text_8cpp.html#af50e951c134c2c98c4c75d687f8fca7a">subst</a>(<span class="stringliteral">"$0$1"</span>, base, nb);
<a name="l00990"></a>00990 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="aa993eaaab62326b7ec82db3ac19d420c"></a><!-- doxytag: member="doc.cpp::cholddir" ref="aa993eaaab62326b7ec82db3ac19d420c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int cholddir </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Switch back to the previously stored current directory. </p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00917">917</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="doc_8cpp_source.html#l00105">gCurrentDir</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00941">openArchFile()</a>, and <a class="el" href="doc_8cpp_source.html#l00216">printDoc()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00918"></a>00918 {
<a name="l00919"></a>00919 <span class="keywordflow">if</span> (chdir(<a class="code" href="doc_8cpp.html#a0c91ed41a90a100a2570f4d993c6e16a" title="Room to save current directory name.">gCurrentDir</a>.c_str()) == 0) {
<a name="l00920"></a>00920 <span class="keywordflow">return</span> 0;
<a name="l00921"></a>00921 } <span class="keywordflow">else</span> {
<a name="l00922"></a>00922 perror(<span class="stringliteral">"cholddir"</span>);
<a name="l00923"></a>00923 exit(errno);
<a name="l00924"></a>00924 }
<a name="l00925"></a>00925 }
</pre></div></p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a8f96b34e1e673115ba649660bbf214eb"></a><!-- doxytag: member="doc.cpp::collectDocEqns" ref="a8f96b34e1e673115ba649660bbf214eb" args="(const vector< Tree > &docBoxes, vector< Tree > &eqBoxes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void collectDocEqns </td>
<td>(</td>
<td class="paramtype">const vector< <a class="el" href="classCTree.html">Tree</a> > & </td>
<td class="paramname"> <em>docBoxes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vector< <a class="el" href="classCTree.html">Tree</a> > & </td>
<td class="paramname"> <em>eqBoxes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>step 0. Feed doceqnInfosVector. </p>
<p>#0.</p>
<p>Collect every <equation> found in all <mdoc> faust comments.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>docBoxes</em> </td><td>The <mdoc> boxes to filter. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>eqBoxes</em> </td><td>The place to store only <equation> boxes. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00531">531</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="faustlexer_8cpp_source.html#l00744">doc</a>, <a class="el" href="list_8hh_source.html#l00133">hd()</a>, <a class="el" href="doc_8cpp_source.html#l00181">isDocEqn()</a>, <a class="el" href="list_8hh_source.html#l00138">isList()</a>, <a class="el" href="list_8cpp_source.html#l00240">reverse()</a>, and <a class="el" href="list_8hh_source.html#l00134">tl()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00505">prepareDocEqns()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00532"></a>00532 {
<a name="l00533"></a>00533 <span class="keywordtype">int</span> nbdoceqn = 0;
<a name="l00534"></a>00534
<a name="l00535"></a>00535 <span class="keywordflow">for</span> (vector<Tree>::const_iterator <a class="code" href="faustlexer_8cpp.html#a96015589396b70e34698a0887a19ad0a">doc</a>=docBoxes.begin(); <a class="code" href="faustlexer_8cpp.html#a96015589396b70e34698a0887a19ad0a">doc</a><docBoxes.end(); <a class="code" href="faustlexer_8cpp.html#a96015589396b70e34698a0887a19ad0a">doc</a>++) {
<a name="l00536"></a>00536 <a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> L = <a class="code" href="list_8cpp.html#a8e15f8d6fcc6cd319059c2e0544145bb">reverse</a>(*<a class="code" href="faustlexer_8cpp.html#a96015589396b70e34698a0887a19ad0a">doc</a>);
<a name="l00537"></a>00537 <a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> expr;
<a name="l00538"></a>00538 <span class="keywordflow">while</span> (<a class="code" href="list_8hh.html#a8bdd73641276e0c0f999f504348eacc1">isList</a>(L)) {
<a name="l00539"></a>00539 <span class="keywordflow">if</span> ( <a class="code" href="doc_8cpp.html#a8f5e00372043167fc1d7fe12532a020e">isDocEqn</a>(<a class="code" href="list_8hh.html#a067ad6f83087b420a1c44e48e56be389">hd</a>(L), expr) ) {
<a name="l00540"></a>00540 eqBoxes.push_back(expr);
<a name="l00541"></a>00541 nbdoceqn++;
<a name="l00542"></a>00542 }
<a name="l00543"></a>00543 L = <a class="code" href="list_8hh.html#a4075748f5c7156306ec898795313a2e0">tl</a>(L);
<a name="l00544"></a>00544 }
<a name="l00545"></a>00545 }
<a name="l00546"></a>00546 <span class="comment">//cerr << "Documentator : collectDocEqns : " << nbdoceqn << " <equation> tags found." << endl;</span>
<a name="l00547"></a>00547 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a3e31ebbced12828da219b955542cdc27"></a><!-- doxytag: member="doc.cpp::collectEqSigs" ref="a3e31ebbced12828da219b955542cdc27" args="(const vector< Tree > &eqSigs, Tree &superEqList)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void collectEqSigs </td>
<td>(</td>
<td class="paramtype">const vector< <a class="el" href="classCTree.html">Tree</a> > & </td>
<td class="paramname"> <em>eqSigs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCTree.html">Tree</a> & </td>
<td class="paramname"> <em>superEqList</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>step 7. Collect all signals in a superlist. </p>
<p>#7.</p>
<p>Collect each prepared list of signals to construct a super list.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>eqSigs</em> </td><td>Contains well-prepared and nicknamed signals. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>superEqList</em> </td><td>The root where to 'cons' signals all together. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00698">698</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="list_8hh_source.html#l00124">cons()</a>, and <a class="el" href="list_8cpp_source.html#l00116">nil</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00505">prepareDocEqns()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00699"></a>00699 {
<a name="l00700"></a>00700 <span class="comment">//cerr << "###\n# Documentator : collectEqSigs" << endl;</span>
<a name="l00701"></a>00701
<a name="l00702"></a>00702 superEqList = <a class="code" href="list_8cpp.html#a538b704dd07794b7237108f1917c471e">nil</a>;
<a name="l00703"></a>00703
<a name="l00704"></a>00704 <span class="keywordflow">for</span>( vector<Tree>::const_iterator it = eqSigs.begin(); it < eqSigs.end(); ++it ) {
<a name="l00705"></a>00705 superEqList = <a class="code" href="list_8hh.html#ae1ed153946fcfc025009c6d9c9c40bee">cons</a>( *it, superEqList );
<a name="l00706"></a>00706 }
<a name="l00707"></a>00707 <span class="comment">//printSignal(superEqList, stdout, 0);</span>
<a name="l00708"></a>00708
<a name="l00709"></a>00709 <span class="comment">//cerr << endl << "Documentator : end of collectEqSigs\n---" << endl;</span>
<a name="l00710"></a>00710 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a375460f577b0036b379b7fbba6c328ae"></a><!-- doxytag: member="doc.cpp::copyFaustSources" ref="a375460f577b0036b379b7fbba6c328ae" args="(const char *projname, const vector< string > &pathnames)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void copyFaustSources </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>projname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const vector< string > & </td>
<td class="paramname"> <em>pathnames</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy all Faust source files into an 'src' subdirectory. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>projname</em> </td><td>Basename of the new doc directory ("*-math"). </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pathnames</em> </td><td>The paths list of the source files to copy. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l01015">1015</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="enrobage_8cpp_source.html#l00316">filebasename()</a>, <a class="el" href="doc_8cpp_source.html#l00873">makedir()</a>, and <a class="el" href="Text_8cpp_source.html#l00060">subst()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00216">printDoc()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l01016"></a>01016 {
<a name="l01017"></a>01017 <span class="keywordtype">string</span> srcdir = <a class="code" href="Text_8cpp.html#af50e951c134c2c98c4c75d687f8fca7a">subst</a>(<span class="stringliteral">"$0/src"</span>, projname);
<a name="l01018"></a>01018 <span class="comment">//cerr << "Documentator : copyFaustSources : Creating directory '" << srcdir << "'" << endl;</span>
<a name="l01019"></a>01019 <a class="code" href="doc_8cpp.html#a39b3d8237212f926fd704b35fcb7becd" title="Create a new directory in the current one.">makedir</a>(srcdir.c_str()); <span class="comment">// create a directory.</span>
<a name="l01020"></a>01020
<a name="l01021"></a>01021 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i< pathnames.size(); i++) {
<a name="l01022"></a>01022 ifstream src;
<a name="l01023"></a>01023 ofstream dst;
<a name="l01024"></a>01024 <span class="keywordtype">string</span> faustfile = pathnames[i];
<a name="l01025"></a>01025 <span class="keywordtype">string</span> copy = <a class="code" href="Text_8cpp.html#af50e951c134c2c98c4c75d687f8fca7a">subst</a>(<span class="stringliteral">"$0/$1"</span>, srcdir, <a class="code" href="enrobage_8cpp.html#a73496d20a5f06ebb81a3ce1cc6d39877">filebasename</a>(faustfile.c_str()));
<a name="l01026"></a>01026 <span class="comment">//cerr << "Documentator : copyFaustSources : Opening input file '" << faustfile << "'" << endl;</span>
<a name="l01027"></a>01027 <span class="comment">//cerr << "Documentator : copyFaustSources : Opening output file '" << copy << "'" << endl;</span>
<a name="l01028"></a>01028 src.open(faustfile.c_str(), ifstream::in);
<a name="l01029"></a>01029 dst.open(copy.c_str(), ofstream::out);
<a name="l01030"></a>01030 <span class="keywordtype">string</span> s;
<a name="l01031"></a>01031 <span class="keywordflow">while</span> ( getline(src,s) ) dst << s << endl;
<a name="l01032"></a>01032 }
<a name="l01033"></a>01033 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="aa454efefb0dc22ade70352eee0fdb9ff"></a><!-- doxytag: member="doc.cpp::docDgm" ref="aa454efefb0dc22ade70352eee0fdb9ff" args="(Tree x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCTree.html">Tree</a> docDgm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCTree.html">Tree</a> </td>
<td class="paramname"> <em>x</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00184">184</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="tree_8hh_source.html#l00173">tree()</a>.</p>
<p>Referenced by <a class="el" href="doc__autodoc_8cpp_source.html#l00058">declareAutoDoc()</a>, and <a class="el" href="faustparser_8cpp_source.html#l01621">yyparse()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00184"></a>00184 { <span class="keywordflow">return</span> <a class="code" href="tree_8hh.html#a61c13e9361cfa80bbb3cd6ce60a8f595">tree</a>(<a class="code" href="doc_8cpp.html#a7114bcd8618d179b0ad442ea7d2a9b8b">DOCDGM</a>, x); }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a74f8c842c37fd8d9e01b397d79abe117"></a><!-- doxytag: member="doc.cpp::docEqn" ref="a74f8c842c37fd8d9e01b397d79abe117" args="(Tree x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCTree.html">Tree</a> docEqn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCTree.html">Tree</a> </td>
<td class="paramname"> <em>x</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00180">180</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="tree_8hh_source.html#l00173">tree()</a>.</p>
<p>Referenced by <a class="el" href="doc__autodoc_8cpp_source.html#l00058">declareAutoDoc()</a>, and <a class="el" href="faustparser_8cpp_source.html#l01621">yyparse()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00180"></a>00180 { <span class="keywordflow">return</span> <a class="code" href="tree_8hh.html#a61c13e9361cfa80bbb3cd6ce60a8f595">tree</a>(<a class="code" href="doc_8cpp.html#a4d2c444fea45c353d1efc09220d6d903">DOCEQN</a>, x); }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a6710f31a71806f69ac8cf5c7933c4fa6"></a><!-- doxytag: member="doc.cpp::docLst" ref="a6710f31a71806f69ac8cf5c7933c4fa6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCTree.html">Tree</a> docLst </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00192">192</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="tree_8hh_source.html#l00173">tree()</a>.</p>
<p>Referenced by <a class="el" href="doc__autodoc_8cpp_source.html#l00058">declareAutoDoc()</a>, and <a class="el" href="faustparser_8cpp_source.html#l01621">yyparse()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00192"></a>00192 { <span class="keywordflow">return</span> <a class="code" href="tree_8hh.html#a61c13e9361cfa80bbb3cd6ce60a8f595">tree</a>(<a class="code" href="doc_8cpp.html#a5224d7cd7a847f4bc17652432c50fac0">DOCLST</a>); }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a8d813459bc7fcb5ceba9c07ca205d1f1"></a><!-- doxytag: member="doc.cpp::docNtc" ref="a8d813459bc7fcb5ceba9c07ca205d1f1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCTree.html">Tree</a> docNtc </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00188">188</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="tree_8hh_source.html#l00173">tree()</a>.</p>
<p>Referenced by <a class="el" href="doc__autodoc_8cpp_source.html#l00058">declareAutoDoc()</a>, and <a class="el" href="faustparser_8cpp_source.html#l01621">yyparse()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00188"></a>00188 { <span class="keywordflow">return</span> <a class="code" href="tree_8hh.html#a61c13e9361cfa80bbb3cd6ce60a8f595">tree</a>(<a class="code" href="doc_8cpp.html#a46fd57f16ddd4d6b43b5a289cfa97339">DOCNTC</a>); }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a3ef69c2f85a3c6ae95968d7563b4aff2"></a><!-- doxytag: member="doc.cpp::docTxt" ref="a3ef69c2f85a3c6ae95968d7563b4aff2" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCTree.html">Tree</a> docTxt </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00166">166</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="symbol_8hh_source.html#l00095">symbol()</a>, and <a class="el" href="tree_8hh_source.html#l00173">tree()</a>.</p>
<p>Referenced by <a class="el" href="doc__autodoc_8cpp_source.html#l00058">declareAutoDoc()</a>, and <a class="el" href="faustparser_8cpp_source.html#l01621">yyparse()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00166"></a>00166 { <span class="keywordflow">return</span> <a class="code" href="tree_8hh.html#a61c13e9361cfa80bbb3cd6ce60a8f595">tree</a>( <a class="code" href="doc_8cpp.html#a3ce37f9c0c4f9e071cc70dcf1f82e1f5">DOCTXT</a>, <a class="code" href="tree_8hh.html#a61c13e9361cfa80bbb3cd6ce60a8f595">tree</a>(<a class="code" href="symbol_8hh.html#aaa87083235b70d1042e59ae25e0800d8" title="Returns (and creates if new) the symbol of name str.">symbol</a>(<a class="code" href="symbol_8hh.html#a8243134fbbd9d924ebbb3f833922e310" title="Returns the name of a symbol.">name</a>)) ); }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a5ea5adac1568a1c91ea6f674a5eccef9"></a><!-- doxytag: member="doc.cpp::getBoxInputsAndOutputs" ref="a5ea5adac1568a1c91ea6f674a5eccef9" args="(const Tree t, int &numInputs, int &numOutputs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void getBoxInputsAndOutputs </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCTree.html">Tree</a> </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>numInputs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>numOutputs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Just get the number of inputs and the number of outputs of a box. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>t</em> </td><td>The box tree to get inputs and outputs from. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>numInputs</em> </td><td>The place to store the number of inputs. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>numOutputs</em> </td><td>The place to store the number of outputs. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00790">790</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="boxtype_8cpp_source.html#l00063">getBoxType()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00645">mapPrepareEqSig()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00791"></a>00791 {
<a name="l00792"></a>00792 <span class="keywordflow">if</span> (!<a class="code" href="boxes_8hh.html#ac5c10eb592a85ecba6d6990f9f78010d" title="Return the type (number of inputs and outputs) of a box or false if undefined.">getBoxType</a>(t, &numInputs, &numOutputs)) {
<a name="l00793"></a>00793 cerr << <span class="stringliteral">"ERROR during the evaluation of t : "</span> << <a class="code" href="classboxpp.html">boxpp</a>(t) << endl;
<a name="l00794"></a>00794 exit(1);
<a name="l00795"></a>00795 }
<a name="l00796"></a>00796 <span class="comment">//cerr << "Documentator : " << numInputs <<" inputs and " << numOutputs <<" outputs for box : " << boxpp(t) << endl;</span>
<a name="l00797"></a>00797 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a0a871f44fa7d57075fcc6e7f835ba913"></a><!-- doxytag: member="doc.cpp::getCompilationDate" ref="a0a871f44fa7d57075fcc6e7f835ba913" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static struct tm * getCompilationDate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static, read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l01047">1047</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="doc_8cpp_source.html#l00110">gCompilationDate</a>, and <a class="el" href="doc_8cpp_source.html#l01039">initCompilationDate()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00413">printfaustdocstamp()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l01048"></a>01048 {
<a name="l01049"></a>01049 <a class="code" href="doc_8cpp.html#a3fb97c3dc5609c5e01797548c69ff295">initCompilationDate</a>();
<a name="l01050"></a>01050 <span class="keywordflow">return</span> &<a class="code" href="doc_8cpp.html#ae57fb3f71c6b5070eaf01b4c6837ff1b">gCompilationDate</a>;
<a name="l01051"></a>01051 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a93f175441540044bcefdcd1a8736d43b"></a><!-- doxytag: member="doc.cpp::getCurrentDir" ref="a93f175441540044bcefdcd1a8736d43b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void getCurrentDir </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get current directory and store it in gCurrentDir. </p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00931">931</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="compatibility_8hh_source.html#l00052">FAUST_PATH_MAX</a>, and <a class="el" href="doc_8cpp_source.html#l00105">gCurrentDir</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00941">openArchFile()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00932"></a>00932 {
<a name="l00933"></a>00933 <span class="keywordtype">char</span> buffer[<a class="code" href="compatibility_8hh.html#a3bf18fd70de2efe183049cb028875fe2">FAUST_PATH_MAX</a>];
<a name="l00934"></a>00934 <a class="code" href="doc_8cpp.html#a0c91ed41a90a100a2570f4d993c6e16a" title="Room to save current directory name.">gCurrentDir</a> = getcwd (buffer, <a class="code" href="compatibility_8hh.html#a3bf18fd70de2efe183049cb028875fe2">FAUST_PATH_MAX</a>);
<a name="l00935"></a>00935 }
</pre></div></p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a3fb97c3dc5609c5e01797548c69ff295"></a><!-- doxytag: member="doc.cpp::initCompilationDate" ref="a3fb97c3dc5609c5e01797548c69ff295" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void initCompilationDate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l01039">1039</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="doc_8cpp_source.html#l00110">gCompilationDate</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l01047">getCompilationDate()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l01040"></a>01040 {
<a name="l01041"></a>01041 time_t now;
<a name="l01042"></a>01042
<a name="l01043"></a>01043 time(&now);
<a name="l01044"></a>01044 <a class="code" href="doc_8cpp.html#ae57fb3f71c6b5070eaf01b4c6837ff1b">gCompilationDate</a> = *localtime(&now);
<a name="l01045"></a>01045 }
</pre></div></p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="adb0333bf59f0c1891e28e6b21b3060a1"></a><!-- doxytag: member="doc.cpp::isDocDgm" ref="adb0333bf59f0c1891e28e6b21b3060a1" args="(Tree t, Tree &x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isDocDgm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCTree.html">Tree</a> </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCTree.html">Tree</a> & </td>
<td class="paramname"> <em>x</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00185">185</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="tree_8cpp_source.html#l00319">isTree()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00445">printdoccontent()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00185"></a>00185 { <span class="keywordflow">return</span> <a class="code" href="tree_8cpp.html#a06be972e0437c7c09e8a1274586fe176">isTree</a>(t, <a class="code" href="doc_8cpp.html#a7114bcd8618d179b0ad442ea7d2a9b8b">DOCDGM</a>, x); }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a8f5e00372043167fc1d7fe12532a020e"></a><!-- doxytag: member="doc.cpp::isDocEqn" ref="a8f5e00372043167fc1d7fe12532a020e" args="(Tree t, Tree &x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isDocEqn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCTree.html">Tree</a> </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCTree.html">Tree</a> & </td>
<td class="paramname"> <em>x</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00181">181</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="tree_8cpp_source.html#l00319">isTree()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00531">collectDocEqns()</a>, and <a class="el" href="doc_8cpp_source.html#l00445">printdoccontent()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00181"></a>00181 { <span class="keywordflow">return</span> <a class="code" href="tree_8cpp.html#a06be972e0437c7c09e8a1274586fe176">isTree</a>(t, <a class="code" href="doc_8cpp.html#a4d2c444fea45c353d1efc09220d6d903">DOCEQN</a>, x); }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="ae3a40683ffbfc5c9a8af59be69241d40"></a><!-- doxytag: member="doc.cpp::isDocLst" ref="ae3a40683ffbfc5c9a8af59be69241d40" args="(Tree t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isDocLst </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCTree.html">Tree</a> </td>
<td class="paramname"> <em>t</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00193">193</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="tree_8cpp_source.html#l00319">isTree()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00445">printdoccontent()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00193"></a>00193 { <span class="keywordflow">return</span> <a class="code" href="tree_8cpp.html#a06be972e0437c7c09e8a1274586fe176">isTree</a>(t, <a class="code" href="doc_8cpp.html#a5224d7cd7a847f4bc17652432c50fac0">DOCLST</a>); }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="ac6cfa5258d1a4a0c52d636615be62a50"></a><!-- doxytag: member="doc.cpp::isDocNtc" ref="ac6cfa5258d1a4a0c52d636615be62a50" args="(Tree t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isDocNtc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCTree.html">Tree</a> </td>
<td class="paramname"> <em>t</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00189">189</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="tree_8cpp_source.html#l00319">isTree()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00445">printdoccontent()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00189"></a>00189 { <span class="keywordflow">return</span> <a class="code" href="tree_8cpp.html#a06be972e0437c7c09e8a1274586fe176">isTree</a>(t, <a class="code" href="doc_8cpp.html#a46fd57f16ddd4d6b43b5a289cfa97339">DOCNTC</a>); }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a9e03bef81fde4e2714cf8525d65eafe1"></a><!-- doxytag: member="doc.cpp::isDocTxt" ref="a9e03bef81fde4e2714cf8525d65eafe1" args="(Tree t0, const char **str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isDocTxt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCTree.html">Tree</a> </td>
<td class="paramname"> <em>t0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"> <em>str</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00168">168</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="node_8hh_source.html#l00193">isSym()</a>, <a class="el" href="tree_8cpp_source.html#l00319">isTree()</a>, <a class="el" href="symbol_8hh_source.html#l00098">name()</a>, and <a class="el" href="tree_8hh_source.html#l00141">CTree::node()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00169"></a>00169 {
<a name="l00170"></a>00170 <a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> t1; <a class="code" href="classSymbol.html" title="Symbols are unique objects with a name stored in a hash table.">Sym</a> s;
<a name="l00171"></a>00171 <span class="keywordflow">if</span> ( <a class="code" href="tree_8cpp.html#a06be972e0437c7c09e8a1274586fe176">isTree</a>(t0, <a class="code" href="doc_8cpp.html#a3ce37f9c0c4f9e071cc70dcf1f82e1f5">DOCTXT</a>, t1) && <a class="code" href="node_8hh.html#ab714e75c43d570297ff54578dc7e9ce3">isSym</a>(t1-><a class="code" href="classCTree.html#a8de786fec095c8304b9ffa7c1c316237" title="return the content of the tree">node</a>(), &s) ) {
<a name="l00172"></a>00172 *str = <a class="code" href="symbol_8hh.html#a8243134fbbd9d924ebbb3f833922e310" title="Returns the name of a symbol.">name</a>(s);
<a name="l00173"></a>00173 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00174"></a>00174 } <span class="keywordflow">else</span> {
<a name="l00175"></a>00175 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00176"></a>00176 }
<a name="l00177"></a>00177 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="ad0b394e474b1e452e44de4b7e7dbb106"></a><!-- doxytag: member="doc.cpp::isDocTxt" ref="ad0b394e474b1e452e44de4b7e7dbb106" args="(Tree t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isDocTxt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCTree.html">Tree</a> </td>
<td class="paramname"> <em>t</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00167">167</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="tree_8hh_source.html#l00141">CTree::node()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00445">printdoccontent()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00167"></a>00167 { <span class="keywordflow">return</span> t-><a class="code" href="classCTree.html#a8de786fec095c8304b9ffa7c1c316237" title="return the content of the tree">node</a>() == <a class="code" href="classNode.html" title="Class Node = (type x (int + double + Sym + void*)).">Node</a>(<a class="code" href="doc_8cpp.html#a3ce37f9c0c4f9e071cc70dcf1f82e1f5">DOCTXT</a>); }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a6fa98093fdea396358b0ea4e20e3821d"></a><!-- doxytag: member="doc.cpp::legalFileName" ref="a6fa98093fdea396358b0ea4e20e3821d" args="(const Tree t, int n, char *dst)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static char * legalFileName </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCTree.html">Tree</a> </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>dst</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Transform the definition name property of tree <t> into a legal file name. </p>
<p>The resulting file name is stored in <dst> a table of at least <n> chars. Returns the <dst> pointer for convenience. </p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00963">963</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="names_8cpp_source.html#l00085">getDefNameProperty()</a>, and <a class="el" href="tree_8cpp_source.html#l00292">tree2str()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00829">printDocDgm()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00964"></a>00964 {
<a name="l00965"></a>00965 <a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> id;
<a name="l00966"></a>00966 <span class="keywordtype">int</span> i=0;
<a name="l00967"></a>00967 <span class="keywordflow">if</span> (<a class="code" href="names_8cpp.html#afa6f89a686c004f84729e2bca7bf2053" title="Indicates the identifier (if any) the expression was a definition of.">getDefNameProperty</a>(t, <span class="keywordtype">id</span>)) {
<a name="l00968"></a>00968 <span class="keyword">const</span> <span class="keywordtype">char</span>* src = <a class="code" href="tree_8cpp.html#ac753d60778175e30a86cba647db017ad" title="if t has a node of type symbol, return its name otherwise error">tree2str</a>(<span class="keywordtype">id</span>);
<a name="l00969"></a>00969 <span class="keywordflow">for</span> (i=0; isalnum(src[i]) && i<16; i++) {
<a name="l00970"></a>00970 dst[i] = src[i];
<a name="l00971"></a>00971 }
<a name="l00972"></a>00972 }
<a name="l00973"></a>00973 dst[i] = 0;
<a name="l00974"></a>00974 <span class="keywordflow">if</span> (strcmp(dst, <span class="stringliteral">"process"</span>) != 0) {
<a name="l00975"></a>00975 <span class="comment">// if it is not process add the hex address to make the name unique</span>
<a name="l00976"></a>00976 snprintf(&dst[i], n-i, <span class="stringliteral">"-%p"</span>, t);
<a name="l00977"></a>00977 }
<a name="l00978"></a>00978 <span class="keywordflow">return</span> dst;
<a name="l00979"></a>00979 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a39b3d8237212f926fd704b35fcb7becd"></a><!-- doxytag: member="doc.cpp::makedir" ref="a39b3d8237212f926fd704b35fcb7becd" args="(const char *dirname)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int makedir </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>dirname</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new directory in the current one. </p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00873">873</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="compatibility_8hh_source.html#l00052">FAUST_PATH_MAX</a>, and <a class="el" href="doc_8cpp_source.html#l00105">gCurrentDir</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l01015">copyFaustSources()</a>, and <a class="el" href="doc_8cpp_source.html#l00216">printDoc()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00874"></a>00874 {
<a name="l00875"></a>00875 <span class="keywordtype">char</span> buffer[<a class="code" href="compatibility_8hh.html#a3bf18fd70de2efe183049cb028875fe2">FAUST_PATH_MAX</a>];
<a name="l00876"></a>00876 <a class="code" href="doc_8cpp.html#a0c91ed41a90a100a2570f4d993c6e16a" title="Room to save current directory name.">gCurrentDir</a> = getcwd (buffer, <a class="code" href="compatibility_8hh.html#a3bf18fd70de2efe183049cb028875fe2">FAUST_PATH_MAX</a>);
<a name="l00877"></a>00877
<a name="l00878"></a>00878 <span class="keywordflow">if</span> ( <a class="code" href="doc_8cpp.html#a0c91ed41a90a100a2570f4d993c6e16a" title="Room to save current directory name.">gCurrentDir</a>.c_str() != 0) {
<a name="l00879"></a>00879 <span class="keywordtype">int</span> status = mkdir(<a class="code" href="main_8cpp.html#a678e1ef3077e128e543805a7381066f9">dirname</a>, S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
<a name="l00880"></a>00880 <span class="keywordflow">if</span> (status == 0 || errno == EEXIST) {
<a name="l00881"></a>00881 <span class="keywordflow">return</span> 0;
<a name="l00882"></a>00882 }
<a name="l00883"></a>00883 }
<a name="l00884"></a>00884 perror(<span class="stringliteral">"makedir"</span>);
<a name="l00885"></a>00885 exit(errno);
<a name="l00886"></a>00886 }
</pre></div></p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a8ea0ae61d941bbbebcd46d210d30356a"></a><!-- doxytag: member="doc.cpp::mapCompileDocEqnSigs" ref="a8ea0ae61d941bbbebcd46d210d30356a" args="(const vector< Tree > &eqSigs, const vector< int > &eqInputs, const vector< int > &eqOutputs, DocCompiler *DC, vector< Lateq * > &docCompiledEqnsVector)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void mapCompileDocEqnSigs </td>
<td>(</td>
<td class="paramtype">const vector< <a class="el" href="classCTree.html">Tree</a> > & </td>
<td class="paramname"> <em>eqSigs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const vector< int > & </td>
<td class="paramname"> <em>eqInputs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const vector< int > & </td>
<td class="paramname"> <em>eqOutputs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDocCompiler.html">DocCompiler</a> * </td>
<td class="paramname"> <em>DC</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vector< <a class="el" href="classLateq.html">Lateq</a> * > & </td>
<td class="paramname"> <em>docCompiledEqnsVector</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>step 10. Compile equations. </p>
<p>#9.</p>
<p>Calculated and set lateq (LaTeX equation) names. Note : Transfered into mapCompileDocEqnSigs (DocCompiler::compileMultiSignal). #10. Name and compile prepared doc <equation> signals.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>eqSigs</em> </td><td>Contains well-prepared and nicknamed signals. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>DC</em> </td><td>The signals compiler. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>docCompiledEqnsVector</em> </td><td>The place to store each compiled Lateq* object. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00742">742</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="doc__compile_8cpp_source.html#l00105">DocCompiler::compileLateq()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00505">prepareDocEqns()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00743"></a>00743 {
<a name="l00744"></a>00744 <span class="comment">//cerr << "###\n# Documentator : mapCompileDocEqnSigs" << endl;</span>
<a name="l00745"></a>00745
<a name="l00746"></a>00746 <span class="keywordflow">for</span>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i < eqSigs.size(); i++ ) {
<a name="l00747"></a>00747
<a name="l00748"></a>00748 <span class="comment">// docCompiledEqnsVector.push_back( DC->compileMultiSignal(*it, 0) );</span>
<a name="l00749"></a>00749 docCompiledEqnsVector.push_back( DC-><a class="code" href="classDocCompiler.html#a951fa6dc2e893e0407cb3b544f3c9a2a">compileLateq</a>(eqSigs[i], <span class="keyword">new</span> <a class="code" href="classLateq.html">Lateq</a>(eqInputs[i], eqOutputs[i])) );
<a name="l00750"></a>00750 }
<a name="l00751"></a>00751
<a name="l00752"></a>00752 <span class="comment">//cerr << "Documentator : end of mapCompileDocEqnSigs\n---" << endl;</span>
<a name="l00753"></a>00753 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a5682d0a758c84ec80d20145b83c6ce2f"></a><!-- doxytag: member="doc.cpp::mapEvalDocEqn" ref="a5682d0a758c84ec80d20145b83c6ce2f" args="(const vector< Tree > &eqBoxes, const Tree &env, vector< Tree > &evalEqBoxes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void mapEvalDocEqn </td>
<td>(</td>
<td class="paramtype">const vector< <a class="el" href="classCTree.html">Tree</a> > & </td>
<td class="paramname"> <em>eqBoxes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCTree.html">Tree</a> & </td>
<td class="paramname"> <em>env</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vector< <a class="el" href="classCTree.html">Tree</a> > & </td>
<td class="paramname"> <em>evalEqBoxes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>step 1. Evaluate boxes. </p>
<p>#1.</p>
<p>Evaluate every doc <equation> (evaluation replaces abstractions by symbolic boxes).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>eqBoxes</em> </td><td>The boxes to evaluate. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>env</em> </td><td>The environment for the evaluation. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>evalEqBoxes</em> </td><td>The place to store evaluated equations boxes. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00557">557</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="eval_8cpp_source.html#l00110">evaldocexpr()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00505">prepareDocEqns()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00558"></a>00558 {
<a name="l00559"></a>00559 <span class="comment">//cerr << "###\n# Documentator : mapEvalDocEqn" << endl;</span>
<a name="l00560"></a>00560
<a name="l00561"></a>00561 <span class="keywordflow">for</span> ( vector<Tree>::const_iterator eq=eqBoxes.begin(); eq < eqBoxes.end(); eq++)
<a name="l00562"></a>00562 {
<a name="l00563"></a>00563 evalEqBoxes.push_back(<a class="code" href="eval_8cpp.html#a4d1e61c6742d24447d08bddbbe341c1f">evaldocexpr</a>( *eq, env ));
<a name="l00564"></a>00564 }
<a name="l00565"></a>00565 <span class="comment">//cerr << "Documentator : end of mapEvalDocEqn\n---" << endl;</span>
<a name="l00566"></a>00566 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a47ecfaa24354f79ef7b9b37c3ea0744d"></a><!-- doxytag: member="doc.cpp::mapGetEqName" ref="a47ecfaa24354f79ef7b9b37c3ea0744d" args="(const vector< Tree > &evalEqBoxes, vector< string > &eqNames)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void mapGetEqName </td>
<td>(</td>
<td class="paramtype">const vector< <a class="el" href="classCTree.html">Tree</a> > & </td>
<td class="paramname"> <em>evalEqBoxes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vector< string > & </td>
<td class="paramname"> <em>eqNames</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>step 2. Get boxes name. </p>
<p>#2.</p>
<p>Get name if exists, else create one, and store it.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>evalEqBoxes</em> </td><td>Evaluated box trees, eventually containing an equation name. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>eqNames</em> </td><td>The place to store equations names. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00575">575</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="doc_8cpp_source.html#l00985">calcNumberedName()</a>, <a class="el" href="boxtype_8cpp_source.html#l00063">getBoxType()</a>, <a class="el" href="names_8cpp_source.html#l00085">getDefNameProperty()</a>, and <a class="el" href="tree_8cpp_source.html#l00292">tree2str()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00505">prepareDocEqns()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00576"></a>00576 {
<a name="l00577"></a>00577 <span class="comment">//cerr << "###\n# Documentator : mapGetEqName" << endl;</span>
<a name="l00578"></a>00578
<a name="l00579"></a>00579 <span class="keywordtype">int</span> i = 1;
<a name="l00580"></a>00580 <span class="keywordflow">for</span>( vector<Tree>::const_iterator eq = evalEqBoxes.begin(); eq < evalEqBoxes.end(); eq++, i++ ) {
<a name="l00581"></a>00581 <a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> id;
<a name="l00582"></a>00582 <span class="keywordtype">string</span> s;
<a name="l00583"></a>00583 <span class="keywordtype">int</span> n,m; <a class="code" href="boxes_8hh.html#ac5c10eb592a85ecba6d6990f9f78010d" title="Return the type (number of inputs and outputs) of a box or false if undefined.">getBoxType</a>(*eq, &n, &m); <span class="comment">// eq name only for bd without inputs</span>
<a name="l00584"></a>00584 <span class="keywordflow">if</span> ( n==0 && <a class="code" href="names_8cpp.html#afa6f89a686c004f84729e2bca7bf2053" title="Indicates the identifier (if any) the expression was a definition of.">getDefNameProperty</a>(*eq, <span class="keywordtype">id</span>) ) {
<a name="l00585"></a>00585 s = <a class="code" href="tree_8cpp.html#ac753d60778175e30a86cba647db017ad" title="if t has a node of type symbol, return its name otherwise error">tree2str</a>(<span class="keywordtype">id</span>);
<a name="l00586"></a>00586 }
<a name="l00587"></a>00587 <span class="keywordflow">else</span> {
<a name="l00588"></a>00588 s = <a class="code" href="doc_8cpp.html#a7347482365f605a414da25751bf1946f" title="Simply concat a string with a number in a &quot;%03d&quot; format.">calcNumberedName</a>(<span class="stringliteral">"doceqn-"</span>, i);
<a name="l00589"></a>00589 }
<a name="l00590"></a>00590 eqNames.push_back( s ) ;
<a name="l00591"></a>00591 }
<a name="l00592"></a>00592 <span class="comment">//cerr << "Documentator : end of mapGetEqName\n---" << endl;</span>
<a name="l00593"></a>00593 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="ad9ae7b77b222a446be950f6668e177a0"></a><!-- doxytag: member="doc.cpp::mapPrepareEqSig" ref="ad9ae7b77b222a446be950f6668e177a0" args="(const vector< Tree > &evalEqBoxes, vector< int > &eqInputs, vector< int > &eqOutputs, vector< Tree > &eqSigs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void mapPrepareEqSig </td>
<td>(</td>
<td class="paramtype">const vector< <a class="el" href="classCTree.html">Tree</a> > & </td>
<td class="paramname"> <em>evalEqBoxes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vector< int > & </td>
<td class="paramname"> <em>eqInputs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vector< int > & </td>
<td class="paramname"> <em>eqOutputs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vector< <a class="el" href="classCTree.html">Tree</a> > & </td>
<td class="paramname"> <em>eqSigs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>step 4&5. Propagate and prepare signals. </p>
<p>#4&5.</p>
<p>Propagate and prepare every doc <equation>.</p>
<p>Call boxPropagateSig, deBruijn2Sym, simplify, and privatise.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>evalEqBoxes</em> </td><td>Equations boxes to propagate as signals. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>eqSigs</em> </td><td>The place to store prepared signals. </td></tr>
</table>
</dd>
</dl>
<p><p>< Convert debruijn recursion into symbolic recursion</p>
<p>< Simplify by executing every computable operation</p>
<p>< convert regular tables into special doctables (regular tables are difficult to translate to equations) </p>
</p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00645">645</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="propagate_8cpp_source.html#l00442">boxPropagateSig()</a>, <a class="el" href="recursive-tree_8cpp_source.html#l00223">deBruijn2Sym()</a>, <a class="el" href="simplify_8cpp_source.html#l00210">docTableConvertion()</a>, <a class="el" href="doc_8cpp_source.html#l00790">getBoxInputsAndOutputs()</a>, <a class="el" href="propagate_8cpp_source.html#l00096">makeSigInputList()</a>, <a class="el" href="list_8cpp_source.html#l00116">nil</a>, and <a class="el" href="simplify_8cpp_source.html#l00072">simplify()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00505">prepareDocEqns()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00646"></a>00646 {
<a name="l00647"></a>00647 <span class="comment">//cerr << "###\n# Documentator : mapPrepareEqSig" << endl;</span>
<a name="l00648"></a>00648
<a name="l00649"></a>00649 <span class="keywordflow">for</span>( vector<Tree>::const_iterator eq = evalEqBoxes.begin(); eq < evalEqBoxes.end(); eq++ ) {
<a name="l00650"></a>00650
<a name="l00651"></a>00651 <span class="keywordtype">int</span> numInputs, numOutputs;
<a name="l00652"></a>00652 <a class="code" href="doc_8cpp.html#a5ea5adac1568a1c91ea6f674a5eccef9" title="Just get the number of inputs and the number of outputs of a box.">getBoxInputsAndOutputs</a>(*eq, numInputs, numOutputs);
<a name="l00653"></a>00653 <span class="comment">//cerr << numInputs <<" ins and " << numOutputs <<" outs" << endl;</span>
<a name="l00654"></a>00654 eqInputs.push_back(numInputs);
<a name="l00655"></a>00655 eqOutputs.push_back(numOutputs);
<a name="l00656"></a>00656
<a name="l00657"></a>00657 <a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> lsig1 = <a class="code" href="propagate_8cpp.html#a2c94521fac4766648f41758d1be4b089">boxPropagateSig</a>( <a class="code" href="list_8cpp.html#a538b704dd07794b7237108f1917c471e">nil</a>, *eq , <a class="code" href="propagate_8cpp.html#a06328b74db9d4726b9144cf9da9a3a17" title="Fabrique une liste de n entrées.">makeSigInputList</a>(numInputs) );
<a name="l00658"></a>00658 <span class="comment">//cerr << "output signals are : " << endl; printSignal(lsig1, stderr);</span>
<a name="l00659"></a>00659
<a name="l00660"></a>00660 <a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> lsig2 = <a class="code" href="recursive-tree_8cpp.html#ab896f65486e6d80d4440721f2f89ff96">deBruijn2Sym</a>(lsig1);
<a name="l00661"></a>00661 <a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> lsig3 = <a class="code" href="simplify_8cpp.html#aa58ab1a209023cba186f077cfdcc5339">simplify</a>(lsig2);
<a name="l00662"></a>00662 <span class="comment">//Tree lsig4 = privatise(lsig3); ///< Un-share tables with multiple writers</span>
<a name="l00663"></a>00663 <a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> lsig4 = <a class="code" href="simplify_8cpp.html#a6a3298b9c61dc3351c7460dab1c9bbde">docTableConvertion</a>(lsig3);
<a name="l00664"></a>00664
<a name="l00665"></a>00665
<a name="l00666"></a>00666 eqSigs.push_back(lsig4);
<a name="l00667"></a>00667 }
<a name="l00668"></a>00668 <span class="comment">//cerr << "Documentator : end of mapPrepareEqSig\n---" << endl;</span>
<a name="l00669"></a>00669 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a84c0256c7510f01e97886d9174f05ff0"></a><!-- doxytag: member="doc.cpp::mapSetSigNickname" ref="a84c0256c7510f01e97886d9174f05ff0" args="(const vector< string > &eqNicknames, const vector< int > &eqInputs, const vector< Tree > &eqSigs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void mapSetSigNickname </td>
<td>(</td>
<td class="paramtype">const vector< string > & </td>
<td class="paramname"> <em>eqNicknames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const vector< int > & </td>
<td class="paramname"> <em>eqInputs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const vector< <a class="el" href="classCTree.html">Tree</a> > & </td>
<td class="paramname"> <em>eqSigs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>step 6. Set signals nicknames. </p>
<p>#6.</p>
<p>Set signals nicknames.</p>
<p>Do nothing for the moment ! </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>eqNicknames</em> </td><td>Contains previously calculated nicknames. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>eqSigs</em> </td><td>The signals to tag with a NICKNAMEPROPERTY. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00679">679</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00505">prepareDocEqns()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00680"></a>00680 {
<a name="l00681"></a>00681 <span class="comment">//cerr << "###\n# Documentator : mapSetSigNickname" << endl;</span>
<a name="l00682"></a>00682
<a name="l00683"></a>00683 <span class="comment">// Do nothing for the moment...</span>
<a name="l00684"></a>00684 <span class="comment">// for( unsigned int i=0; i < eqSigs.size(); i++ ) {</span>
<a name="l00685"></a>00685 <span class="comment">// if (eqInputs[i] == 0) // Only "generators" should be finally named with user equation (nick)name.</span>
<a name="l00686"></a>00686 <span class="comment">// setSigListNickName(eqSigs[i], eqNicknames[i]);</span>
<a name="l00687"></a>00687 <span class="comment">// }</span>
<a name="l00688"></a>00688 <span class="comment">//cerr << "Documentator : end of mapSetSigNickname\n---" << endl;</span>
<a name="l00689"></a>00689 }
</pre></div></p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a4ba32ce8ec678ffbdf068a4483543239"></a><!-- doxytag: member="doc.cpp::mkchdir" ref="a4ba32ce8ec678ffbdf068a4483543239" args="(const char *dirname)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int mkchdir </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>dirname</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new directory in the current one, then 'cd' into this new directory. </p>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>The current directory is saved to be later restaured. </dd></dl>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00896">896</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="compatibility_8hh_source.html#l00052">FAUST_PATH_MAX</a>, and <a class="el" href="doc_8cpp_source.html#l00105">gCurrentDir</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00216">printDoc()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00897"></a>00897 {
<a name="l00898"></a>00898 <span class="keywordtype">char</span> buffer[<a class="code" href="compatibility_8hh.html#a3bf18fd70de2efe183049cb028875fe2">FAUST_PATH_MAX</a>];
<a name="l00899"></a>00899 <a class="code" href="doc_8cpp.html#a0c91ed41a90a100a2570f4d993c6e16a" title="Room to save current directory name.">gCurrentDir</a> = getcwd (buffer, <a class="code" href="compatibility_8hh.html#a3bf18fd70de2efe183049cb028875fe2">FAUST_PATH_MAX</a>);
<a name="l00900"></a>00900
<a name="l00901"></a>00901 <span class="keywordflow">if</span> ( <a class="code" href="doc_8cpp.html#a0c91ed41a90a100a2570f4d993c6e16a" title="Room to save current directory name.">gCurrentDir</a>.c_str() != 0) {
<a name="l00902"></a>00902 <span class="keywordtype">int</span> status = mkdir(<a class="code" href="main_8cpp.html#a678e1ef3077e128e543805a7381066f9">dirname</a>, S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
<a name="l00903"></a>00903 <span class="keywordflow">if</span> (status == 0 || errno == EEXIST) {
<a name="l00904"></a>00904 <span class="keywordflow">if</span> (chdir(<a class="code" href="main_8cpp.html#a678e1ef3077e128e543805a7381066f9">dirname</a>) == 0) {
<a name="l00905"></a>00905 <span class="keywordflow">return</span> 0;
<a name="l00906"></a>00906 }
<a name="l00907"></a>00907 }
<a name="l00908"></a>00908 }
<a name="l00909"></a>00909 perror(<span class="stringliteral">"mkchdir"</span>);
<a name="l00910"></a>00910 exit(errno);
<a name="l00911"></a>00911 }
</pre></div></p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a56d99634f77c578d4704e016bfe61331"></a><!-- doxytag: member="doc.cpp::openArchFile" ref="a56d99634f77c578d4704e016bfe61331" args="(const string &filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static istream * openArchFile </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>filename</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open architecture file. </p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00941">941</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="doc_8cpp_source.html#l00917">cholddir()</a>, <a class="el" href="doc_8cpp_source.html#l00931">getCurrentDir()</a>, and <a class="el" href="enrobage_8cpp_source.html#l00069">open_arch_stream()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00216">printDoc()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00942"></a>00942 {
<a name="l00943"></a>00943 istream* file;
<a name="l00944"></a>00944 <a class="code" href="doc_8cpp.html#a93f175441540044bcefdcd1a8736d43b" title="Get current directory and store it in gCurrentDir.">getCurrentDir</a>(); <span class="comment">// Save the current directory.</span>
<a name="l00945"></a>00945 <span class="comment">//cerr << "Documentator : openArchFile : Opening input file '" << filename << "'" << endl;</span>
<a name="l00946"></a>00946 <span class="keywordflow">if</span> ( (file = <a class="code" href="enrobage_8cpp.html#a901a730cc8136f70a2073da23fafa61e" title="Try to open an architecture file searching in various directories.">open_arch_stream</a>(filename.c_str())) ) {
<a name="l00947"></a>00947 <span class="comment">//cerr << "Documentator : openArchFile : Opening '" << filename << "'" << endl;</span>
<a name="l00948"></a>00948 } <span class="keywordflow">else</span> {
<a name="l00949"></a>00949 cerr << <span class="stringliteral">"ERROR : can't open architecture file "</span> << filename << endl;
<a name="l00950"></a>00950 exit(1);
<a name="l00951"></a>00951 }
<a name="l00952"></a>00952 <a class="code" href="doc_8cpp.html#aa993eaaab62326b7ec82db3ac19d420c" title="Switch back to the previously stored current directory.">cholddir</a>(); <span class="comment">// Return to current directory.</span>
<a name="l00953"></a>00953 <span class="keywordflow">return</span> file;
<a name="l00954"></a>00954 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="afa7596184f452ff056cbd6d0290b9dca"></a><!-- doxytag: member="doc.cpp::prepareDocEqns" ref="afa7596184f452ff056cbd6d0290b9dca" args="(const vector< Tree > &docBoxes, vector< Lateq * > &docCompiledEqnsVector)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void prepareDocEqns </td>
<td>(</td>
<td class="paramtype">const vector< <a class="el" href="classCTree.html">Tree</a> > & </td>
<td class="paramname"> <em>docBoxes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vector< <a class="el" href="classLateq.html">Lateq</a> * > & </td>
<td class="paramname"> <em>docCompiledEqnsVector</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Caller function. </p>
<p>Caller function for all steps of doc equations preparation.</p>
<p>Note : many of the functions called put their result into their last argument in a "source / destination" manner, the "destination" being declared before the function call.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>docBoxes</em> </td><td>The <mdoc> boxes to collect and prepare. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>docCompiledEqnsVector</em> </td><td>The place to store compiled equations. </td></tr>
</table>
</dd>
</dl>
<p><p>< step 0. Feed doceqnInfosVector.</p>
<p>< step 1. Evaluate boxes.</p>
<p>< step 2. Get boxes name.</p>
<p>< step 3. Calculate nicknames.</p>
<p>< step 4&5. Propagate and prepare signals.</p>
<p>< step 6. Set signals nicknames.</p>
<p>< step 7. Collect all signals in a superlist.</p>
<p>< step 8. Annotate superEqList.</p>
<p>< step 10. Compile every signal. </p>
</p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00505">505</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="doc_8cpp_source.html#l00719">annotateSuperList()</a>, <a class="el" href="doc_8cpp_source.html#l00605">calcEqnsNicknames()</a>, <a class="el" href="doc_8cpp_source.html#l00531">collectDocEqns()</a>, <a class="el" href="doc_8cpp_source.html#l00698">collectEqSigs()</a>, <a class="el" href="doc_8cpp_source.html#l00742">mapCompileDocEqnSigs()</a>, <a class="el" href="doc_8cpp_source.html#l00557">mapEvalDocEqn()</a>, <a class="el" href="doc_8cpp_source.html#l00575">mapGetEqName()</a>, <a class="el" href="doc_8cpp_source.html#l00645">mapPrepareEqSig()</a>, and <a class="el" href="doc_8cpp_source.html#l00679">mapSetSigNickname()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00445">printdoccontent()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00506"></a>00506 {
<a name="l00507"></a>00507 vector<Tree> eqBoxes; <a class="code" href="doc_8cpp.html#a8f96b34e1e673115ba649660bbf214eb" title="step 0. Feed doceqnInfosVector.">collectDocEqns</a>( docBoxes, eqBoxes );
<a name="l00508"></a>00508 vector<Tree> evalEqBoxes; <a class="code" href="doc_8cpp.html#a5682d0a758c84ec80d20145b83c6ce2f" title="step 1. Evaluate boxes.">mapEvalDocEqn</a>( eqBoxes, <a class="code" href="doc_8cpp.html#a52086e1c3e02821c4ce3f5a0626c2662">gExpandedDefList</a>, evalEqBoxes );
<a name="l00509"></a>00509 vector<string> eqNames; <a class="code" href="doc_8cpp.html#a47ecfaa24354f79ef7b9b37c3ea0744d" title="step 2. Get boxes name.">mapGetEqName</a>( evalEqBoxes, eqNames );
<a name="l00510"></a>00510 vector<string> eqNicknames; <a class="code" href="doc_8cpp.html#a2b66e4aa1fc586d461378d44dce359de" title="step 3. Calculate nicknames.">calcEqnsNicknames</a>( eqNames, eqNicknames );
<a name="l00511"></a>00511
<a name="l00512"></a>00512 vector<int> eqInputs;
<a name="l00513"></a>00513 vector<int> eqOutputs;
<a name="l00514"></a>00514 vector<Tree> eqSigs; <a class="code" href="doc_8cpp.html#ad9ae7b77b222a446be950f6668e177a0" title="step 4&amp;5. Propagate and prepare signals.">mapPrepareEqSig</a>( evalEqBoxes, eqInputs, eqOutputs, eqSigs );
<a name="l00515"></a>00515 <a class="code" href="doc_8cpp.html#a84c0256c7510f01e97886d9174f05ff0" title="step 6. Set signals nicknames.">mapSetSigNickname</a>( eqNicknames, eqInputs, eqSigs );
<a name="l00516"></a>00516 <a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> superEqList; <a class="code" href="doc_8cpp.html#a3e31ebbced12828da219b955542cdc27" title="step 7. Collect all signals in a superlist.">collectEqSigs</a>( eqSigs, superEqList );
<a name="l00517"></a>00517
<a name="l00518"></a>00518 <a class="code" href="classDocCompiler.html" title="Compile a list of FAUST signals into a list of LaTeX formulas.">DocCompiler</a>* DC = <span class="keyword">new</span> <a class="code" href="classDocCompiler.html" title="Compile a list of FAUST signals into a list of LaTeX formulas.">DocCompiler</a>(0, 0);
<a name="l00519"></a>00519 <a class="code" href="doc_8cpp.html#a22864a1de755e55e1745d94835f4693e" title="step 8. Annotate superlist.">annotateSuperList</a>( DC, superEqList );
<a name="l00520"></a>00520 <span class="comment">//calcAndSetLtqNames( superEqList ); ///< step 9. (directly in 10.)</span>
<a name="l00521"></a>00521 <a class="code" href="doc_8cpp.html#a8ea0ae61d941bbbebcd46d210d30356a" title="step 10. Compile equations.">mapCompileDocEqnSigs</a>( eqSigs, eqInputs, eqOutputs, DC, docCompiledEqnsVector );
<a name="l00522"></a>00522 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a8c5b3a35aaf051de7ed2a8e480a010f4"></a><!-- doxytag: member="doc.cpp::printDoc" ref="a8c5b3a35aaf051de7ed2a8e480a010f4" args="(const char *projname, const char *docdev, const char *faustversion)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void printDoc </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>projname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>docdev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>faustversion</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The entry point to generate faust doc files. </p>
<p>The entry point to generate the output LaTeX file, stored in the directory "<projname>-math/". This file eventually references images for diagrams, generated in SVG subdirectories. The device system was adapted from drawSchema's device system.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>projname</em> </td><td>Basename of the new doc directory ("*-math"). </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>docdev</em> </td><td>The doc device; only ".tex" is supported for the moment. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>faustversion</em> </td><td>The current version of this Faust compiler. </td></tr>
</table>
</dd>
</dl>
<p><p>File stuff : create doc directories and a tex file.</p>
<p>Create THE mathdoc tex file.</p>
<p>Init and load translation file.</p>
<p>Simulate a default doc if no <mdoc> tag detected.</p>
<p>Printing stuff : in the '.tex' ouptut file, eventually including SVG files.</p>
<p>< Faust version and compilation date (comment).</p>
<p>< Static LaTeX header (packages and setup).</p>
<p>< Dynamic visible header (maketitle).</p>
<p>< Generate math contents (main stuff!).</p>
<p>< Static LaTeX footer. </p>
</p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00216">216</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="doc_8cpp_source.html#l00917">cholddir()</a>, <a class="el" href="doc_8cpp_source.html#l01015">copyFaustSources()</a>, <a class="el" href="doc__autodoc_8cpp_source.html#l00058">declareAutoDoc()</a>, <a class="el" href="doc_8cpp_source.html#l00104">gDocDevSuffix</a>, <a class="el" href="doc_8cpp_source.html#l00113">gDocLang</a>, <a class="el" href="main_8cpp_source.html#l00103">gDocName</a>, <a class="el" href="doc_8cpp_source.html#l00108">gDocVector</a>, <a class="el" href="doc_8cpp_source.html#l00106">gLatexheaderfilename</a>, <a class="el" href="sourcereader_8cpp_source.html#l00251">SourceReader::listSrcFiles()</a>, <a class="el" href="doc__lang_8cpp_source.html#l00076">loadTranslationFile()</a>, <a class="el" href="doc_8cpp_source.html#l00873">makedir()</a>, <a class="el" href="doc_8cpp_source.html#l00896">mkchdir()</a>, <a class="el" href="doc_8cpp_source.html#l00941">openArchFile()</a>, <a class="el" href="doc_8cpp_source.html#l00445">printdoccontent()</a>, <a class="el" href="doc_8cpp_source.html#l00287">printdocheader()</a>, <a class="el" href="doc_8cpp_source.html#l00413">printfaustdocstamp()</a>, <a class="el" href="doc_8cpp_source.html#l00398">printlatexfooter()</a>, <a class="el" href="doc_8cpp_source.html#l00276">printlatexheader()</a>, and <a class="el" href="Text_8cpp_source.html#l00060">subst()</a>.</p>
<p>Referenced by <a class="el" href="main_8cpp_source.html#l00475">main()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00217"></a>00217 {
<a name="l00218"></a>00218 <a class="code" href="doc_8cpp.html#a1023cd82d29af98e7692cd9b7784e94e" title="&quot;.tex&quot; (or .??? - used to choose output device).">gDocDevSuffix</a> = docdev;
<a name="l00219"></a>00219
<a name="l00221"></a>00221 <span class="comment">//cerr << "Documentator : printDoc : gFaustDirectory = '" << gFaustDirectory << "'" << endl;</span>
<a name="l00222"></a>00222 <span class="comment">//cerr << "Documentator : printDoc : gFaustSuperDirectory = '" << gFaustSuperDirectory << "'" << endl;</span>
<a name="l00223"></a>00223 <span class="comment">//cerr << "Documentator : printDoc : gFaustSuperSuperDirectory = '" << gFaustSuperSuperDirectory << "'" << endl;</span>
<a name="l00224"></a>00224 <span class="comment">//cerr << "Documentator : printDoc : gCurrentDir = '" << gCurrentDir << "'" << endl;</span>
<a name="l00225"></a>00225
<a name="l00226"></a>00226 <a class="code" href="doc_8cpp.html#a39b3d8237212f926fd704b35fcb7becd" title="Create a new directory in the current one.">makedir</a>(projname); <span class="comment">// create a top directory to store files</span>
<a name="l00227"></a>00227
<a name="l00228"></a>00228 <span class="keywordtype">string</span> svgTopDir = <a class="code" href="Text_8cpp.html#af50e951c134c2c98c4c75d687f8fca7a">subst</a>(<span class="stringliteral">"$0/svg"</span>, projname);
<a name="l00229"></a>00229 <a class="code" href="doc_8cpp.html#a39b3d8237212f926fd704b35fcb7becd" title="Create a new directory in the current one.">makedir</a>(svgTopDir.c_str()); <span class="comment">// create a directory to store svg-* subdirectories.</span>
<a name="l00230"></a>00230
<a name="l00231"></a>00231 <span class="keywordtype">string</span> cppdir = <a class="code" href="Text_8cpp.html#af50e951c134c2c98c4c75d687f8fca7a">subst</a>(<span class="stringliteral">"$0/cpp"</span>, projname);
<a name="l00232"></a>00232 <a class="code" href="doc_8cpp.html#a39b3d8237212f926fd704b35fcb7becd" title="Create a new directory in the current one.">makedir</a>(cppdir.c_str()); <span class="comment">// create a cpp directory.</span>
<a name="l00233"></a>00233
<a name="l00234"></a>00234 <span class="keywordtype">string</span> pdfdir = <a class="code" href="Text_8cpp.html#af50e951c134c2c98c4c75d687f8fca7a">subst</a>(<span class="stringliteral">"$0/pdf"</span>, projname);
<a name="l00235"></a>00235 <a class="code" href="doc_8cpp.html#a39b3d8237212f926fd704b35fcb7becd" title="Create a new directory in the current one.">makedir</a>(pdfdir.c_str()); <span class="comment">// create a pdf directory.</span>
<a name="l00236"></a>00236
<a name="l00237"></a>00237 <span class="comment">/* Copy all Faust source files into an 'src' sub-directory. */</span>
<a name="l00238"></a>00238 vector<string> pathnames = <a class="code" href="doc_8cpp.html#af59bae68e0652dd8c1ecbf661cbe8373">gReader</a>.<a class="code" href="classSourceReader.html#a02d4fe696337e6e327b14620ed76b626" title="Return a vector of pathnames representing the list of all the source files that have...">listSrcFiles</a>();
<a name="l00239"></a>00239 <a class="code" href="doc_8cpp.html#a375460f577b0036b379b7fbba6c328ae" title="Copy all Faust source files into an &#39;src&#39; subdirectory.">copyFaustSources</a>(projname, pathnames);
<a name="l00240"></a>00240
<a name="l00241"></a>00241 <span class="keywordtype">string</span> texdir = <a class="code" href="Text_8cpp.html#af50e951c134c2c98c4c75d687f8fca7a">subst</a>(<span class="stringliteral">"$0/tex"</span>, projname);
<a name="l00242"></a>00242 <a class="code" href="doc_8cpp.html#a4ba32ce8ec678ffbdf068a4483543239" title="Create a new directory in the current one, then &#39;cd&#39; into this new directory...">mkchdir</a>(texdir.c_str()); <span class="comment">// create a directory and move into.</span>
<a name="l00243"></a>00243
<a name="l00245"></a>00245 ofstream docout(<a class="code" href="Text_8cpp.html#af50e951c134c2c98c4c75d687f8fca7a">subst</a>(<span class="stringliteral">"$0.$1"</span>, <a class="code" href="doc_8cpp.html#a90baf99fd6ffa7248d895c7d33e0a8cf" title="Contains the filename for out documentation.">gDocName</a>, docdev).c_str());
<a name="l00246"></a>00246 <a class="code" href="doc_8cpp.html#aa993eaaab62326b7ec82db3ac19d420c" title="Switch back to the previously stored current directory.">cholddir</a>(); <span class="comment">// return to current directory</span>
<a name="l00247"></a>00247
<a name="l00249"></a>00249 <a class="code" href="doc__lang_8cpp.html#abc3498b3fe2b5d2aed70c4ace6f4b7a5">loadTranslationFile</a>(<a class="code" href="doc_8cpp.html#ac83dd0bfbc11705a903a395da7bc0f7c">gDocLang</a>);
<a name="l00250"></a>00250
<a name="l00252"></a>00252 <span class="keywordflow">if</span> (<a class="code" href="doc_8cpp.html#a7c306e8c82617863fda51d2c1158f5ab" title="Contains &lt;mdoc&gt; parsed trees: DOCTXT, DOCEQN, DOCDGM.">gDocVector</a>.empty()) { <a class="code" href="doc__autodoc_8cpp.html#a397f3918046c844eb8a0d69a852547c7" title="Declare an automatic documentation.">declareAutoDoc</a>(); }
<a name="l00253"></a>00253
<a name="l00255"></a>00255 <a class="code" href="doc_8cpp.html#aa8c8181fc55b942a887b1a7ad1bc8426" title="Print a &quot;doc stamp&quot; in the LaTeX document :the Faust version,the date of...">printfaustdocstamp</a>(faustversion, docout);
<a name="l00256"></a>00256 istream* latexheader = <a class="code" href="doc_8cpp.html#a56d99634f77c578d4704e016bfe61331" title="Open architecture file.">openArchFile</a>(<a class="code" href="doc_8cpp.html#ac656ad6ba04fe2497fce8da01ae10a73">gLatexheaderfilename</a>);
<a name="l00257"></a>00257 <a class="code" href="doc_8cpp.html#a06e9e0c3a7caa845483c8ced3afccf4d" title="Print a static LaTeX header.">printlatexheader</a>(*latexheader, docout);
<a name="l00258"></a>00258 <a class="code" href="doc_8cpp.html#a2ca219c50890ea7db162df03fcc9b799" title="Print the dynamic visible header, in a LaTeX &quot;tabular&quot; environment.">printdocheader</a>(docout);
<a name="l00259"></a>00259 <a class="code" href="doc_8cpp.html#abda5dcd1f0ce42df1ebd6896188db07c" title="Main documentator loop.">printdoccontent</a>(svgTopDir.c_str(), <a class="code" href="doc_8cpp.html#a7c306e8c82617863fda51d2c1158f5ab" title="Contains &lt;mdoc&gt; parsed trees: DOCTXT, DOCEQN, DOCDGM.">gDocVector</a>, faustversion, docout);
<a name="l00260"></a>00260 <a class="code" href="doc_8cpp.html#aca5cd842cbf22e8d931752073744be45" title="Print the static LaTeX footer.">printlatexfooter</a>(docout);
<a name="l00261"></a>00261
<a name="l00262"></a>00262 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="abda5dcd1f0ce42df1ebd6896188db07c"></a><!-- doxytag: member="doc.cpp::printdoccontent" ref="abda5dcd1f0ce42df1ebd6896188db07c" args="(const char *svgTopDir, const vector< Tree > &docVector, const string &faustversion, ostream &docout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void printdoccontent </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>svgTopDir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const vector< <a class="el" href="classCTree.html">Tree</a> > & </td>
<td class="paramname"> <em>docVector</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>faustversion</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>docout</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Main documentator loop. </p>
<p>First loop on gDocVector, which contains the faust <mdoc> trees. Second loop for each of these <mdoc> trees, which contain parsed input expressions of 3 types : DOCEQN for <equation> tags, DOCDGM for <diagram> tags, and DOCTXT for direct LaTeX text (no tag).</p>
<ul>
<li>DOCTXT expressions printing is trivial.</li>
<li>DOCDGM expressions printing calls 'printDocDgm' to generate SVG files and print LaTeX "figure" code.</li>
<li>DOCEQN expressions printing calls 'printDocEqn' after an important preparing work has been done by 'prepareDocEqns'.</li>
</ul>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>projname</em> </td><td>Basename of the new doc directory ("*-math"). </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>docVector</em> </td><td>Contains all <mdoc> parsed content (as boxes). </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>faustversion</em> </td><td>The current version of this Faust compiler. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>docout</em> </td><td>The output file to print into. </td></tr>
</table>
</dd>
</dl>
<p><p>Equations need to be prepared (named and compiled) before printing.</p>
<p>< Quite a lot of stuff there.</p>
<p>< For diagram directories numbering.</p>
<p>First level printing loop, on docVector.</p>
<p>Second level printing loop, on each <mdoc>.</p>
<p>< After equations are well prepared and named. </p>
</p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00445">445</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="tree_8hh_source.html#l00143">CTree::branch()</a>, <a class="el" href="faustlexer_8cpp_source.html#l00744">doc</a>, <a class="el" href="list_8hh_source.html#l00133">hd()</a>, <a class="el" href="doc_8cpp_source.html#l00185">isDocDgm()</a>, <a class="el" href="doc_8cpp_source.html#l00181">isDocEqn()</a>, <a class="el" href="doc_8cpp_source.html#l00193">isDocLst()</a>, <a class="el" href="doc_8cpp_source.html#l00189">isDocNtc()</a>, <a class="el" href="doc_8cpp_source.html#l00167">isDocTxt()</a>, <a class="el" href="list_8hh_source.html#l00138">isList()</a>, <a class="el" href="doc_8cpp_source.html#l00505">prepareDocEqns()</a>, <a class="el" href="doc_8cpp_source.html#l00829">printDocDgm()</a>, <a class="el" href="doc_8cpp_source.html#l00806">printDocEqn()</a>, <a class="el" href="doc__notice_8cpp_source.html#l00068">printDocNotice()</a>, <a class="el" href="doc_8cpp_source.html#l00342">printfaustlistings()</a>, <a class="el" href="list_8cpp_source.html#l00240">reverse()</a>, and <a class="el" href="list_8hh_source.html#l00134">tl()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00216">printDoc()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00446"></a>00446 {
<a name="l00447"></a>00447 <span class="comment">//cerr << endl << "Documentator : printdoccontent : " << docVector.size() << " <mdoc> tags read." << endl;</span>
<a name="l00448"></a>00448
<a name="l00450"></a>00450 vector<Lateq*> docCompiledEqnsVector;
<a name="l00451"></a>00451 <a class="code" href="doc_8cpp.html#afa7596184f452ff056cbd6d0290b9dca" title="Caller function.">prepareDocEqns</a>( docVector, docCompiledEqnsVector );
<a name="l00452"></a>00452
<a name="l00453"></a>00453 vector<Lateq*>::iterator eqn_it = docCompiledEqnsVector.begin();
<a name="l00454"></a>00454 <span class="keywordtype">int</span> i = 1;
<a name="l00455"></a>00455
<a name="l00457"></a>00457 <span class="keywordflow">for</span> (vector<Tree>::const_iterator <a class="code" href="faustlexer_8cpp.html#a96015589396b70e34698a0887a19ad0a">doc</a>=docVector.begin(); <a class="code" href="faustlexer_8cpp.html#a96015589396b70e34698a0887a19ad0a">doc</a><docVector.end(); <a class="code" href="faustlexer_8cpp.html#a96015589396b70e34698a0887a19ad0a">doc</a>++) {
<a name="l00458"></a>00458
<a name="l00459"></a>00459 <a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> L = <a class="code" href="list_8cpp.html#a8e15f8d6fcc6cd319059c2e0544145bb">reverse</a>(*<a class="code" href="faustlexer_8cpp.html#a96015589396b70e34698a0887a19ad0a">doc</a>);
<a name="l00460"></a>00460 <span class="comment">//cerr << "Entering into <mdoc> parsing..." << endl; </span>
<a name="l00461"></a>00461
<a name="l00463"></a>00463 <span class="keywordflow">while</span> (<a class="code" href="list_8hh.html#a8bdd73641276e0c0f999f504348eacc1">isList</a>(L)) {
<a name="l00464"></a>00464 <a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> expr;
<a name="l00465"></a>00465 <span class="keywordflow">if</span> ( <a class="code" href="doc_8cpp.html#a8f5e00372043167fc1d7fe12532a020e">isDocEqn</a>(<a class="code" href="list_8hh.html#a067ad6f83087b420a1c44e48e56be389">hd</a>(L), expr) ) {
<a name="l00466"></a>00466 <a class="code" href="doc_8cpp.html#a9c0f85706b52c4c57bfe6f54875c3813" title="Print doc equations, following the Lateq::println method.">printDocEqn</a>(*eqn_it++, docout);
<a name="l00467"></a>00467 }
<a name="l00468"></a>00468 <span class="keywordflow">else</span> <span class="keywordflow">if</span> ( <a class="code" href="doc_8cpp.html#adb0333bf59f0c1891e28e6b21b3060a1">isDocDgm</a>(<a class="code" href="list_8hh.html#a067ad6f83087b420a1c44e48e56be389">hd</a>(L), expr) ) {
<a name="l00469"></a>00469 <a class="code" href="doc_8cpp.html#a90774f58d14494c245c5003211c98a00" title="Doc diagrams handling.">printDocDgm</a>(expr, svgTopDir, docout, i++);
<a name="l00470"></a>00470 }
<a name="l00471"></a>00471 <span class="keywordflow">else</span> <span class="keywordflow">if</span> ( <a class="code" href="doc_8cpp.html#ad0b394e474b1e452e44de4b7e7dbb106">isDocTxt</a>(<a class="code" href="list_8hh.html#a067ad6f83087b420a1c44e48e56be389">hd</a>(L)) ) {
<a name="l00472"></a>00472 docout << *<a class="code" href="list_8hh.html#a067ad6f83087b420a1c44e48e56be389">hd</a>(L)-><a class="code" href="classCTree.html#a06c1513b23dc7b0d9da9c930c6dc43c5" title="return the ith branch (subtree) of a tree">branch</a>(0) << endl; <span class="comment">// Directly print registered doc text.</span>
<a name="l00473"></a>00473 }
<a name="l00474"></a>00474 <span class="keywordflow">else</span> <span class="keywordflow">if</span> ( <a class="code" href="doc_8cpp.html#ac6cfa5258d1a4a0c52d636615be62a50">isDocNtc</a>(<a class="code" href="list_8hh.html#a067ad6f83087b420a1c44e48e56be389">hd</a>(L)) ) {
<a name="l00475"></a>00475 <a class="code" href="doc__notice_8cpp.html#a2270b36463f6626b5b2bf8add3f87406" title="Print the content of the notice (a string map), as LaTeX items inside an itemize...">printDocNotice</a>(faustversion, docout);
<a name="l00476"></a>00476 }
<a name="l00477"></a>00477 <span class="keywordflow">else</span> <span class="keywordflow">if</span> ( <a class="code" href="doc_8cpp.html#ae3a40683ffbfc5c9a8af59be69241d40">isDocLst</a>(<a class="code" href="list_8hh.html#a067ad6f83087b420a1c44e48e56be389">hd</a>(L)) ) {
<a name="l00478"></a>00478 <a class="code" href="doc_8cpp.html#a9ca06818fbc5569e6ba2beeb8c4ca38a" title="Print listings of each Faust code &quot;.dsp&quot; files, calling the &#39;printfaustlisting&#39;...">printfaustlistings</a>(docout);
<a name="l00479"></a>00479 }
<a name="l00480"></a>00480 <span class="keywordflow">else</span> {
<a name="l00481"></a>00481 cerr << <span class="stringliteral">"ERROR : "</span> << *<a class="code" href="list_8hh.html#a067ad6f83087b420a1c44e48e56be389">hd</a>(L) << <span class="stringliteral">" is not a valid documentation type."</span> << endl;
<a name="l00482"></a>00482 }
<a name="l00483"></a>00483 L = <a class="code" href="list_8hh.html#a4075748f5c7156306ec898795313a2e0">tl</a>(L);
<a name="l00484"></a>00484 }
<a name="l00485"></a>00485 <span class="comment">//cerr << " ...end of <mdoc> parsing." << endl; </span>
<a name="l00486"></a>00486 }
<a name="l00487"></a>00487 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a90774f58d14494c245c5003211c98a00"></a><!-- doxytag: member="doc.cpp::printDocDgm" ref="a90774f58d14494c245c5003211c98a00" args="(const Tree expr, const char *svgTopDir, ostream &docout, int i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void printDocDgm </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCTree.html">Tree</a> </td>
<td class="paramname"> <em>expr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>svgTopDir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>docout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Doc diagrams handling. </p>
<p>Three steps : 1. evaluate expression 2. call svg drawing in the appropriate directory 3. print latex figure code with the appropriate directory reference</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>expr</em> </td><td>Parsed input expression, as boxes tree. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>svgTopDir</em> </td><td>Basename of the new doc directory ("*-math/svg"). </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>docout</em> </td><td>The output file to print into. </td></tr>
</table>
</dd>
</dl>
<p><p>1. Evaluate expression.</p>
<p>2. Draw the diagram after its evaluation, in SVG. Warning : pdflatex can't directly include SVG files !</p>
<p>3. Print LaTeX figure code.</p>
<p>4. Warn about naming interferences (in the notice). </p>
</p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00829">829</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="drawschema_8cpp_source.html#l00158">drawSchema()</a>, <a class="el" href="eval_8cpp_source.html#l00110">evaldocexpr()</a>, <a class="el" href="doc__notice_8cpp_source.html#l00036">gDocNoticeFlagMap</a>, <a class="el" href="errormsg_8cpp_source.html#l00031">gErrorCount</a>, <a class="el" href="doc_8cpp_source.html#l00963">legalFileName()</a>, <a class="el" href="doc_8cpp_source.html#l00083">MAXIDCHARS</a>, and <a class="el" href="Text_8cpp_source.html#l00060">subst()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00445">printdoccontent()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00830"></a>00830 {
<a name="l00832"></a>00832 <a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> docdgm = <a class="code" href="eval_8cpp.html#a4d1e61c6742d24447d08bddbbe341c1f">evaldocexpr</a>(expr, <a class="code" href="doc_8cpp.html#a52086e1c3e02821c4ce3f5a0626c2662">gExpandedDefList</a>);
<a name="l00833"></a>00833 <span class="keywordflow">if</span> (<a class="code" href="errormsg_8cpp.html#a446dbef8a744dce9d99bab7cf8c7d6d0">gErrorCount</a> > 0) {
<a name="l00834"></a>00834 cerr << <span class="stringliteral">"Total of "</span> << <a class="code" href="errormsg_8cpp.html#a446dbef8a744dce9d99bab7cf8c7d6d0">gErrorCount</a> << <span class="stringliteral">" errors during evaluation of : diagram docdgm = "</span> << <a class="code" href="classboxpp.html">boxpp</a>(docdgm) << <span class="stringliteral">";\n"</span>;
<a name="l00835"></a>00835 exit(1);
<a name="l00836"></a>00836 }
<a name="l00837"></a>00837
<a name="l00842"></a>00842 <span class="keywordtype">char</span> dgmid[<a class="code" href="doc_8cpp.html#a55ee21aeba68dbe17ffd10e4fd626690" title="max numbers (characters) to represent ids (e.g. for directories).">MAXIDCHARS</a>+1];
<a name="l00843"></a>00843 sprintf(dgmid, <span class="stringliteral">"%02d"</span>, i);
<a name="l00844"></a>00844 <span class="keywordtype">string</span> thisdgmdir = <a class="code" href="Text_8cpp.html#af50e951c134c2c98c4c75d687f8fca7a">subst</a>(<span class="stringliteral">"$0/svg-$1"</span>, svgTopDir, dgmid);
<a name="l00845"></a>00845 <span class="comment">//cerr << "Documentator : printDocDgm : drawSchema in '" << gCurrentDir << "/" << thisdgmdir << "'" << endl;</span>
<a name="l00846"></a>00846
<a name="l00847"></a>00847 <a class="code" href="drawschema_8cpp.html#a3be4e4d89005ef7378ba7e4c609efea2" title="The entry point to generate from a block diagram as a set of svg files stored in...">drawSchema</a>( docdgm, thisdgmdir.c_str(), <span class="stringliteral">"svg"</span> );
<a name="l00848"></a>00848
<a name="l00850"></a>00850 <span class="keywordtype">char</span> temp[1024];
<a name="l00851"></a>00851 <span class="keyword">const</span> <span class="keywordtype">string</span> dgmfilename = <a class="code" href="doc_8cpp.html#a6fa98093fdea396358b0ea4e20e3821d" title="Transform the definition name property of tree &lt;t&gt; into a legal file name.">legalFileName</a>(docdgm, 1024, temp);
<a name="l00852"></a>00852 <span class="comment">//docout << "figure \\ref{figure" << i << "}";</span>
<a name="l00853"></a>00853 docout << <span class="stringliteral">"\\begin{figure}[ht!]"</span> << endl;
<a name="l00854"></a>00854 docout << <span class="stringliteral">"\t\\centering"</span> << endl;
<a name="l00855"></a>00855 docout << <span class="stringliteral">"\t\\includegraphics[width=\\textwidth]{"</span> << <a class="code" href="Text_8cpp.html#af50e951c134c2c98c4c75d687f8fca7a">subst</a>(<span class="stringliteral">"../svg/svg-$0/"</span>, dgmid) << dgmfilename << <span class="stringliteral">"}"</span> << endl;
<a name="l00856"></a>00856 docout << <span class="stringliteral">"\t\\caption{block-diagram of \\texttt{"</span> << dgmfilename << <span class="stringliteral">"}}"</span> << endl;
<a name="l00857"></a>00857 docout << <span class="stringliteral">"\t\\label{figure"</span> << i << <span class="stringliteral">"}"</span> << endl;
<a name="l00858"></a>00858 docout << <span class="stringliteral">"\\end{figure}"</span> << endl << endl;
<a name="l00859"></a>00859
<a name="l00861"></a>00861 <a class="code" href="doc__notice_8cpp.html#a492e098f4f84d8c67a9060854d23e558" title="gDocNoticeFlagMap is public to let others turn to &quot;true&quot; flags that one...">gDocNoticeFlagMap</a>[<span class="stringliteral">"nameconflicts"</span>] = <span class="keyword">true</span>;
<a name="l00862"></a>00862 <a class="code" href="doc__notice_8cpp.html#a492e098f4f84d8c67a9060854d23e558" title="gDocNoticeFlagMap is public to let others turn to &quot;true&quot; flags that one...">gDocNoticeFlagMap</a>[<span class="stringliteral">"svgdir"</span>] = <span class="keyword">true</span>;
<a name="l00863"></a>00863 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a9c0f85706b52c4c57bfe6f54875c3813"></a><!-- doxytag: member="doc.cpp::printDocEqn" ref="a9c0f85706b52c4c57bfe6f54875c3813" args="(Lateq *ltq, ostream &docout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void printDocEqn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classLateq.html">Lateq</a> * </td>
<td class="paramname"> <em>ltq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>docout</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print doc equations, following the <a class="el" href="classLateq.html#a21dbc72f648ae58202a45996f5d5527e" title="Top-level method to print a whole set of compiled LaTeX formulas.">Lateq::println</a> method. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>ltq</em> </td><td>The object containing compiled LaTeX code of equations. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>docout</em> </td><td>The output file to print into. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00806">806</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="lateq_8cpp_source.html#l00077">Lateq::println()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00445">printdoccontent()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00807"></a>00807 {
<a name="l00808"></a>00808 ltq-><a class="code" href="classLateq.html#a21dbc72f648ae58202a45996f5d5527e" title="Top-level method to print a whole set of compiled LaTeX formulas.">println</a>(docout);
<a name="l00809"></a>00809 <span class="comment">//cerr << "Documentator : printDocEqn : "; ltq->println(cerr); cerr << endl;</span>
<a name="l00810"></a>00810 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a2ca219c50890ea7db162df03fcc9b799"></a><!-- doxytag: member="doc.cpp::printdocheader" ref="a2ca219c50890ea7db162df03fcc9b799" args="(ostream &docout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void printdocheader </td>
<td>(</td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>docout</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print the dynamic visible header, in a LaTeX "tabular" environment. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>docout</em> </td><td>The LaTeX output file to print into. </td></tr>
</table>
</dd>
</dl>
<p><p>< Default title.</p>
<p>< Default author. </p>
</p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00287">287</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="doc__metadatas_8cpp_source.html#l00035">gDocMetadatasStringMap</a>, <a class="el" href="main_8cpp_source.html#l00087">gMetaDataSet</a>, <a class="el" href="doc_8cpp_source.html#l00996">rmExternalDoubleQuotes()</a>, <a class="el" href="tree_8hh_source.html#l00173">tree()</a>, <a class="el" href="tree_8cpp_source.html#l00292">tree2str()</a>, and <a class="el" href="Text_8cpp_source.html#l00220">unquote()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00216">printDoc()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00288"></a>00288 {
<a name="l00289"></a>00289 <span class="comment">/* Defines the metadata we want to print as comments at the begin of the LaTeX file. */</span>
<a name="l00290"></a>00290 set<Tree> selectedKeys;
<a name="l00291"></a>00291 selectedKeys.insert(<a class="code" href="tree_8hh.html#a61c13e9361cfa80bbb3cd6ce60a8f595">tree</a>(<span class="stringliteral">"name"</span>));
<a name="l00292"></a>00292 selectedKeys.insert(<a class="code" href="tree_8hh.html#a61c13e9361cfa80bbb3cd6ce60a8f595">tree</a>(<span class="stringliteral">"author"</span>));
<a name="l00293"></a>00293 selectedKeys.insert(<a class="code" href="tree_8hh.html#a61c13e9361cfa80bbb3cd6ce60a8f595">tree</a>(<span class="stringliteral">"copyright"</span>));
<a name="l00294"></a>00294 selectedKeys.insert(<a class="code" href="tree_8hh.html#a61c13e9361cfa80bbb3cd6ce60a8f595">tree</a>(<span class="stringliteral">"license"</span>));
<a name="l00295"></a>00295 selectedKeys.insert(<a class="code" href="tree_8hh.html#a61c13e9361cfa80bbb3cd6ce60a8f595">tree</a>(<span class="stringliteral">"version"</span>));
<a name="l00296"></a>00296
<a name="l00297"></a>00297 <span class="keywordtype">string</span> title = <span class="stringliteral">"Documentation"</span>;
<a name="l00298"></a>00298 <span class="keywordflow">if</span> (<a class="code" href="doc_8cpp.html#aaf647729deae314d35817ccb36f088e4">gMetaDataSet</a>.count(<a class="code" href="tree_8hh.html#a61c13e9361cfa80bbb3cd6ce60a8f595">tree</a>(<span class="stringliteral">"name"</span>))) {
<a name="l00299"></a>00299 title = <a class="code" href="Text_8cpp.html#a43603e937810ca498bdad7f930938491" title="remove quotes from a string">unquote</a>( <a class="code" href="tree_8cpp.html#ac753d60778175e30a86cba647db017ad" title="if t has a node of type symbol, return its name otherwise error">tree2str</a>(*(<a class="code" href="doc_8cpp.html#aaf647729deae314d35817ccb36f088e4">gMetaDataSet</a>[<a class="code" href="tree_8hh.html#a61c13e9361cfa80bbb3cd6ce60a8f595">tree</a>(<span class="stringliteral">"name"</span>)].begin())) );
<a name="l00300"></a>00300 }
<a name="l00301"></a>00301 docout << <span class="stringliteral">"\\title{"</span> << title << <span class="stringliteral">"}"</span> << endl;
<a name="l00302"></a>00302
<a name="l00303"></a>00303 <span class="keywordtype">string</span> author = <span class="stringliteral">"(anonymous)"</span>;
<a name="l00304"></a>00304 <span class="keywordflow">if</span> (<a class="code" href="doc_8cpp.html#aaf647729deae314d35817ccb36f088e4">gMetaDataSet</a>.count(<a class="code" href="tree_8hh.html#a61c13e9361cfa80bbb3cd6ce60a8f595">tree</a>(<span class="stringliteral">"author"</span>))) {
<a name="l00305"></a>00305 author = <a class="code" href="Text_8cpp.html#a43603e937810ca498bdad7f930938491" title="remove quotes from a string">unquote</a>( <a class="code" href="tree_8cpp.html#ac753d60778175e30a86cba647db017ad" title="if t has a node of type symbol, return its name otherwise error">tree2str</a>(*(<a class="code" href="doc_8cpp.html#aaf647729deae314d35817ccb36f088e4">gMetaDataSet</a>[<a class="code" href="tree_8hh.html#a61c13e9361cfa80bbb3cd6ce60a8f595">tree</a>(<span class="stringliteral">"author"</span>)].begin())) );
<a name="l00306"></a>00306 docout << <span class="stringliteral">"\\author{"</span> << author << <span class="stringliteral">"}"</span> << endl;
<a name="l00307"></a>00307 }
<a name="l00308"></a>00308
<a name="l00309"></a>00309 docout << <span class="stringliteral">"\\date{\\today}"</span> << endl << endl;
<a name="l00310"></a>00310 docout << <span class="stringliteral">"\\maketitle"</span> << endl << endl;
<a name="l00311"></a>00311
<a name="l00312"></a>00312
<a name="l00313"></a>00313 <span class="keywordflow">if</span> (! <a class="code" href="doc_8cpp.html#aaf647729deae314d35817ccb36f088e4">gMetaDataSet</a>.empty()) {
<a name="l00314"></a>00314 docout << <span class="stringliteral">"\\begin{tabular}{ll}"</span> << endl;
<a name="l00315"></a>00315 docout << <span class="stringliteral">"\t\\hline"</span> << endl;
<a name="l00316"></a>00316 <span class="keywordflow">for</span> (map<<a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a>, set<Tree> >::iterator i = <a class="code" href="doc_8cpp.html#aaf647729deae314d35817ccb36f088e4">gMetaDataSet</a>.begin(); i != <a class="code" href="doc_8cpp.html#aaf647729deae314d35817ccb36f088e4">gMetaDataSet</a>.end(); i++) {
<a name="l00317"></a>00317 <span class="keywordflow">if</span> (selectedKeys.count(i->first)) {
<a name="l00318"></a>00318 <span class="comment">//docout << "\t\\textbf{" << *(i->first);</span>
<a name="l00319"></a>00319 docout << <span class="stringliteral">"\t\\textbf{"</span> << <a class="code" href="doc_8cpp.html#aa19e3a2853a131a2165ddead4a0e565d">gDocMetadatasStringMap</a>[<a class="code" href="tree_8cpp.html#ac753d60778175e30a86cba647db017ad" title="if t has a node of type symbol, return its name otherwise error">tree2str</a>(i->first)];
<a name="l00320"></a>00320 <span class="keyword">const</span> <span class="keywordtype">char</span>* sep = <span class="stringliteral">"} & "</span>;
<a name="l00321"></a>00321 <span class="keywordflow">for</span> (set<Tree>::iterator j = i->second.begin(); j != i->second.end(); j++) {
<a name="l00322"></a>00322 docout << sep << <a class="code" href="doc_8cpp.html#a016b1cbb37d2aee62272c6c955e4e078" title="Remove the leading and trailing double quotes of a string (but not those in the middle...">rmExternalDoubleQuotes</a>(<a class="code" href="tree_8cpp.html#ac753d60778175e30a86cba647db017ad" title="if t has a node of type symbol, return its name otherwise error">tree2str</a>(*j));
<a name="l00323"></a>00323 sep = <span class="stringliteral">", "</span>;
<a name="l00324"></a>00324 }
<a name="l00325"></a>00325 <span class="keyword">const</span> <span class="keywordtype">char</span>* sep2 = <span class="stringliteral">"\\\\"</span>;
<a name="l00326"></a>00326 docout << sep2 << endl;
<a name="l00327"></a>00327 }
<a name="l00328"></a>00328 }
<a name="l00329"></a>00329 docout << <span class="stringliteral">"\t\\hline\\\\"</span> << endl;
<a name="l00330"></a>00330 docout << <span class="stringliteral">"\\end{tabular}"</span> << endl;
<a name="l00331"></a>00331 docout << <span class="stringliteral">"\\bigskip"</span> << endl << endl;
<a name="l00332"></a>00332 }
<a name="l00333"></a>00333 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="aa8c8181fc55b942a887b1a7ad1bc8426"></a><!-- doxytag: member="doc.cpp::printfaustdocstamp" ref="aa8c8181fc55b942a887b1a7ad1bc8426" args="(const string &faustversion, ostream &docout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void printfaustdocstamp </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>faustversion</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>docout</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print a "doc stamp" in the LaTeX document :</p>
<ul>
<li>the Faust version,</li>
<li>the date of doc compilation,</li>
<li>faust's web site URL. </li>
</ul>
</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>faustversion</em> </td><td>The current version of this Faust compiler. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>docout</em> </td><td>The LaTeX output file to print into. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00413">413</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="doc_8cpp_source.html#l01047">getCompilationDate()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00216">printDoc()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00414"></a>00414 {
<a name="l00415"></a>00415 <span class="keywordtype">char</span> datebuf [150];
<a name="l00416"></a>00416 strftime (datebuf, 150, <span class="stringliteral">"%c"</span>, <a class="code" href="doc_8cpp.html#a0a871f44fa7d57075fcc6e7f835ba913">getCompilationDate</a>());
<a name="l00417"></a>00417
<a name="l00418"></a>00418 docout << <span class="stringliteral">"%% This documentation was generated with Faust version "</span> << faustversion << endl;
<a name="l00419"></a>00419 docout << <span class="stringliteral">"%% "</span> << datebuf << endl;
<a name="l00420"></a>00420 docout << <span class="stringliteral">"%% http://faust.grame.fr"</span> << endl << endl;
<a name="l00421"></a>00421 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a9b7ec85e7bc000dc74a58a44b893a82d"></a><!-- doxytag: member="doc.cpp::printfaustlisting" ref="a9b7ec85e7bc000dc74a58a44b893a82d" args="(string &faustfile, ostream &docout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void printfaustlisting </td>
<td>(</td>
<td class="paramtype">string & </td>
<td class="paramname"> <em>faustfile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>docout</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print a listing of the Faust code, in a LaTeX "listing" environment. </p>
<p>Strip content of <mdoc> tags.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>faustfile</em> </td><td>The source file containing the Faust code. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>docout</em> </td><td>The LaTeX output file to print into. </td></tr>
</table>
</dd>
</dl>
<p><p>We suppose there's only one <mdoc> tag per line. </p>
</p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00360">360</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="enrobage_8cpp_source.html#l00316">filebasename()</a>, and <a class="el" href="main_8cpp_source.html#l00117">gStripDocSwitch</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00342">printfaustlistings()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00361"></a>00361 {
<a name="l00362"></a>00362 <span class="keywordtype">string</span> s;
<a name="l00363"></a>00363 ifstream src;
<a name="l00364"></a>00364
<a name="l00365"></a>00365 <span class="comment">//cerr << "Documentator : printfaustlisting : Opening file '" << faustfile << "'" << endl;</span>
<a name="l00366"></a>00366 src.open(faustfile.c_str(), ifstream::in);
<a name="l00367"></a>00367
<a name="l00368"></a>00368 docout << endl << <span class="stringliteral">"\\bigskip\\bigskip"</span> << endl;
<a name="l00369"></a>00369 docout << <span class="stringliteral">"\\begin{lstlisting}[caption=\\texttt{"</span> << <a class="code" href="enrobage_8cpp.html#a73496d20a5f06ebb81a3ce1cc6d39877">filebasename</a>(faustfile.c_str()) << <span class="stringliteral">"}]"</span> << endl;
<a name="l00370"></a>00370
<a name="l00371"></a>00371 <span class="keywordtype">bool</span> isInsideDoc = <span class="keyword">false</span>;
<a name="l00372"></a>00372
<a name="l00373"></a>00373 <span class="keywordflow">if</span> (faustfile != <span class="stringliteral">""</span> && src.good()) {
<a name="l00374"></a>00374 <span class="keywordflow">while</span>(getline(src, s)) {
<a name="l00375"></a>00375 <span class="keywordtype">size_t</span> foundopendoc = s.find(<span class="stringliteral">"<mdoc>"</span>);
<a name="l00376"></a>00376 <span class="keywordflow">if</span> (foundopendoc != string::npos && <a class="code" href="doc_8cpp.html#a88af9e6ad20008837e470be54b69437c">gStripDocSwitch</a>) isInsideDoc = <span class="keyword">true</span>;
<a name="l00377"></a>00377
<a name="l00378"></a>00378 <span class="keywordflow">if</span> (isInsideDoc == <span class="keyword">false</span>)
<a name="l00379"></a>00379 docout << s << endl;
<a name="l00380"></a>00380
<a name="l00381"></a>00381 <span class="keywordtype">size_t</span> foundclosedoc = s.find(<span class="stringliteral">"</mdoc>"</span>);
<a name="l00382"></a>00382 <span class="keywordflow">if</span> (foundclosedoc != string::npos && <a class="code" href="doc_8cpp.html#a88af9e6ad20008837e470be54b69437c">gStripDocSwitch</a>) isInsideDoc = <span class="keyword">false</span>;
<a name="l00383"></a>00383 }
<a name="l00384"></a>00384 } <span class="keywordflow">else</span> {
<a name="l00385"></a>00385 cerr << <span class="stringliteral">"ERROR : can't open faust source file "</span> << faustfile << endl;
<a name="l00386"></a>00386 exit(1);
<a name="l00387"></a>00387 }
<a name="l00388"></a>00388
<a name="l00389"></a>00389 docout << <span class="stringliteral">"\\end{lstlisting}"</span> << endl << endl;
<a name="l00390"></a>00390 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a9ca06818fbc5569e6ba2beeb8c4ca38a"></a><!-- doxytag: member="doc.cpp::printfaustlistings" ref="a9ca06818fbc5569e6ba2beeb8c4ca38a" args="(ostream &docout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void printfaustlistings </td>
<td>(</td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>docout</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print listings of each Faust code ".dsp" files, calling the 'printfaustlisting' function. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>docout</em> </td><td>The LaTeX output file to print into. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00342">342</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>References <a class="el" href="sourcereader_8cpp_source.html#l00251">SourceReader::listSrcFiles()</a>, and <a class="el" href="doc_8cpp_source.html#l00360">printfaustlisting()</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00445">printdoccontent()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00343"></a>00343 {
<a name="l00344"></a>00344 vector<string> pathnames = <a class="code" href="doc_8cpp.html#af59bae68e0652dd8c1ecbf661cbe8373">gReader</a>.<a class="code" href="classSourceReader.html#a02d4fe696337e6e327b14620ed76b626" title="Return a vector of pathnames representing the list of all the source files that have...">listSrcFiles</a>();
<a name="l00345"></a>00345
<a name="l00346"></a>00346 <span class="comment">/* Listings printing. */</span>
<a name="l00347"></a>00347 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i< pathnames.size(); i++) {
<a name="l00348"></a>00348 <a class="code" href="doc_8cpp.html#a9b7ec85e7bc000dc74a58a44b893a82d" title="Print a listing of the Faust code, in a LaTeX &quot;listing&quot; environment.">printfaustlisting</a>(pathnames[i], docout);
<a name="l00349"></a>00349 }
<a name="l00350"></a>00350 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="aca5cd842cbf22e8d931752073744be45"></a><!-- doxytag: member="doc.cpp::printlatexfooter" ref="aca5cd842cbf22e8d931752073744be45" args="(ostream &docout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void printlatexfooter </td>
<td>(</td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>docout</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print the static LaTeX footer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>docout</em> </td><td>The LaTeX output file to print into. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00398">398</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00216">printDoc()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00399"></a>00399 {
<a name="l00400"></a>00400 docout << endl << <span class="stringliteral">"\\end{document}"</span> << endl << endl;
<a name="l00401"></a>00401 }
</pre></div></p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a06e9e0c3a7caa845483c8ced3afccf4d"></a><!-- doxytag: member="doc.cpp::printlatexheader" ref="a06e9e0c3a7caa845483c8ced3afccf4d" args="(istream &latexheader, ostream &docout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void printlatexheader </td>
<td>(</td>
<td class="paramtype">istream & </td>
<td class="paramname"> <em>latexheader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>docout</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print a static LaTeX header. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>latexheader</em> </td><td>The file containing the static part of the LaTeX header. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>docout</em> </td><td>The LaTeX output file to print into. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00276">276</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00216">printDoc()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00277"></a>00277 {
<a name="l00278"></a>00278 <span class="keywordtype">string</span> s;
<a name="l00279"></a>00279 <span class="keywordflow">while</span>(getline(latexheader, s)) docout << s << endl;
<a name="l00280"></a>00280 }
</pre></div></p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a016b1cbb37d2aee62272c6c955e4e078"></a><!-- doxytag: member="doc.cpp::rmExternalDoubleQuotes" ref="a016b1cbb37d2aee62272c6c955e4e078" args="(const string &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static string rmExternalDoubleQuotes </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>s</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove the leading and trailing double quotes of a string (but not those in the middle of the string). </p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00996">996</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00287">printdocheader()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00997"></a>00997 {
<a name="l00998"></a>00998 <span class="keywordtype">size_t</span> i = s.find_first_not_of(<span class="stringliteral">"\""</span>);
<a name="l00999"></a>00999 <span class="keywordtype">size_t</span> j = s.find_last_not_of(<span class="stringliteral">"\""</span>);
<a name="l01000"></a>01000
<a name="l01001"></a>01001 <span class="keywordflow">if</span> ( (i != string::npos) & (j != string::npos) ) {
<a name="l01002"></a>01002 <span class="keywordflow">return</span> s.substr(i, 1+j-i);
<a name="l01003"></a>01003 } <span class="keywordflow">else</span> {
<a name="l01004"></a>01004 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
<a name="l01005"></a>01005 }
<a name="l01006"></a>01006 }
</pre></div></p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="a7114bcd8618d179b0ad442ea7d2a9b8b"></a><!-- doxytag: member="doc.cpp::DOCDGM" ref="a7114bcd8618d179b0ad442ea7d2a9b8b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSymbol.html">Sym</a> <a class="el" href="doc_8cpp.html#a7114bcd8618d179b0ad442ea7d2a9b8b">DOCDGM</a> = symbol ("DocDgm")</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00183">183</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4d2c444fea45c353d1efc09220d6d903"></a><!-- doxytag: member="doc.cpp::DOCEQN" ref="a4d2c444fea45c353d1efc09220d6d903" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSymbol.html">Sym</a> <a class="el" href="doc_8cpp.html#a4d2c444fea45c353d1efc09220d6d903">DOCEQN</a> = symbol ("DocEqn")</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00179">179</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5224d7cd7a847f4bc17652432c50fac0"></a><!-- doxytag: member="doc.cpp::DOCLST" ref="a5224d7cd7a847f4bc17652432c50fac0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSymbol.html">Sym</a> <a class="el" href="doc_8cpp.html#a5224d7cd7a847f4bc17652432c50fac0">DOCLST</a> = symbol ("DocLst")</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00191">191</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a46fd57f16ddd4d6b43b5a289cfa97339"></a><!-- doxytag: member="doc.cpp::DOCNTC" ref="a46fd57f16ddd4d6b43b5a289cfa97339" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSymbol.html">Sym</a> <a class="el" href="doc_8cpp.html#a46fd57f16ddd4d6b43b5a289cfa97339">DOCNTC</a> = symbol ("DocNtc")</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00187">187</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3ce37f9c0c4f9e071cc70dcf1f82e1f5"></a><!-- doxytag: member="doc.cpp::DOCTXT" ref="a3ce37f9c0c4f9e071cc70dcf1f82e1f5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSymbol.html">Sym</a> <a class="el" href="doc_8cpp.html#a3ce37f9c0c4f9e071cc70dcf1f82e1f5">DOCTXT</a> = symbol ("DocTxt")</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00165">165</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae57fb3f71c6b5070eaf01b4c6837ff1b"></a><!-- doxytag: member="doc.cpp::gCompilationDate" ref="ae57fb3f71c6b5070eaf01b4c6837ff1b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct tm <a class="el" href="doc__notice_8cpp.html#ae57fb3f71c6b5070eaf01b4c6837ff1b">gCompilationDate</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00110">110</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l01047">getCompilationDate()</a>, and <a class="el" href="doc_8cpp_source.html#l01039">initCompilationDate()</a>.</p>
</div>
</div>
<a class="anchor" id="a0c91ed41a90a100a2570f4d993c6e16a"></a><!-- doxytag: member="doc.cpp::gCurrentDir" ref="a0c91ed41a90a100a2570f4d993c6e16a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string <a class="el" href="drawschema_8cpp.html#a7ce3017d02da6ef6554e0406e1a5b767">gCurrentDir</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Room to save current directory name. </p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00105">105</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00917">cholddir()</a>, <a class="el" href="doc_8cpp_source.html#l00931">getCurrentDir()</a>, <a class="el" href="doc_8cpp_source.html#l00873">makedir()</a>, and <a class="el" href="doc_8cpp_source.html#l00896">mkchdir()</a>.</p>
</div>
</div>
<a class="anchor" id="a4741733b16ad8f554a8b5c0ca5045d14"></a><!-- doxytag: member="doc.cpp::gDetailsSwitch" ref="a4741733b16ad8f554a8b5c0ca5045d14" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="main_8cpp.html#a4741733b16ad8f554a8b5c0ca5045d14">gDetailsSwitch</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="main_8cpp_source.html#l00110">110</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
<p>Referenced by <a class="el" href="main_8cpp_source.html#l00475">main()</a>, and <a class="el" href="main_8cpp_source.html#l00160">process_cmdline()</a>.</p>
</div>
</div>
<a class="anchor" id="a1023cd82d29af98e7692cd9b7784e94e"></a><!-- doxytag: member="doc.cpp::gDocDevSuffix" ref="a1023cd82d29af98e7692cd9b7784e94e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="doc_8cpp.html#a1023cd82d29af98e7692cd9b7784e94e">gDocDevSuffix</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>".tex" (or .??? - used to choose output device). </p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00104">104</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00216">printDoc()</a>.</p>
</div>
</div>
<a class="anchor" id="ac83dd0bfbc11705a903a395da7bc0f7c"></a><!-- doxytag: member="doc.cpp::gDocLang" ref="ac83dd0bfbc11705a903a395da7bc0f7c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string <a class="el" href="main_8cpp.html#ac83dd0bfbc11705a903a395da7bc0f7c">gDocLang</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00113">113</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00216">printDoc()</a>, and <a class="el" href="main_8cpp_source.html#l00160">process_cmdline()</a>.</p>
</div>
</div>
<a class="anchor" id="aa19e3a2853a131a2165ddead4a0e565d"></a><!-- doxytag: member="doc.cpp::gDocMetadatasStringMap" ref="aa19e3a2853a131a2165ddead4a0e565d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">map<string, string> <a class="el" href="doc__metadatas_8cpp.html#aa19e3a2853a131a2165ddead4a0e565d">gDocMetadatasStringMap</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc__metadatas_8cpp_source.html#l00035">35</a> of file <a class="el" href="doc__metadatas_8cpp_source.html">doc_metadatas.cpp</a>.</p>
<p>Referenced by <a class="el" href="doc__lang_8cpp_source.html#l00113">importDocStrings()</a>, <a class="el" href="doc_8cpp_source.html#l00287">printdocheader()</a>, and <a class="el" href="doc__lang_8cpp_source.html#l00176">storePair()</a>.</p>
</div>
</div>
<a class="anchor" id="a90baf99fd6ffa7248d895c7d33e0a8cf"></a><!-- doxytag: member="doc.cpp::gDocName" ref="a90baf99fd6ffa7248d895c7d33e0a8cf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string <a class="el" href="main_8cpp.html#a90baf99fd6ffa7248d895c7d33e0a8cf">gDocName</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Contains the filename for out documentation. </p>
<p>Definition at line <a class="el" href="main_8cpp_source.html#l00103">103</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
<p>Referenced by <a class="el" href="main_8cpp_source.html#l00452">initFaustDirectories()</a>, and <a class="el" href="doc_8cpp_source.html#l00216">printDoc()</a>.</p>
</div>
</div>
<a class="anchor" id="a7c306e8c82617863fda51d2c1158f5ab"></a><!-- doxytag: member="doc.cpp::gDocVector" ref="a7c306e8c82617863fda51d2c1158f5ab" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="classCTree.html">Tree</a>> <a class="el" href="sourcereader_8cpp.html#a7c306e8c82617863fda51d2c1158f5ab">gDocVector</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Contains <mdoc> parsed trees: DOCTXT, DOCEQN, DOCDGM. </p>
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00108">108</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>Referenced by <a class="el" href="sourcereader_8cpp_source.html#l00321">declareDoc()</a>, and <a class="el" href="doc_8cpp_source.html#l00216">printDoc()</a>.</p>
</div>
</div>
<a class="anchor" id="a52086e1c3e02821c4ce3f5a0626c2662"></a><!-- doxytag: member="doc.cpp::gExpandedDefList" ref="a52086e1c3e02821c4ce3f5a0626c2662" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCTree.html">Tree</a> <a class="el" href="main_8cpp.html#a52086e1c3e02821c4ce3f5a0626c2662">gExpandedDefList</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="main_8cpp_source.html#l00104">104</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a320fc936026f318a3fc46f47ef379713"></a><!-- doxytag: member="doc.cpp::gFaustDirectory" ref="a320fc936026f318a3fc46f47ef379713" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string <a class="el" href="enrobage_8cpp.html#a320fc936026f318a3fc46f47ef379713">gFaustDirectory</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="main_8cpp_source.html#l00099">99</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
<p>Referenced by <a class="el" href="enrobage_8cpp_source.html#l00258">fopensearch()</a>, <a class="el" href="main_8cpp_source.html#l00452">initFaustDirectories()</a>, and <a class="el" href="enrobage_8cpp_source.html#l00069">open_arch_stream()</a>.</p>
</div>
</div>
<a class="anchor" id="a2529dab7cac84bd8f69c14ee8a3cbfe2"></a><!-- doxytag: member="doc.cpp::gFaustSuperDirectory" ref="a2529dab7cac84bd8f69c14ee8a3cbfe2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string <a class="el" href="enrobage_8cpp.html#a2529dab7cac84bd8f69c14ee8a3cbfe2">gFaustSuperDirectory</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="main_8cpp_source.html#l00098">98</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
<p>Referenced by <a class="el" href="enrobage_8cpp_source.html#l00258">fopensearch()</a>, <a class="el" href="main_8cpp_source.html#l00452">initFaustDirectories()</a>, and <a class="el" href="enrobage_8cpp_source.html#l00069">open_arch_stream()</a>.</p>
</div>
</div>
<a class="anchor" id="a09fc40a224a32f929decbac5a21140ef"></a><!-- doxytag: member="doc.cpp::gFaustSuperSuperDirectory" ref="a09fc40a224a32f929decbac5a21140ef" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string <a class="el" href="enrobage_8cpp.html#a09fc40a224a32f929decbac5a21140ef">gFaustSuperSuperDirectory</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="main_8cpp_source.html#l00097">97</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
<p>Referenced by <a class="el" href="enrobage_8cpp_source.html#l00258">fopensearch()</a>, <a class="el" href="main_8cpp_source.html#l00452">initFaustDirectories()</a>, and <a class="el" href="enrobage_8cpp_source.html#l00069">open_arch_stream()</a>.</p>
</div>
</div>
<a class="anchor" id="ac656ad6ba04fe2497fce8da01ae10a73"></a><!-- doxytag: member="doc.cpp::gLatexheaderfilename" ref="ac656ad6ba04fe2497fce8da01ae10a73" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const string <a class="el" href="doc_8cpp.html#ac656ad6ba04fe2497fce8da01ae10a73">gLatexheaderfilename</a> = "latexheader.tex"<code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="doc_8cpp_source.html#l00106">106</a> of file <a class="el" href="doc_8cpp_source.html">doc.cpp</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00216">printDoc()</a>.</p>
</div>
</div>
<a class="anchor" id="a1c0fac9c77fcd7f4e21daf398e9830de"></a><!-- doxytag: member="doc.cpp::gMasterDocument" ref="a1c0fac9c77fcd7f4e21daf398e9830de" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string <a class="el" href="sourcereader_8cpp.html#a1c0fac9c77fcd7f4e21daf398e9830de">gMasterDocument</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="main_8cpp_source.html#l00100">100</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
<p>Referenced by <a class="el" href="sourcereader_8cpp_source.html#l00303">declareMetadata()</a>, <a class="el" href="main_8cpp_source.html#l00452">initFaustDirectories()</a>, and <a class="el" href="main_8cpp_source.html#l00475">main()</a>.</p>
</div>
</div>
<a class="anchor" id="aaf647729deae314d35817ccb36f088e4"></a><!-- doxytag: member="doc.cpp::gMetaDataSet" ref="aaf647729deae314d35817ccb36f088e4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">map<<a class="el" href="classCTree.html">Tree</a>, set<<a class="el" href="classCTree.html">Tree</a>> > <a class="el" href="sourcereader_8cpp.html#aaf647729deae314d35817ccb36f088e4">gMetaDataSet</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="main_8cpp_source.html#l00087">87</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
<p>Referenced by <a class="el" href="sourcereader_8cpp_source.html#l00303">declareMetadata()</a>, <a class="el" href="main_8cpp_source.html#l00475">main()</a>, <a class="el" href="doc_8cpp_source.html#l00287">printdocheader()</a>, <a class="el" href="main_8cpp_source.html#l00387">printheader()</a>, <a class="el" href="klass_8cpp_source.html#l00655">Klass::println()</a>, and <a class="el" href="klass_8cpp_source.html#l00195">Klass::printMetadata()</a>.</p>
</div>
</div>
<a class="anchor" id="af59bae68e0652dd8c1ecbf661cbe8373"></a><!-- doxytag: member="doc.cpp::gReader" ref="af59bae68e0652dd8c1ecbf661cbe8373" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSourceReader.html">SourceReader</a> <a class="el" href="main_8cpp.html#af59bae68e0652dd8c1ecbf661cbe8373">gReader</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="main_8cpp_source.html#l00085">85</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a88af9e6ad20008837e470be54b69437c"></a><!-- doxytag: member="doc.cpp::gStripDocSwitch" ref="a88af9e6ad20008837e470be54b69437c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="main_8cpp.html#a88af9e6ad20008837e470be54b69437c">gStripDocSwitch</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="main_8cpp_source.html#l00117">117</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00360">printfaustlisting()</a>, and <a class="el" href="main_8cpp_source.html#l00160">process_cmdline()</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Apr 29 00:00:04 2010 for FAUST compiler by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
