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 if(binary.assignment)
213 formatted += format(" %s ", binary.oper);
215 formatted += binary.oper;
216 binary.right->visit(*this);
217 formatted += binary.after;
220 void ProgramCompiler::Formatter::visit(FunctionCall &call)
222 formatted += format("%s(", call.name);
223 for(vector<NodePtr<Expression> >::iterator i=call.arguments.begin(); i!=call.arguments.end(); ++i)
225 if(i!=call.arguments.begin())
232 void ProgramCompiler::Formatter::visit(ExpressionStatement &expr)
234 expr.expression->visit(*this);
238 void ProgramCompiler::Formatter::visit(Block &block)
247 formatted += format("%s{\n", string(indent*2, ' '));
250 bool change_indent = (!formatted.empty() && !else_if);
251 indent += change_indent;
252 string spaces(indent*2, ' ');
253 for(list<NodePtr<Node> >::iterator i=block.body.begin(); i!=block.body.end(); ++i)
255 if(i!=block.body.begin())
261 indent -= change_indent;
264 formatted += format("\n%s}", string(indent*2, ' '));
267 void ProgramCompiler::Formatter::visit(Layout &layout)
269 formatted += "layout(";
270 for(vector<Layout::Qualifier>::const_iterator i=layout.qualifiers.begin(); i!=layout.qualifiers.end(); ++i)
272 if(i!=layout.qualifiers.begin())
274 formatted += i->identifier;
275 if(!i->value.empty())
276 formatted += format("=%s", i->value);
278 formatted += format(") %s;", layout.interface);
281 void ProgramCompiler::Formatter::visit(StructDeclaration &strct)
283 formatted += format("struct %s\n", strct.name);
284 strct.members.visit(*this);
288 void ProgramCompiler::Formatter::visit(VariableDeclaration &var)
291 formatted += "const ";
292 if(!var.sampling.empty())
293 formatted += format("%s ", var.sampling);
294 if(!var.interface.empty() && var.interface!=block_interface)
295 formatted += format("%s ", var.interface);
296 formatted += format("%s %s", var.type, var.name);
301 var.array_size->visit(*this);
304 if(var.init_expression)
307 var.init_expression->visit(*this);
313 void ProgramCompiler::Formatter::visit(InterfaceBlock &iface)
315 SetForScope<string> set(block_interface, iface.interface);
316 formatted += format("%s %s\n", iface.interface, iface.name);
317 iface.members.visit(*this);
321 void ProgramCompiler::Formatter::visit(FunctionDeclaration &func)
323 formatted += format("%s %s(", func.return_type, func.name);
324 for(vector<NodePtr<VariableDeclaration> >::iterator i=func.parameters.begin(); i!=func.parameters.end(); ++i)
326 if(i!=func.parameters.begin())
328 SetFlag set(parameter_list);
335 func.body.visit(*this);
341 void ProgramCompiler::Formatter::visit(Conditional &cond)
350 cond.condition->visit(*this);
353 cond.body.visit(*this);
354 if(!cond.else_body.body.empty())
356 formatted += format("\n%selse", string(indent*2, ' '));
357 SetFlag set(else_if);
358 cond.else_body.visit(*this);
362 void ProgramCompiler::Formatter::visit(Iteration &iter)
365 iter.init_statement->visit(*this);
367 iter.condition->visit(*this);
369 iter.loop_expression->visit(*this);
371 iter.body.visit(*this);
374 void ProgramCompiler::Formatter::visit(Return &ret)
376 formatted += "return ";
377 ret.expression->visit(*this);
382 ProgramCompiler::VariableResolver::VariableResolver():
386 void ProgramCompiler::VariableResolver::apply(Stage &s)
388 SetForScope<Stage *> set(stage, &s);
389 Stage *builtins = get_builtins(stage->type);
391 blocks.push_back(&builtins->content);
392 stage->content.visit(*this);
397 void ProgramCompiler::VariableResolver::visit(Block &block)
399 blocks.push_back(&block);
400 block.variables.clear();
401 TraversingVisitor::visit(block);
405 void ProgramCompiler::VariableResolver::visit(VariableReference &var)
409 for(vector<Block *>::iterator i=blocks.end(); i!=blocks.begin(); )
412 map<string, VariableDeclaration *>::iterator j = (*i)->variables.find(var.name);
413 if(j!=(*i)->variables.end())
415 var.declaration = j->second;
416 type = j->second->type_declaration;
422 void ProgramCompiler::VariableResolver::visit(MemberAccess &memacc)
425 TraversingVisitor::visit(memacc);
426 memacc.declaration = 0;
429 map<string, VariableDeclaration *>::iterator i = type->members.variables.find(memacc.member);
430 if(i!=type->members.variables.end())
432 memacc.declaration = i->second;
433 type = i->second->type_declaration;
440 void ProgramCompiler::VariableResolver::visit(BinaryExpression &binary)
444 binary.right->visit(*this);
446 binary.left->visit(*this);
450 TraversingVisitor::visit(binary);
455 void ProgramCompiler::VariableResolver::visit(StructDeclaration &strct)
457 TraversingVisitor::visit(strct);
458 blocks.back()->types[strct.name] = &strct;
461 void ProgramCompiler::VariableResolver::visit(VariableDeclaration &var)
463 for(vector<Block *>::iterator i=blocks.end(); i!=blocks.begin(); )
466 map<string, StructDeclaration *>::iterator j = (*i)->types.find(var.type);
467 if(j!=(*i)->types.end())
468 var.type_declaration = j->second;
471 if(!block_interface.empty() && var.interface.empty())
472 var.interface = block_interface;
474 TraversingVisitor::visit(var);
475 blocks.back()->variables[var.name] = &var;
476 if(anonymous && blocks.size()>1)
477 blocks[blocks.size()-2]->variables[var.name] = &var;
480 void ProgramCompiler::VariableResolver::visit(InterfaceBlock &iface)
482 SetFlag set(anonymous);
483 SetForScope<string> set2(block_interface, iface.interface);
484 TraversingVisitor::visit(iface);
488 ProgramCompiler::InterfaceGenerator::InterfaceGenerator():
493 string ProgramCompiler::InterfaceGenerator::get_out_prefix(StageType type)
497 else if(type==GEOMETRY)
503 void ProgramCompiler::InterfaceGenerator::apply(Stage &s)
505 SetForScope<Stage *> set(stage, &s);
507 in_prefix = get_out_prefix(stage->previous->type);
508 out_prefix = get_out_prefix(stage->type);
509 stage->content.visit(*this);
512 void ProgramCompiler::InterfaceGenerator::visit(Block &block)
514 SetForScope<unsigned> set(scope_level, scope_level+1);
515 for(list<NodePtr<Node> >::iterator i=block.body.begin(); i!=block.body.end(); )
521 for(map<string, VariableDeclaration *>::iterator j=iface_declarations.begin(); j!=iface_declarations.end(); ++j)
523 list<NodePtr<Node> >::iterator k = block.body.insert(i, j->second);
526 iface_declarations.clear();
529 for(list<Node *>::iterator j=insert_nodes.begin(); j!=insert_nodes.end(); ++j)
530 block.body.insert(i, *j);
531 insert_nodes.clear();
534 block.body.erase(i++);
541 string ProgramCompiler::InterfaceGenerator::change_prefix(const string &name, const string &prefix) const
543 unsigned offset = (name.compare(0, in_prefix.size(), in_prefix) ? 0 : in_prefix.size());
544 return prefix+name.substr(offset);
547 bool ProgramCompiler::InterfaceGenerator::generate_interface(VariableDeclaration &var, const string &iface, const string &name)
549 const map<string, VariableDeclaration *> &stage_vars = (iface=="in" ? stage->in_variables : stage->out_variables);
550 if(stage_vars.count(name) || iface_declarations.count(name))
553 VariableDeclaration* iface_var = new VariableDeclaration;
554 iface_var->sampling = var.sampling;
555 iface_var->interface = iface;
556 iface_var->type = var.type;
557 iface_var->type_declaration = var.type_declaration;
558 iface_var->name = name;
559 if(stage->type==GEOMETRY)
560 iface_var->array = ((var.array && var.interface!="in") || iface=="in");
562 iface_var->array = var.array;
564 iface_var->array_size = var.array_size;
566 iface_var->linked_declaration = &var;
567 iface_declarations[name] = iface_var;
572 void ProgramCompiler::InterfaceGenerator::insert_assignment(const string &left, ProgramSyntax::Expression *right)
574 BinaryExpression *assign = new BinaryExpression;
575 VariableReference *ref = new VariableReference;
579 assign->right = right;
580 assign->assignment = true;
582 ExpressionStatement *stmt = new ExpressionStatement;
583 stmt->expression = assign;
584 insert_nodes.push_back(stmt);
587 void ProgramCompiler::InterfaceGenerator::visit(VariableReference &var)
589 if(var.declaration || !stage->previous)
591 if(iface_declarations.count(var.name))
594 const map<string, VariableDeclaration *> &prev_out = stage->previous->out_variables;
595 map<string, VariableDeclaration *>::const_iterator i = prev_out.find(var.name);
596 if(i==prev_out.end())
597 i = prev_out.find(in_prefix+var.name);
598 if(i!=prev_out.end())
599 generate_interface(*i->second, "in", var.name);
602 void ProgramCompiler::InterfaceGenerator::visit(VariableDeclaration &var)
604 if(var.interface=="out")
607 stage->out_variables[var.name] = &var;
608 else if(generate_interface(var, "out", change_prefix(var.name, string())))
611 if(var.init_expression)
612 insert_assignment(var.name, var.init_expression->clone());
615 else if(var.interface=="in")
617 stage->in_variables[var.name] = &var;
618 if(var.linked_declaration)
619 var.linked_declaration->linked_declaration = &var;
620 else if(stage->previous)
622 const map<string, VariableDeclaration *> &prev_out = stage->previous->out_variables;
623 map<string, VariableDeclaration *>::const_iterator i = prev_out.find(var.name);
624 if(i!=prev_out.end())
626 var.linked_declaration = i->second;
627 i->second->linked_declaration = &var;
632 TraversingVisitor::visit(var);
635 void ProgramCompiler::InterfaceGenerator::visit(Passthrough &pass)
637 vector<VariableDeclaration *> pass_vars;
639 for(map<string, VariableDeclaration *>::const_iterator i=stage->in_variables.begin(); i!=stage->in_variables.end(); ++i)
640 pass_vars.push_back(i->second);
641 for(map<string, VariableDeclaration *>::const_iterator i=iface_declarations.begin(); i!=iface_declarations.end(); ++i)
642 if(i->second->interface=="in")
643 pass_vars.push_back(i->second);
647 const map<string, VariableDeclaration *> &prev_out = stage->previous->out_variables;
648 for(map<string, VariableDeclaration *>::const_iterator i=prev_out.begin(); i!=prev_out.end(); ++i)
651 for(vector<VariableDeclaration *>::const_iterator j=pass_vars.begin(); (!linked && j!=pass_vars.end()); ++j)
652 linked = ((*j)->linked_declaration==i->second);
654 if(!linked && generate_interface(*i->second, "in", i->second->name))
655 pass_vars.push_back(i->second);
659 for(vector<VariableDeclaration *>::const_iterator i=pass_vars.begin(); i!=pass_vars.end(); ++i)
661 string out_name = change_prefix((*i)->name, out_prefix);
662 generate_interface(**i, "out", out_name);
664 VariableReference *ref = new VariableReference;
665 ref->name = (*i)->name;
668 BinaryExpression *subscript = new BinaryExpression;
669 subscript->left = ref;
670 subscript->oper = "[";
671 subscript->right = pass.subscript;
672 subscript->after = "]";
673 insert_assignment(out_name, subscript);
676 insert_assignment(out_name, ref);
683 void ProgramCompiler::VariableRenamer::visit(VariableReference &var)
686 var.name = var.declaration->name;
689 void ProgramCompiler::VariableRenamer::visit(VariableDeclaration &var)
691 if(var.linked_declaration)
692 var.name = var.linked_declaration->name;
693 TraversingVisitor::visit(var);
697 ProgramCompiler::UnusedVariableLocator::UnusedVariableLocator():
700 record_target(false),
701 assignment_target(0),
702 indeterminate_target(false),
703 self_referencing(false)
706 void ProgramCompiler::UnusedVariableLocator::visit(VariableReference &var)
710 if(assignment_target)
711 indeterminate_target = true;
713 assignment_target = var.declaration;
717 unused_nodes.erase(var.declaration);
719 map<VariableDeclaration *, Node *>::iterator i = assignments.find(var.declaration);
720 if(i!=assignments.end())
722 unused_nodes.erase(i->second);
723 assignments.erase(i);
726 if(assignment && var.declaration==assignment_target)
727 self_referencing = true;
730 map<VariableDeclaration *, Node *>::iterator i = aggregates.find(var.declaration);
731 if(i!=aggregates.end())
732 unused_nodes.erase(i->second);
735 void ProgramCompiler::UnusedVariableLocator::visit(MemberAccess &memacc)
737 TraversingVisitor::visit(memacc);
738 unused_nodes.erase(memacc.declaration);
741 void ProgramCompiler::UnusedVariableLocator::visit(BinaryExpression &binary)
743 if(binary.assignment)
747 SetFlag set(record_target);
748 binary.left->visit(*this);
751 self_referencing = true;
752 binary.right->visit(*this);
754 else if(record_target && binary.oper=="[")
756 binary.left->visit(*this);
757 SetForScope<bool> set(record_target, false);
758 binary.right->visit(*this);
761 TraversingVisitor::visit(binary);
764 void ProgramCompiler::UnusedVariableLocator::visit(ExpressionStatement &expr)
767 assignment_target = 0;
768 indeterminate_target = false;
769 self_referencing = false;
770 TraversingVisitor::visit(expr);
771 if(assignment && assignment_target && !indeterminate_target)
773 Node *&assign = assignments[assignment_target];
775 unused_nodes.erase(assign);
777 unused_nodes.insert(assign);
779 if(assignment_target->interface=="out" && (stage->type==FRAGMENT || assignment_target->linked_declaration))
780 unused_nodes.erase(assignment_target);
782 unused_nodes.insert(&expr);
787 void ProgramCompiler::UnusedVariableLocator::visit(StructDeclaration &strct)
789 SetForScope<Node *> set(aggregate, &strct);
790 unused_nodes.insert(&strct);
791 TraversingVisitor::visit(strct);
794 void ProgramCompiler::UnusedVariableLocator::visit(VariableDeclaration &var)
797 aggregates[&var] = aggregate;
800 unused_nodes.insert(&var);
801 if(var.init_expression)
803 unused_nodes.insert(&*var.init_expression);
804 assignments[&var] = &*var.init_expression;
807 unused_nodes.erase(var.type_declaration);
808 TraversingVisitor::visit(var);
811 void ProgramCompiler::UnusedVariableLocator::visit(InterfaceBlock &iface)
813 SetForScope<Node *> set(aggregate, &iface);
814 unused_nodes.insert(&iface);
815 TraversingVisitor::visit(iface);
819 void ProgramCompiler::NodeRemover::visit(Block &block)
821 for(list<NodePtr<Node> >::iterator i=block.body.begin(); i!=block.body.end(); )
824 if(to_remove.count(&**i))
825 block.body.erase(i++);
831 void ProgramCompiler::NodeRemover::visit(VariableDeclaration &var)
833 if(to_remove.count(&var))
835 stage->in_variables.erase(var.name);
836 stage->out_variables.erase(var.name);
837 if(var.linked_declaration)
838 var.linked_declaration->linked_declaration = 0;
840 else if(var.init_expression && to_remove.count(&*var.init_expression))
841 var.init_expression = 0;