<!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_autodoc.cpp Source File</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>
<h1>doc_autodoc.cpp</h1><a href="doc__autodoc_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/************************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> ************************************************************************</span>
<a name="l00003"></a>00003 <span class="comment"> FAUST compiler</span>
<a name="l00004"></a>00004 <span class="comment"> Copyright (C) 2003-2004 GRAME, Centre National de Creation Musicale</span>
<a name="l00005"></a>00005 <span class="comment"> ---------------------------------------------------------------------</span>
<a name="l00006"></a>00006 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00007"></a>00007 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00008"></a>00008 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00009"></a>00009 <span class="comment"> (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"> </span>
<a name="l00011"></a>00011 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00014"></a>00014 <span class="comment"> GNU General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"> </span>
<a name="l00016"></a>00016 <span class="comment"> You should have received a copy of the GNU General Public License</span>
<a name="l00017"></a>00017 <span class="comment"> along with this program; if not, write to the Free Software</span>
<a name="l00018"></a>00018 <span class="comment"> Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00019"></a>00019 <span class="comment"> ************************************************************************</span>
<a name="l00020"></a>00020 <span class="comment"> ************************************************************************/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#include <iostream></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <string></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <set></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <map></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <cstdlib></span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="doc__autodoc_8hh.html">doc_autodoc.hh</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="tlib_8hh.html">tlib.hh</a>"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="boxes_8hh.html">boxes.hh</a>"</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include "<a class="code" href="doc_8hh.html">doc.hh</a>"</span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">extern</span> <a class="code" href="classSourceReader.html">SourceReader</a> <a class="code" href="doc_8cpp.html#af59bae68e0652dd8c1ecbf661cbe8373">gReader</a>;
<a name="l00036"></a>00036
<a name="l00037"></a><a class="code" href="doc__lang_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">00037</a> map<string, string> <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>;
<a name="l00038"></a><a class="code" href="doc__lang_8cpp.html#adc3ebffae641bccf859c7175786b8276">00038</a> set<string> <a class="code" href="doc__autodoc_8cpp.html#adc3ebffae641bccf859c7175786b8276">gDocAutodocKeySet</a>;
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="doc__autodoc_8cpp.html#acaa5fea9d875d26a82c92910ff3b14f2" title="Initialize gDocAutodocKeySet, a set containing all the keywords.">initDocAutodocKeySet</a>();
<a name="l00041"></a>00041
<a name="l00042"></a>00042
<a name="l00043"></a>00043
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="comment">/*****************************************************************************</span>
<a name="l00046"></a>00046 <span class="comment"> Public functions</span>
<a name="l00047"></a>00047 <span class="comment"> *****************************************************************************/</span>
<a name="l00048"></a>00048
<a name="l00049"></a>00049
<a name="l00058"></a><a class="code" href="doc__autodoc_8hh.html#a397f3918046c844eb8a0d69a852547c7">00058</a> <span class="keywordtype">void</span> <a class="code" href="doc__autodoc_8cpp.html#a397f3918046c844eb8a0d69a852547c7" title="Declare an automatic documentation.">declareAutoDoc</a>()
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060 <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> autodoc = <a class="code" href="list_8cpp.html#a538b704dd07794b7237108f1917c471e">nil</a>;
<a name="l00061"></a>00061 <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> process = <a class="code" href="boxes_8cpp.html#ab32253e24dd40d91b770b381da0d35b1">boxIdent</a>(<span class="stringliteral">"process"</span>);
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="keywordtype">string</span> autoEquationTxt = <span class="stringliteral">"\n"</span> + <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autoeqntitle"</span>] + <span class="stringliteral">"\n\n"</span>;
<a name="l00064"></a>00064 autoEquationTxt += <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autoeqntext"</span>] + <span class="stringliteral">"\n"</span>;
<a name="l00065"></a>00065 autodoc = <a class="code" href="list_8hh.html#ae1ed153946fcfc025009c6d9c9c40bee">cons</a>(<a class="code" href="doc_8cpp.html#a3ef69c2f85a3c6ae95968d7563b4aff2">docTxt</a>(autoEquationTxt.c_str()), autodoc);
<a name="l00066"></a>00066 autodoc = <a class="code" href="list_8hh.html#ae1ed153946fcfc025009c6d9c9c40bee">cons</a>(<a class="code" href="doc_8cpp.html#a74f8c842c37fd8d9e01b397d79abe117">docEqn</a>(process), autodoc);
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="keywordtype">string</span> autoDiagramTxt = <span class="stringliteral">"\n"</span> + <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autodgmtitle"</span>] + <span class="stringliteral">"\n\n"</span>;
<a name="l00069"></a>00069 autoDiagramTxt += <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autodgmtext"</span>] + <span class="stringliteral">"\n"</span>;
<a name="l00070"></a>00070 autodoc = <a class="code" href="list_8hh.html#ae1ed153946fcfc025009c6d9c9c40bee">cons</a>(<a class="code" href="doc_8cpp.html#a3ef69c2f85a3c6ae95968d7563b4aff2">docTxt</a>(autoDiagramTxt.c_str()), autodoc);
<a name="l00071"></a>00071 autodoc = <a class="code" href="list_8hh.html#ae1ed153946fcfc025009c6d9c9c40bee">cons</a>(<a class="code" href="doc_8cpp.html#aa454efefb0dc22ade70352eee0fdb9ff">docDgm</a>(process), autodoc);
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keywordtype">string</span> autoNoticeTxt = <span class="stringliteral">"\n"</span> + <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autontctitle"</span>] + <span class="stringliteral">"\n\n"</span>;
<a name="l00074"></a>00074 autoNoticeTxt += <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autontctext"</span>] + <span class="stringliteral">"\n"</span>;
<a name="l00075"></a>00075 autodoc = <a class="code" href="list_8hh.html#ae1ed153946fcfc025009c6d9c9c40bee">cons</a>(<a class="code" href="doc_8cpp.html#a3ef69c2f85a3c6ae95968d7563b4aff2">docTxt</a>(autoNoticeTxt.c_str()), autodoc);
<a name="l00076"></a>00076 autodoc = <a class="code" href="list_8hh.html#ae1ed153946fcfc025009c6d9c9c40bee">cons</a>(<a class="code" href="doc_8cpp.html#a8d813459bc7fcb5ceba9c07ca205d1f1">docNtc</a>(), autodoc);
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="keywordtype">string</span> autoListingTxt;
<a name="l00079"></a>00079 vector<string> pathnames = gReader.<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="l00080"></a>00080 <span class="keywordflow">if</span>(pathnames.size() > 1) {
<a name="l00081"></a>00081 autoListingTxt = <span class="stringliteral">"\n"</span> + <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autolsttitle2"</span>] + <span class="stringliteral">"\n\n"</span>;
<a name="l00082"></a>00082 autoListingTxt += <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autolsttext2"</span>] + <span class="stringliteral">"\n"</span>;
<a name="l00083"></a>00083 } <span class="keywordflow">else</span> {
<a name="l00084"></a>00084 autoListingTxt = <span class="stringliteral">"\n"</span> + <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autolsttitle1"</span>] + <span class="stringliteral">"\n\n"</span>;
<a name="l00085"></a>00085 autoListingTxt += <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autolsttext1"</span>] + <span class="stringliteral">"\n"</span>;
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087 autodoc = <a class="code" href="list_8hh.html#ae1ed153946fcfc025009c6d9c9c40bee">cons</a>(<a class="code" href="doc_8cpp.html#a3ef69c2f85a3c6ae95968d7563b4aff2">docTxt</a>(autoListingTxt.c_str()), autodoc);
<a name="l00088"></a>00088 autodoc = <a class="code" href="list_8hh.html#ae1ed153946fcfc025009c6d9c9c40bee">cons</a>(<a class="code" href="doc_8cpp.html#a6710f31a71806f69ac8cf5c7933c4fa6">docLst</a>(), autodoc);
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <a class="code" href="sourcereader_8cpp.html#a7cd651735195e5651ebee01a3f6e914c">declareDoc</a>(autodoc);
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092
<a name="l00093"></a>00093
<a name="l00097"></a><a class="code" href="doc__autodoc_8hh.html#a1d778042564fea9d2d42bed09c836f13">00097</a> <span class="keywordtype">void</span> <a class="code" href="doc__autodoc_8cpp.html#a1d778042564fea9d2d42bed09c836f13" title="Dispatch initialization of autodoc container.">initDocAutodoc</a>()
<a name="l00098"></a>00098 {
<a name="l00099"></a>00099 <a class="code" href="doc__autodoc_8cpp.html#acaa5fea9d875d26a82c92910ff3b14f2" title="Initialize gDocAutodocKeySet, a set containing all the keywords.">initDocAutodocKeySet</a>();
<a name="l00100"></a>00100 }
<a name="l00101"></a>00101
<a name="l00102"></a>00102
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="comment">/*****************************************************************************</span>
<a name="l00105"></a>00105 <span class="comment"> Static functions</span>
<a name="l00106"></a>00106 <span class="comment"> *****************************************************************************/</span>
<a name="l00107"></a>00107
<a name="l00108"></a>00108
<a name="l00112"></a><a class="code" href="doc__autodoc_8cpp.html#acaa5fea9d875d26a82c92910ff3b14f2">00112</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="doc__autodoc_8cpp.html#acaa5fea9d875d26a82c92910ff3b14f2" title="Initialize gDocAutodocKeySet, a set containing all the keywords.">initDocAutodocKeySet</a>() {
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <a class="code" href="doc__autodoc_8cpp.html#adc3ebffae641bccf859c7175786b8276">gDocAutodocKeySet</a>.insert(<span class="stringliteral">"autoeqntitle"</span>);
<a name="l00115"></a>00115 <a class="code" href="doc__autodoc_8cpp.html#adc3ebffae641bccf859c7175786b8276">gDocAutodocKeySet</a>.insert(<span class="stringliteral">"autoeqntext"</span>);
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <a class="code" href="doc__autodoc_8cpp.html#adc3ebffae641bccf859c7175786b8276">gDocAutodocKeySet</a>.insert(<span class="stringliteral">"autodgmtitle"</span>);
<a name="l00118"></a>00118 <a class="code" href="doc__autodoc_8cpp.html#adc3ebffae641bccf859c7175786b8276">gDocAutodocKeySet</a>.insert(<span class="stringliteral">"autodgmtext"</span>);
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <a class="code" href="doc__autodoc_8cpp.html#adc3ebffae641bccf859c7175786b8276">gDocAutodocKeySet</a>.insert(<span class="stringliteral">"autontctitle"</span>);
<a name="l00121"></a>00121 <a class="code" href="doc__autodoc_8cpp.html#adc3ebffae641bccf859c7175786b8276">gDocAutodocKeySet</a>.insert(<span class="stringliteral">"autontctext"</span>);
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <a class="code" href="doc__autodoc_8cpp.html#adc3ebffae641bccf859c7175786b8276">gDocAutodocKeySet</a>.insert(<span class="stringliteral">"autolsttitle1"</span>);
<a name="l00124"></a>00124 <a class="code" href="doc__autodoc_8cpp.html#adc3ebffae641bccf859c7175786b8276">gDocAutodocKeySet</a>.insert(<span class="stringliteral">"autolsttext1"</span>);
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <a class="code" href="doc__autodoc_8cpp.html#adc3ebffae641bccf859c7175786b8276">gDocAutodocKeySet</a>.insert(<span class="stringliteral">"autolsttitle2"</span>);
<a name="l00127"></a>00127 <a class="code" href="doc__autodoc_8cpp.html#adc3ebffae641bccf859c7175786b8276">gDocAutodocKeySet</a>.insert(<span class="stringliteral">"autolsttext2"</span>);
<a name="l00128"></a>00128 }
<a name="l00129"></a>00129
<a name="l00130"></a>00130
<a name="l00134"></a><a class="code" href="doc__autodoc_8cpp.html#af602964a8cc5140f9453135a14c91436">00134</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="doc__autodoc_8cpp.html#af602964a8cc5140f9453135a14c91436" title="Simple trace function.">printDocAutodocStringMapContent</a>() {
<a name="l00135"></a>00135 <span class="keywordtype">bool</span> trace = <span class="keyword">false</span>;
<a name="l00136"></a>00136 <span class="keywordflow">if</span>(trace) {
<a name="l00137"></a>00137 cout << <span class="stringliteral">"gDocAutodocStringMap.size() = "</span> << <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>.size() << endl;
<a name="l00138"></a>00138 map<string,string>::iterator it;
<a name="l00139"></a>00139 <span class="keywordtype">int</span> i = 1;
<a name="l00140"></a>00140 <span class="keywordflow">for</span>(it = <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>.begin(); it!=<a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>.end(); ++it)
<a name="l00141"></a>00141 cout << i++ << <span class="stringliteral">".\tgDocNoticeStringMap["</span> << it->first << <span class="stringliteral">"] \t= '"</span> << it->second << <span class="stringliteral">"'"</span> << endl;
<a name="l00142"></a>00142 }
<a name="l00143"></a>00143 }
<a name="l00144"></a>00144
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Apr 28 23:59:58 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>
