source/glsl/debug.cpp

   1 #include <msp/stringcodec/utf8.h>
   2 #include <msp/strings/format.h>
   3 #include "debug.h"
   4
   5 using namespace std;
   6
   7 namespace Msp {
   8 namespace GL {
   9 namespace SL {
  10
  11 const std::string &DumpTree::apply(Stage &stage)
  12 {
  13         formatted = format("Stage: %s\n", Stage::get_stage_name(stage.type));
  14         tree.push_back(BRANCH);
  15         append(format("Version: %d.%02d", stage.required_features.glsl_version.major, stage.required_features.glsl_version.minor));
  16
  17         for(std::map<string, TypeDeclaration *>::const_iterator i=stage.types.begin(); i!=stage.types.end(); ++i)
  18                 append(format("Type: %%%d %s", get_label(*i->second), i->first));
  19
  20         set<InterfaceBlock *> seen_interfaces;
  21         for(std::map<string, InterfaceBlock *>::const_iterator i=stage.interface_blocks.begin(); i!=stage.interface_blocks.end(); ++i)
  22                 if(seen_interfaces.insert(i->second).second)
  23                 {
  24                         string text = format("Interface block: %%%d %s %s", get_label(*i->second), i->second->interface, i->second->block_name);
  25                         if(!i->second->instance_name.empty())
  26                                 text += format(" %s", i->second->instance_name);
  27                         append(text);
  28                 }
  29
  30         for(std::map<string, FunctionDeclaration *>::const_iterator i=stage.functions.begin(); i!=stage.functions.end(); ++i)
  31                 append(format("Function: %%%d %s", get_label(*i->second), i->first));
  32
  33         last_branch();
  34         stage.content.visit(*this);
  35         return formatted;
  36 }
  37
  38 void DumpTree::append(const string &line)
  39 {
  40         StringCodec::Utf8::Encoder enc;
  41         for(vector<TreeChars>::const_iterator i=tree.begin(); i!=tree.end(); )
  42         {
  43                 enc.encode_char(*i++, formatted);
  44                 enc.encode_char((i==tree.end() ? REACH : EMPTY), formatted);
  45         }
  46         formatted += line;
  47         formatted += '\n';
  48 }
  49
  50 void DumpTree::append_subtree(const vector<Branch> &branches)
  51 {
  52         begin_sub();
  53         for(vector<Branch>::const_iterator i=branches.begin(); i!=branches.end(); )
  54         {
  55                 vector<Branch>::const_iterator j = increment(i, branches);
  56                 if(!j->text.empty())
  57                 {
  58                         if(j->node)
  59                                 annotated_branch(j->text, *j->node);
  60                         else
  61                                 append(j->text);
  62                 }
  63                 else
  64                         j->node->visit(*this);
  65         }
  66         end_sub();
  67 }
  68
  69 void DumpTree::begin_sub()
  70 {
  71         tree.back() = (tree.back()==BRANCH_LAST ? EMPTY : STRAIGHT);
  72         tree.push_back(BRANCH);
  73 }
  74
  75 void DumpTree::last_branch()
  76 {
  77         tree.back() = BRANCH_LAST;
  78 }
  79
  80 void DumpTree::end_sub()
  81 {
  82         tree.pop_back();
  83         if(tree.back()==STRAIGHT)
  84                 tree.back() = BRANCH;
  85 }
  86
  87 void DumpTree::annotated_branch(const string &annotation, Node &node)
  88 {
  89         append(annotation);
  90         begin_sub();
  91         last_branch();
  92         node.visit(*this);
  93         end_sub();
  94 }
  95
  96 unsigned DumpTree::get_label(const Node &node)
  97 {
  98         unsigned &label = node_labels[&node];
  99         if(!label)
 100                 label = node_labels.size();
 101         return label;
 102 }
 103
 104 string DumpTree::format_type(TypeDeclaration *type)
 105 {
 106         return (type ? type->name : "?");
 107 }
 108
 109 template<typename T>
 110 typename T::const_iterator DumpTree::increment(typename T::const_iterator &iter, const T &container)
 111 {
 112         typename T::const_iterator ret = iter++;
 113         if(iter==container.end())
 114                 last_branch();
 115         return ret;
 116 }
 117
 118 void DumpTree::visit(Block &block)
 119 {
 120         append(format("Block %s", (block.use_braces ? "{}" : "(inline)")));
 121         begin_sub();
 122
 123         for(std::map<string, VariableDeclaration *>::const_iterator i=block.variables.begin(); i!=block.variables.end(); ++i)
 124                 append(format("Variable: %%%d %s %s", get_label(*i->second), i->second->type, i->first));
 125
 126         bool labeled_body = !block.variables.empty();
 127         if(labeled_body)
 128         {
 129                 last_branch();
 130                 append("Body");
 131                 begin_sub();
 132         }
 133         for(NodeList<Statement>::const_iterator i=block.body.begin(); i!=block.body.end(); )
 134         {
 135                 NodeList<Statement>::const_iterator j = increment(i, block.body);
 136                 (*j)->visit(*this);
 137         }
 138         if(labeled_body)
 139                 end_sub();
 140
 141         end_sub();
 142 }
 143
 144 void DumpTree::visit(Literal &literal)
 145 {
 146         append(format("Literal: %s -> %s", literal.token, format_type(literal.type)));
 147 }
 148
 149 void DumpTree::visit(VariableReference &var)
 150 {
 151         string text;
 152         if(var.declaration)
 153                 text += format("%%%d ", get_label(*var.declaration));
 154         text += format("%s (var) -> %s", var.name, format_type(var.type));
 155         append(text);
 156 }
 157
 158 void DumpTree::visit(InterfaceBlockReference &iface)
 159 {
 160         string text;
 161         if(iface.declaration)
 162                 text += format("%%%d ", get_label(*iface.declaration));
 163         text += format("%s (iface) -> %s", iface.name, format_type(iface.type));
 164         append(text);
 165 }
 166
 167 void DumpTree::visit(MemberAccess &memacc)
 168 {
 169         string text = "Member access:";
 170         if(memacc.declaration)
 171                 text += format(" %%%d", get_label(*memacc.declaration));
 172         text += format(" .%s -> %s", memacc.member, format_type(memacc.type));
 173         annotated_branch(text, *memacc.left);
 174 }
 175
 176 void DumpTree::visit(Swizzle &swizzle)
 177 {
 178         static const char components[4] = { 'x', 'y', 'z', 'w' };
 179         string text = "Swizzle: .";
 180         for(unsigned i=0; i<swizzle.count; ++i)
 181                 text += components[swizzle.components[i]];
 182         text += format(" -> %s", format_type(swizzle.type));
 183         annotated_branch(text, *swizzle.left);
 184 }
 185
 186 void DumpTree::visit(UnaryExpression &unary)
 187 {
 188         string text = format("Unary: %s, %sfix -> %s", unary.oper->token, (unary.oper->type==Operator::PREFIX ? "pre" : "post"), format_type(unary.type));
 189         annotated_branch(text, *unary.expression);
 190 }
 191
 192 void DumpTree::visit(BinaryExpression &binary)
 193 {
 194         append(format("Binary: %s%s -> %s", binary.oper->token, binary.oper->token2, format_type(binary.type)));
 195         begin_sub();
 196         binary.left->visit(*this);
 197         last_branch();
 198         binary.right->visit(*this);
 199         end_sub();
 200 }
 201
 202 void DumpTree::visit(Assignment &assign)
 203 {
 204         append(format("Assignment: %s%s -> %s", assign.oper->token, (assign.self_referencing ? " (self-referencing)" : ""), format_type(assign.type)));
 205         begin_sub();
 206         if(assign.target.declaration)
 207         {
 208                 string text = format("Target: %%%d", get_label(*assign.target.declaration));
 209
 210                 static const char swizzle[4] = { 'x', 'y', 'z', 'w' };
 211                 for(unsigned i=0; i<assign.target.chain_len; ++i)
 212                 {
 213                         unsigned component = assign.target.chain[i];
 214                         switch(static_cast<Assignment::Target::ChainType>(component&0xC0))
 215                         {
 216                         case Assignment::Target::MEMBER:
 217                                 text += format(" .%d", component&0x3F);
 218                                 break;
 219                         case Assignment::Target::SWIZZLE:
 220                                 text += " .";
 221                                 for(unsigned j=0; j<4; ++j)
 222                                         if(component&(1<<j))
 223                                                 text += swizzle[j];
 224                                 break;
 225                         case Assignment::Target::ARRAY:
 226                                 text += format(" [%d]", component&0x3F);
 227                                 break;
 228                         }
 229                 }
 230                 append(text);
 231         }
 232         assign.left->visit(*this);
 233         last_branch();
 234         assign.right->visit(*this);
 235         end_sub();
 236 }
 237
 238 void DumpTree::visit(TernaryExpression &ternary)
 239 {
 240         append(format("Ternary: %s%s -> %s", ternary.oper->token, ternary.oper->token2, format_type(ternary.type)));
 241         begin_sub();
 242         ternary.condition->visit(*this);
 243         ternary.true_expr->visit(*this);
 244         last_branch();
 245         ternary.false_expr->visit(*this);
 246         end_sub();
 247 }
 248
 249 void DumpTree::visit(FunctionCall &call)
 250 {
 251         string head = "Function call: ";
 252         if(call.declaration)
 253                 head += format("%%%d ", get_label(*call.declaration));
 254         head += call.name;
 255         if(call.constructor)
 256                 head += " (constructor)";
 257         head += format(" -> %s", format_type(call.type));
 258         append(head);
 259
 260         begin_sub();
 261         for(NodeArray<Expression>::const_iterator i=call.arguments.begin(); i!=call.arguments.end(); )
 262         {
 263                 NodeArray<Expression>::const_iterator j = increment(i, call.arguments);
 264                 (*j)->visit(*this);
 265         }
 266         end_sub();
 267 }
 268
 269 void DumpTree::visit(ExpressionStatement &expr)
 270 {
 271         annotated_branch("expr;", *expr.expression);
 272 }
 273
 274 void DumpTree::visit(Import &import)
 275 {
 276         append(format("import %s", import.module));
 277 }
 278
 279 void DumpTree::visit(Precision &prec)
 280 {
 281         append(format("precision %s %s", prec.precision, prec.type));
 282 }
 283
 284 void DumpTree::visit(Layout &layout)
 285 {
 286         append("Layout");
 287         begin_sub();
 288         for(vector<Layout::Qualifier>::const_iterator i=layout.qualifiers.begin(); i!=layout.qualifiers.end(); )
 289         {
 290                 vector<Layout::Qualifier>::const_iterator j = increment(i, layout.qualifiers);
 291                 string qualifier = j->name;
 292                 if(j->has_value)
 293                         qualifier += format("=%d", j->value);
 294                 append(qualifier);
 295         }
 296         end_sub();
 297 }
 298
 299 void DumpTree::visit(InterfaceLayout &layout)
 300 {
 301         annotated_branch(format("Layout: %s", layout.interface), layout.layout);
 302 }
 303
 304 void DumpTree::visit(BasicTypeDeclaration &type)
 305 {
 306         append(format("%%%d typedef %s", get_label(type), type.name));
 307
 308         vector<Branch> branches;
 309         if(type.base_type)
 310                 branches.push_back(format("%s: %%%d %s", (type.kind==BasicTypeDeclaration::ALIAS ? "Alias of" : "Base"), get_label(*type.base_type), type.base_type->name));
 311         if(type.kind==BasicTypeDeclaration::VECTOR)
 312                 branches.push_back(format("Vector: %d", type.size));
 313         else if(type.kind==BasicTypeDeclaration::MATRIX)
 314                 branches.push_back(format("Matrix: %dx%d", type.size&0xFFFF, type.size>>16));
 315         append_subtree(branches);
 316 }
 317
 318 void DumpTree::visit(ImageTypeDeclaration &type)
 319 {
 320         static const char *dims[] = { "1D", "2D", "3D", "Cube" };
 321
 322         append(format("%%%d typedef %s", get_label(type), type.name));
 323
 324         vector<Branch> branches;
 325         branches.push_back(format("Dimensions: %s%s", dims[type.dimensions-1], (type.array ? " array" : "")));
 326         if(type.base_type)
 327                 branches.push_back(format("Element type: %%%d %s", get_label(*type.base_type), type.base_type->name));
 328         if(type.shadow)
 329                 branches.push_back("Shadow");
 330         append_subtree(branches);
 331 }
 332
 333 void DumpTree::visit(StructDeclaration &strct)
 334 {
 335         annotated_branch(format("%%%d struct %s", get_label(strct), strct.name), strct.members);
 336 }
 337
 338 void DumpTree::visit(VariableDeclaration &var)
 339 {
 340         string decl = format("%%%d ", get_label(var));
 341         if(var.constant)
 342                 decl += "const ";
 343         if(!var.interpolation.empty())
 344                 decl += format("%s ", var.interpolation);
 345         if(!var.sampling.empty())
 346                 decl += format("%s ", var.sampling);
 347         if(!var.interface.empty())
 348                 decl += format("%s ", var.interface);
 349         if(!var.precision.empty())
 350                 decl += format("%s ", var.precision);
 351         decl += format("%s %s", var.type, var.name);
 352         if(var.source==BUILTIN_SOURCE)
 353                 decl += " (builtin)";
 354         else if(var.linked_declaration)
 355                 decl += " (linked)";
 356         append(decl);
 357
 358         vector<Branch> branches;
 359         if(var.type_declaration)
 360                 branches.push_back(format("Type: %%%d %s", get_label(*var.type_declaration), var.type_declaration->name));
 361         if(var.layout)
 362                 branches.push_back(var.layout.get());
 363         if(var.array)
 364         {
 365                 if(var.array_size)
 366                         branches.push_back(Branch("Array []", var.array_size.get()));
 367                 else
 368                         branches.push_back("Array []");
 369         }
 370         if(var.init_expression)
 371                 branches.push_back(var.init_expression.get());
 372         append_subtree(branches);
 373 }
 374
 375 void DumpTree::visit(InterfaceBlock &iface)
 376 {
 377         string head;
 378         if(!iface.instance_name.empty())
 379                 head += format("%%%d ", get_label(iface));
 380         head += format("%s %s", iface.interface, iface.block_name);
 381         if(!iface.instance_name.empty())
 382                 head += format(" %s", iface.instance_name);
 383         if(iface.array)
 384                 head += "[]";
 385         if(iface.source==BUILTIN_SOURCE)
 386                 head += " (builtin)";
 387         else if(iface.linked_block)
 388                 head += " (linked)";
 389         append(head);
 390
 391         begin_sub();
 392         last_branch();
 393         if(iface.type_declaration)
 394                 append(format("Type: %%%d %s", get_label(*iface.type_declaration), iface.type_declaration->name));
 395         else if(iface.members)
 396                 iface.members->visit(*this);
 397         end_sub();
 398 }
 399
 400 void DumpTree::visit(FunctionDeclaration &func)
 401 {
 402         string text = format("%%%d %s %s%s", get_label(func), func.return_type, func.name, (func.signature.empty() ? "(?)" : func.signature));
 403         if(func.source==BUILTIN_SOURCE)
 404                 text += " (builtin)";
 405         else if(!func.definition)
 406                 text += " (undefined)";
 407         append(text);
 408
 409         begin_sub();
 410         if(func.return_type_declaration)
 411                 append(format("Return type: %%%d %s", get_label(*func.return_type_declaration), func.return_type_declaration->name));
 412         for(NodeArray<VariableDeclaration>::const_iterator i=func.parameters.begin(); i!=func.parameters.end(); ++i)
 413                 (*i)->visit(*this);
 414         last_branch();
 415         if(func.definition==&func)
 416                 func.body.visit(*this);
 417         else if(func.definition)
 418                 append(format("Definition: %%%d", get_label(*func.definition)));
 419         end_sub();
 420 }
 421
 422 void DumpTree::visit(Conditional &cond)
 423 {
 424         append("if()");
 425
 426         vector<Branch> branches;
 427         branches.push_back(cond.condition.get());
 428         branches.push_back(&cond.body);
 429         if(!cond.else_body.body.empty())
 430                 branches.push_back(&cond.else_body);
 431         append_subtree(branches);
 432 }
 433
 434 void DumpTree::visit(Iteration &iter)
 435 {
 436         append("for()");
 437
 438         begin_sub();
 439         if(iter.init_statement)
 440                 annotated_branch("Initialization", *iter.init_statement);
 441         if(iter.condition)
 442                 annotated_branch("Condition", *iter.condition);
 443         if(iter.loop_expression)
 444                 annotated_branch("Loop", *iter.loop_expression);
 445         last_branch();
 446         annotated_branch("Body", iter.body);
 447         end_sub();
 448 }
 449
 450 void DumpTree::visit(Passthrough &pass)
 451 {
 452         if(pass.subscript)
 453                 annotated_branch("passthrough[]", *pass.subscript);
 454         else
 455                 append("passthrough;");
 456 }
 457
 458 void DumpTree::visit(Return &ret)
 459 {
 460         if(ret.expression)
 461                 annotated_branch("return", *ret.expression);
 462         else
 463                 append("return;");
 464 }
 465
 466 void DumpTree::visit(Jump &jump)
 467 {
 468         append(format("%s;", jump.keyword));
 469 }
 470
 471 } // namespace SL
 472 } // namespace GL
 473 } // namespace Msp