]> git.tdb.fi Git - libs/gl.git/blob - source/programcompiler.cpp
79031e41eeda0cc970162d3632c31eaadd253ae5
[libs/gl.git] / source / programcompiler.cpp
1 #include <msp/core/raii.h>
2 #include <msp/strings/format.h>
3 #include <msp/strings/utils.h>
4 #include "error.h"
5 #include "program.h"
6 #include "programcompiler.h"
7 #include "shader.h"
8
9 using namespace std;
10
11 namespace Msp {
12 namespace GL {
13
14 using namespace ProgramSyntax;
15
16 ProgramCompiler::ProgramCompiler():
17         module(0)
18 { }
19
20 void ProgramCompiler::compile(const string &source)
21 {
22         module = &parser.parse(source);
23         process();
24 }
25
26 void ProgramCompiler::compile(IO::Base &io)
27 {
28         module = &parser.parse(io);
29         process();
30 }
31
32 void ProgramCompiler::add_shaders(Program &program)
33 {
34         if(!module)
35                 throw invalid_operation("ProgramCompiler::add_shaders");
36
37         string head = "#version 150\n";
38         for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
39         {
40                 if(i->type==VERTEX)
41                         program.attach_shader_owned(new VertexShader(head+create_source(*i)));
42                 else if(i->type==GEOMETRY)
43                         program.attach_shader_owned(new GeometryShader(head+create_source(*i)));
44                 else if(i->type==FRAGMENT)
45                         program.attach_shader_owned(new FragmentShader(head+create_source(*i)));
46         }
47
48         program.bind_attribute(VERTEX4, "vertex");
49         program.bind_attribute(NORMAL3, "normal");
50         program.bind_attribute(COLOR4_FLOAT, "color");
51         program.bind_attribute(TEXCOORD4, "texcoord");
52 }
53
54 void ProgramCompiler::process()
55 {
56         for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
57                 generate(*i);
58         for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
59                 optimize(*i);
60 }
61
62 void ProgramCompiler::generate(Stage &stage)
63 {
64         inject_block(stage.content, module->shared.content);
65
66         apply<VariableResolver>(stage);
67         apply<InterfaceGenerator>(stage);
68         apply<VariableResolver>(stage);
69         apply<VariableRenamer>(stage);
70 }
71
72 void ProgramCompiler::optimize(Stage &stage)
73 {
74         while(1)
75         {
76                 UnusedVariableLocator unused_locator;
77                 unused_locator.apply(stage);
78
79                 NodeRemover remover;
80                 remover.to_remove = unused_locator.unused_nodes;
81                 remover.apply(stage);
82
83                 if(!remover.n_removed)
84                         break;
85         }
86 }
87
88 void ProgramCompiler::inject_block(Block &target, const Block &source)
89 {
90         list<NodePtr<Node> >::iterator insert_point = target.body.begin();
91         for(list<NodePtr<Node> >::const_iterator i=source.body.begin(); i!=source.body.end(); ++i)
92                 target.body.insert(insert_point, (*i)->clone());
93 }
94
95 template<typename T>
96 void ProgramCompiler::apply(Stage &stage)
97 {
98         T visitor;
99         visitor.apply(stage);
100 }
101
102 string ProgramCompiler::create_source(Stage &stage)
103 {
104         Formatter formatter;
105         formatter.apply(stage);
106         return formatter.formatted;
107 }
108
109
110 ProgramCompiler::Visitor::Visitor():
111         stage(0)
112 { }
113
114 void ProgramCompiler::Visitor::apply(Stage &s)
115 {
116         SetForScope<Stage *> set(stage, &s);
117         stage->content.visit(*this);
118 }
119
120
121 ProgramCompiler::Formatter::Formatter():
122         indent(0),
123         parameter_list(false),
124         else_if(false)
125 { }
126
127 void ProgramCompiler::Formatter::visit(Literal &literal)
128 {
129         formatted += literal.token;
130 }
131
132 void ProgramCompiler::Formatter::visit(ParenthesizedExpression &parexpr)
133 {
134         formatted += '(';
135         parexpr.expression->visit(*this);
136         formatted += ')';
137 }
138
139 void ProgramCompiler::Formatter::visit(VariableReference &var)
140 {
141         formatted += var.name;
142 }
143
144 void ProgramCompiler::Formatter::visit(MemberAccess &memacc)
145 {
146         memacc.left->visit(*this);
147         formatted += format(".%s", memacc.member);
148 }
149
150 void ProgramCompiler::Formatter::visit(UnaryExpression &unary)
151 {
152         if(unary.prefix)
153                 formatted += unary.oper;
154         unary.expression->visit(*this);
155         if(!unary.prefix)
156                 formatted += unary.oper;
157 }
158
159 void ProgramCompiler::Formatter::visit(BinaryExpression &binary)
160 {
161         binary.left->visit(*this);
162         if(binary.assignment)
163                 formatted += format(" %s ", binary.oper);
164         else
165                 formatted += binary.oper;
166         binary.right->visit(*this);
167         formatted += binary.after;
168 }
169
170 void ProgramCompiler::Formatter::visit(FunctionCall &call)
171 {
172         formatted += format("%s(", call.name);
173         for(vector<NodePtr<Expression> >::iterator i=call.arguments.begin(); i!=call.arguments.end(); ++i)
174         {
175                 if(i!=call.arguments.begin())
176                         formatted += ", ";
177                 (*i)->visit(*this);
178         }
179         formatted += ')';
180 }
181
182 void ProgramCompiler::Formatter::visit(ExpressionStatement &expr)
183 {
184         expr.expression->visit(*this);
185         formatted += ';';
186 }
187
188 void ProgramCompiler::Formatter::visit(Block &block)
189 {
190         if(block.use_braces)
191         {
192                 if(else_if)
193                 {
194                         formatted += '\n';
195                         else_if = false;
196                 }
197                 formatted += format("%s{\n", string(indent*2, ' '));
198         }
199
200         bool change_indent = (!formatted.empty() && !else_if);
201         indent += change_indent;
202         string spaces(indent*2, ' ');
203         for(list<NodePtr<Node> >::iterator i=block.body.begin(); i!=block.body.end(); ++i)
204         {
205                 if(i!=block.body.begin())
206                         formatted += '\n';
207                 if(!else_if)
208                         formatted += spaces;
209                 (*i)->visit(*this);
210         }
211         indent -= change_indent;
212
213         if(block.use_braces)
214                 formatted += format("\n%s}", string(indent*2, ' '));
215 }
216
217 void ProgramCompiler::Formatter::visit(Layout &layout)
218 {
219         formatted += "layout(";
220         for(vector<Layout::Qualifier>::const_iterator i=layout.qualifiers.begin(); i!=layout.qualifiers.end(); ++i)
221         {
222                 if(i!=layout.qualifiers.begin())
223                         formatted += ", ";
224                 formatted += i->identifier;
225                 if(!i->value.empty())
226                         formatted += format("=%s", i->value);
227         }
228         formatted += format(") %s;", layout.interface);
229 }
230
231 void ProgramCompiler::Formatter::visit(StructDeclaration &strct)
232 {
233         formatted += format("struct %s\n", strct.name);
234         strct.members.visit(*this);
235         formatted += ';';
236 }
237
238 void ProgramCompiler::Formatter::visit(VariableDeclaration &var)
239 {
240         if(var.constant)
241                 formatted += "const ";
242         if(!var.sampling.empty())
243                 formatted += format("%s ", var.sampling);
244         if(!var.interface.empty())
245                 formatted += format("%s ", var.interface);
246         formatted += format("%s %s", var.type, var.name);
247         if(var.array)
248         {
249                 formatted += '[';
250                 if(var.array_size)
251                         var.array_size->visit(*this);
252                 formatted += ']';
253         }
254         if(var.init_expression)
255         {
256                 formatted += " = ";
257                 var.init_expression->visit(*this);
258         }
259         if(!parameter_list)
260                 formatted += ';';
261 }
262
263 void ProgramCompiler::Formatter::visit(InterfaceBlock &iface)
264 {
265         formatted += format("%s %s\n", iface.interface, iface.name);
266         iface.members.visit(*this);
267         formatted += ';';
268 }
269
270 void ProgramCompiler::Formatter::visit(FunctionDeclaration &func)
271 {
272         formatted += format("%s %s(", func.return_type, func.name);
273         for(vector<NodePtr<VariableDeclaration> >::iterator i=func.parameters.begin(); i!=func.parameters.end(); ++i)
274         {
275                 if(i!=func.parameters.begin())
276                         formatted += ", ";
277                 SetFlag set(parameter_list);
278                 (*i)->visit(*this);
279         }
280         formatted += ')';
281         if(func.definition)
282         {
283                 formatted += '\n';
284                 func.body.visit(*this);
285         }
286         else
287                 formatted += ';';
288 }
289
290 void ProgramCompiler::Formatter::visit(Conditional &cond)
291 {
292         if(else_if)
293         {
294                 formatted += ' ';
295                 else_if = false;
296         }
297
298         formatted += "if(";
299         cond.condition->visit(*this);
300         formatted += ")\n";
301
302         cond.body.visit(*this);
303         if(!cond.else_body.body.empty())
304         {
305                 formatted += format("\n%selse", string(indent*2, ' '));
306                 SetFlag set(else_if);
307                 cond.else_body.visit(*this);
308         }
309 }
310
311 void ProgramCompiler::Formatter::visit(Iteration &iter)
312 {
313         formatted += "for(";
314         iter.init_statement->visit(*this);
315         formatted += ' ';
316         iter.condition->visit(*this);
317         formatted += "; ";
318         iter.loop_expression->visit(*this);
319         formatted += ")\n";
320         iter.body.visit(*this);
321 }
322
323 void ProgramCompiler::Formatter::visit(Return &ret)
324 {
325         formatted += "return ";
326         ret.expression->visit(*this);
327         formatted += ';';
328 }
329
330
331 ProgramCompiler::VariableResolver::VariableResolver():
332         anonymous(false)
333 { }
334
335 void ProgramCompiler::VariableResolver::visit(Block &block)
336 {
337         blocks.push_back(&block);
338         block.variables.clear();
339         TraversingVisitor::visit(block);
340         blocks.pop_back();
341 }
342
343 void ProgramCompiler::VariableResolver::visit(VariableReference &var)
344 {
345         var.declaration = 0;
346         type = 0;
347         for(vector<Block *>::iterator i=blocks.end(); i!=blocks.begin(); )
348         {
349                 --i;
350                 map<string, VariableDeclaration *>::iterator j = (*i)->variables.find(var.name);
351                 if(j!=(*i)->variables.end())
352                 {
353                         var.declaration = j->second;
354                         type = j->second->type_declaration;
355                         break;
356                 }
357         }
358 }
359
360 void ProgramCompiler::VariableResolver::visit(MemberAccess &memacc)
361 {
362         type = 0;
363         TraversingVisitor::visit(memacc);
364         memacc.declaration = 0;
365         if(type)
366         {
367                 map<string, VariableDeclaration *>::iterator i = type->members.variables.find(memacc.member);
368                 if(i!=type->members.variables.end())
369                 {
370                         memacc.declaration = i->second;
371                         type = i->second->type_declaration;
372                 }
373                 else
374                         type = 0;
375         }
376 }
377
378 void ProgramCompiler::VariableResolver::visit(BinaryExpression &binary)
379 {
380         if(binary.oper=="[")
381         {
382                 binary.right->visit(*this);
383                 type = 0;
384                 binary.left->visit(*this);
385         }
386         else
387         {
388                 TraversingVisitor::visit(binary);
389                 type = 0;
390         }
391 }
392
393 void ProgramCompiler::VariableResolver::visit(StructDeclaration &strct)
394 {
395         TraversingVisitor::visit(strct);
396         blocks.back()->types[strct.name] = &strct;
397 }
398
399 void ProgramCompiler::VariableResolver::visit(VariableDeclaration &var)
400 {
401         for(vector<Block *>::iterator i=blocks.end(); i!=blocks.begin(); )
402         {
403                 --i;
404                 map<string, StructDeclaration *>::iterator j = (*i)->types.find(var.type);
405                 if(j!=(*i)->types.end())
406                         var.type_declaration = j->second;
407         }
408
409         TraversingVisitor::visit(var);
410         blocks.back()->variables[var.name] = &var;
411         if(anonymous && blocks.size()>1)
412                 blocks[blocks.size()-2]->variables[var.name] = &var;
413 }
414
415 void ProgramCompiler::VariableResolver::visit(InterfaceBlock &iface)
416 {
417         SetFlag set(anonymous);
418         TraversingVisitor::visit(iface);
419 }
420
421
422 ProgramCompiler::InterfaceGenerator::InterfaceGenerator():
423         scope_level(0),
424         remove_node(false)
425 { }
426
427 string ProgramCompiler::InterfaceGenerator::get_out_prefix(StageType type)
428 {
429         if(type==VERTEX)
430                 return "_vs_out_";
431         else if(type==GEOMETRY)
432                 return "_gs_out_";
433         else
434                 return string();
435 }
436
437 void ProgramCompiler::InterfaceGenerator::apply(Stage &s)
438 {
439         SetForScope<Stage *> set(stage, &s);
440         if(stage->previous)
441                 in_prefix = get_out_prefix(stage->previous->type);
442         out_prefix = get_out_prefix(stage->type);
443         stage->content.visit(*this);
444 }
445
446 void ProgramCompiler::InterfaceGenerator::visit(Block &block)
447 {
448         SetForScope<unsigned> set(scope_level, scope_level+1);
449         for(list<NodePtr<Node> >::iterator i=block.body.begin(); i!=block.body.end(); )
450         {
451                 (*i)->visit(*this);
452
453                 if(scope_level==1)
454                 {
455                         for(map<string, VariableDeclaration *>::iterator j=iface_declarations.begin(); j!=iface_declarations.end(); ++j)
456                         {
457                                 list<NodePtr<Node> >::iterator k = block.body.insert(i, j->second);
458                                 (*k)->visit(*this);
459                         }
460                         iface_declarations.clear();
461                 }
462
463                 for(list<Node *>::iterator j=insert_nodes.begin(); j!=insert_nodes.end(); ++j)
464                         block.body.insert(i, *j);
465                 insert_nodes.clear();
466
467                 if(remove_node)
468                         block.body.erase(i++);
469                 else
470                         ++i;
471                 remove_node = false;
472         }
473 }
474
475 string ProgramCompiler::InterfaceGenerator::change_prefix(const string &name, const string &prefix) const
476 {
477         unsigned offset = (name.compare(0, in_prefix.size(), in_prefix) ? 0 : in_prefix.size());
478         return prefix+name.substr(offset);
479 }
480
481 bool ProgramCompiler::InterfaceGenerator::generate_interface(VariableDeclaration &var, const string &iface, const string &name)
482 {
483         const map<string, VariableDeclaration *> &stage_vars = (iface=="in" ? stage->in_variables : stage->out_variables);
484         if(stage_vars.count(name) || iface_declarations.count(name))
485                 return false;
486
487         VariableDeclaration* iface_var = new VariableDeclaration;
488         iface_var->sampling = var.sampling;
489         iface_var->interface = iface;
490         iface_var->type = var.type;
491         iface_var->type_declaration = var.type_declaration;
492         iface_var->name = name;
493         iface_var->array = (var.array || (stage->type==GEOMETRY && iface=="in"));
494         iface_var->array_size = var.array_size;
495         if(iface=="in")
496                 iface_var->linked_declaration = &var;
497         iface_declarations[name] = iface_var;
498
499         return true;
500 }
501
502 void ProgramCompiler::InterfaceGenerator::insert_assignment(const string &left, ProgramSyntax::Expression *right)
503 {
504         BinaryExpression *assign = new BinaryExpression;
505         VariableReference *ref = new VariableReference;
506         ref->name = left;
507         assign->left = ref;
508         assign->oper = "=";
509         assign->right = right;
510         assign->assignment = true;
511
512         ExpressionStatement *stmt = new ExpressionStatement;
513         stmt->expression = assign;
514         insert_nodes.push_back(stmt);
515 }
516
517 void ProgramCompiler::InterfaceGenerator::visit(VariableReference &var)
518 {
519         if(var.declaration || !stage->previous)
520                 return;
521         if(iface_declarations.count(var.name))
522                 return;
523
524         const map<string, VariableDeclaration *> &prev_out = stage->previous->out_variables;
525         map<string, VariableDeclaration *>::const_iterator i = prev_out.find(var.name);
526         if(i==prev_out.end())
527                 i = prev_out.find(in_prefix+var.name);
528         if(i!=prev_out.end())
529                 generate_interface(*i->second, "in", var.name);
530 }
531
532 void ProgramCompiler::InterfaceGenerator::visit(VariableDeclaration &var)
533 {
534         if(var.interface=="out")
535         {
536                 if(scope_level==1)
537                         stage->out_variables[var.name] = &var;
538                 else if(generate_interface(var, "out", change_prefix(var.name, string())))
539                 {
540                         remove_node = true;
541                         if(var.init_expression)
542                                 insert_assignment(var.name, var.init_expression->clone());
543                 }
544         }
545         else if(var.interface=="in")
546         {
547                 stage->in_variables[var.name] = &var;
548                 if(var.linked_declaration)
549                         var.linked_declaration->linked_declaration = &var;
550                 else if(stage->previous)
551                 {
552                         const map<string, VariableDeclaration *> &prev_out = stage->previous->out_variables;
553                         map<string, VariableDeclaration *>::const_iterator i = prev_out.find(var.name);
554                         if(i!=prev_out.end())
555                         {
556                                 var.linked_declaration = i->second;
557                                 i->second->linked_declaration = &var;
558                         }
559                 }
560         }
561
562         TraversingVisitor::visit(var);
563 }
564
565 void ProgramCompiler::InterfaceGenerator::visit(Passthrough &pass)
566 {
567         vector<VariableDeclaration *> pass_vars;
568
569         for(map<string, VariableDeclaration *>::const_iterator i=stage->in_variables.begin(); i!=stage->in_variables.end(); ++i)
570                 pass_vars.push_back(i->second);
571         for(map<string, VariableDeclaration *>::const_iterator i=iface_declarations.begin(); i!=iface_declarations.end(); ++i)
572                 if(i->second->interface=="in")
573                         pass_vars.push_back(i->second);
574
575         if(stage->previous)
576         {
577                 const map<string, VariableDeclaration *> &prev_out = stage->previous->out_variables;
578                 for(map<string, VariableDeclaration *>::const_iterator i=prev_out.begin(); i!=prev_out.end(); ++i)
579                 {
580                         bool linked = false;
581                         for(vector<VariableDeclaration *>::const_iterator j=pass_vars.begin(); (!linked && j!=pass_vars.end()); ++j)
582                                 linked = ((*j)->linked_declaration==i->second);
583
584                         if(!linked && generate_interface(*i->second, "in", i->second->name))
585                                 pass_vars.push_back(i->second);
586                 }
587         }
588
589         for(vector<VariableDeclaration *>::const_iterator i=pass_vars.begin(); i!=pass_vars.end(); ++i)
590         {
591                 string out_name = change_prefix((*i)->name, out_prefix);
592                 generate_interface(**i, "out", out_name);
593
594                 VariableReference *ref = new VariableReference;
595                 ref->name = (*i)->name;
596                 if(pass.subscript)
597                 {
598                         BinaryExpression *subscript = new BinaryExpression;
599                         subscript->left = ref;
600                         subscript->oper = "[";
601                         subscript->right = pass.subscript;
602                         subscript->after = "]";
603                         insert_assignment(out_name, subscript);
604                 }
605                 else
606                         insert_assignment(out_name, ref);
607         }
608
609         remove_node = true;
610 }
611
612
613 void ProgramCompiler::VariableRenamer::visit(VariableReference &var)
614 {
615         if(var.declaration)
616                 var.name = var.declaration->name;
617 }
618
619 void ProgramCompiler::VariableRenamer::visit(VariableDeclaration &var)
620 {
621         if(var.linked_declaration)
622                 var.name = var.linked_declaration->name;
623         TraversingVisitor::visit(var);
624 }
625
626
627 ProgramCompiler::UnusedVariableLocator::UnusedVariableLocator():
628         assignment(false),
629         assignment_target(0)
630 { }
631
632 void ProgramCompiler::UnusedVariableLocator::visit(VariableReference &var)
633 {
634         if(assignment)
635                 assignment_target = var.declaration;
636         else
637         {
638                 unused_nodes.erase(var.declaration);
639                 map<VariableDeclaration *, Node *>::iterator i = assignments.find(var.declaration);
640                 if(i!=assignments.end())
641                 {
642                         unused_nodes.erase(i->second);
643                         assignments.erase(i);
644                 }
645         }
646 }
647
648 void ProgramCompiler::UnusedVariableLocator::visit(MemberAccess &memacc)
649 {
650         TraversingVisitor::visit(memacc);
651         unused_nodes.erase(memacc.declaration);
652 }
653
654 void ProgramCompiler::UnusedVariableLocator::visit(BinaryExpression &binary)
655 {
656         if(binary.assignment)
657         {
658                 binary.right->visit(*this);
659                 assignment = true;
660                 binary.left->visit(*this);
661         }
662         else
663                 TraversingVisitor::visit(binary);
664 }
665
666 void ProgramCompiler::UnusedVariableLocator::visit(ExpressionStatement &expr)
667 {
668         assignment = false;
669         assignment_target = 0;
670         TraversingVisitor::visit(expr);
671         if(assignment && assignment_target)
672         {
673                 Node *&assign = assignments[assignment_target];
674                 if(assign)
675                         unused_nodes.insert(assign);
676                 assign = &expr;
677                 if(assignment_target->interface!="out" || (stage->type!=FRAGMENT && !assignment_target->linked_declaration))
678                         unused_nodes.insert(&expr);
679                 else
680                         unused_nodes.erase(assignment_target);
681         }
682         assignment = false;
683 }
684
685 void ProgramCompiler::UnusedVariableLocator::visit(VariableDeclaration &var)
686 {
687         unused_nodes.insert(&var);
688         TraversingVisitor::visit(var);
689 }
690
691
692 ProgramCompiler::NodeRemover::NodeRemover():
693         n_removed(0),
694         immutable_block(false),
695         remove_block(false)
696 { }
697
698 void ProgramCompiler::NodeRemover::visit(Block &block)
699 {
700         remove_block = immutable_block;
701         for(list<NodePtr<Node> >::iterator i=block.body.begin(); i!=block.body.end(); )
702         {
703                 bool remove = to_remove.count(&**i);
704                 if(!remove)
705                         remove_block = false;
706                 (*i)->visit(*this);
707
708                 if(remove ? !immutable_block : remove_block)
709                 {
710                         block.body.erase(i++);
711                         ++n_removed;
712                 }
713                 else
714                         ++i;
715         }
716 }
717
718 void ProgramCompiler::NodeRemover::visit(StructDeclaration &strct)
719 {
720         SetFlag set(immutable_block);
721         TraversingVisitor::visit(strct);
722 }
723
724 void ProgramCompiler::NodeRemover::visit(VariableDeclaration &var)
725 {
726         if(to_remove.count(&var))
727         {
728                 stage->in_variables.erase(var.name);
729                 stage->out_variables.erase(var.name);
730                 if(var.linked_declaration)
731                         var.linked_declaration->linked_declaration = 0;
732         }
733 }
734
735 void ProgramCompiler::NodeRemover::visit(InterfaceBlock &iface)
736 {
737         SetFlag set(immutable_block);
738         TraversingVisitor::visit(iface);
739 }
740
741 } // namespace GL
742 } // namespace Msp