<!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.hh 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.hh File Reference</h1><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/>
<div class="dynheader">
Include dependency graph for doc.hh:</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_8hh_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</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_8hh.html#a5f8dc6249f173985d8067995e6d8450a">docTxt</a> (const char *)</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_8hh.html#a74f8c842c37fd8d9e01b397d79abe117">docEqn</a> (<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_8hh.html#aa454efefb0dc22ade70352eee0fdb9ff">docDgm</a> (<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_8hh.html#a8d813459bc7fcb5ceba9c07ca205d1f1">docNtc</a> ()</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_8hh.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_8hh.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_8hh.html#aa881e9aaddabd05ef454610927901eee">isDocTxt</a> (<a class="el" href="classCTree.html">Tree</a> t, const char **)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8hh.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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8hh.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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="doc_8hh.html#ac6cfa5258d1a4a0c52d636615be62a50">isDocNtc</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_8hh.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_8hh.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>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="aa454efefb0dc22ade70352eee0fdb9ff"></a><!-- doxytag: member="doc.hh::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.hh::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.hh::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.hh::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="a5f8dc6249f173985d8067995e6d8450a"></a><!-- doxytag: member="doc.hh::docTxt" ref="a5f8dc6249f173985d8067995e6d8450a" args="(const char *)" -->
<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"></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="adb0333bf59f0c1891e28e6b21b3060a1"></a><!-- doxytag: member="doc.hh::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.hh::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.hh::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.hh::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="aa881e9aaddabd05ef454610927901eee"></a><!-- doxytag: member="doc.hh::isDocTxt" ref="aa881e9aaddabd05ef454610927901eee" args="(Tree t, const char **)" -->
<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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"></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.hh::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="a8c5b3a35aaf051de7ed2a8e480a010f4"></a><!-- doxytag: member="doc.hh::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>
</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>
