1 #include <msp/core/raii.h>
2 #include <msp/strings/format.h>
3 #include <msp/strings/utils.h>
6 #include "programcompiler.h"
13 const char builtins_src[] =
15 "out gl_PerVertex {\n"
16 " vec4 gl_Position;\n"
17 " float gl_ClipDistance[];\n"
21 " vec4 gl_Position;\n"
22 " float gl_ClipDistance[];\n"
24 "out gl_PerVertex {\n"
25 " vec4 gl_Position;\n"
26 " float gl_ClipDistance[];\n"
34 using namespace ProgramSyntax;
36 ProgramCompiler::ProgramCompiler():
40 void ProgramCompiler::compile(const string &source)
42 module = &parser.parse(source);
46 void ProgramCompiler::compile(IO::Base &io)
48 module = &parser.parse(io);
52 void ProgramCompiler::add_shaders(Program &program)
55 throw invalid_operation("ProgramCompiler::add_shaders");
57 string head = "#version 150\n";
58 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
61 program.attach_shader_owned(new VertexShader(head+create_source(*i)));
62 else if(i->type==GEOMETRY)
63 program.attach_shader_owned(new GeometryShader(head+create_source(*i)));
64 else if(i->type==FRAGMENT)
65 program.attach_shader_owned(new FragmentShader(head+create_source(*i)));
68 program.bind_attribute(VERTEX4, "vertex");
69 program.bind_attribute(NORMAL3, "normal");
70 program.bind_attribute(COLOR4_FLOAT, "color");
71 program.bind_attribute(TEXCOORD4, "texcoord");
74 Module *ProgramCompiler::create_builtins_module()
77 Module *module = new Module(parser.parse(builtins_src));
78 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
80 VariableResolver resolver;
81 i->content.visit(resolver);
82 for(map<string, VariableDeclaration *>::iterator j=i->content.variables.begin(); j!=i->content.variables.end(); ++j)
83 j->second->linked_declaration = j->second;
88 Module &ProgramCompiler::get_builtins_module()
90 static RefPtr<Module> builtins_module = create_builtins_module();
91 return *builtins_module;
94 Stage *ProgramCompiler::get_builtins(StageType type)
96 Module &module = get_builtins_module();
97 for(list<Stage>::iterator i=module.stages.begin(); i!=module.stages.end(); ++i)
103 void ProgramCompiler::process()
105 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
107 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); )
110 i = module->stages.begin();
116 void ProgramCompiler::generate(Stage &stage)
118 inject_block(stage.content, module->shared.content);
120 apply<VariableResolver>(stage);
121 apply<InterfaceGenerator>(stage);
122 apply<VariableResolver>(stage);
123 apply<VariableRenamer>(stage);
126 bool ProgramCompiler::optimize(Stage &stage)
128 UnusedVariableLocator unused_locator;
129 unused_locator.apply(stage);
132 remover.to_remove = unused_locator.unused_nodes;
133 remover.apply(stage);
135 return !unused_locator.unused_nodes.empty();
138 void ProgramCompiler::inject_block(Block &target, const Block &source)
140 list<NodePtr<Node> >::iterator insert_point = target.body.begin();
141 for(list<NodePtr<Node> >::const_iterator i=source.body.begin(); i!=source.body.end(); ++i)
142 target.body.insert(insert_point, (*i)->clone());
146 void ProgramCompiler::apply(Stage &stage)
149 visitor.apply(stage);
152 string ProgramCompiler::create_source(Stage &stage)
155 formatter.apply(stage);
156 return formatter.formatted;
160 ProgramCompiler::Visitor::Visitor():
164 void ProgramCompiler::Visitor::apply(Stage &s)
166 SetForScope<Stage *> set(stage, &s);
167 stage->content.visit(*this);
171 ProgramCompiler::Formatter::Formatter():
173 parameter_list(false),
177 void ProgramCompiler::Formatter::visit(Literal &literal)
179 formatted += literal.token;
182 void ProgramCompiler::Formatter::visit(ParenthesizedExpression &parexpr)
185 parexpr.expression->visit(*this);
189 void ProgramCompiler::Formatter::visit(VariableReference &var)
191 formatted += var.name;
194 void ProgramCompiler::Formatter::visit(MemberAccess &memacc)
196 memacc.left->visit(*this);
197 formatted += format(".%s", memacc.member);
200 void ProgramCompiler::Formatter::visit(UnaryExpression &unary)
203 formatted += unary.oper;
204 unary.expression->visit(*this);
206 formatted += unary.oper;
209 void ProgramCompiler::Formatter::visit(BinaryExpression &binary)
211 binary.left->visit(*this);
212 formatted += binary.oper;
213 binary.right->visit(*this);
214 formatted += binary.after;
217 void ProgramCompiler::Formatter::visit(Assignment &assign)
219 assign.left->visit(*this);
220 formatted += format(" %s ", assign.oper);
221 assign.right->visit(*this);
224 void ProgramCompiler::Formatter::visit(FunctionCall &call)
226 formatted += format("%s(", call.name);
227 for(vector<NodePtr<Expression> >::iterator i=call.arguments.begin(); i!=call.arguments.end(); ++i)
229 if(i!=call.arguments.begin())
236 void ProgramCompiler::Formatter::visit(ExpressionStatement &expr)
238 expr.expression->visit(*this);
242 void ProgramCompiler::Formatter::visit(Block &block)
251 formatted += format("%s{\n", string(indent*2, ' '));
254 bool change_indent = (!formatted.empty() && !else_if);
255 indent += change_indent;
256 string spaces(indent*2, ' ');
257 for(list<NodePtr<Node> >::iterator i=block.body.begin(); i!=block.body.end(); ++i)
259 if(i!=block.body.begin())
265 indent -= change_indent;
268 formatted += format("\n%s}", string(indent*2, ' '));
271 void ProgramCompiler::Formatter::visit(Layout &layout)
273 formatted += "layout(";
274 for(vector<Layout::Qualifier>::const_iterator i=layout.qualifiers.begin(); i!=layout.qualifiers.end(); ++i)
276 if(i!=layout.qualifiers.begin())
278 formatted += i->identifier;
279 if(!i->value.empty())
280 formatted += format("=%s", i->value);
282 formatted += format(") %s;", layout.interface);
285 void ProgramCompiler::Formatter::visit(StructDeclaration &strct)
287 formatted += format("struct %s\n", strct.name);
288 strct.members.visit(*this);
292 void ProgramCompiler::Formatter::visit(VariableDeclaration &var)
295 formatted += "const ";
296 if(!var.sampling.empty())
297 formatted += format("%s ", var.sampling);
298 if(!var.interface.empty() && var.interface!=block_interface)
299 formatted += format("%s ", var.interface);
300 formatted += format("%s %s", var.type, var.name);
305 var.array_size->visit(*this);
308 if(var.init_expression)
311 var.init_expression->visit(*this);
317 void ProgramCompiler::Formatter::visit(InterfaceBlock &iface)
319 SetForScope<string> set(block_interface, iface.interface);
320 formatted += format("%s %s\n", iface.interface, iface.name);
321 iface.members.visit(*this);
325 void ProgramCompiler::Formatter::visit(FunctionDeclaration &func)
327 formatted += format("%s %s(", func.return_type, func.name);
328 for(vector<NodePtr<VariableDeclaration> >::iterator i=func.parameters.begin(); i!=func.parameters.end(); ++i)
330 if(i!=func.parameters.begin())
332 SetFlag set(parameter_list);
339 func.body.visit(*this);
345 void ProgramCompiler::Formatter::visit(Conditional &cond)
354 cond.condition->visit(*this);
357 cond.body.visit(*this);
358 if(!cond.else_body.body.empty())
360 formatted += format("\n%selse", string(indent*2, ' '));
361 SetFlag set(else_if);
362 cond.else_body.visit(*this);
366 void ProgramCompiler::Formatter::visit(Iteration &iter)
369 iter.init_statement->visit(*this);
371 iter.condition->visit(*this);
373 iter.loop_expression->visit(*this);
375 iter.body.visit(*this);
378 void ProgramCompiler::Formatter::visit(Return &ret)
380 formatted += "return ";
381 ret.expression->visit(*this);
386 ProgramCompiler::VariableResolver::VariableResolver():
388 record_target(false),
389 assignment_target(0),
390 self_referencing(false)
393 void ProgramCompiler::VariableResolver::apply(Stage &s)
395 SetForScope<Stage *> set(stage, &s);
396 Stage *builtins = get_builtins(stage->type);
398 blocks.push_back(&builtins->content);
399 stage->content.visit(*this);
404 void ProgramCompiler::VariableResolver::visit(Block &block)
406 blocks.push_back(&block);
407 block.variables.clear();
408 TraversingVisitor::visit(block);
412 void ProgramCompiler::VariableResolver::visit(VariableReference &var)
416 for(vector<Block *>::iterator i=blocks.end(); i!=blocks.begin(); )
419 map<string, VariableDeclaration *>::iterator j = (*i)->variables.find(var.name);
420 if(j!=(*i)->variables.end())
422 var.declaration = j->second;
423 type = j->second->type_declaration;
430 if(assignment_target)
432 record_target = false;
433 assignment_target = 0;
436 assignment_target = var.declaration;
438 else if(var.declaration && var.declaration==assignment_target)
439 self_referencing = true;
442 void ProgramCompiler::VariableResolver::visit(MemberAccess &memacc)
445 TraversingVisitor::visit(memacc);
446 memacc.declaration = 0;
449 map<string, VariableDeclaration *>::iterator i = type->members.variables.find(memacc.member);
450 if(i!=type->members.variables.end())
452 memacc.declaration = i->second;
453 type = i->second->type_declaration;
460 void ProgramCompiler::VariableResolver::visit(BinaryExpression &binary)
465 SetForScope<bool> set(record_target, false);
466 binary.right->visit(*this);
469 binary.left->visit(*this);
473 TraversingVisitor::visit(binary);
478 void ProgramCompiler::VariableResolver::visit(Assignment &assign)
481 SetFlag set(record_target);
482 assignment_target = 0;
483 assign.left->visit(*this);
486 self_referencing = false;
487 assign.right->visit(*this);
489 assign.self_referencing = (self_referencing || assign.oper!="=");
490 assign.target_declaration = assignment_target;
493 void ProgramCompiler::VariableResolver::visit(StructDeclaration &strct)
495 TraversingVisitor::visit(strct);
496 blocks.back()->types[strct.name] = &strct;
499 void ProgramCompiler::VariableResolver::visit(VariableDeclaration &var)
501 for(vector<Block *>::iterator i=blocks.end(); i!=blocks.begin(); )
504 map<string, StructDeclaration *>::iterator j = (*i)->types.find(var.type);
505 if(j!=(*i)->types.end())
506 var.type_declaration = j->second;
509 if(!block_interface.empty() && var.interface.empty())
510 var.interface = block_interface;
512 TraversingVisitor::visit(var);
513 blocks.back()->variables[var.name] = &var;
514 if(anonymous && blocks.size()>1)
515 blocks[blocks.size()-2]->variables[var.name] = &var;
518 void ProgramCompiler::VariableResolver::visit(InterfaceBlock &iface)
520 SetFlag set(anonymous);
521 SetForScope<string> set2(block_interface, iface.interface);
522 TraversingVisitor::visit(iface);
526 ProgramCompiler::InterfaceGenerator::InterfaceGenerator():
531 string ProgramCompiler::InterfaceGenerator::get_out_prefix(StageType type)
535 else if(type==GEOMETRY)
541 void ProgramCompiler::InterfaceGenerator::apply(Stage &s)
543 SetForScope<Stage *> set(stage, &s);
545 in_prefix = get_out_prefix(stage->previous->type);
546 out_prefix = get_out_prefix(stage->type);
547 stage->content.visit(*this);
550 void ProgramCompiler::InterfaceGenerator::visit(Block &block)
552 SetForScope<unsigned> set(scope_level, scope_level+1);
553 for(list<NodePtr<Node> >::iterator i=block.body.begin(); i!=block.body.end(); )
559 for(map<string, VariableDeclaration *>::iterator j=iface_declarations.begin(); j!=iface_declarations.end(); ++j)
561 list<NodePtr<Node> >::iterator k = block.body.insert(i, j->second);
564 iface_declarations.clear();
567 for(list<Node *>::iterator j=insert_nodes.begin(); j!=insert_nodes.end(); ++j)
568 block.body.insert(i, *j);
569 insert_nodes.clear();
572 block.body.erase(i++);
579 string ProgramCompiler::InterfaceGenerator::change_prefix(const string &name, const string &prefix) const
581 unsigned offset = (name.compare(0, in_prefix.size(), in_prefix) ? 0 : in_prefix.size());
582 return prefix+name.substr(offset);
585 bool ProgramCompiler::InterfaceGenerator::generate_interface(VariableDeclaration &var, const string &iface, const string &name)
587 const map<string, VariableDeclaration *> &stage_vars = (iface=="in" ? stage->in_variables : stage->out_variables);
588 if(stage_vars.count(name) || iface_declarations.count(name))
591 VariableDeclaration* iface_var = new VariableDeclaration;
592 iface_var->sampling = var.sampling;
593 iface_var->interface = iface;
594 iface_var->type = var.type;
595 iface_var->type_declaration = var.type_declaration;
596 iface_var->name = name;
597 if(stage->type==GEOMETRY)
598 iface_var->array = ((var.array && var.interface!="in") || iface=="in");
600 iface_var->array = var.array;
602 iface_var->array_size = var.array_size;
604 iface_var->linked_declaration = &var;
605 iface_declarations[name] = iface_var;
610 void ProgramCompiler::InterfaceGenerator::insert_assignment(const string &left, ProgramSyntax::Expression *right)
612 Assignment *assign = new Assignment;
613 VariableReference *ref = new VariableReference;
617 assign->right = right;
619 ExpressionStatement *stmt = new ExpressionStatement;
620 stmt->expression = assign;
621 insert_nodes.push_back(stmt);
624 void ProgramCompiler::InterfaceGenerator::visit(VariableReference &var)
626 if(var.declaration || !stage->previous)
628 if(iface_declarations.count(var.name))
631 const map<string, VariableDeclaration *> &prev_out = stage->previous->out_variables;
632 map<string, VariableDeclaration *>::const_iterator i = prev_out.find(var.name);
633 if(i==prev_out.end())
634 i = prev_out.find(in_prefix+var.name);
635 if(i!=prev_out.end())
636 generate_interface(*i->second, "in", var.name);
639 void ProgramCompiler::InterfaceGenerator::visit(VariableDeclaration &var)
641 if(var.interface=="out")
644 stage->out_variables[var.name] = &var;
645 else if(generate_interface(var, "out", change_prefix(var.name, string())))
648 if(var.init_expression)
649 insert_assignment(var.name, var.init_expression->clone());
652 else if(var.interface=="in")
654 stage->in_variables[var.name] = &var;
655 if(var.linked_declaration)
656 var.linked_declaration->linked_declaration = &var;
657 else if(stage->previous)
659 const map<string, VariableDeclaration *> &prev_out = stage->previous->out_variables;
660 map<string, VariableDeclaration *>::const_iterator i = prev_out.find(var.name);
661 if(i!=prev_out.end())
663 var.linked_declaration = i->second;
664 i->second->linked_declaration = &var;
669 TraversingVisitor::visit(var);
672 void ProgramCompiler::InterfaceGenerator::visit(Passthrough &pass)
674 vector<VariableDeclaration *> pass_vars;
676 for(map<string, VariableDeclaration *>::const_iterator i=stage->in_variables.begin(); i!=stage->in_variables.end(); ++i)
677 pass_vars.push_back(i->second);
678 for(map<string, VariableDeclaration *>::const_iterator i=iface_declarations.begin(); i!=iface_declarations.end(); ++i)
679 if(i->second->interface=="in")
680 pass_vars.push_back(i->second);
684 const map<string, VariableDeclaration *> &prev_out = stage->previous->out_variables;
685 for(map<string, VariableDeclaration *>::const_iterator i=prev_out.begin(); i!=prev_out.end(); ++i)
688 for(vector<VariableDeclaration *>::const_iterator j=pass_vars.begin(); (!linked && j!=pass_vars.end()); ++j)
689 linked = ((*j)->linked_declaration==i->second);
691 if(!linked && generate_interface(*i->second, "in", i->second->name))
692 pass_vars.push_back(i->second);
696 if(stage->type==GEOMETRY)
698 VariableReference *ref = new VariableReference;
701 BinaryExpression *subscript = new BinaryExpression;
702 subscript->left = ref;
703 subscript->oper = "[";
704 subscript->right = pass.subscript;
705 subscript->after = "]";
707 MemberAccess *memacc = new MemberAccess;
708 memacc->left = subscript;
709 memacc->member = "gl_Position";
711 insert_assignment("gl_Position", memacc);
714 for(vector<VariableDeclaration *>::const_iterator i=pass_vars.begin(); i!=pass_vars.end(); ++i)
716 string out_name = change_prefix((*i)->name, out_prefix);
717 generate_interface(**i, "out", out_name);
719 VariableReference *ref = new VariableReference;
720 ref->name = (*i)->name;
723 BinaryExpression *subscript = new BinaryExpression;
724 subscript->left = ref;
725 subscript->oper = "[";
726 subscript->right = pass.subscript;
727 subscript->after = "]";
728 insert_assignment(out_name, subscript);
731 insert_assignment(out_name, ref);
738 void ProgramCompiler::VariableRenamer::visit(VariableReference &var)
741 var.name = var.declaration->name;
744 void ProgramCompiler::VariableRenamer::visit(VariableDeclaration &var)
746 if(var.linked_declaration)
747 var.name = var.linked_declaration->name;
748 TraversingVisitor::visit(var);
752 ProgramCompiler::UnusedVariableLocator::UnusedVariableLocator():
755 assignment_target(false)
758 void ProgramCompiler::UnusedVariableLocator::apply(Stage &s)
760 assignments.push_back(BlockAssignmentMap());
762 assignments.pop_back();
765 void ProgramCompiler::UnusedVariableLocator::visit(VariableReference &var)
767 unused_nodes.erase(var.declaration);
769 map<VariableDeclaration *, Node *>::iterator i = aggregates.find(var.declaration);
770 if(i!=aggregates.end())
771 unused_nodes.erase(i->second);
773 if(assignment_target)
776 for(vector<BlockAssignmentMap>::iterator j=assignments.end(); j!=assignments.begin(); )
779 BlockAssignmentMap::iterator k = j->find(var.declaration);
782 for(vector<Node *>::iterator l=k->second.nodes.begin(); l!=k->second.nodes.end(); ++l)
783 unused_nodes.erase(*l);
790 void ProgramCompiler::UnusedVariableLocator::visit(MemberAccess &memacc)
792 TraversingVisitor::visit(memacc);
793 unused_nodes.erase(memacc.declaration);
796 void ProgramCompiler::UnusedVariableLocator::visit(BinaryExpression &binary)
800 binary.left->visit(*this);
801 SetForScope<bool> set(assignment_target, false);
802 binary.right->visit(*this);
805 TraversingVisitor::visit(binary);
808 void ProgramCompiler::UnusedVariableLocator::visit(Assignment &assign)
811 SetForScope<bool> set(assignment_target, !assign.self_referencing);
812 assign.left->visit(*this);
814 assign.right->visit(*this);
815 assignment = &assign;
818 void ProgramCompiler::UnusedVariableLocator::record_assignment(VariableDeclaration &var, Node &node, bool self_ref)
820 unused_nodes.insert(&node);
821 BlockAssignmentMap &block_assignments = assignments.back();
822 AssignmentList &var_assignments = block_assignments[&var];
824 var_assignments.nodes.clear();
825 var_assignments.nodes.push_back(&node);
826 var_assignments.conditional = false;
827 var_assignments.self_referencing = self_ref;
830 void ProgramCompiler::UnusedVariableLocator::visit(ExpressionStatement &expr)
833 TraversingVisitor::visit(expr);
834 if(assignment && assignment->target_declaration)
835 record_assignment(*assignment->target_declaration, expr, assignment->self_referencing);
838 void ProgramCompiler::UnusedVariableLocator::visit(StructDeclaration &strct)
840 SetForScope<Node *> set(aggregate, &strct);
841 unused_nodes.insert(&strct);
842 TraversingVisitor::visit(strct);
845 void ProgramCompiler::UnusedVariableLocator::visit(VariableDeclaration &var)
848 aggregates[&var] = aggregate;
851 unused_nodes.insert(&var);
852 if(var.init_expression)
853 record_assignment(var, *var.init_expression, false);
855 unused_nodes.erase(var.type_declaration);
856 TraversingVisitor::visit(var);
859 void ProgramCompiler::UnusedVariableLocator::visit(InterfaceBlock &iface)
861 SetForScope<Node *> set(aggregate, &iface);
862 unused_nodes.insert(&iface);
863 TraversingVisitor::visit(iface);
866 void ProgramCompiler::UnusedVariableLocator::visit(FunctionDeclaration &func)
868 assignments.push_back(BlockAssignmentMap());
870 for(vector<NodePtr<VariableDeclaration> >::iterator i=func.parameters.begin(); i!=func.parameters.end(); ++i)
872 func.body.visit(*this);
874 BlockAssignmentMap &block_assignments = assignments.back();
875 for(map<string, VariableDeclaration *>::iterator i=func.body.variables.begin(); i!=func.body.variables.end(); ++i)
876 block_assignments.erase(i->second);
877 for(BlockAssignmentMap::iterator i=block_assignments.begin(); i!=block_assignments.end(); ++i)
879 if(i->first->interface=="out" && stage->type!=FRAGMENT && !i->first->linked_declaration)
882 for(vector<Node *>::iterator j=i->second.nodes.begin(); j!=i->second.nodes.end(); ++j)
883 unused_nodes.erase(*j);
886 assignments.pop_back();
889 void ProgramCompiler::UnusedVariableLocator::merge_down_assignments()
891 BlockAssignmentMap &parent_assignments = assignments[assignments.size()-2];
892 BlockAssignmentMap &block_assignments = assignments.back();
893 for(BlockAssignmentMap::iterator i=block_assignments.begin(); i!=block_assignments.end(); ++i)
895 BlockAssignmentMap::iterator j = parent_assignments.find(i->first);
896 if(j==parent_assignments.end())
897 parent_assignments.insert(*i);
898 else if(i->second.self_referencing || i->second.conditional)
900 j->second.nodes.insert(j->second.nodes.end(), i->second.nodes.begin(), i->second.nodes.end());
901 j->second.conditional |= i->second.conditional;
902 j->second.self_referencing |= i->second.self_referencing;
905 j->second = i->second;
907 assignments.pop_back();
910 void ProgramCompiler::UnusedVariableLocator::visit(Conditional &cond)
912 cond.condition->visit(*this);
913 assignments.push_back(BlockAssignmentMap());
914 cond.body.visit(*this);
916 BlockAssignmentMap if_assignments;
917 swap(assignments.back(), if_assignments);
918 cond.else_body.visit(*this);
920 BlockAssignmentMap &else_assignments = assignments.back();
921 for(BlockAssignmentMap::iterator i=else_assignments.begin(); i!=else_assignments.end(); ++i)
923 BlockAssignmentMap::iterator j = if_assignments.find(i->first);
924 if(j!=if_assignments.end())
926 i->second.nodes.insert(i->second.nodes.end(), j->second.nodes.begin(), j->second.nodes.end());
927 i->second.conditional |= j->second.conditional;
928 i->second.self_referencing |= j->second.self_referencing;
929 if_assignments.erase(j);
932 i->second.conditional = true;
935 for(BlockAssignmentMap::iterator i=if_assignments.begin(); i!=if_assignments.end(); ++i)
937 i->second.conditional = true;
938 else_assignments.insert(*i);
941 merge_down_assignments();
944 void ProgramCompiler::UnusedVariableLocator::visit(Iteration &iter)
946 assignments.push_back(BlockAssignmentMap());
947 TraversingVisitor::visit(iter);
948 merge_down_assignments();
952 void ProgramCompiler::NodeRemover::visit(Block &block)
954 for(list<NodePtr<Node> >::iterator i=block.body.begin(); i!=block.body.end(); )
957 if(to_remove.count(&**i))
958 block.body.erase(i++);
964 void ProgramCompiler::NodeRemover::visit(VariableDeclaration &var)
966 if(to_remove.count(&var))
968 stage->in_variables.erase(var.name);
969 stage->out_variables.erase(var.name);
970 if(var.linked_declaration)
971 var.linked_declaration->linked_declaration = 0;
973 else if(var.init_expression && to_remove.count(&*var.init_expression))
974 var.init_expression = 0;