1 #include <msp/core/raii.h>
2 #include <msp/gl/extensions/ext_gpu_shader4.h>
3 #include <msp/strings/format.h>
4 #include <msp/strings/utils.h>
7 #include "programcompiler.h"
15 const char builtins_src[] =
16 "#pragma MSP stage(vertex)\n"
17 "out gl_PerVertex {\n"
18 " vec4 gl_Position;\n"
19 " float gl_ClipDistance[];\n"
21 "#pragma MSP stage(geometry)\n"
23 " vec4 gl_Position;\n"
24 " float gl_ClipDistance[];\n"
26 "out gl_PerVertex {\n"
27 " vec4 gl_Position;\n"
28 " float gl_ClipDistance[];\n"
36 using namespace ProgramSyntax;
38 ProgramCompiler::ProgramCompiler():
43 ProgramCompiler::~ProgramCompiler()
48 void ProgramCompiler::compile(const string &source, const string &src_name)
52 module = new Module();
54 imported_names.insert(src_name);
55 append_module(parser.parse(source, src_name));
59 void ProgramCompiler::compile(IO::Base &io, Resources *res, const string &src_name)
63 module = new Module();
65 imported_names.insert(src_name);
66 append_module(parser.parse(io, src_name));
70 void ProgramCompiler::compile(IO::Base &io, const string &src_name)
72 compile(io, 0, src_name);
75 void ProgramCompiler::add_shaders(Program &program)
78 throw invalid_operation("ProgramCompiler::add_shaders");
80 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
84 program.attach_shader_owned(new VertexShader(apply<Formatter>(*i)));
85 for(map<string, unsigned>::iterator j=i->locations.begin(); j!=i->locations.end(); ++j)
86 program.bind_attribute(j->second, j->first);
88 else if(i->type==GEOMETRY)
89 program.attach_shader_owned(new GeometryShader(apply<Formatter>(*i)));
90 else if(i->type==FRAGMENT)
92 program.attach_shader_owned(new FragmentShader(apply<Formatter>(*i)));
95 for(map<string, unsigned>::iterator j=i->locations.begin(); j!=i->locations.end(); ++j)
96 program.bind_fragment_data(j->second, j->first);
102 Module *ProgramCompiler::create_builtins_module()
104 ProgramParser parser;
105 Module *module = new Module(parser.parse(builtins_src, "<builtin>"));
106 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
108 VariableResolver resolver;
109 i->content.visit(resolver);
110 for(map<string, VariableDeclaration *>::iterator j=i->content.variables.begin(); j!=i->content.variables.end(); ++j)
111 j->second->linked_declaration = j->second;
116 Module &ProgramCompiler::get_builtins_module()
118 static RefPtr<Module> builtins_module = create_builtins_module();
119 return *builtins_module;
122 Stage *ProgramCompiler::get_builtins(StageType type)
124 Module &module = get_builtins_module();
125 for(list<Stage>::iterator i=module.stages.begin(); i!=module.stages.end(); ++i)
131 void ProgramCompiler::append_module(ProgramSyntax::Module &mod)
133 vector<Import *> imports = apply<NodeGatherer<Import> >(mod.shared);
134 for(vector<Import *>::iterator i=imports.begin(); i!=imports.end(); ++i)
135 import((*i)->module);
136 apply<NodeRemover>(mod.shared, set<Node *>(imports.begin(), imports.end()));
138 append_stage(mod.shared);
139 for(list<Stage>::iterator i=mod.stages.begin(); i!=mod.stages.end(); ++i)
143 void ProgramCompiler::append_stage(Stage &stage)
146 if(stage.type==SHARED)
147 target = &module->shared;
150 list<Stage>::iterator i;
151 for(i=module->stages.begin(); (i!=module->stages.end() && i->type<stage.type); ++i) ;
152 if(i==module->stages.end() || i->type>stage.type)
154 list<Stage>::iterator j = module->stages.insert(i, stage.type);
155 if(i!=module->stages.end())
158 if(i!=module->stages.begin())
165 for(NodeList<Node>::iterator i=stage.content.body.begin(); i!=stage.content.body.end(); ++i)
166 target->content.body.push_back(*i);
167 apply<DeclarationCombiner>(*target);
170 void ProgramCompiler::process()
172 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
174 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); )
177 i = module->stages.begin();
181 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
185 void ProgramCompiler::import(const string &name)
187 string fn = name+".glsl";
188 if(imported_names.count(fn))
190 imported_names.insert(fn);
192 RefPtr<IO::Seekable> io = (resources ? resources->open_raw(fn) : Resources::get_builtins().open(fn));
194 throw runtime_error(format("module %s not found", name));
195 ProgramParser import_parser;
196 append_module(import_parser.parse(*io, fn));
199 void ProgramCompiler::generate(Stage &stage)
201 inject_block(stage.content, module->shared.content);
203 apply<DeclarationReorderer>(stage);
204 apply<FunctionResolver>(stage);
205 apply<VariableResolver>(stage);
206 apply<InterfaceGenerator>(stage);
207 apply<VariableResolver>(stage);
208 apply<DeclarationReorderer>(stage);
209 apply<FunctionResolver>(stage);
210 apply<LegacyConverter>(stage);
213 bool ProgramCompiler::optimize(Stage &stage)
215 apply<ConstantConditionEliminator>(stage);
217 set<FunctionDeclaration *> inlineable = apply<InlineableFunctionLocator>(stage);
218 apply<FunctionInliner>(stage, inlineable);
220 set<Node *> unused = apply<UnusedVariableLocator>(stage);
221 set<Node *> unused2 = apply<UnusedFunctionLocator>(stage);
222 unused.insert(unused2.begin(), unused2.end());
223 apply<NodeRemover>(stage, unused);
225 return !unused.empty();
228 void ProgramCompiler::finalize(Stage &stage)
230 if(get_gl_api()==OPENGL_ES2)
231 apply<DefaultPrecisionGenerator>(stage);
233 apply<PrecisionRemover>(stage);
236 void ProgramCompiler::inject_block(Block &target, const Block &source)
238 list<RefPtr<Node> >::iterator insert_point = target.body.begin();
239 for(list<RefPtr<Node> >::const_iterator i=source.body.begin(); i!=source.body.end(); ++i)
240 target.body.insert(insert_point, (*i)->clone());
244 typename T::ResultType ProgramCompiler::apply(Stage &stage)
247 visitor.apply(stage);
248 return visitor.get_result();
251 template<typename T, typename A>
252 typename T::ResultType ProgramCompiler::apply(Stage &stage, const A &arg)
255 visitor.apply(stage);
256 return visitor.get_result();
260 ProgramCompiler::Visitor::Visitor():
264 void ProgramCompiler::Visitor::apply(Stage &s)
266 SetForScope<Stage *> set(stage, &s);
267 stage->content.visit(*this);
271 ProgramCompiler::BlockModifier::BlockModifier():
275 void ProgramCompiler::BlockModifier::flatten_block(Block &block)
277 insert_nodes.insert(insert_nodes.end(), block.body.begin(), block.body.end());
281 void ProgramCompiler::BlockModifier::apply_and_increment(Block &block, list<RefPtr<Node> >::iterator &i)
283 block.body.insert(i, insert_nodes.begin(), insert_nodes.end());
284 insert_nodes.clear();
287 block.body.erase(i++);
293 void ProgramCompiler::BlockModifier::visit(Block &block)
295 for(list<RefPtr<Node> >::iterator i=block.body.begin(); i!=block.body.end(); )
298 apply_and_increment(block, i);
303 ProgramCompiler::Formatter::Formatter():
305 parameter_list(false),
309 void ProgramCompiler::Formatter::apply(ProgramSyntax::Stage &s)
311 GLApi api = get_gl_api();
312 const Version &ver = s.required_version;
316 formatted += format("#version %d%02d", ver.major, ver.minor);
317 if(api==OPENGL_ES2 && ver>=Version(3, 0))
325 void ProgramCompiler::Formatter::visit(Literal &literal)
327 formatted += literal.token;
330 void ProgramCompiler::Formatter::visit(ParenthesizedExpression &parexpr)
333 parexpr.expression->visit(*this);
337 void ProgramCompiler::Formatter::visit(VariableReference &var)
339 formatted += var.name;
342 void ProgramCompiler::Formatter::visit(MemberAccess &memacc)
344 memacc.left->visit(*this);
345 formatted += format(".%s", memacc.member);
348 void ProgramCompiler::Formatter::visit(UnaryExpression &unary)
351 formatted += unary.oper;
352 unary.expression->visit(*this);
354 formatted += unary.oper;
357 void ProgramCompiler::Formatter::visit(BinaryExpression &binary)
359 binary.left->visit(*this);
360 formatted += binary.oper;
361 binary.right->visit(*this);
362 formatted += binary.after;
365 void ProgramCompiler::Formatter::visit(Assignment &assign)
367 assign.left->visit(*this);
368 formatted += format(" %s ", assign.oper);
369 assign.right->visit(*this);
372 void ProgramCompiler::Formatter::visit(FunctionCall &call)
374 formatted += format("%s(", call.name);
375 for(vector<RefPtr<Expression> >::iterator i=call.arguments.begin(); i!=call.arguments.end(); ++i)
377 if(i!=call.arguments.begin())
384 void ProgramCompiler::Formatter::visit(ExpressionStatement &expr)
386 expr.expression->visit(*this);
390 void ProgramCompiler::Formatter::visit(Block &block)
395 unsigned brace_indent = indent;
396 bool use_braces = (block.use_braces || (indent && block.body.size()!=1));
398 formatted += format("%s{\n", string(brace_indent*2, ' '));
400 SetForScope<unsigned> set(indent, indent+(indent>0 || use_braces));
401 string spaces(indent*2, ' ');
402 for(list<RefPtr<Node> >::iterator i=block.body.begin(); i!=block.body.end(); ++i)
404 if(i!=block.body.begin())
412 formatted += format("\n%s}", string(brace_indent*2, ' '));
415 void ProgramCompiler::Formatter::visit(Import &import)
417 formatted += format("import %s;", import.module);
420 void ProgramCompiler::Formatter::visit(Precision &prec)
422 formatted += format("precision %s %s;", prec.precision, prec.type);
425 void ProgramCompiler::Formatter::visit(Layout &layout)
427 formatted += "layout(";
428 for(vector<Layout::Qualifier>::const_iterator i=layout.qualifiers.begin(); i!=layout.qualifiers.end(); ++i)
430 if(i!=layout.qualifiers.begin())
432 formatted += i->identifier;
433 if(!i->value.empty())
434 formatted += format("=%s", i->value);
439 void ProgramCompiler::Formatter::visit(InterfaceLayout &layout)
441 layout.layout.visit(*this);
442 formatted += format(" %s;", layout.interface);
445 void ProgramCompiler::Formatter::visit(StructDeclaration &strct)
447 formatted += format("struct %s\n", strct.name);
448 strct.members.visit(*this);
452 void ProgramCompiler::Formatter::visit(VariableDeclaration &var)
456 var.layout->visit(*this);
460 formatted += "const ";
461 if(!var.interpolation.empty())
462 formatted += format("%s ", var.interpolation);
463 if(!var.sampling.empty())
464 formatted += format("%s ", var.sampling);
465 if(!var.interface.empty() && var.interface!=block_interface)
467 string interface = var.interface;
468 if(stage->required_version<Version(1, 30))
470 if(stage->type==VERTEX && var.interface=="in")
471 interface = "attribute";
472 else if((stage->type==VERTEX && var.interface=="out") || (stage->type==FRAGMENT && var.interface=="in"))
473 interface = "varying";
475 formatted += format("%s ", interface);
477 if(!var.precision.empty())
478 formatted += format("%s ", var.precision);
479 formatted += format("%s %s", var.type, var.name);
484 var.array_size->visit(*this);
487 if(var.init_expression)
490 var.init_expression->visit(*this);
496 void ProgramCompiler::Formatter::visit(InterfaceBlock &iface)
498 SetForScope<string> set(block_interface, iface.interface);
499 formatted += format("%s %s\n", iface.interface, iface.name);
500 iface.members.visit(*this);
504 void ProgramCompiler::Formatter::visit(FunctionDeclaration &func)
506 formatted += format("%s %s(", func.return_type, func.name);
507 for(vector<RefPtr<VariableDeclaration> >::iterator i=func.parameters.begin(); i!=func.parameters.end(); ++i)
509 if(i!=func.parameters.begin())
511 SetFlag set(parameter_list);
515 if(func.definition==&func)
518 func.body.visit(*this);
524 void ProgramCompiler::Formatter::visit(Conditional &cond)
527 formatted.replace(formatted.rfind('\n'), string::npos, 1, ' ');
532 cond.condition->visit(*this);
535 cond.body.visit(*this);
536 if(!cond.else_body.body.empty())
538 formatted += format("\n%selse\n", string(indent*2, ' '));
539 SetForScope<unsigned> set(else_if, 2);
540 cond.else_body.visit(*this);
544 void ProgramCompiler::Formatter::visit(Iteration &iter)
547 iter.init_statement->visit(*this);
549 iter.condition->visit(*this);
551 iter.loop_expression->visit(*this);
553 iter.body.visit(*this);
556 void ProgramCompiler::Formatter::visit(Return &ret)
558 formatted += "return";
562 ret.expression->visit(*this);
567 void ProgramCompiler::Formatter::visit(Jump &jump)
569 formatted += jump.keyword;
574 ProgramCompiler::DeclarationCombiner::DeclarationCombiner():
578 void ProgramCompiler::DeclarationCombiner::visit(Block &block)
583 SetForScope<bool> set(toplevel, false);
584 BlockModifier::visit(block);
587 void ProgramCompiler::DeclarationCombiner::visit(FunctionDeclaration &func)
589 vector<FunctionDeclaration *> &decls = functions[func.name];
592 for(vector<FunctionDeclaration *>::iterator i=decls.begin(); i!=decls.end(); ++i)
594 (*i)->definition = func.definition;
595 (*i)->body.body.clear();
598 decls.push_back(&func);
601 void ProgramCompiler::DeclarationCombiner::visit(VariableDeclaration &var)
603 VariableDeclaration *&ptr = variables[var.name];
606 ptr->type = var.type;
607 if(var.init_expression)
608 ptr->init_expression = var.init_expression;
616 ProgramCompiler::VariableResolver::VariableResolver():
618 record_target(false),
619 assignment_target(0),
620 self_referencing(false)
623 void ProgramCompiler::VariableResolver::apply(Stage &s)
625 SetForScope<Stage *> set(stage, &s);
626 Stage *builtins = get_builtins(stage->type);
628 blocks.push_back(&builtins->content);
629 stage->content.visit(*this);
634 void ProgramCompiler::VariableResolver::visit(Block &block)
636 blocks.push_back(&block);
637 block.variables.clear();
638 TraversingVisitor::visit(block);
642 void ProgramCompiler::VariableResolver::visit(VariableReference &var)
646 for(vector<Block *>::iterator i=blocks.end(); i!=blocks.begin(); )
649 map<string, VariableDeclaration *>::iterator j = (*i)->variables.find(var.name);
650 if(j!=(*i)->variables.end())
652 var.declaration = j->second;
653 type = j->second->type_declaration;
660 if(assignment_target)
662 record_target = false;
663 assignment_target = 0;
666 assignment_target = var.declaration;
668 else if(var.declaration && var.declaration==assignment_target)
669 self_referencing = true;
672 void ProgramCompiler::VariableResolver::visit(MemberAccess &memacc)
675 TraversingVisitor::visit(memacc);
676 memacc.declaration = 0;
679 map<string, VariableDeclaration *>::iterator i = type->members.variables.find(memacc.member);
680 if(i!=type->members.variables.end())
682 memacc.declaration = i->second;
683 type = i->second->type_declaration;
690 void ProgramCompiler::VariableResolver::visit(BinaryExpression &binary)
695 SetForScope<bool> set(record_target, false);
696 binary.right->visit(*this);
699 binary.left->visit(*this);
703 TraversingVisitor::visit(binary);
708 void ProgramCompiler::VariableResolver::visit(Assignment &assign)
711 SetFlag set(record_target);
712 assignment_target = 0;
713 assign.left->visit(*this);
716 self_referencing = false;
717 assign.right->visit(*this);
719 assign.self_referencing = (self_referencing || assign.oper!="=");
720 assign.target_declaration = assignment_target;
723 void ProgramCompiler::VariableResolver::visit(StructDeclaration &strct)
725 TraversingVisitor::visit(strct);
726 blocks.back()->types[strct.name] = &strct;
729 void ProgramCompiler::VariableResolver::visit(VariableDeclaration &var)
731 for(vector<Block *>::iterator i=blocks.end(); i!=blocks.begin(); )
734 map<string, StructDeclaration *>::iterator j = (*i)->types.find(var.type);
735 if(j!=(*i)->types.end())
736 var.type_declaration = j->second;
739 if(!block_interface.empty() && var.interface.empty())
740 var.interface = block_interface;
742 TraversingVisitor::visit(var);
743 blocks.back()->variables[var.name] = &var;
744 if(anonymous && blocks.size()>1)
745 blocks[blocks.size()-2]->variables[var.name] = &var;
748 void ProgramCompiler::VariableResolver::visit(InterfaceBlock &iface)
750 SetFlag set(anonymous);
751 SetForScope<string> set2(block_interface, iface.interface);
752 TraversingVisitor::visit(iface);
756 void ProgramCompiler::FunctionResolver::visit(FunctionCall &call)
758 map<string, vector<FunctionDeclaration *> >::iterator i = functions.find(call.name);
759 if(i!=functions.end())
760 call.declaration = i->second.back();
762 TraversingVisitor::visit(call);
765 void ProgramCompiler::FunctionResolver::visit(FunctionDeclaration &func)
767 vector<FunctionDeclaration *> &decls = functions[func.name];
770 for(vector<FunctionDeclaration *>::iterator i=decls.begin(); i!=decls.end(); ++i)
771 (*i)->definition = func.definition;
773 decls.push_back(&func);
775 else if(!decls.empty() && decls.back()->definition)
776 func.definition = decls.back()->definition;
778 decls.push_back(&func);
780 TraversingVisitor::visit(func);
784 ProgramCompiler::InterfaceGenerator::InterfaceGenerator():
788 string ProgramCompiler::InterfaceGenerator::get_out_prefix(StageType type)
792 else if(type==GEOMETRY)
798 void ProgramCompiler::InterfaceGenerator::apply(Stage &s)
800 SetForScope<Stage *> set(stage, &s);
802 in_prefix = get_out_prefix(stage->previous->type);
803 out_prefix = get_out_prefix(stage->type);
804 stage->content.visit(*this);
807 void ProgramCompiler::InterfaceGenerator::visit(Block &block)
809 SetForScope<unsigned> set(scope_level, scope_level+1);
810 for(list<RefPtr<Node> >::iterator i=block.body.begin(); i!=block.body.end(); )
816 for(map<string, RefPtr<VariableDeclaration> >::iterator j=iface_declarations.begin(); j!=iface_declarations.end(); ++j)
818 list<RefPtr<Node> >::iterator k = block.body.insert(i, j->second);
821 iface_declarations.clear();
824 apply_and_increment(block, i);
828 string ProgramCompiler::InterfaceGenerator::change_prefix(const string &name, const string &prefix) const
830 unsigned offset = (name.compare(0, in_prefix.size(), in_prefix) ? 0 : in_prefix.size());
831 return prefix+name.substr(offset);
834 bool ProgramCompiler::InterfaceGenerator::generate_interface(VariableDeclaration &var, const string &iface, const string &name)
836 const map<string, VariableDeclaration *> &stage_vars = (iface=="in" ? stage->in_variables : stage->out_variables);
837 if(stage_vars.count(name) || iface_declarations.count(name))
840 VariableDeclaration* iface_var = new VariableDeclaration;
841 iface_var->sampling = var.sampling;
842 iface_var->interface = iface;
843 iface_var->type = var.type;
844 iface_var->type_declaration = var.type_declaration;
845 iface_var->name = name;
846 if(stage->type==GEOMETRY)
847 iface_var->array = ((var.array && var.interface!="in") || iface=="in");
849 iface_var->array = var.array;
851 iface_var->array_size = var.array_size;
853 iface_var->linked_declaration = &var;
854 iface_declarations[name] = iface_var;
859 void ProgramCompiler::InterfaceGenerator::insert_assignment(const string &left, ProgramSyntax::Expression *right)
861 Assignment *assign = new Assignment;
862 VariableReference *ref = new VariableReference;
866 assign->right = right;
868 ExpressionStatement *stmt = new ExpressionStatement;
869 stmt->expression = assign;
871 insert_nodes.push_back(stmt);
874 void ProgramCompiler::InterfaceGenerator::visit(VariableReference &var)
876 if(var.declaration || !stage->previous)
878 if(iface_declarations.count(var.name))
881 const map<string, VariableDeclaration *> &prev_out = stage->previous->out_variables;
882 map<string, VariableDeclaration *>::const_iterator i = prev_out.find(var.name);
883 if(i==prev_out.end())
884 i = prev_out.find(in_prefix+var.name);
885 if(i!=prev_out.end())
887 generate_interface(*i->second, "in", i->second->name);
888 var.name = i->second->name;
892 void ProgramCompiler::InterfaceGenerator::visit(VariableDeclaration &var)
894 if(var.interface=="out")
897 stage->out_variables[var.name] = &var;
898 else if(generate_interface(var, "out", change_prefix(var.name, string())))
901 if(var.init_expression)
903 insert_assignment(var.name, var.init_expression->clone());
908 else if(var.interface=="in")
910 stage->in_variables[var.name] = &var;
911 if(var.linked_declaration)
912 var.linked_declaration->linked_declaration = &var;
913 else if(stage->previous)
915 const map<string, VariableDeclaration *> &prev_out = stage->previous->out_variables;
916 map<string, VariableDeclaration *>::const_iterator i = prev_out.find(var.name);
917 if(i!=prev_out.end())
919 var.linked_declaration = i->second;
920 i->second->linked_declaration = &var;
925 TraversingVisitor::visit(var);
928 void ProgramCompiler::InterfaceGenerator::visit(Passthrough &pass)
930 vector<VariableDeclaration *> pass_vars;
932 for(map<string, VariableDeclaration *>::const_iterator i=stage->in_variables.begin(); i!=stage->in_variables.end(); ++i)
933 pass_vars.push_back(i->second);
934 for(map<string, RefPtr<VariableDeclaration> >::const_iterator i=iface_declarations.begin(); i!=iface_declarations.end(); ++i)
935 if(i->second->interface=="in")
936 pass_vars.push_back(i->second.get());
940 const map<string, VariableDeclaration *> &prev_out = stage->previous->out_variables;
941 for(map<string, VariableDeclaration *>::const_iterator i=prev_out.begin(); i!=prev_out.end(); ++i)
944 for(vector<VariableDeclaration *>::const_iterator j=pass_vars.begin(); (!linked && j!=pass_vars.end()); ++j)
945 linked = ((*j)->linked_declaration==i->second);
947 if(!linked && generate_interface(*i->second, "in", i->second->name))
948 pass_vars.push_back(i->second);
952 if(stage->type==GEOMETRY)
954 VariableReference *ref = new VariableReference;
957 BinaryExpression *subscript = new BinaryExpression;
958 subscript->left = ref;
959 subscript->oper = "[";
960 subscript->right = pass.subscript;
961 subscript->after = "]";
963 MemberAccess *memacc = new MemberAccess;
964 memacc->left = subscript;
965 memacc->member = "gl_Position";
967 insert_assignment("gl_Position", memacc);
970 for(vector<VariableDeclaration *>::const_iterator i=pass_vars.begin(); i!=pass_vars.end(); ++i)
972 string out_name = change_prefix((*i)->name, out_prefix);
973 generate_interface(**i, "out", out_name);
975 VariableReference *ref = new VariableReference;
976 ref->name = (*i)->name;
979 BinaryExpression *subscript = new BinaryExpression;
980 subscript->left = ref;
981 subscript->oper = "[";
982 subscript->right = pass.subscript;
983 subscript->after = "]";
984 insert_assignment(out_name, subscript);
987 insert_assignment(out_name, ref);
994 ProgramCompiler::DeclarationReorderer::DeclarationReorderer():
999 void ProgramCompiler::DeclarationReorderer::visit(FunctionCall &call)
1001 FunctionDeclaration *def = call.declaration;
1003 def = def->definition;
1004 if(def && !ordered_funcs.count(def))
1005 needed_funcs.insert(def);
1008 void ProgramCompiler::DeclarationReorderer::visit(Block &block)
1010 SetForScope<unsigned> set(scope_level, scope_level+1);
1012 return Visitor::visit(block);
1014 list<RefPtr<Node> >::iterator struct_insert_point = block.body.end();
1015 list<RefPtr<Node> >::iterator variable_insert_point = block.body.end();
1016 list<RefPtr<Node> >::iterator function_insert_point = block.body.end();
1017 unsigned unordered_func_count = 0;
1018 bool ordered_any_funcs = false;
1020 for(list<RefPtr<Node> >::iterator i=block.body.begin(); i!=block.body.end(); )
1022 kind = NO_DECLARATION;
1026 if(kind==STRUCT && struct_insert_point!=block.body.end())
1028 block.body.insert(struct_insert_point, *i);
1031 else if(kind>STRUCT && struct_insert_point==block.body.end())
1032 struct_insert_point = i;
1034 if(kind==VARIABLE && variable_insert_point!=block.body.end())
1036 block.body.insert(variable_insert_point, *i);
1039 else if(kind>VARIABLE && variable_insert_point==block.body.end())
1040 variable_insert_point = i;
1044 if(function_insert_point==block.body.end())
1045 function_insert_point = i;
1047 if(needed_funcs.empty())
1049 ordered_funcs.insert(i->get());
1050 if(i!=function_insert_point)
1052 block.body.insert(function_insert_point, *i);
1056 ++function_insert_point;
1057 ordered_any_funcs = true;
1060 ++unordered_func_count;
1065 if(function_insert_point==i)
1066 ++function_insert_point;
1067 block.body.erase(i++);
1072 if(i==block.body.end() && unordered_func_count)
1074 if(!ordered_any_funcs)
1075 // A subset of the remaining functions forms a recursive loop
1076 /* TODO pick a function and move it up, adding any necessary
1080 i = function_insert_point;
1081 unordered_func_count = 0;
1086 void ProgramCompiler::DeclarationReorderer::visit(ProgramSyntax::VariableDeclaration &var)
1088 Visitor::visit(var);
1092 void ProgramCompiler::DeclarationReorderer::visit(FunctionDeclaration &func)
1094 needed_funcs.clear();
1095 func.body.visit(*this);
1096 needed_funcs.erase(&func);
1101 ProgramCompiler::InlineableFunctionLocator::InlineableFunctionLocator():
1105 void ProgramCompiler::InlineableFunctionLocator::visit(FunctionCall &call)
1107 FunctionDeclaration *def = call.declaration;
1108 if(def && def->definition!=def)
1109 def = def->definition;
1113 unsigned &count = refcounts[def];
1115 if(count>1 || def==in_function)
1116 inlineable.erase(def);
1119 TraversingVisitor::visit(call);
1122 void ProgramCompiler::InlineableFunctionLocator::visit(FunctionDeclaration &func)
1124 unsigned &count = refcounts[func.definition];
1125 if(!count && func.parameters.empty())
1126 inlineable.insert(func.definition);
1128 SetForScope<FunctionDeclaration *> set(in_function, &func);
1129 TraversingVisitor::visit(func);
1133 ProgramCompiler::FunctionInliner::FunctionInliner():
1137 ProgramCompiler::FunctionInliner::FunctionInliner(const set<FunctionDeclaration *> &in):
1142 void ProgramCompiler::FunctionInliner::visit_and_inline(RefPtr<Expression> &ptr)
1147 ptr = inline_result;
1150 void ProgramCompiler::FunctionInliner::visit(Block &block)
1155 for(list<RefPtr<Node> >::iterator i=block.body.begin(); i!=block.body.end(); ++i)
1163 void ProgramCompiler::FunctionInliner::visit(UnaryExpression &unary)
1165 visit_and_inline(unary.expression);
1169 void ProgramCompiler::FunctionInliner::visit(BinaryExpression &binary)
1171 visit_and_inline(binary.left);
1172 visit_and_inline(binary.right);
1176 void ProgramCompiler::FunctionInliner::visit(MemberAccess &memacc)
1178 visit_and_inline(memacc.left);
1182 void ProgramCompiler::FunctionInliner::visit(FunctionCall &call)
1184 for(vector<RefPtr<Expression> >::iterator i=call.arguments.begin(); i!=call.arguments.end(); ++i)
1185 visit_and_inline(*i);
1187 FunctionDeclaration *def = call.declaration;
1188 if(def && def->definition!=def)
1189 def = def->definition;
1191 if(def && inlineable.count(def))
1200 void ProgramCompiler::FunctionInliner::visit(Return &ret)
1202 TraversingVisitor::visit(ret);
1205 inline_result = ret.expression->clone();
1209 ProgramCompiler::ExpressionEvaluator::ExpressionEvaluator():
1215 ProgramCompiler::ExpressionEvaluator::ExpressionEvaluator(const ValueMap &v):
1216 variable_values(&v),
1221 void ProgramCompiler::ExpressionEvaluator::visit(Literal &literal)
1223 if(literal.token=="true")
1225 else if(literal.token=="false")
1228 result = lexical_cast<float>(literal.token);
1229 result_valid = true;
1232 void ProgramCompiler::ExpressionEvaluator::visit(ParenthesizedExpression &parexp)
1234 parexp.expression->visit(*this);
1237 void ProgramCompiler::ExpressionEvaluator::visit(VariableReference &var)
1239 if(!var.declaration)
1244 ValueMap::const_iterator i = variable_values->find(var.declaration);
1245 if(i!=variable_values->end())
1246 i->second->visit(*this);
1248 else if(var.declaration->init_expression)
1249 var.declaration->init_expression->visit(*this);
1252 void ProgramCompiler::ExpressionEvaluator::visit(UnaryExpression &unary)
1254 result_valid = false;
1255 unary.expression->visit(*this);
1262 result_valid = false;
1265 void ProgramCompiler::ExpressionEvaluator::visit(BinaryExpression &binary)
1267 result_valid = false;
1268 binary.left->visit(*this);
1272 float left_result = result;
1273 result_valid = false;
1274 binary.right->visit(*this);
1278 if(binary.oper=="<")
1279 result = (left_result<result);
1280 else if(binary.oper=="<=")
1281 result = (left_result<=result);
1282 else if(binary.oper==">")
1283 result = (left_result>result);
1284 else if(binary.oper==">=")
1285 result = (left_result>=result);
1286 else if(binary.oper=="==")
1287 result = (left_result==result);
1288 else if(binary.oper=="!=")
1289 result = (left_result!=result);
1290 else if(binary.oper=="&&")
1291 result = (left_result && result);
1292 else if(binary.oper=="||")
1293 result = (left_result || result);
1295 result_valid = false;
1299 ProgramCompiler::ConstantConditionEliminator::ConstantConditionEliminator():
1304 void ProgramCompiler::ConstantConditionEliminator::visit(Block &block)
1306 SetForScope<unsigned> set(scope_level, scope_level+1);
1307 BlockModifier::visit(block);
1309 for(map<string, VariableDeclaration *>::const_iterator i=block.variables.begin(); i!=block.variables.end(); ++i)
1310 variable_values.erase(i->second);
1313 void ProgramCompiler::ConstantConditionEliminator::visit(UnaryExpression &unary)
1315 if(VariableReference *var = dynamic_cast<VariableReference *>(unary.expression.get()))
1316 if(unary.oper=="++" || unary.oper=="--")
1317 variable_values.erase(var->declaration);
1320 void ProgramCompiler::ConstantConditionEliminator::visit(Assignment &assign)
1322 variable_values.erase(assign.target_declaration);
1325 void ProgramCompiler::ConstantConditionEliminator::visit(VariableDeclaration &var)
1327 if(var.constant || scope_level>1)
1328 variable_values[&var] = var.init_expression.get();
1331 void ProgramCompiler::ConstantConditionEliminator::visit(Conditional &cond)
1335 ExpressionEvaluator eval(variable_values);
1336 cond.condition->visit(eval);
1337 if(eval.result_valid)
1339 flatten_block(eval.result ? cond.body : cond.else_body);
1344 TraversingVisitor::visit(cond);
1347 void ProgramCompiler::ConstantConditionEliminator::visit(Iteration &iter)
1353 /* If the loop condition is always false on the first iteration, the
1354 entire loop can be removed */
1355 if(iter.init_statement)
1356 iter.init_statement->visit(*this);
1357 ExpressionEvaluator eval(variable_values);
1358 iter.condition->visit(eval);
1359 if(eval.result_valid && !eval.result)
1366 /* Record all assignments that occur inside the loop body so those
1367 variables won't be considered as constant */
1368 SetFlag set_record(record_only);
1369 TraversingVisitor::visit(iter);
1372 TraversingVisitor::visit(iter);
1374 if(VariableDeclaration *init_decl = dynamic_cast<VariableDeclaration *>(iter.init_statement.get()))
1375 variable_values.erase(init_decl);
1379 ProgramCompiler::UnusedVariableLocator::UnusedVariableLocator():
1382 assignment_target(false),
1386 void ProgramCompiler::UnusedVariableLocator::apply(Stage &s)
1388 variables.push_back(BlockVariableMap());
1390 BlockVariableMap &global_variables = variables.back();
1391 for(BlockVariableMap::iterator i=global_variables.begin(); i!=global_variables.end(); ++i)
1393 if(i->first->interface=="out" && (s.type==FRAGMENT || i->first->linked_declaration || !i->first->name.compare(0, 3, "gl_")))
1395 if(!i->second.referenced)
1397 unused_nodes.insert(i->first);
1398 clear_assignments(i->second, true);
1401 variables.pop_back();
1404 void ProgramCompiler::UnusedVariableLocator::visit(VariableReference &var)
1406 map<VariableDeclaration *, Node *>::iterator i = aggregates.find(var.declaration);
1407 if(i!=aggregates.end())
1408 unused_nodes.erase(i->second);
1410 if(var.declaration && !assignment_target)
1412 VariableInfo &var_info = variables.back()[var.declaration];
1413 var_info.assignments.clear();
1414 var_info.referenced = true;
1418 void ProgramCompiler::UnusedVariableLocator::visit(MemberAccess &memacc)
1420 TraversingVisitor::visit(memacc);
1421 unused_nodes.erase(memacc.declaration);
1424 void ProgramCompiler::UnusedVariableLocator::visit(BinaryExpression &binary)
1426 if(binary.oper=="[")
1428 binary.left->visit(*this);
1429 SetForScope<bool> set(assignment_target, false);
1430 binary.right->visit(*this);
1433 TraversingVisitor::visit(binary);
1436 void ProgramCompiler::UnusedVariableLocator::visit(Assignment &assign)
1439 SetForScope<bool> set(assignment_target, !assign.self_referencing);
1440 assign.left->visit(*this);
1442 assign.right->visit(*this);
1443 assignment = &assign;
1446 void ProgramCompiler::UnusedVariableLocator::record_assignment(VariableDeclaration &var, Node &node, bool self_ref)
1448 VariableInfo &var_info = variables.back()[&var];
1450 clear_assignments(var_info, true);
1451 var_info.assignments.push_back(&node);
1452 var_info.conditionally_assigned = false;
1455 void ProgramCompiler::UnusedVariableLocator::clear_assignments(VariableInfo &var_info, bool mark_unused)
1459 for(vector<Node *>::iterator i=var_info.assignments.begin(); i!=var_info.assignments.end(); ++i)
1460 unused_nodes.insert(*i);
1462 var_info.assignments.clear();
1465 void ProgramCompiler::UnusedVariableLocator::visit(ExpressionStatement &expr)
1468 TraversingVisitor::visit(expr);
1469 if(assignment && assignment->target_declaration)
1470 record_assignment(*assignment->target_declaration, expr, assignment->self_referencing);
1473 void ProgramCompiler::UnusedVariableLocator::visit(StructDeclaration &strct)
1475 SetForScope<Node *> set(aggregate, &strct);
1476 unused_nodes.insert(&strct);
1477 TraversingVisitor::visit(strct);
1480 void ProgramCompiler::UnusedVariableLocator::visit(VariableDeclaration &var)
1483 aggregates[&var] = aggregate;
1486 variables.back()[&var].local = true;
1487 if(var.init_expression)
1488 record_assignment(var, *var.init_expression, false);
1490 unused_nodes.erase(var.type_declaration);
1491 TraversingVisitor::visit(var);
1494 void ProgramCompiler::UnusedVariableLocator::visit(InterfaceBlock &iface)
1496 SetForScope<Node *> set(aggregate, &iface);
1497 unused_nodes.insert(&iface);
1498 TraversingVisitor::visit(iface);
1501 void ProgramCompiler::UnusedVariableLocator::visit(FunctionDeclaration &func)
1503 variables.push_back(BlockVariableMap());
1506 SetForScope<bool> set(global_scope, false);
1507 for(vector<RefPtr<VariableDeclaration> >::iterator i=func.parameters.begin(); i!=func.parameters.end(); ++i)
1509 func.body.visit(*this);
1512 BlockVariableMap &block_variables = variables.back();
1513 for(BlockVariableMap::iterator i=block_variables.begin(); i!=block_variables.end(); ++i)
1514 i->second.conditionally_assigned = true;
1515 for(vector<RefPtr<VariableDeclaration> >::iterator i=func.parameters.begin(); i!=func.parameters.end(); ++i)
1516 block_variables[i->get()].referenced = true;
1517 merge_down_variables();
1520 void ProgramCompiler::UnusedVariableLocator::merge_down_variables()
1522 BlockVariableMap &parent_variables = variables[variables.size()-2];
1523 BlockVariableMap &block_variables = variables.back();
1524 for(BlockVariableMap::iterator i=block_variables.begin(); i!=block_variables.end(); ++i)
1528 if(!i->second.referenced)
1529 unused_nodes.insert(i->first);
1530 clear_assignments(i->second, true);
1534 BlockVariableMap::iterator j = parent_variables.find(i->first);
1535 if(j==parent_variables.end())
1536 parent_variables.insert(*i);
1539 if(i->second.referenced || !i->second.conditionally_assigned)
1540 clear_assignments(j->second, !i->second.referenced);
1541 j->second.conditionally_assigned = i->second.conditionally_assigned;
1542 j->second.referenced |= i->second.referenced;
1543 j->second.assignments.insert(j->second.assignments.end(), i->second.assignments.begin(), i->second.assignments.end());
1546 variables.pop_back();
1549 void ProgramCompiler::UnusedVariableLocator::visit(Conditional &cond)
1551 cond.condition->visit(*this);
1552 variables.push_back(BlockVariableMap());
1553 cond.body.visit(*this);
1555 BlockVariableMap if_variables;
1556 swap(variables.back(), if_variables);
1557 cond.else_body.visit(*this);
1559 BlockVariableMap &else_variables = variables.back();
1560 for(BlockVariableMap::iterator i=else_variables.begin(); i!=else_variables.end(); ++i)
1562 BlockVariableMap::iterator j = if_variables.find(i->first);
1563 if(j!=if_variables.end())
1565 i->second.assignments.insert(i->second.assignments.end(), j->second.assignments.begin(), j->second.assignments.end());
1566 i->second.conditionally_assigned |= j->second.conditionally_assigned;
1567 if_variables.erase(j);
1570 i->second.conditionally_assigned = true;
1573 for(BlockVariableMap::iterator i=if_variables.begin(); i!=if_variables.end(); ++i)
1575 i->second.conditionally_assigned = true;
1576 else_variables.insert(*i);
1579 merge_down_variables();
1582 void ProgramCompiler::UnusedVariableLocator::visit(Iteration &iter)
1584 variables.push_back(BlockVariableMap());
1585 TraversingVisitor::visit(iter);
1587 BlockVariableMap &block_variables = variables.back();
1588 for(BlockVariableMap::iterator i=block_variables.begin(); i!=block_variables.end(); ++i)
1589 if(!i->second.local && i->second.referenced)
1590 i->second.assignments.clear();
1592 merge_down_variables();
1596 ProgramCompiler::UnusedVariableLocator::VariableInfo::VariableInfo():
1598 conditionally_assigned(false),
1603 void ProgramCompiler::UnusedFunctionLocator::visit(FunctionCall &call)
1605 TraversingVisitor::visit(call);
1607 unused_nodes.erase(call.declaration);
1608 if(call.declaration && call.declaration->definition!=call.declaration)
1609 used_definitions.insert(call.declaration->definition);
1612 void ProgramCompiler::UnusedFunctionLocator::visit(FunctionDeclaration &func)
1614 TraversingVisitor::visit(func);
1616 if((func.name!="main" || func.body.body.empty()) && !used_definitions.count(&func))
1617 unused_nodes.insert(&func);
1621 ProgramCompiler::NodeRemover::NodeRemover(const set<Node *> &r):
1625 void ProgramCompiler::NodeRemover::visit(Block &block)
1627 for(list<RefPtr<Node> >::iterator i=block.body.begin(); i!=block.body.end(); )
1630 if(to_remove.count(i->get()))
1631 block.body.erase(i++);
1637 void ProgramCompiler::NodeRemover::visit(VariableDeclaration &var)
1639 if(to_remove.count(&var))
1641 stage->in_variables.erase(var.name);
1642 stage->out_variables.erase(var.name);
1643 stage->locations.erase(var.name);
1644 if(var.linked_declaration)
1645 var.linked_declaration->linked_declaration = 0;
1647 else if(var.init_expression && to_remove.count(var.init_expression.get()))
1648 var.init_expression = 0;
1652 void ProgramCompiler::PrecisionRemover::visit(Precision &)
1657 void ProgramCompiler::PrecisionRemover::visit(VariableDeclaration &var)
1659 var.precision.clear();
1663 ProgramCompiler::DefaultPrecisionGenerator::DefaultPrecisionGenerator():
1667 void ProgramCompiler::DefaultPrecisionGenerator::visit(Block &block)
1671 SetForScope<bool> set(toplevel, false);
1672 BlockModifier::visit(block);
1675 Visitor::visit(block);
1678 void ProgramCompiler::DefaultPrecisionGenerator::visit(Precision &prec)
1680 have_default.insert(prec.type);
1683 void ProgramCompiler::DefaultPrecisionGenerator::visit(VariableDeclaration &var)
1685 if(var.type_declaration)
1688 string type = var.type;
1689 if(!type.compare(0, 3, "vec") || !type.compare(0, 3, "mat"))
1691 else if(!type.compare(0, 3, "ivec") || type=="uint")
1694 if(!have_default.count(type))
1696 Precision *prec = new Precision;
1697 if(!type.compare(0, 7, "sampler"))
1698 prec->precision = "lowp";
1699 else if(stage->type==FRAGMENT)
1700 prec->precision = "mediump";
1702 prec->precision = "highp";
1704 insert_nodes.push_back(prec);
1706 have_default.insert(type);
1711 ProgramCompiler::LegacyConverter::LegacyConverter():
1712 target_api(get_gl_api()),
1713 target_version(get_glsl_version()),
1717 ProgramCompiler::LegacyConverter::LegacyConverter(const Version &v):
1718 target_api(get_gl_api()),
1723 bool ProgramCompiler::LegacyConverter::check_version(const Version &feature_version) const
1725 if(target_version<feature_version)
1727 else if(stage->required_version<feature_version)
1728 stage->required_version = feature_version;
1733 bool ProgramCompiler::LegacyConverter::supports_unified_interface_syntax() const
1735 if(target_api==OPENGL_ES2)
1736 return check_version(Version(3, 0));
1738 return check_version(Version(1, 30));
1741 void ProgramCompiler::LegacyConverter::visit(VariableReference &var)
1743 if(var.declaration==frag_out && !supports_unified_interface_syntax())
1745 var.name = "gl_FragColor";
1746 var.declaration = 0;
1749 else if(var.declaration)
1750 type = var.declaration->type;
1755 void ProgramCompiler::LegacyConverter::visit(Assignment &assign)
1757 TraversingVisitor::visit(assign);
1758 if(assign.target_declaration==frag_out && !supports_unified_interface_syntax())
1759 assign.target_declaration = 0;
1762 bool ProgramCompiler::LegacyConverter::supports_unified_sampling_functions() const
1764 if(target_api==OPENGL_ES2)
1765 return check_version(Version(3, 0));
1767 return check_version(Version(1, 30));
1770 void ProgramCompiler::LegacyConverter::visit(FunctionCall &call)
1772 if(call.name=="texture" && !call.declaration && !supports_unified_sampling_functions())
1774 vector<RefPtr<Expression> >::iterator i = call.arguments.begin();
1775 if(i!=call.arguments.end())
1778 if(type=="sampler1D")
1779 call.name = "texture1D";
1780 else if(type=="sampler2D")
1781 call.name = "texture2D";
1782 else if(type=="sampler3D")
1783 call.name = "texture3D";
1784 else if(type=="sampler1DShadow")
1785 call.name = "shadow1D";
1786 else if(type=="sampler2DShadow")
1787 call.name = "shadow2D";
1789 for(; i!=call.arguments.end(); ++i)
1794 TraversingVisitor::visit(call);
1797 bool ProgramCompiler::LegacyConverter::supports_interface_layouts() const
1799 if(target_api==OPENGL_ES2)
1800 return check_version(Version(3, 0));
1802 return check_version(Version(3, 30));
1805 bool ProgramCompiler::LegacyConverter::supports_centroid_sampling() const
1807 if(target_api==OPENGL_ES2)
1808 return check_version(Version(3, 0));
1810 return check_version(Version(1, 20));
1813 bool ProgramCompiler::LegacyConverter::supports_sample_sampling() const
1815 if(target_api==OPENGL_ES2)
1816 return check_version(Version(3, 20));
1818 return check_version(Version(4, 0));
1821 void ProgramCompiler::LegacyConverter::visit(VariableDeclaration &var)
1823 if(var.layout && !supports_interface_layouts())
1825 vector<Layout::Qualifier>::iterator i;
1826 for(i=var.layout->qualifiers.begin(); (i!=var.layout->qualifiers.end() && i->identifier!="location"); ++i) ;
1827 if(i!=var.layout->qualifiers.end())
1829 unsigned location = lexical_cast<unsigned>(i->value);
1830 if(stage->type==VERTEX && var.interface=="in")
1832 stage->locations[var.name] = location;
1833 var.layout->qualifiers.erase(i);
1835 else if(stage->type==FRAGMENT && var.interface=="out")
1838 static Require _req(EXT_gpu_shader4);
1839 stage->locations[var.name] = location;
1840 var.layout->qualifiers.erase(i);
1843 if(var.layout->qualifiers.empty())
1848 if(var.sampling=="centroid")
1850 if(!supports_centroid_sampling())
1851 var.sampling = string();
1853 else if(var.sampling=="sample")
1855 if(!supports_sample_sampling())
1856 var.sampling = string();
1859 if((var.interface=="in" || var.interface=="out") && !supports_unified_interface_syntax())
1861 if(stage->type==FRAGMENT && var.interface=="out")
1868 TraversingVisitor::visit(var);
1871 bool ProgramCompiler::LegacyConverter::supports_interface_blocks(const string &iface) const
1873 if(target_api==OPENGL_ES2)
1875 if(iface=="uniform")
1876 return check_version(Version(3, 0));
1878 return check_version(Version(3, 20));
1881 return check_version(Version(1, 50));
1884 void ProgramCompiler::LegacyConverter::visit(InterfaceBlock &iface)
1886 if(!supports_interface_blocks(iface.interface))
1887 flatten_block(iface.members);