1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/************************************************************************
************************************************************************
FAUST compiler
Copyright (C) 2003-2018 GRAME, Centre National de Creation Musicale
---------------------------------------------------------------------
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
************************************************************************
************************************************************************/
#include <cstdlib>
#include <iostream>
#include <map>
#include <set>
#include <string>
#include "boxes.hh"
#include "doc.hh"
#include "doc_autodoc.hh"
#include "global.hh"
#include "tlib.hh"
using namespace std;
/*****************************************************************************
Public functions
*****************************************************************************/
/**
* @brief Declare an automatic documentation.
*
* This function simulates a default documentation :
* if no <mdoc> tag was found in the input faust file,
* and yet the '-mdoc' option was called,
* then print a complete 'process' doc.
*/
void declareAutoDoc()
{
Tree autodoc = gGlobal->nil;
Tree process = boxIdent("process");
/** Autodoc's "head", with title, author, date, and metadatas. */
/** The latex title macro is bound to the metadata "name" if it exists,
(corresponding to "declare name") or else just to the file name. */
autodoc = cons(docTxt("\\title{"), autodoc);
if (gGlobal->gMetaDataSet.count(tree("name"))) {
autodoc = cons(docMtd(tree("name")), autodoc);
} else {
autodoc = cons(docTxt(gGlobal->gDocName.c_str()), autodoc);
}
autodoc = cons(docTxt("}\n"), autodoc);
/** The latex author macro is bound to the metadata "author" if it exists,
(corresponding to "declare author") or else no author item is printed. */
if (gGlobal->gMetaDataSet.count(tree("author"))) {
autodoc = cons(docTxt("\\author{"), autodoc);
autodoc = cons(docMtd(tree("author")), autodoc);
autodoc = cons(docTxt("}\n"), autodoc);
}
/** The latex date macro is bound to the metadata "date" if it exists,
(corresponding to "declare date") or else to the today latex macro. */
autodoc = cons(docTxt("\\date{"), autodoc);
if (gGlobal->gMetaDataSet.count(tree("date"))) {
autodoc = cons(docMtd(tree("date")), autodoc);
} else {
autodoc = cons(docTxt("\\today"), autodoc);
}
autodoc = cons(docTxt("}\n"), autodoc);
/** The latex maketitle macro. */
autodoc = cons(docTxt("\\maketitle\n"), autodoc);
/** Insert all declared metadatas in a latex tabular environment. */
if (!gGlobal->gMetaDataSet.empty()) {
autodoc = cons(docTxt("\\begin{tabular}{ll}\n"), autodoc);
autodoc = cons(docTxt("\t\\hline\n"), autodoc);
for (const auto& it : gGlobal->gMetaDataSet) {
string mtdkey = tree2str(it.first);
string mtdTranslatedKey = gGlobal->gDocMetadatasStringMap[mtdkey];
if (mtdTranslatedKey.empty()) {
mtdTranslatedKey = mtdkey;
}
autodoc = cons(docTxt("\t\\textbf{"), autodoc);
autodoc = cons(docTxt(mtdTranslatedKey.c_str()), autodoc);
autodoc = cons(docTxt("} & "), autodoc);
autodoc = cons(docMtd(tree(mtdkey.c_str())), autodoc);
autodoc = cons(docTxt(" \\\\\n"), autodoc);
}
autodoc = cons(docTxt("\t\\hline\n"), autodoc);
autodoc = cons(docTxt("\\end{tabular}\n"), autodoc);
autodoc = cons(docTxt("\\bigskip\n"), autodoc);
}
/** Autodoc's "body", with equation and diagram of process, and notice and listing. */
string autoPresentationTxt =
"\n\\bigskip \\\\ " + gGlobal->gDocAutodocStringMap["thisdoc"] + " \\\\ ";
autodoc = cons(docTxt(autoPresentationTxt.c_str()), autodoc);
string autoEquationTxt = "\n" + gGlobal->gDocAutodocStringMap["autoeqntitle"] + "\n\n";
autoEquationTxt += gGlobal->gDocAutodocStringMap["autoeqntext"] + "\n";
autodoc = cons(docTxt(autoEquationTxt.c_str()), autodoc);
autodoc = cons(docEqn(process), autodoc);
string autoDiagramTxt = "\n" + gGlobal->gDocAutodocStringMap["autodgmtitle"] + "\n\n";
autoDiagramTxt += gGlobal->gDocAutodocStringMap["autodgmtext"] + "\n";
autodoc = cons(docTxt(autoDiagramTxt.c_str()), autodoc);
autodoc = cons(docDgm(process), autodoc);
string autoNoticeTxt = "\n" + gGlobal->gDocAutodocStringMap["autontctitle"] + "\n\n";
// autoNoticeTxt += gGlobal->gDocAutodocStringMap["autontctext"] + "\n";
autodoc = cons(docTxt(autoNoticeTxt.c_str()), autodoc);
autodoc = cons(docNtc(), autodoc);
string autoListingTxt;
vector<string> pathnames = gGlobal->gReader.listSrcFiles();
if (pathnames.size() > 1) {
autoListingTxt = "\n" + gGlobal->gDocAutodocStringMap["autolsttitle2"] + "\n\n";
autoListingTxt += gGlobal->gDocAutodocStringMap["autolsttext2"] + "\n";
} else {
autoListingTxt = "\n" + gGlobal->gDocAutodocStringMap["autolsttitle1"] + "\n\n";
autoListingTxt += gGlobal->gDocAutodocStringMap["autolsttext1"] + "\n";
}
autodoc = cons(docTxt(autoListingTxt.c_str()), autodoc);
autodoc = cons(docLst(), autodoc);
declareDoc(autodoc);
}
/**
* Initialize gGlobal->gDocAutodocKeySet, a set containing all the keywords.
*/
void initDocAutodoc()
{
gGlobal->gDocAutodocKeySet.insert("thisdoc");
gGlobal->gDocAutodocKeySet.insert("autoeqntitle");
gGlobal->gDocAutodocKeySet.insert("autoeqntext");
gGlobal->gDocAutodocKeySet.insert("autodgmtitle");
gGlobal->gDocAutodocKeySet.insert("autodgmtext");
gGlobal->gDocAutodocKeySet.insert("autontctitle");
gGlobal->gDocAutodocKeySet.insert("autontctext");
gGlobal->gDocAutodocKeySet.insert("autolsttitle1");
gGlobal->gDocAutodocKeySet.insert("autolsttext1");
gGlobal->gDocAutodocKeySet.insert("autolsttitle2");
gGlobal->gDocAutodocKeySet.insert("autolsttext2");
}
#if 0
/**
* Simple trace function.
*/
static void printDocAutodocStringMapContent()
{
bool trace = false;
if (trace) {
cout << "gGlobal->gDocAutodocStringMap.size() = " << gGlobal->gDocAutodocStringMap.size() << endl;
map<string,string>::iterator it;
int i = 1;
for (it = gGlobal->gDocAutodocStringMap.begin(); it!=gGlobal->gDocAutodocStringMap.end(); ++it)
cout << i++ << ".\tgGlobal->gDocNoticeStringMap[" << it->first << "] \t= '" << it->second << "'" << endl;
}
}
#endif
|
