New directory tree, with preprocessor/ inside interpretor/.

[Faustine.git] / interpretor / preprocessor / faust-0.9.47mr3 / compiler / headers / sigtyperules.hh

diff --git a/interpretor/preprocessor/faust-0.9.47mr3/compiler/headers/sigtyperules.hh b/interpretor/preprocessor/faust-0.9.47mr3/compiler/headers/sigtyperules.hh
new file mode 100644 (file)
index 0000000..e8d405e
--- /dev/null
+++ b/interpretor/preprocessor/faust-0.9.47mr3/compiler/headers/sigtyperules.hh
@@ -0,0 +1,71 @@
+/************************************************************************
+ ************************************************************************
+    FAUST compiler
+       Copyright (C) 2003-2004 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 General Public License as published by
+    the Free Software Foundation; either version 2 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 General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ ************************************************************************
+ ************************************************************************/
+
+
+
+#ifndef _SIGTYPERULES_
+#define _SIGTYPERULES_
+
+#include "signals.hh"
+#include "sigtype.hh"
+#include "sigraterules.hh"
+
+
+extern bool gVectorSwitch;
+
+
+/** \file sigtyperules.hh
+ * API to the typing system of signals
+ *
+ * Two functions are provided :
+ *
+ * \li void typeAnnotation(Tree term)       : annotates a signal term and its subterms with type information
+ * \li Type getCertifiedSigType(Tree term)  : return the type of a previously annotated signal term
+ *
+ * TypeAnnotation must be called first to annotate a signal or a list of signals, before being able to
+ * call getCertifiedType on any subterms. GetCertifiedType will produce an error if a term was not
+ * previously annotated.
+ *
+ **/
+
+
+
+
+/**
+ *     Annotates a signal term and its subterms with type information
+ */
+void typeAnnotation(Tree term);
+
+
+
+/**
+ *     Return the type of a previously annotated signal term
+ */
+Type getCertifiedSigType(Tree term);
+
+
+/**
+ *     print annotation statistics
+ */
+void annotationStatistics();
+
+#endif
+