File: doc_compile.hh

package info (click to toggle)
faust 2.79.3%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 397,496 kB
  • sloc: cpp: 278,433; ansic: 116,164; javascript: 18,529; vhdl: 14,052; sh: 13,884; java: 5,900; objc: 3,852; python: 3,222; makefile: 2,655; cs: 1,672; lisp: 1,146; ruby: 954; yacc: 586; xml: 471; lex: 247; awk: 110; tcl: 26
file content (152 lines) | stat: -rw-r--r-- 6,632 bytes parent folder | download | duplicates (2)
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
/************************************************************************
 ************************************************************************
    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_COMPILE_SCAL_
#define _DOC_COMPILE_SCAL_

#include <list>
#include <map>
#include <string>

#include "Text.hh"
#include "description.hh"
#include "doc_Text.hh"
#include "garbageable.hh"
#include "lateq.hh"
#include "occurrences.hh"
#include "property.hh"
#include "signals.hh"
#include "sigtyperules.hh"

///////////////////////////////////////////////////////////////////////
/**
 * Compile a list of FAUST signals into a list of LaTeX formulas.
 */
///////////////////////////////////////////////////////////////////////

class DocCompiler : public virtual Garbageable {
   protected:
    property<std::string> fCompileProperty;
    property<std::string> fVectorProperty;

    Lateq*       fLateq;
    Description* fDescription;

    Tree      fSharingKey;
    OccMarkup fOccMarkup;
    int       fPriority;  ///< math priority context

   public:
    DocCompiler(int numInputs, int numOutputs)
        : fLateq(new Lateq(numInputs, numOutputs)), fDescription(0), fPriority(0)
    {
    }

    DocCompiler(Lateq* k, int priority) : fLateq(k), fDescription(0), fPriority(priority) {}

    virtual ~DocCompiler() {}

    Lateq* compileLateq(Tree L, Lateq* compiledEqn);
    Tree   annotate(Tree L0);

    Lateq*       getLateq() { return (Lateq*)fLateq; }
    void         setDescription(Description* descr) { fDescription = descr; }
    Description* getDescription() { return fDescription; }

   protected:
    std::string CS(Tree sig, int priority);
    std::string generateCode(Tree sig, int priority);
    std::string generateCacheCode(Tree sig, const std::string& exp);
    std::string generateVariableStore(Tree sig, const std::string& exp);

    std::string getFreshID(const std::string& prefix);

    bool        getCompiledExpression(Tree sig, std::string& name);
    std::string setCompiledExpression(Tree sig, const std::string& name);

    void setVectorNameProperty(Tree sig, const std::string& vecname);
    bool getVectorNameProperty(Tree sig, std::string& vecname);

    int  getSharingCount(Tree t);
    void setSharingCount(Tree t, int count);
    void sharingAnalysis(Tree t);
    void sharingAnnotation(int vctxt, Tree t);

    bool isShortEnough(std::string& s, unsigned int max);

    /* Code generation. */

    std::string generateXtended(Tree sig, int priority);
    std::string generateDelayAccess(Tree sig, Tree arg, Tree size, int priority);
    std::string generatePrefix(Tree sig, Tree x, Tree e, int priority);
    std::string generateBinOp(Tree sig, int opcode, Tree arg1, Tree arg2, int priority);

    std::string generateFFun(Tree sig, Tree ff, Tree largs, int priority);

    std::string generateInput(Tree sig, const std::string& idx);
    std::string generateOutput(Tree sig, const std::string& idx, const std::string& arg1);

    std::string generateDocConstantTbl(Tree sig, Tree size, Tree content);
    std::string generateDocWriteTbl(Tree sig, Tree size, Tree content, Tree widx, Tree wsig);
    std::string generateDocAccessTbl(Tree sig, Tree tbl, Tree ridx);

    std::string generateSelect2(Tree sig, Tree sel, Tree s1, Tree s2, int priority);

    std::string generateRecProj(Tree sig, Tree exp, int i, int priority);
    void        generateRec(Tree sig, Tree var, Tree le, int priority);

    std::string generateIntCast(Tree sig, Tree x, int priority);
    std::string generateFloatCast(Tree sig, Tree x, int priority);

    std::string generateButton(Tree sig, Tree label);
    std::string generateCheckbox(Tree sig, Tree label);
    std::string generateVSlider(Tree sig, Tree label, Tree cur, Tree min, Tree max, Tree step);
    std::string generateHSlider(Tree sig, Tree label, Tree cur, Tree min, Tree max, Tree step);
    std::string generateNumEntry(Tree sig, Tree label, Tree cur, Tree min, Tree max, Tree step);

    std::string generateVBargraph(Tree sig, Tree label, Tree min, Tree max, const std::string& exp);
    std::string generateHBargraph(Tree sig, Tree label, Tree min, Tree max, const std::string& exp);
    std::string generateAttach(Tree sig, Tree x, Tree y, int priority);
    std::string generateControl(Tree sig, Tree arg1, Tree arg2, int priority);
    std::string generateNumber(Tree sig, const std::string& exp);
    std::string generateFConst(Tree sig, const std::string& file, const std::string& name);
    std::string generateFVar(Tree sig, const std::string& file, const std::string& name);

    std::string generateDelayVec(Tree sig, const std::string& exp, const std::string& ctype,
                                 const std::string& vname, int mxd);
    std::string generateDelayVecNoTemp(Tree sig, const std::string& exp, const std::string& ctype,
                                       const std::string& vname, int mxd);
    void        generateDelayLine(const std::string& ctype, const std::string& vname, int mxd,
                                  const std::string& exp);

    void getTypedNames(Type t, const std::string& prefix, std::string& ctype, std::string& vname);
    void printGCCall(Tree sig, const std::string& calledFunction);

    /* Managment of user interface elements. */

    void        getUIDocInfos(Tree path, std::string& label, std::string& unit);
    std::string getUIDir(Tree pathname);
    std::string prepareBinaryUI(const std::string& name, Tree pathname);
    std::string prepareIntervallicUI(const std::string& name, Tree path, Tree tcur, Tree tmin,
                                     Tree tmax);
};

#endif