File: doc.hh

package info (click to toggle)
faust 2.81.10%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 431,496 kB
  • sloc: cpp: 283,941; ansic: 116,215; javascript: 18,529; sh: 14,356; vhdl: 14,052; java: 5,900; python: 5,091; objc: 3,852; makefile: 2,725; cs: 1,672; lisp: 1,146; ruby: 954; yacc: 586; xml: 471; lex: 247; awk: 111; tcl: 26
file content (74 lines) | stat: -rw-r--r-- 3,022 bytes parent folder | download | duplicates (3)
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
/************************************************************************
 ************************************************************************
    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.
 ************************************************************************
 ************************************************************************/

#ifndef _DOC_
#define _DOC_

/*****************************************************************************
******************************************************************************
                            FAUST DOCUMENTATOR
                        K. Barkati & Y. Orlarey, (c) Grame 2009
------------------------------------------------------------------------------

 History :
 ---------
    2009-07-19 : First version

******************************************************************************
*****************************************************************************/

#include "eval.hh"
#include "tlib.hh"

/*****************************************************************************
******************************************************************************

                                The Documentator

******************************************************************************
*****************************************************************************/

/*****************************************************************************
                              Doc Types Creation & Test
*****************************************************************************/

Tree docTxt(const char*);
Tree docEqn(Tree x);
Tree docDgm(Tree x);
Tree docNtc();
Tree docLst();
Tree docMtd(Tree x);

bool isDocTxt(Tree t);
bool isDocTxt(Tree t, const char**);
bool isDocEqn(Tree t, Tree& x);
bool isDocDgm(Tree t, Tree& x);
bool isDocNtc(Tree t);
bool isDocLst(Tree t);
bool isDocMtd(Tree t);

/*****************************************************************************
                              Printing Public Function
*****************************************************************************/

void printDoc(const char* projname, const char* docdev, const char* faustversion);

#endif