]> git.tdb.fi Git - libs/gl.git/blob - source/programcompiler.h
Remove conditionals and loops that can be determined to never run
[libs/gl.git] / source / programcompiler.h
1 #ifndef MSP_GL_PROGRAMCOMPILER_H_
2 #define MSP_GL_PROGRAMCOMPILER_H_
3
4 #include <set>
5 #include "programparser.h"
6 #include "programsyntax.h"
7
8 namespace Msp {
9 namespace GL {
10
11 class Program;
12 class Resources;
13
14 class ProgramCompiler
15 {
16 private:
17         struct Visitor: ProgramSyntax::TraversingVisitor
18         {
19                 typedef void ResultType;
20
21                 ProgramSyntax::Stage *stage;
22
23                 Visitor();
24
25                 virtual void apply(ProgramSyntax::Stage &);
26                 void get_result() const { }
27         };
28
29         struct Formatter: Visitor
30         {
31                 typedef std::string ResultType;
32
33                 std::string formatted;
34                 unsigned indent;
35                 bool parameter_list;
36                 unsigned else_if;
37                 std::string block_interface;
38
39                 Formatter();
40
41                 const std::string &get_result() const { return formatted; }
42                 virtual void visit(ProgramSyntax::Block &);
43                 virtual void visit(ProgramSyntax::Literal &);
44                 virtual void visit(ProgramSyntax::ParenthesizedExpression &);
45                 virtual void visit(ProgramSyntax::VariableReference &);
46                 virtual void visit(ProgramSyntax::MemberAccess &);
47                 virtual void visit(ProgramSyntax::UnaryExpression &);
48                 virtual void visit(ProgramSyntax::BinaryExpression &);
49                 virtual void visit(ProgramSyntax::Assignment &);
50                 virtual void visit(ProgramSyntax::FunctionCall &);
51                 virtual void visit(ProgramSyntax::ExpressionStatement &);
52                 virtual void visit(ProgramSyntax::Import &);
53                 virtual void visit(ProgramSyntax::Layout &);
54                 virtual void visit(ProgramSyntax::StructDeclaration &);
55                 virtual void visit(ProgramSyntax::VariableDeclaration &);
56                 virtual void visit(ProgramSyntax::InterfaceBlock &);
57                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
58                 virtual void visit(ProgramSyntax::Conditional &);
59                 virtual void visit(ProgramSyntax::Iteration &);
60                 virtual void visit(ProgramSyntax::Return &);
61         };
62
63         template<typename T>
64         struct NodeGatherer: Visitor
65         {
66                 typedef std::list<T *> ResultType;
67
68                 std::list<T *> nodes;
69
70                 const ResultType &get_result() const { return nodes; }
71                 virtual void visit(T &n) { nodes.push_back(&n); }
72         };
73
74         struct DeclarationCombiner: Visitor
75         {
76                 bool toplevel;
77                 std::map<std::string, std::vector<ProgramSyntax::FunctionDeclaration *> > functions;
78                 std::map<std::string, ProgramSyntax::VariableDeclaration *> variables;
79                 bool remove_node;
80
81                 DeclarationCombiner();
82
83                 virtual void visit(ProgramSyntax::Block &);
84                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
85                 virtual void visit(ProgramSyntax::VariableDeclaration &);
86         };
87
88         struct VariableResolver: Visitor
89         {
90                 std::vector<ProgramSyntax::Block *> blocks;
91                 ProgramSyntax::StructDeclaration *type;
92                 bool anonymous;
93                 std::string block_interface;
94                 bool record_target;
95                 ProgramSyntax::VariableDeclaration *assignment_target;
96                 bool self_referencing;
97
98                 VariableResolver();
99
100                 virtual void apply(ProgramSyntax::Stage &);
101                 virtual void visit(ProgramSyntax::Block &);
102                 virtual void visit(ProgramSyntax::VariableReference &);
103                 virtual void visit(ProgramSyntax::MemberAccess &);
104                 virtual void visit(ProgramSyntax::BinaryExpression &);
105                 virtual void visit(ProgramSyntax::Assignment &);
106                 virtual void visit(ProgramSyntax::StructDeclaration &);
107                 virtual void visit(ProgramSyntax::VariableDeclaration &);
108                 virtual void visit(ProgramSyntax::InterfaceBlock &);
109         };
110
111         struct InterfaceGenerator: Visitor
112         {
113                 std::string in_prefix;
114                 std::string out_prefix;
115                 unsigned scope_level;
116                 std::map<std::string, ProgramSyntax::VariableDeclaration *> iface_declarations;
117                 bool remove_node;
118                 std::list<ProgramSyntax::Node *> insert_nodes;
119
120                 InterfaceGenerator();
121
122                 static std::string get_out_prefix(ProgramSyntax::StageType);
123                 virtual void apply(ProgramSyntax::Stage &);
124                 virtual void visit(ProgramSyntax::Block &);
125                 std::string change_prefix(const std::string &, const std::string &) const;
126                 bool generate_interface(ProgramSyntax::VariableDeclaration &, const std::string &, const std::string &);
127                 void insert_assignment(const std::string &, ProgramSyntax::Expression *);
128                 virtual void visit(ProgramSyntax::VariableReference &);
129                 virtual void visit(ProgramSyntax::VariableDeclaration &);
130                 virtual void visit(ProgramSyntax::Passthrough &);
131         };
132
133         struct VariableRenamer: Visitor
134         {
135                 virtual void visit(ProgramSyntax::VariableReference &);
136                 virtual void visit(ProgramSyntax::VariableDeclaration &);
137         };
138
139         struct ExpressionEvaluator: ProgramSyntax::NodeVisitor
140         {
141                 typedef std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Expression *> ValueMap;
142
143                 const ValueMap *variable_values;
144                 float result;
145                 bool result_valid;
146
147                 ExpressionEvaluator();
148                 ExpressionEvaluator(const ValueMap &);
149
150                 virtual void visit(ProgramSyntax::Literal &);
151                 virtual void visit(ProgramSyntax::VariableReference &);
152                 virtual void visit(ProgramSyntax::UnaryExpression &);
153                 virtual void visit(ProgramSyntax::BinaryExpression &);
154         };
155
156         struct ConstantConditionEliminator: Visitor
157         {
158                 unsigned scope_level;
159                 ExpressionEvaluator::ValueMap variable_values;
160                 bool remove_node;
161                 ProgramSyntax::Block *replacement_block;
162
163                 ConstantConditionEliminator();
164
165                 virtual void visit(ProgramSyntax::Block &);
166                 virtual void visit(ProgramSyntax::Assignment &);
167                 virtual void visit(ProgramSyntax::VariableDeclaration &);
168                 virtual void visit(ProgramSyntax::Conditional &);
169                 virtual void visit(ProgramSyntax::Iteration &);
170         };
171
172         struct UnusedVariableLocator: Visitor
173         {
174                 struct AssignmentList
175                 {
176                         std::vector<ProgramSyntax::Node *> nodes;
177                         bool conditional;
178                         bool self_referencing;
179                 };
180
181                 typedef std::set<ProgramSyntax::Node *> ResultType;
182                 typedef std::map<ProgramSyntax::VariableDeclaration *, AssignmentList> BlockAssignmentMap;
183
184                 std::set<ProgramSyntax::Node *> unused_nodes;
185                 std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Node *> aggregates;
186                 ProgramSyntax::Node *aggregate;
187                 std::vector<BlockAssignmentMap> assignments;
188                 ProgramSyntax::Assignment *assignment;
189                 bool assignment_target;
190
191                 UnusedVariableLocator();
192
193                 virtual void apply(ProgramSyntax::Stage &);
194                 const ResultType &get_result() const { return unused_nodes; }
195                 virtual void visit(ProgramSyntax::VariableReference &);
196                 virtual void visit(ProgramSyntax::MemberAccess &);
197                 virtual void visit(ProgramSyntax::BinaryExpression &);
198                 virtual void visit(ProgramSyntax::Assignment &);
199                 void record_assignment(ProgramSyntax::VariableDeclaration &, ProgramSyntax::Node &, bool);
200                 virtual void visit(ProgramSyntax::ExpressionStatement &);
201                 virtual void visit(ProgramSyntax::StructDeclaration &);
202                 virtual void visit(ProgramSyntax::VariableDeclaration &);
203                 virtual void visit(ProgramSyntax::InterfaceBlock &);
204                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
205                 void merge_down_assignments();
206                 virtual void visit(ProgramSyntax::Conditional &);
207                 virtual void visit(ProgramSyntax::Iteration &);
208         };
209
210         struct NodeRemover: Visitor
211         {
212                 std::set<ProgramSyntax::Node *> to_remove;
213
214                 NodeRemover() { }
215                 NodeRemover(const std::set<ProgramSyntax::Node *> &);
216
217                 virtual void visit(ProgramSyntax::Block &);
218                 virtual void visit(ProgramSyntax::VariableDeclaration &);
219         };
220
221         Resources *resources;
222         ProgramParser parser;
223         ProgramSyntax::Module *module;
224
225 public:
226         ProgramCompiler();
227
228         void compile(const std::string &);
229         void compile(IO::Base &, Resources * = 0);
230         void add_shaders(Program &);
231
232 private:
233         static ProgramSyntax::Module *create_builtins_module();
234         static ProgramSyntax::Module &get_builtins_module();
235         static ProgramSyntax::Stage *get_builtins(ProgramSyntax::StageType);
236         void process();
237         void import(const std::string &);
238         void generate(ProgramSyntax::Stage &);
239         bool optimize(ProgramSyntax::Stage &);
240         static void inject_block(ProgramSyntax::Block &, const ProgramSyntax::Block &);
241         template<typename T>
242         static typename T::ResultType apply(ProgramSyntax::Stage &);
243         template<typename T, typename A>
244         static typename T::ResultType apply(ProgramSyntax::Stage &, const A &);
245 };
246
247 } // namespace GL
248 } // namespace Msp
249
250 #endif