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->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(ParenthesizedExpression &parexpr)
 150 {
 151         annotated_branch(format("(expr) -> %s", format_type(parexpr.type)), *parexpr.expression);
 152 }
 153
 154 void DumpTree::visit(VariableReference &var)
 155 {
 156         string text;
 157         if(var.declaration)
 158                 text += format("%%%d ", get_label(*var.declaration));
 159         text += format("%s (var) -> %s", var.name, format_type(var.type));
 160         append(text);
 161 }
 162
 163 void DumpTree::visit(InterfaceBlockReference &iface)
 164 {
 165         string text;
 166         if(iface.declaration)
 167                 text += format("%%%d ", get_label(*iface.declaration));
 168         text += format("%s (iface) -> %s", iface.name, format_type(iface.type));
 169         append(text);
 170 }
 171
 172 void DumpTree::visit(MemberAccess &memacc)
 173 {
 174         string text = "Member access:";
 175         if(memacc.declaration)
 176                 text += format(" %%%d", get_label(*memacc.declaration));
 177         text += format(" .%s -> %s", memacc.member, format_type(memacc.type));
 178         annotated_branch(text, *memacc.left);
 179 }
 180
 181 void DumpTree::visit(Swizzle &swizzle)
 182 {
 183         static const char components[4] = { 'x', 'y', 'z', 'w' };
 184         string text = "Swizzle: .";
 185         for(unsigned i=0; i<swizzle.count; ++i)
 186                 text += components[swizzle.components[i]];
 187         text += format(" -> %s", format_type(swizzle.type));
 188         annotated_branch(text, *swizzle.left);
 189 }
 190
 191 void DumpTree::visit(UnaryExpression &unary)
 192 {
 193         string text = format("Unary: %s, %sfix -> %s", unary.oper->token, (unary.oper->type==Operator::PREFIX ? "pre" : "post"), format_type(unary.type));
 194         annotated_branch(text, *unary.expression);
 195 }
 196
 197 void DumpTree::visit(BinaryExpression &binary)
 198 {
 199         append(format("Binary: %s -> %s", (binary.oper->token[0]=='[' ? "[]" : binary.oper->token), format_type(binary.type)));
 200         begin_sub();
 201         binary.left->visit(*this);
 202         last_branch();
 203         binary.right->visit(*this);
 204         end_sub();
 205 }
 206
 207 void DumpTree::visit(Assignment &assign)
 208 {
 209         append(format("Assignment: %s%s -> %s", assign.oper->token, (assign.self_referencing ? " (self-referencing)" : ""), format_type(assign.type)));
 210         begin_sub();
 211         if(assign.target.declaration)
 212         {
 213                 string text = format("Target: %%%d", get_label(*assign.target.declaration));
 214
 215                 static const char swizzle[4] = { 'x', 'y', 'z', 'w' };
 216                 for(unsigned i=0; i<assign.target.chain_len; ++i)
 217                 {
 218                         unsigned component = assign.target.chain[i];
 219                         switch(static_cast<Assignment::Target::ChainType>(component&0xC0))
 220                         {
 221                         case Assignment::Target::MEMBER:
 222                                 text += format(" .%d", component&0x3F);
 223                                 break;
 224                         case Assignment::Target::SWIZZLE:
 225                                 text += " .";
 226                                 for(unsigned j=0; j<4; ++j)
 227                                         if(component&(1<<j))
 228                                                 text += swizzle[j];
 229                                 break;
 230                         case Assignment::Target::ARRAY:
 231                                 text += format(" [%d]", component&0x3F);
 232                                 break;
 233                         }
 234                 }
 235                 append(text);
 236         }
 237         assign.left->visit(*this);
 238         last_branch();
 239         assign.right->visit(*this);
 240         end_sub();
 241 }
 242
 243 void DumpTree::visit(FunctionCall &call)
 244 {
 245         string head = "Function call: ";
 246         if(call.declaration)
 247                 head += format("%%%d ", get_label(*call.declaration));
 248         head += call.name;
 249         if(call.constructor)
 250                 head += " (constructor)";
 251         head += format(" -> %s", format_type(call.type));
 252         append(head);
 253
 254         begin_sub();
 255         for(NodeArray<Expression>::const_iterator i=call.arguments.begin(); i!=call.arguments.end(); )
 256         {
 257                 NodeArray<Expression>::const_iterator j = increment(i, call.arguments);
 258                 (*j)->visit(*this);
 259         }
 260         end_sub();
 261 }
 262
 263 void DumpTree::visit(ExpressionStatement &expr)
 264 {
 265         annotated_branch("expr;", *expr.expression);
 266 }
 267
 268 void DumpTree::visit(Import &import)
 269 {
 270         append(format("import %s", import.module));
 271 }
 272
 273 void DumpTree::visit(Precision &prec)
 274 {
 275         append(format("precision %s %s", prec.precision, prec.type));
 276 }
 277
 278 void DumpTree::visit(Layout &layout)
 279 {
 280         append("Layout");
 281         begin_sub();
 282         for(vector<Layout::Qualifier>::const_iterator i=layout.qualifiers.begin(); i!=layout.qualifiers.end(); )
 283         {
 284                 vector<Layout::Qualifier>::const_iterator j = increment(i, layout.qualifiers);
 285                 string qualifier = j->name;
 286                 if(j->has_value)
 287                         qualifier += format("=%d", j->value);
 288                 append(qualifier);
 289         }
 290         end_sub();
 291 }
 292
 293 void DumpTree::visit(InterfaceLayout &layout)
 294 {
 295         annotated_branch(format("Layout: %s", layout.interface), layout.layout);
 296 }
 297
 298 void DumpTree::visit(BasicTypeDeclaration &type)
 299 {
 300         append(format("%%%d typedef %s", get_label(type), type.name));
 301
 302         vector<Branch> branches;
 303         if(type.base_type)
 304                 branches.push_back(format("%s: %%%d %s", (type.kind==BasicTypeDeclaration::ALIAS ? "Alias of" : "Base"), get_label(*type.base_type), type.base_type->name));
 305         if(type.kind==BasicTypeDeclaration::VECTOR)
 306                 branches.push_back(format("Vector: %d", type.size));
 307         else if(type.kind==BasicTypeDeclaration::MATRIX)
 308                 branches.push_back(format("Matrix: %dx%d", type.size&0xFFFF, type.size>>16));
 309         append_subtree(branches);
 310 }
 311
 312 void DumpTree::visit(ImageTypeDeclaration &type)
 313 {
 314         static const char *dims[] = { "1D", "2D", "3D", "Cube" };
 315
 316         append(format("%%%d typedef %s", get_label(type), type.name));
 317
 318         vector<Branch> branches;
 319         branches.push_back(format("Dimensions: %s%s", dims[type.dimensions-1], (type.array ? " array" : "")));
 320         if(type.base_type)
 321                 branches.push_back(format("Element type: %%%d %s", get_label(*type.base_type), type.base_type->name));
 322         if(type.shadow)
 323                 branches.push_back("Shadow");
 324         append_subtree(branches);
 325 }
 326
 327 void DumpTree::visit(StructDeclaration &strct)
 328 {
 329         annotated_branch(format("%%%d struct %s", get_label(strct), strct.name), strct.members);
 330 }
 331
 332 void DumpTree::visit(VariableDeclaration &var)
 333 {
 334         string decl = format("%%%d ", get_label(var));
 335         if(var.constant)
 336                 decl += "const ";
 337         if(!var.interpolation.empty())
 338                 decl += format("%s ", var.interpolation);
 339         if(!var.sampling.empty())
 340                 decl += format("%s ", var.sampling);
 341         if(!var.interface.empty())
 342                 decl += format("%s ", var.interface);
 343         if(!var.precision.empty())
 344                 decl += format("%s ", var.precision);
 345         decl += format("%s %s", var.type, var.name);
 346         if(var.source==BUILTIN_SOURCE)
 347                 decl += " (builtin)";
 348         else if(var.linked_declaration)
 349                 decl += " (linked)";
 350         append(decl);
 351
 352         vector<Branch> branches;
 353         if(var.type_declaration)
 354                 branches.push_back(format("Type: %%%d %s", get_label(*var.type_declaration), var.type_declaration->name));
 355         if(var.layout)
 356                 branches.push_back(var.layout.get());
 357         if(var.array)
 358         {
 359                 if(var.array_size)
 360                         branches.push_back(Branch("Array []", var.array_size.get()));
 361                 else
 362                         branches.push_back("Array []");
 363         }
 364         if(var.init_expression)
 365                 branches.push_back(var.init_expression.get());
 366         append_subtree(branches);
 367 }
 368
 369 void DumpTree::visit(InterfaceBlock &block)
 370 {
 371         string head;
 372         if(!block.instance_name.empty())
 373                 head += format("%%%d ", get_label(block));
 374         head += format("%s %s", block.interface, block.name);
 375         if(!block.instance_name.empty())
 376                 head += format(" %s", block.instance_name);
 377         if(block.array)
 378                 head += "[]";
 379         if(block.source==BUILTIN_SOURCE)
 380                 head += " (builtin)";
 381         else if(block.linked_block)
 382                 head += " (linked)";
 383         append(head);
 384
 385         begin_sub();
 386         last_branch();
 387         if(block.type_declaration)
 388                 append(format("Type: %%%d %s", get_label(*block.type_declaration), block.type_declaration->name));
 389         else if(block.members)
 390                 block.members->visit(*this);
 391         end_sub();
 392 }
 393
 394 void DumpTree::visit(FunctionDeclaration &func)
 395 {
 396         string text = format("%%%d %s %s", get_label(func), func.return_type, func.name);
 397         if(func.source==BUILTIN_SOURCE)
 398                 text += " (builtin)";
 399         else if(!func.definition)
 400                 text += " (undefined)";
 401         append(text);
 402
 403         begin_sub();
 404         for(NodeArray<VariableDeclaration>::const_iterator i=func.parameters.begin(); i!=func.parameters.end(); ++i)
 405                 (*i)->visit(*this);
 406         last_branch();
 407         if(func.definition==&func)
 408                 func.body.visit(*this);
 409         else if(func.definition)
 410                 append(format("Definition: %%%d", get_label(*func.definition)));
 411         end_sub();
 412 }
 413
 414 void DumpTree::visit(Conditional &cond)
 415 {
 416         append("if()");
 417
 418         vector<Branch> branches;
 419         branches.push_back(cond.condition.get());
 420         branches.push_back(&cond.body);
 421         if(!cond.else_body.body.empty())
 422                 branches.push_back(&cond.else_body);
 423         append_subtree(branches);
 424 }
 425
 426 void DumpTree::visit(Iteration &iter)
 427 {
 428         append("for()");
 429
 430         begin_sub();
 431         if(iter.init_statement)
 432                 annotated_branch("Initialization", *iter.init_statement);
 433         if(iter.condition)
 434                 annotated_branch("Condition", *iter.condition);
 435         if(iter.loop_expression)
 436                 annotated_branch("Loop", *iter.loop_expression);
 437         last_branch();
 438         annotated_branch("Body", iter.body);
 439         end_sub();
 440 }
 441
 442 void DumpTree::visit(Passthrough &pass)
 443 {
 444         if(pass.subscript)
 445                 annotated_branch("passthrough[]", *pass.subscript);
 446         else
 447                 append("passthrough;");
 448 }
 449
 450 void DumpTree::visit(Return &ret)
 451 {
 452         if(ret.expression)
 453                 annotated_branch("return", *ret.expression);
 454         else
 455                 append("return;");
 456 }
 457
 458 void DumpTree::visit(Jump &jump)
 459 {
 460         append(format("%s;", jump.keyword));
 461 }
 462
 463 } // namespace SL
 464 } // namespace GL
 465 } // namespace Msp