FAUST compiler: doc.hh Source File

Go to the documentation of this file.
00001 #ifndef _DOC_
00002 #define _DOC_
00003 
00004 /************************************************************************
00005  ************************************************************************
00006     FAUST compiler
00007     Copyright (C) 2003-2004 GRAME, Centre National de Creation Musicale
00008     ---------------------------------------------------------------------
00009     This program is free software; you can redistribute it and/or modify
00010     it under the terms of the GNU General Public License as published by
00011     the Free Software Foundation; either version 2 of the License, or
00012     (at your option) any later version.
00013 
00014     This program is distributed in the hope that it will be useful,
00015     but WITHOUT ANY WARRANTY; without even the implied warranty of
00016     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00017     GNU General Public License for more details.
00018 
00019     You should have received a copy of the GNU General Public License
00020     along with this program; if not, write to the Free Software
00021     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
00022  ************************************************************************
00023  ************************************************************************/
00024 
00025 
00026 
00027 /*****************************************************************************
00028 ******************************************************************************
00029                             FAUST DOCUMENTATOR
00030                         K. Barkati & Y. Orlarey, (c) Grame 2009
00031 ------------------------------------------------------------------------------
00032 
00033  History :
00034  ---------
00035     2009-07-19 : First version
00036 
00037 ******************************************************************************
00038 *****************************************************************************/
00039 
00040 #include "tlib.hh"
00041 #include "eval.hh"
00042 //#include "signals.hh"
00043 
00044 //struct Automaton;
00045 
00046 
00047 
00048 /*****************************************************************************
00049 ******************************************************************************
00050 
00051                                 The Documentator
00052 
00053 ******************************************************************************
00054 *****************************************************************************/
00055 
00056 
00057 
00058 
00059 /*****************************************************************************
00060                               Doc Types Creation & Test
00061 *****************************************************************************/
00062 
00063 Tree docTxt   (const char*);
00064 Tree docEqn   (Tree x);
00065 Tree docDgm   (Tree x);
00066 Tree docNtc   ();
00067 Tree docLst   ();
00068 Tree docMtd   (Tree x);
00069 
00070 bool isDocTxt   (Tree t);
00071 bool isDocTxt   (Tree t, const char**);
00072 bool isDocEqn   (Tree t, Tree& x);
00073 bool isDocDgm   (Tree t, Tree& x);
00074 bool isDocNtc   (Tree t);
00075 bool isDocLst   (Tree t);
00076 bool isDocMtd   (Tree t);
00077 
00078 
00079 /*****************************************************************************
00080                               Printing Public Function
00081 *****************************************************************************/
00082 
00083 void printDoc(const char* projname, const char* docdev, const char* faustversion);
00084 
00085 
00086 
00087 
00088 
00089 #endif