a9d28dbe759f2efc13f16b49282b1656bfc7de50
[Faustine.git] / interpretor / faust-0.9.47mr3 / compiler / documentator / doc.hh
1 #ifndef _DOC_
2 #define _DOC_
3
4 /************************************************************************
5 ************************************************************************
6 FAUST compiler
7 Copyright (C) 2003-2004 GRAME, Centre National de Creation Musicale
8 ---------------------------------------------------------------------
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 ************************************************************************
23 ************************************************************************/
24
25
26
27 /*****************************************************************************
28 ******************************************************************************
29 FAUST DOCUMENTATOR
30 K. Barkati & Y. Orlarey, (c) Grame 2009
31 ------------------------------------------------------------------------------
32
33 History :
34 ---------
35 2009-07-19 : First version
36
37 ******************************************************************************
38 *****************************************************************************/
39
40 #include "tlib.hh"
41 #include "eval.hh"
42 //#include "signals.hh"
43
44 //struct Automaton;
45
46
47
48 /*****************************************************************************
49 ******************************************************************************
50
51 The Documentator
52
53 ******************************************************************************
54 *****************************************************************************/
55
56
57
58
59 /*****************************************************************************
60 Doc Types Creation & Test
61 *****************************************************************************/
62
63 Tree docTxt (const char*);
64 Tree docEqn (Tree x);
65 Tree docDgm (Tree x);
66 Tree docNtc ();
67 Tree docLst ();
68 Tree docMtd (Tree x);
69
70 bool isDocTxt (Tree t);
71 bool isDocTxt (Tree t, const char**);
72 bool isDocEqn (Tree t, Tree& x);
73 bool isDocDgm (Tree t, Tree& x);
74 bool isDocNtc (Tree t);
75 bool isDocLst (Tree t);
76 bool isDocMtd (Tree t);
77
78
79 /*****************************************************************************
80 Printing Public Function
81 *****************************************************************************/
82
83 void printDoc(const char* projname, const char* docdev, const char* faustversion);
84
85
86
87
88
89 #endif