]> git.tdb.fi Git - libs/gl.git/blobdiff - source/glsl/debug.cpp
Check the flat qualifier from the correct member
[libs/gl.git] / source / glsl / debug.cpp
index ef9e3e0eafc325a92f3bf389329c3efb3563b738..a090c3622079bd9bfeedf2fc517a276d7877d463 100644 (file)
@@ -8,27 +8,38 @@ namespace Msp {
 namespace GL {
 namespace SL {
 
-const std::string &DumpTree::apply(Stage &stage)
+const DumpTree::Colors DumpTree::no_colors =
+{ "", "", "", "", "", "", "" };
+
+const DumpTree::Colors DumpTree::default_colors =
+{
+       "\033[0m",         // default
+       "\033[38;5;250m",  // tree
+       "\033[38;5;244m",  // location
+       "\033[38;5;146m",  // label
+       "\033[38;5;194m",  // type
+       "\033[38;5;230m",  // name
+       "\033[38;5;210m"   // error
+};
+
+DumpTree::DumpTree(bool use_colors):
+       colors(use_colors ? default_colors : no_colors)
+{ }
+
+string DumpTree::apply(Stage &stage)
 {
        formatted = format("Stage: %s\n", Stage::get_stage_name(stage.type));
-       tree.push_back(BRANCH);
+       begin_sub();
        append(format("Version: %d.%02d", stage.required_features.glsl_version.major, stage.required_features.glsl_version.minor));
 
-       for(std::map<string, TypeDeclaration *>::const_iterator i=stage.types.begin(); i!=stage.types.end(); ++i)
-               append(format("Type: %%%d %s", get_label(*i->second), i->first));
+       for(const auto &kvp: stage.types)
+               append(format("Type: %s %s%s%s", get_label(*kvp.second), colors.type_color, kvp.first, colors.default_color));
 
-       set<InterfaceBlock *> seen_interfaces;
-       for(std::map<string, InterfaceBlock *>::const_iterator i=stage.interface_blocks.begin(); i!=stage.interface_blocks.end(); ++i)
-               if(seen_interfaces.insert(i->second).second)
-               {
-                       string text = format("Interface block: %%%d %s %s", get_label(*i->second), i->second->interface, i->second->name);
-                       if(!i->second->instance_name.empty())
-                               text += format(" %s", i->second->instance_name);
-                       append(text);
-               }
+       for(const auto &kvp: stage.interface_blocks)
+               append(format("Interface block: %s %s", get_label(*kvp.second), format_name(kvp.first)));
 
-       for(std::map<string, FunctionDeclaration *>::const_iterator i=stage.functions.begin(); i!=stage.functions.end(); ++i)
-               append(format("Function: %%%d %s", get_label(*i->second), i->first));
+       for(const auto &kvp: stage.functions)
+               append(format("Function: %s %s", get_label(*kvp.second), format_name(kvp.first)));
 
        last_branch();
        stage.content.visit(*this);
@@ -37,28 +48,48 @@ const std::string &DumpTree::apply(Stage &stage)
 
 void DumpTree::append(const string &line)
 {
+       formatted += colors.tree_color;
        StringCodec::Utf8::Encoder enc;
-       for(vector<TreeChars>::const_iterator i=tree.begin(); i!=tree.end(); )
+       for(auto i=tree.begin(); i!=tree.end(); )
        {
                enc.encode_char(*i++, formatted);
                enc.encode_char((i==tree.end() ? REACH : EMPTY), formatted);
        }
+       formatted += colors.default_color;
        formatted += line;
        formatted += '\n';
 }
 
+void DumpTree::append(const Node &node, const string &line)
+{
+       string location;
+       if(node.source==BUILTIN_SOURCE)
+               location = "builtin";
+       else if(node.source==INTERNAL_SOURCE)
+               location = "internal";
+       else if(node.source==GENERATED_SOURCE)
+               location = "generated";
+       else
+               location = format("%s:%s", node.source, node.line);
+       append(format("%s<%s>%s %s", colors.location_color, location, colors.default_color, line));
+}
+
 void DumpTree::append_subtree(const vector<Branch> &branches)
 {
        begin_sub();
-       for(vector<Branch>::const_iterator i=branches.begin(); i!=branches.end(); )
+       for(auto i=branches.begin(); i!=branches.end(); )
        {
-               vector<Branch>::const_iterator j = increment(i, branches);
+               auto j = increment(i, branches);
                if(!j->text.empty())
                {
+                       append(j->text);
                        if(j->node)
-                               annotated_branch(j->text, *j->node);
-                       else
-                               append(j->text);
+                       {
+                               begin_sub();
+                               last_branch();
+                               j->node->visit(*this);
+                               end_sub();
+                       }
                }
                else
                        j->node->visit(*this);
@@ -66,9 +97,18 @@ void DumpTree::append_subtree(const vector<Branch> &branches)
        end_sub();
 }
 
+void DumpTree::append_subtree(Node &node)
+{
+       begin_sub();
+       last_branch();
+       node.visit(*this);
+       end_sub();
+}
+
 void DumpTree::begin_sub()
 {
-       tree.back() = (tree.back()==BRANCH_LAST ? EMPTY : STRAIGHT);
+       if(!tree.empty())
+               tree.back() = (tree.back()==BRANCH_LAST ? EMPTY : STRAIGHT);
        tree.push_back(BRANCH);
 }
 
@@ -80,36 +120,37 @@ void DumpTree::last_branch()
 void DumpTree::end_sub()
 {
        tree.pop_back();
-       if(tree.back()==STRAIGHT)
+       if(!tree.empty() && tree.back()==STRAIGHT)
                tree.back() = BRANCH;
 }
 
-void DumpTree::annotated_branch(const string &annotation, Node &node)
-{
-       append(annotation);
-       begin_sub();
-       last_branch();
-       node.visit(*this);
-       end_sub();
-}
-
-unsigned DumpTree::get_label(const Node &node)
+std::string DumpTree::get_label(const Node &node)
 {
        unsigned &label = node_labels[&node];
        if(!label)
                label = node_labels.size();
-       return label;
+       return format("%s%%%d%s", colors.label_color, label, colors.default_color);
 }
 
 string DumpTree::format_type(TypeDeclaration *type)
 {
-       return (type ? type->name : "?");
+       return type ? format_type(type->name) : format("%s?%s", colors.error_color, colors.default_color);
+}
+
+string DumpTree::format_type(const string &type)
+{
+       return format("%s%s%s", colors.type_color, type, colors.default_color);
+}
+
+string DumpTree::format_name(const string &name)
+{
+       return format("%s%s%s", colors.name_color, name, colors.default_color);
 }
 
 template<typename T>
 typename T::const_iterator DumpTree::increment(typename T::const_iterator &iter, const T &container)
 {
-       typename T::const_iterator ret = iter++;
+       auto ret = iter++;
        if(iter==container.end())
                last_branch();
        return ret;
@@ -117,65 +158,43 @@ typename T::const_iterator DumpTree::increment(typename T::const_iterator &iter,
 
 void DumpTree::visit(Block &block)
 {
-       append(format("Block %s", (block.use_braces ? "{}" : "(inline)")));
+       append(block, format("Block %s", (block.use_braces ? "{}" : "(inline)")));
        begin_sub();
 
-       for(std::map<string, VariableDeclaration *>::const_iterator i=block.variables.begin(); i!=block.variables.end(); ++i)
-               append(format("Variable: %%%d %s %s", get_label(*i->second), i->second->type, i->first));
+       for(const auto &kvp: block.variables)
+               append(format("Variable: %s %s %s", get_label(*kvp.second), format_type(kvp.second->type), format_name(kvp.first)));
 
-       bool labeled_body = !block.variables.empty();
-       if(labeled_body)
+       for(auto i=block.body.cbegin(); i!=block.body.cend(); )
        {
-               last_branch();
-               append("Body");
-               begin_sub();
-       }
-       for(NodeList<Statement>::const_iterator i=block.body.begin(); i!=block.body.end(); )
-       {
-               NodeList<Statement>::const_iterator j = increment(i, block.body);
+               auto j = increment(i, block.body);
                (*j)->visit(*this);
        }
-       if(labeled_body)
-               end_sub();
 
        end_sub();
 }
 
 void DumpTree::visit(Literal &literal)
 {
-       append(format("Literal: %s -> %s", literal.token, format_type(literal.type)));
-}
-
-void DumpTree::visit(ParenthesizedExpression &parexpr)
-{
-       annotated_branch(format("(expr) -> %s", format_type(parexpr.type)), *parexpr.expression);
+       append(literal, format("Literal: %s -> %s", literal.token, format_type(literal.type)));
 }
 
 void DumpTree::visit(VariableReference &var)
 {
        string text;
        if(var.declaration)
-               text += format("%%%d ", get_label(*var.declaration));
-       text += format("%s (var) -> %s", var.name, format_type(var.type));
-       append(text);
-}
-
-void DumpTree::visit(InterfaceBlockReference &iface)
-{
-       string text;
-       if(iface.declaration)
-               text += format("%%%d ", get_label(*iface.declaration));
-       text += format("%s (iface) -> %s", iface.name, format_type(iface.type));
-       append(text);
+               text += format("%s ", get_label(*var.declaration));
+       text += format("%s -> %s", format_name(var.name), format_type(var.type));
+       append(var, text);
 }
 
 void DumpTree::visit(MemberAccess &memacc)
 {
        string text = "Member access:";
        if(memacc.declaration)
-               text += format(" %%%d", get_label(*memacc.declaration));
-       text += format(" .%s -> %s", memacc.member, format_type(memacc.type));
-       annotated_branch(text, *memacc.left);
+               text += format(" %s", get_label(*memacc.declaration));
+       text += format(" .%s (%d) -> %s", format_name(memacc.member), memacc.index, format_type(memacc.type));
+       append(memacc, text);
+       append_subtree(*memacc.left);
 }
 
 void DumpTree::visit(Swizzle &swizzle)
@@ -185,18 +204,20 @@ void DumpTree::visit(Swizzle &swizzle)
        for(unsigned i=0; i<swizzle.count; ++i)
                text += components[swizzle.components[i]];
        text += format(" -> %s", format_type(swizzle.type));
-       annotated_branch(text, *swizzle.left);
+       append(swizzle, text);
+       append_subtree(*swizzle.left);
 }
 
 void DumpTree::visit(UnaryExpression &unary)
 {
        string text = format("Unary: %s, %sfix -> %s", unary.oper->token, (unary.oper->type==Operator::PREFIX ? "pre" : "post"), format_type(unary.type));
-       annotated_branch(text, *unary.expression);
+       append(unary, text);
+       append_subtree(*unary.expression);
 }
 
 void DumpTree::visit(BinaryExpression &binary)
 {
-       append(format("Binary: %s -> %s", (binary.oper->token[0]=='[' ? "[]" : binary.oper->token), format_type(binary.type)));
+       append(binary, format("Binary: %s%s -> %s", binary.oper->token, binary.oper->token2, format_type(binary.type)));
        begin_sub();
        binary.left->visit(*this);
        last_branch();
@@ -206,11 +227,11 @@ void DumpTree::visit(BinaryExpression &binary)
 
 void DumpTree::visit(Assignment &assign)
 {
-       append(format("Assignment: %s%s -> %s", assign.oper->token, (assign.self_referencing ? " (self-referencing)" : ""), format_type(assign.type)));
+       append(assign, format("Assignment: %s%s -> %s", assign.oper->token, (assign.self_referencing ? " (self-referencing)" : ""), format_type(assign.type)));
        begin_sub();
        if(assign.target.declaration)
        {
-               string text = format("Target: %%%d", get_label(*assign.target.declaration));
+               string text = format("Target: %s", get_label(*assign.target.declaration));
 
                static const char swizzle[4] = { 'x', 'y', 'z', 'w' };
                for(unsigned i=0; i<assign.target.chain_len; ++i)
@@ -240,21 +261,32 @@ void DumpTree::visit(Assignment &assign)
        end_sub();
 }
 
+void DumpTree::visit(TernaryExpression &ternary)
+{
+       append(ternary, format("Ternary: %s%s -> %s", ternary.oper->token, ternary.oper->token2, format_type(ternary.type)));
+       begin_sub();
+       ternary.condition->visit(*this);
+       ternary.true_expr->visit(*this);
+       last_branch();
+       ternary.false_expr->visit(*this);
+       end_sub();
+}
+
 void DumpTree::visit(FunctionCall &call)
 {
        string head = "Function call: ";
        if(call.declaration)
-               head += format("%%%d ", get_label(*call.declaration));
-       head += call.name;
+               head += format("%s ", get_label(*call.declaration));
+       head += format_name(call.name);
        if(call.constructor)
                head += " (constructor)";
        head += format(" -> %s", format_type(call.type));
-       append(head);
+       append(call, head);
 
        begin_sub();
-       for(NodeArray<Expression>::const_iterator i=call.arguments.begin(); i!=call.arguments.end(); )
+       for(auto i=call.arguments.cbegin(); i!=call.arguments.cend(); )
        {
-               NodeArray<Expression>::const_iterator j = increment(i, call.arguments);
+               auto j = increment(i, call.arguments);
                (*j)->visit(*this);
        }
        end_sub();
@@ -262,26 +294,27 @@ void DumpTree::visit(FunctionCall &call)
 
 void DumpTree::visit(ExpressionStatement &expr)
 {
-       annotated_branch("expr;", *expr.expression);
+       append(expr, "expr;");
+       append_subtree(*expr.expression);
 }
 
 void DumpTree::visit(Import &import)
 {
-       append(format("import %s", import.module));
+       append(import, format("import %s", import.module));
 }
 
 void DumpTree::visit(Precision &prec)
 {
-       append(format("precision %s %s", prec.precision, prec.type));
+       append(prec, format("precision %s %s", prec.precision, prec.type));
 }
 
 void DumpTree::visit(Layout &layout)
 {
-       append("Layout");
+       append(layout, "Layout");
        begin_sub();
-       for(vector<Layout::Qualifier>::const_iterator i=layout.qualifiers.begin(); i!=layout.qualifiers.end(); )
+       for(auto i=layout.qualifiers.cbegin(); i!=layout.qualifiers.cend(); )
        {
-               vector<Layout::Qualifier>::const_iterator j = increment(i, layout.qualifiers);
+               auto j = increment(i, layout.qualifiers);
                string qualifier = j->name;
                if(j->has_value)
                        qualifier += format("=%d", j->value);
@@ -292,46 +325,62 @@ void DumpTree::visit(Layout &layout)
 
 void DumpTree::visit(InterfaceLayout &layout)
 {
-       annotated_branch(format("Layout: %s", layout.interface), layout.layout);
+       append(layout, format("Layout: %s", layout.interface));
+       append_subtree(layout.layout);
 }
 
 void DumpTree::visit(BasicTypeDeclaration &type)
 {
-       append(format("%%%d typedef %s", get_label(type), type.name));
+       append(type, format("%s typedef %s", get_label(type), format_type(type.name)));
 
        vector<Branch> branches;
        if(type.base_type)
-               branches.push_back(format("%s: %%%d %s", (type.kind==BasicTypeDeclaration::ALIAS ? "Alias of" : "Base"), get_label(*type.base_type), type.base_type->name));
+               branches.emplace_back(format("%s: %s %s", (type.kind==BasicTypeDeclaration::ALIAS ? "Alias of" : "Base"), get_label(*type.base_type), format_type(type.base_type->name)));
        if(type.kind==BasicTypeDeclaration::VECTOR)
-               branches.push_back(format("Vector: %d", type.size));
+               branches.emplace_back(format("Vector: %d", type.size));
        else if(type.kind==BasicTypeDeclaration::MATRIX)
-               branches.push_back(format("Matrix: %dx%d", type.size&0xFFFF, type.size>>16));
+               branches.emplace_back(format("Matrix: %dx%d", type.size&0xFFFF, type.size>>16));
+       if(type.extended_alignment)
+               branches.emplace_back("Extended alignment");
        append_subtree(branches);
 }
 
 void DumpTree::visit(ImageTypeDeclaration &type)
 {
-       static const char *dims[] = { "1D", "2D", "3D", "Cube" };
+       static const char *const dims[] = { "1D", "2D", "3D", "Cube" };
 
-       append(format("%%%d typedef %s", get_label(type), type.name));
+       append(type, format("%s typedef %s", get_label(type), format_type(type.name)));
 
        vector<Branch> branches;
-       branches.push_back(format("Dimensions: %s%s", dims[type.dimensions-1], (type.array ? " array" : "")));
+       branches.emplace_back(format("Dimensions: %s%s", dims[type.dimensions-1], (type.array ? " array" : "")));
        if(type.base_type)
-               branches.push_back(format("Element type: %%%d %s", get_label(*type.base_type), type.base_type->name));
+               branches.emplace_back(format("Element type: %s %s", get_label(*type.base_type), format_type(type.base_type->name)));
+       if(!type.format.empty())
+               branches.emplace_back(format("Texel format: %s", type.format));
+       if(type.sampled)
+               branches.emplace_back("Sampled");
        if(type.shadow)
-               branches.push_back("Shadow");
+               branches.emplace_back("Shadow");
+       if(type.multisample)
+               branches.emplace_back("Multisample");
        append_subtree(branches);
 }
 
 void DumpTree::visit(StructDeclaration &strct)
 {
-       annotated_branch(format("%%%d struct %s", get_label(strct), strct.name), strct.members);
+       append(strct, format("%s struct %s", get_label(strct), strct.name));
+       vector<Branch> branches;
+       if(!strct.block_name.empty())
+               branches.emplace_back(format("Interface block: %s", format_name(strct.block_name)));
+       if(strct.extended_alignment)
+               branches.emplace_back("Extended alignment");
+       branches.emplace_back(&strct.members);
+       append_subtree(branches);
 }
 
 void DumpTree::visit(VariableDeclaration &var)
 {
-       string decl = format("%%%d ", get_label(var));
+       string decl = format("%s ", get_label(var));
        if(var.constant)
                decl += "const ";
        if(!var.interpolation.empty())
@@ -342,122 +391,98 @@ void DumpTree::visit(VariableDeclaration &var)
                decl += format("%s ", var.interface);
        if(!var.precision.empty())
                decl += format("%s ", var.precision);
-       decl += format("%s %s", var.type, var.name);
+       decl += format("%s %s", format_type(var.type), format_name(var.name));
        if(var.source==BUILTIN_SOURCE)
                decl += " (builtin)";
        else if(var.linked_declaration)
                decl += " (linked)";
-       append(decl);
+       append(var, decl);
 
        vector<Branch> branches;
        if(var.type_declaration)
-               branches.push_back(format("Type: %%%d %s", get_label(*var.type_declaration), var.type_declaration->name));
+               branches.emplace_back(format("Type: %s %s", get_label(*var.type_declaration), format_type(var.type_declaration->name)));
+       if(var.block_declaration)
+               branches.emplace_back(format("Interface block: %s", format_name(var.block_declaration->block_name)));
        if(var.layout)
-               branches.push_back(var.layout.get());
+               branches.emplace_back(var.layout.get());
        if(var.array)
        {
                if(var.array_size)
-                       branches.push_back(Branch("Array []", var.array_size.get()));
+                       branches.emplace_back("Array []", var.array_size.get());
                else
-                       branches.push_back("Array []");
+                       branches.emplace_back("Array []");
        }
        if(var.init_expression)
-               branches.push_back(var.init_expression.get());
+               branches.emplace_back(var.init_expression.get());
        append_subtree(branches);
 }
 
-void DumpTree::visit(InterfaceBlock &block)
-{
-       string head;
-       if(!block.instance_name.empty())
-               head += format("%%%d ", get_label(block));
-       head += format("%s %s", block.interface, block.name);
-       if(!block.instance_name.empty())
-               head += format(" %s", block.instance_name);
-       if(block.array)
-               head += "[]";
-       if(block.source==BUILTIN_SOURCE)
-               head += " (builtin)";
-       else if(block.linked_block)
-               head += " (linked)";
-       append(head);
-
-       begin_sub();
-       last_branch();
-       if(block.type_declaration)
-               append(format("Type: %%%d %s", get_label(*block.type_declaration), block.type_declaration->name));
-       else if(block.members)
-               block.members->visit(*this);
-       end_sub();
-}
-
 void DumpTree::visit(FunctionDeclaration &func)
 {
-       string text = format("%%%d %s %s", get_label(func), func.return_type, func.name);
+       string text = format("%s %s %s%s", get_label(func), format_type(func.return_type), format_name(func.name), (func.signature.empty() ? "(?)" : func.signature));
        if(func.source==BUILTIN_SOURCE)
                text += " (builtin)";
        else if(!func.definition)
                text += " (undefined)";
-       append(text);
+       append(func, text);
 
        begin_sub();
-       for(NodeArray<VariableDeclaration>::const_iterator i=func.parameters.begin(); i!=func.parameters.end(); ++i)
-               (*i)->visit(*this);
+       if(func.return_type_declaration)
+               append(format("Return type: %s %s", get_label(*func.return_type_declaration), format_type(func.return_type_declaration)));
+       for(const RefPtr<VariableDeclaration> &p: func.parameters)
+               p->visit(*this);
        last_branch();
        if(func.definition==&func)
                func.body.visit(*this);
        else if(func.definition)
-               append(format("Definition: %%%d", get_label(*func.definition)));
+               append(format("Definition: %s", get_label(*func.definition)));
        end_sub();
 }
 
 void DumpTree::visit(Conditional &cond)
 {
-       append("if()");
+       append(cond, "if()");
 
        vector<Branch> branches;
-       branches.push_back(cond.condition.get());
-       branches.push_back(&cond.body);
+       branches.emplace_back(cond.condition.get());
+       branches.emplace_back("then", &cond.body);
        if(!cond.else_body.body.empty())
-               branches.push_back(&cond.else_body);
+               branches.emplace_back("else", &cond.else_body);
        append_subtree(branches);
 }
 
 void DumpTree::visit(Iteration &iter)
 {
-       append("for()");
+       append(iter, "for()");
 
-       begin_sub();
+       vector<Branch> branches;
        if(iter.init_statement)
-               annotated_branch("Initialization", *iter.init_statement);
+               branches.emplace_back("Initialization", iter.init_statement.get());
        if(iter.condition)
-               annotated_branch("Condition", *iter.condition);
+               branches.emplace_back("Condition", iter.condition.get());
        if(iter.loop_expression)
-               annotated_branch("Loop", *iter.loop_expression);
-       last_branch();
-       annotated_branch("Body", iter.body);
-       end_sub();
+               branches.emplace_back("Loop", iter.loop_expression.get());
+       branches.emplace_back(&iter.body);
+       append_subtree(branches);
 }
 
 void DumpTree::visit(Passthrough &pass)
 {
+       append(pass, (pass.subscript ? "passthrough[]" : "passthrough"));
        if(pass.subscript)
-               annotated_branch("passthrough[]", *pass.subscript);
-       else
-               append("passthrough;");
+               append_subtree(*pass.subscript);
 }
 
 void DumpTree::visit(Return &ret)
 {
+       append(ret, (ret.expression ? "return" : "return;"));
        if(ret.expression)
-               annotated_branch("return", *ret.expression);
-       else
-               append("return;");
+               append_subtree(*ret.expression);
 }
 
 void DumpTree::visit(Jump &jump)
 {
-       append(format("%s;", jump.keyword));
+       append(jump, format("%s;", jump.keyword));
 }
 
 } // namespace SL