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         if(module->vertex_context.present)
  39                 program.attach_shader_owned(new VertexShader(head+format_context(module->vertex_context)));
  40         if(module->geometry_context.present)
  41                 program.attach_shader_owned(new GeometryShader(head+format_context(module->geometry_context)));
  42         if(module->fragment_context.present)
  43                 program.attach_shader_owned(new FragmentShader(head+format_context(module->fragment_context)));
  44
  45         program.bind_attribute(VERTEX4, "vertex");
  46         program.bind_attribute(NORMAL3, "normal");
  47         program.bind_attribute(COLOR4_FLOAT, "color");
  48         program.bind_attribute(TEXCOORD4, "texcoord");
  49 }
  50
  51 void ProgramCompiler::process()
  52 {
  53         if(module->vertex_context.present)
  54                 generate(module->vertex_context);
  55         if(module->geometry_context.present)
  56                 generate(module->geometry_context);
  57         if(module->fragment_context.present)
  58                 generate(module->fragment_context);
  59
  60         if(module->vertex_context.present)
  61                 optimize(module->vertex_context);
  62         if(module->geometry_context.present)
  63                 optimize(module->geometry_context);
  64         if(module->fragment_context.present)
  65                 optimize(module->fragment_context);
  66 }
  67
  68 void ProgramCompiler::generate(Context &context)
  69 {
  70         inject_block(context.content, module->global_context.content);
  71
  72         resolve_variables(context);
  73
  74         InterfaceGenerator generator;
  75         generator.visit(context);
  76
  77         resolve_variables(context);
  78
  79         VariableRenamer renamer;
  80         context.content.visit(renamer);
  81 }
  82
  83 void ProgramCompiler::optimize(Context &context)
  84 {
  85         while(1)
  86         {
  87                 UnusedVariableLocator unused_locator;
  88                 unused_locator.visit(context);
  89
  90                 NodeRemover remover;
  91                 remover.to_remove = unused_locator.unused_nodes;
  92                 remover.visit(context);
  93
  94                 if(!remover.n_removed)
  95                         break;
  96         }
  97 }
  98
  99 void ProgramCompiler::inject_block(Block &target, const Block &source)
 100 {
 101         list<NodePtr<Node> >::iterator insert_point = target.body.begin();
 102         for(list<NodePtr<Node> >::const_iterator i=source.body.begin(); i!=source.body.end(); ++i)
 103                 target.body.insert(insert_point, (*i)->clone());
 104 }
 105
 106 void ProgramCompiler::resolve_variables(Context &context)
 107 {
 108         VariableResolver resolver;
 109         context.content.visit(resolver);
 110 }
 111
 112 string ProgramCompiler::format_context(Context &context)
 113 {
 114         Formatter formatter;
 115         context.content.visit(formatter);
 116         return formatter.formatted;
 117 }
 118
 119
 120 ProgramCompiler::Formatter::Formatter():
 121         indent(0),
 122         parameter_list(false),
 123         else_if(false)
 124 { }
 125
 126 void ProgramCompiler::Formatter::visit(Literal &literal)
 127 {
 128         formatted += literal.token;
 129 }
 130
 131 void ProgramCompiler::Formatter::visit(ParenthesizedExpression &parexpr)
 132 {
 133         formatted += '(';
 134         parexpr.expression->visit(*this);
 135         formatted += ')';
 136 }
 137
 138 void ProgramCompiler::Formatter::visit(VariableReference &var)
 139 {
 140         formatted += var.name;
 141 }
 142
 143 void ProgramCompiler::Formatter::visit(MemberAccess &memacc)
 144 {
 145         memacc.left->visit(*this);
 146         formatted += format(".%s", memacc.member);
 147 }
 148
 149 void ProgramCompiler::Formatter::visit(UnaryExpression &unary)
 150 {
 151         if(unary.prefix)
 152                 formatted += unary.oper;
 153         unary.expression->visit(*this);
 154         if(!unary.prefix)
 155                 formatted += unary.oper;
 156 }
 157
 158 void ProgramCompiler::Formatter::visit(BinaryExpression &binary)
 159 {
 160         binary.left->visit(*this);
 161         if(binary.assignment)
 162                 formatted += format(" %s ", binary.oper);
 163         else
 164                 formatted += binary.oper;
 165         binary.right->visit(*this);
 166         formatted += binary.after;
 167 }
 168
 169 void ProgramCompiler::Formatter::visit(FunctionCall &call)
 170 {
 171         formatted += format("%s(", call.name);
 172         for(vector<NodePtr<Expression> >::iterator i=call.arguments.begin(); i!=call.arguments.end(); ++i)
 173         {
 174                 if(i!=call.arguments.begin())
 175                         formatted += ", ";
 176                 (*i)->visit(*this);
 177         }
 178         formatted += ')';
 179 }
 180
 181 void ProgramCompiler::Formatter::visit(ExpressionStatement &expr)
 182 {
 183         expr.expression->visit(*this);
 184         formatted += ';';
 185 }
 186
 187 void ProgramCompiler::Formatter::visit(Block &block)
 188 {
 189         if(block.use_braces)
 190         {
 191                 if(else_if)
 192                 {
 193                         formatted += '\n';
 194                         else_if = false;
 195                 }
 196                 formatted += format("%s{\n", string(indent*2, ' '));
 197         }
 198
 199         bool change_indent = (!formatted.empty() && !else_if);
 200         indent += change_indent;
 201         string spaces(indent*2, ' ');
 202         for(list<NodePtr<Node> >::iterator i=block.body.begin(); i!=block.body.end(); ++i)
 203         {
 204                 if(i!=block.body.begin())
 205                         formatted += '\n';
 206                 if(!else_if)
 207                         formatted += spaces;
 208                 (*i)->visit(*this);
 209         }
 210         indent -= change_indent;
 211
 212         if(block.use_braces)
 213                 formatted += format("\n%s}", string(indent*2, ' '));
 214 }
 215
 216 void ProgramCompiler::Formatter::visit(Layout &layout)
 217 {
 218         formatted += "layout(";
 219         for(vector<Layout::Qualifier>::const_iterator i=layout.qualifiers.begin(); i!=layout.qualifiers.end(); ++i)
 220         {
 221                 if(i!=layout.qualifiers.begin())
 222                         formatted += ", ";
 223                 formatted += i->identifier;
 224                 if(!i->value.empty())
 225                         formatted += format("=%s", i->value);
 226         }
 227         formatted += format(") %s;", layout.interface);
 228 }
 229
 230 void ProgramCompiler::Formatter::visit(StructDeclaration &strct)
 231 {
 232         formatted += format("struct %s\n", strct.name);
 233         strct.members.visit(*this);
 234         formatted += ';';
 235 }
 236
 237 void ProgramCompiler::Formatter::visit(VariableDeclaration &var)
 238 {
 239         if(var.constant)
 240                 formatted += "const ";
 241         if(!var.sampling.empty())
 242                 formatted += format("%s ", var.sampling);
 243         if(!var.interface.empty())
 244                 formatted += format("%s ", var.interface);
 245         formatted += format("%s %s", var.type, var.name);
 246         if(var.array)
 247         {
 248                 formatted += '[';
 249                 if(var.array_size)
 250                         var.array_size->visit(*this);
 251                 formatted += ']';
 252         }
 253         if(var.init_expression)
 254         {
 255                 formatted += " = ";
 256                 var.init_expression->visit(*this);
 257         }
 258         if(!parameter_list)
 259                 formatted += ';';
 260 }
 261
 262 void ProgramCompiler::Formatter::visit(InterfaceBlock &iface)
 263 {
 264         formatted += format("%s %s\n", iface.interface, iface.name);
 265         iface.members.visit(*this);
 266         formatted += ';';
 267 }
 268
 269 void ProgramCompiler::Formatter::visit(FunctionDeclaration &func)
 270 {
 271         formatted += format("%s %s(", func.return_type, func.name);
 272         for(vector<NodePtr<VariableDeclaration> >::iterator i=func.parameters.begin(); i!=func.parameters.end(); ++i)
 273         {
 274                 if(i!=func.parameters.begin())
 275                         formatted += ", ";
 276                 SetFlag set(parameter_list);
 277                 (*i)->visit(*this);
 278         }
 279         formatted += ')';
 280         if(func.definition)
 281         {
 282                 formatted += '\n';
 283                 func.body.visit(*this);
 284         }
 285         else
 286                 formatted += ';';
 287 }
 288
 289 void ProgramCompiler::Formatter::visit(Conditional &cond)
 290 {
 291         if(else_if)
 292         {
 293                 formatted += ' ';
 294                 else_if = false;
 295         }
 296
 297         formatted += "if(";
 298         cond.condition->visit(*this);
 299         formatted += ")\n";
 300
 301         cond.body.visit(*this);
 302         if(!cond.else_body.body.empty())
 303         {
 304                 formatted += format("\n%selse", string(indent*2, ' '));
 305                 SetFlag set(else_if);
 306                 cond.else_body.visit(*this);
 307         }
 308 }
 309
 310 void ProgramCompiler::Formatter::visit(Iteration &iter)
 311 {
 312         formatted += "for(";
 313         iter.init_statement->visit(*this);
 314         formatted += ' ';
 315         iter.condition->visit(*this);
 316         formatted += "; ";
 317         iter.loop_expression->visit(*this);
 318         formatted += ")\n";
 319         iter.body.visit(*this);
 320 }
 321
 322 void ProgramCompiler::Formatter::visit(Return &ret)
 323 {
 324         formatted += "return ";
 325         ret.expression->visit(*this);
 326         formatted += ';';
 327 }
 328
 329
 330 ProgramCompiler::VariableResolver::VariableResolver():
 331         anonymous(false)
 332 { }
 333
 334 void ProgramCompiler::VariableResolver::visit(Block &block)
 335 {
 336         blocks.push_back(&block);
 337         block.variables.clear();
 338         TraversingVisitor::visit(block);
 339         blocks.pop_back();
 340 }
 341
 342 void ProgramCompiler::VariableResolver::visit(VariableReference &var)
 343 {
 344         var.declaration = 0;
 345         type = 0;
 346         for(vector<Block *>::iterator i=blocks.end(); i!=blocks.begin(); )
 347         {
 348                 --i;
 349                 map<string, VariableDeclaration *>::iterator j = (*i)->variables.find(var.name);
 350                 if(j!=(*i)->variables.end())
 351                 {
 352                         var.declaration = j->second;
 353                         type = j->second->type_declaration;
 354                         break;
 355                 }
 356         }
 357 }
 358
 359 void ProgramCompiler::VariableResolver::visit(MemberAccess &memacc)
 360 {
 361         type = 0;
 362         TraversingVisitor::visit(memacc);
 363         memacc.declaration = 0;
 364         if(type)
 365         {
 366                 map<string, VariableDeclaration *>::iterator i = type->members.variables.find(memacc.member);
 367                 if(i!=type->members.variables.end())
 368                 {
 369                         memacc.declaration = i->second;
 370                         type = i->second->type_declaration;
 371                 }
 372                 else
 373                         type = 0;
 374         }
 375 }
 376
 377 void ProgramCompiler::VariableResolver::visit(BinaryExpression &binary)
 378 {
 379         if(binary.oper=="[")
 380         {
 381                 binary.right->visit(*this);
 382                 type = 0;
 383                 binary.left->visit(*this);
 384         }
 385         else
 386         {
 387                 TraversingVisitor::visit(binary);
 388                 type = 0;
 389         }
 390 }
 391
 392 void ProgramCompiler::VariableResolver::visit(StructDeclaration &strct)
 393 {
 394         TraversingVisitor::visit(strct);
 395         blocks.back()->types[strct.name] = &strct;
 396 }
 397
 398 void ProgramCompiler::VariableResolver::visit(VariableDeclaration &var)
 399 {
 400         for(vector<Block *>::iterator i=blocks.end(); i!=blocks.begin(); )
 401         {
 402                 --i;
 403                 map<string, StructDeclaration *>::iterator j = (*i)->types.find(var.type);
 404                 if(j!=(*i)->types.end())
 405                         var.type_declaration = j->second;
 406         }
 407
 408         TraversingVisitor::visit(var);
 409         blocks.back()->variables[var.name] = &var;
 410         if(anonymous && blocks.size()>1)
 411                 blocks[blocks.size()-2]->variables[var.name] = &var;
 412 }
 413
 414 void ProgramCompiler::VariableResolver::visit(InterfaceBlock &iface)
 415 {
 416         SetFlag set(anonymous);
 417         TraversingVisitor::visit(iface);
 418 }
 419
 420
 421 ProgramCompiler::InterfaceGenerator::InterfaceGenerator():
 422         context(0),
 423         scope_level(0),
 424         remove_node(false)
 425 { }
 426
 427 string ProgramCompiler::InterfaceGenerator::get_out_prefix(ContextType 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::visit(Context &ctx)
 438 {
 439         SetForScope<Context *> set(context, &ctx);
 440         if(context->previous)
 441                 in_prefix = get_out_prefix(context->previous->type);
 442         out_prefix = get_out_prefix(context->type);
 443         ctx.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, NodePtr<Node> >::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<NodePtr<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 &out, const string &iface, const string &name)
 482 {
 483         const map<string, VariableDeclaration *> &context_vars = (iface=="in" ? context->in_variables : context->out_variables);
 484         if(context_vars.count(name) || iface_declarations.count(name))
 485                 return false;
 486
 487         VariableDeclaration* iface_var = new VariableDeclaration;
 488         iface_var->sampling = out.sampling;
 489         iface_var->interface = iface;
 490         iface_var->type = out.type;
 491         iface_var->type_declaration = out.type_declaration;
 492         iface_var->name = name;
 493         iface_var->array = (out.array || (context->type==GEOMETRY && iface=="in"));
 494         iface_var->array_size = out.array_size;
 495         if(iface=="in")
 496                 iface_var->linked_declaration = &out;
 497         iface_declarations[iface_var->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 || !context->previous)
 520                 return;
 521         if(iface_declarations.count(var.name))
 522                 return;
 523
 524         const map<string, VariableDeclaration *> &prev_out = context->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                         context->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                 context->in_variables[var.name] = &var;
 548                 if(var.linked_declaration)
 549                         var.linked_declaration->linked_declaration = &var;
 550                 else if(context->previous)
 551                 {
 552                         const map<string, VariableDeclaration *> &prev_out = context->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         if(context->previous)
 568         {
 569                 const map<string, VariableDeclaration *> &prev_out = context->previous->out_variables;
 570                 for(map<string, VariableDeclaration *>::const_iterator i=prev_out.begin(); i!=prev_out.end(); ++i)
 571                 {
 572                         string out_name = change_prefix(i->second->name, out_prefix);
 573                         generate_interface(*i->second, "in", i->second->name);
 574                         generate_interface(*i->second, "out", out_name);
 575
 576                         VariableReference *ref = new VariableReference;
 577                         ref->name = i->first;
 578                         if(pass.subscript)
 579                         {
 580                                 BinaryExpression *subscript = new BinaryExpression;
 581                                 subscript->left = ref;
 582                                 subscript->oper = "[";
 583                                 subscript->right = pass.subscript;
 584                                 subscript->after = "]";
 585                                 insert_assignment(out_name, subscript);
 586                         }
 587                         else
 588                                 insert_assignment(out_name, ref);
 589                 }
 590         }
 591
 592         remove_node = true;
 593 }
 594
 595
 596 void ProgramCompiler::VariableRenamer::visit(VariableReference &var)
 597 {
 598         if(var.declaration)
 599                 var.name = var.declaration->name;
 600 }
 601
 602 void ProgramCompiler::VariableRenamer::visit(VariableDeclaration &var)
 603 {
 604         if(var.linked_declaration)
 605                 var.name = var.linked_declaration->name;
 606         TraversingVisitor::visit(var);
 607 }
 608
 609
 610 ProgramCompiler::UnusedVariableLocator::UnusedVariableLocator():
 611         context(0),
 612         assignment(false),
 613         assignment_target(0)
 614 { }
 615
 616 void ProgramCompiler::UnusedVariableLocator::visit(Context &ctx)
 617 {
 618         context = &ctx;
 619         ctx.content.visit(*this);
 620 }
 621
 622 void ProgramCompiler::UnusedVariableLocator::visit(VariableReference &var)
 623 {
 624         if(assignment)
 625                 assignment_target = var.declaration;
 626         else
 627         {
 628                 unused_nodes.erase(var.declaration);
 629                 map<VariableDeclaration *, Node *>::iterator i = assignments.find(var.declaration);
 630                 if(i!=assignments.end())
 631                         unused_nodes.erase(i->second);
 632         }
 633 }
 634
 635 void ProgramCompiler::UnusedVariableLocator::visit(MemberAccess &memacc)
 636 {
 637         TraversingVisitor::visit(memacc);
 638         unused_nodes.erase(memacc.declaration);
 639 }
 640
 641 void ProgramCompiler::UnusedVariableLocator::visit(BinaryExpression &binary)
 642 {
 643         if(binary.assignment)
 644         {
 645                 binary.right->visit(*this);
 646                 assignment = true;
 647                 binary.left->visit(*this);
 648         }
 649         else
 650                 TraversingVisitor::visit(binary);
 651 }
 652
 653 void ProgramCompiler::UnusedVariableLocator::visit(ExpressionStatement &expr)
 654 {
 655         assignment = false;
 656         assignment_target = 0;
 657         TraversingVisitor::visit(expr);
 658         if(assignment && assignment_target)
 659         {
 660                 if(assignment_target->interface!="out" || (context->type!=FRAGMENT && !assignment_target->linked_declaration))
 661                 {
 662                         unused_nodes.insert(&expr);
 663                         assignments[assignment_target] = &expr;
 664                 }
 665                 else
 666                         unused_nodes.erase(assignment_target);
 667         }
 668         assignment = false;
 669 }
 670
 671 void ProgramCompiler::UnusedVariableLocator::visit(VariableDeclaration &var)
 672 {
 673         unused_nodes.insert(&var);
 674         TraversingVisitor::visit(var);
 675 }
 676
 677
 678 ProgramCompiler::NodeRemover::NodeRemover():
 679         context(0),
 680         n_removed(0),
 681         immutable_block(false),
 682         remove_block(false)
 683 { }
 684
 685 void ProgramCompiler::NodeRemover::visit(Context &ctx)
 686 {
 687         context = &ctx;
 688         ctx.content.visit(*this);
 689 }
 690
 691 void ProgramCompiler::NodeRemover::visit(Block &block)
 692 {
 693         remove_block = immutable_block;
 694         for(list<NodePtr<Node> >::iterator i=block.body.begin(); i!=block.body.end(); )
 695         {
 696                 bool remove = to_remove.count(&**i);
 697                 if(!remove)
 698                         remove_block = false;
 699                 (*i)->visit(*this);
 700
 701                 if(remove ? !immutable_block : remove_block)
 702                 {
 703                         block.body.erase(i++);
 704                         ++n_removed;
 705                 }
 706                 else
 707                         ++i;
 708         }
 709 }
 710
 711 void ProgramCompiler::NodeRemover::visit(StructDeclaration &strct)
 712 {
 713         SetFlag set(immutable_block);
 714         TraversingVisitor::visit(strct);
 715 }
 716
 717 void ProgramCompiler::NodeRemover::visit(VariableDeclaration &var)
 718 {
 719         if(to_remove.count(&var))
 720         {
 721                 context->in_variables.erase(var.name);
 722                 context->out_variables.erase(var.name);
 723                 if(var.linked_declaration)
 724                         var.linked_declaration->linked_declaration = 0;
 725         }
 726 }
 727
 728 void ProgramCompiler::NodeRemover::visit(InterfaceBlock &iface)
 729 {
 730         SetFlag set(immutable_block);
 731         TraversingVisitor::visit(iface);
 732 }
 733
 734 } // namespace GL
 735 } // namespace Msp