Utility class for inspecting and debugging Protobuf MaterialXDocument messages. More...

#include <materialx_serializer.h>

Static Public Member Functions
static MaterialXDocument	fromString (const std::string &data)
	Parse binary data to create Protobuf document.

static std::string	toString (const MaterialXDocument &pb_doc)
	Serialize Protobuf document to binary string.

static std::string	toJson (const MaterialXDocument &pb_doc, int indent=2)
	Convert Protobuf document to JSON string.

static void	debugInspect (const MaterialXDocument &pb_doc, int max_depth=10)
	Print detailed document structure with attributes and children.

static void	debugInspectCompact (const MaterialXDocument &pb_doc, int max_depth=10)
	Print compact document structure.

static void	debugInspectSimple (const MaterialXDocument &pb_doc)
	Print simple tree structure of document.

static std::string	generateMermaidDiagram (const MaterialXDocument &pb_doc)
	Generate a Mermaid diagram from protobuf document hierarchy.

Static Private Member Functions
static void	printElement (const MaterialXElement &element, int depth, int max_depth)

static void	printElementCompact (const MaterialXElement &element, int depth, int max_depth)

static void	printTree (const MaterialXElement &element, const std::string &prefix, bool is_last)

static void	addMermaidElements (const MaterialXElement &element, std::vector< std::string > &lines)

Detailed Description

Utility class for inspecting and debugging Protobuf MaterialXDocument messages.

Print the protobuf document structure in various formats.
Generate Mermaid diagrams for visualization of the document hierarchy.

Member Function Documentation

◆ addMermaidElements()

void Util::addMermaidElements	(	const MaterialXElement &	element,
		std::vector< std::string > &	lines )

staticprivate

                                                                                          {
    std::string node_id = element.name();
    std::replace(node_id.begin(), node_id.end(), ' ', '_');
    
    std::ostringstream node_line;
    node_line << "    " << node_id << "[" << element.name() << " : " << element.type() << "]";
    lines.push_back(node_line.str());
    
    for (const MaterialXElement& child : element.children()) {
        std::string child_id = child.name();
        std::replace(child_id.begin(), child_id.end(), ' ', '_');
        
        addMermaidElements(child, lines);
        
        std::ostringstream edge_line;
        edge_line << "    " << node_id << " --> " << child_id;
        lines.push_back(edge_line.str());
    }
}

◆ debugInspect()

void Util::debugInspect	(	const MaterialXDocument &	pb_doc,
		int	max_depth = 10 )

static

Print detailed document structure with attributes and children.

Parameters

pb_doc	Protobuf document to inspect.
max_depth	Maximum depth to print (default: 10).

                                                                      {
    const Version& pb_version = pb_doc.schema_version();
    std::cout << "Schema Version: " << pb_version.major() << "." 
              << pb_version.minor() << "." << pb_version.patch() << std::endl;
    
    // Print document attributes
    std::ostringstream attrs;
    for (const Attribute& attr : pb_doc.attributes()) {
        if (!attrs.str().empty()) attrs << ", ";
        attrs << attr.key() << "=" << attr.value();
    }
    std::cout << "Document:" << (attrs.str().empty() ? "" : " [" + attrs.str() + "]") << std::endl;
    
    // Print elements
    for (const MaterialXElement& element : pb_doc.elements()) {
        printElement(element, 0, max_depth);
    }
}

◆ debugInspectCompact()

void Util::debugInspectCompact	(	const MaterialXDocument &	pb_doc,
		int	max_depth = 10 )

static

Print compact document structure.

Parameters

pb_doc	Protobuf document to inspect.
max_depth	Maximum depth to print (default: 10).

                                                                             {
    const Version& pb_version = pb_doc.schema_version();
    std::cout << "Schema Version: " << pb_version.major() << "." 
              << pb_version.minor() << "." << pb_version.patch() << std::endl;
    
    // Print document attributes
    std::ostringstream attrs;
    for (const Attribute& attr : pb_doc.attributes()) {
        if (!attrs.str().empty()) attrs << ", ";
        attrs << attr.key() << "=" << attr.value();
    }
    std::cout << "Document:" << (attrs.str().empty() ? "" : " [" + attrs.str() + "]") << std::endl;
    
    // Print elements
    for (const MaterialXElement& element : pb_doc.elements()) {
        printElementCompact(element, 0, max_depth);
    }
}

◆ debugInspectSimple()

void Util::debugInspectSimple ( const MaterialXDocument & pb_doc )

static

Print simple tree structure of document.

Parameters

pb_doc Protobuf document to inspect.

                                                             {
    const Version& pb_version = pb_doc.schema_version();
    std::cout << "Schema Version: " << pb_version.major() << "." 
              << pb_version.minor() << "." << pb_version.patch() << std::endl;
    
    // Print document attributes
    std::ostringstream attrs;
    for (const Attribute& attr : pb_doc.attributes()) {
        if (!attrs.str().empty()) attrs << ", ";
        attrs << attr.key() << "=" << attr.value();
    }
    std::cout << "Document:" << (attrs.str().empty() ? "" : " [" + attrs.str() + "]") << std::endl;
    
    // Print elements
    int total = pb_doc.elements_size();
    for (int i = 0; i < total; ++i) {
        printTree(pb_doc.elements(i), "", i == total - 1);
    }
}

◆ fromString()

MaterialXDocument Util::fromString ( const std::string & data )

static

Parse binary data to create Protobuf document.

Parameters

data	Binary string data.

Returns: Protobuf document.

                                                        {
    MaterialXDocument pb_doc;
    if (!pb_doc.ParseFromString(data)) {
        throw std::runtime_error("Failed to parse protobuf data");
    }
    return pb_doc;
}

◆ generateMermaidDiagram()

std::string Util::generateMermaidDiagram ( const MaterialXDocument & pb_doc )

static

Generate a Mermaid diagram from protobuf document hierarchy.

Parameters

pb_doc Protobuf document to visualize.

Returns: Mermaid diagram source code.

                                                                      {
    std::vector<std::string> lines;
    lines.push_back("graph LR");
    
    for (const MaterialXElement& element : pb_doc.elements()) {
        addMermaidElements(element, lines);
    }
    
    std::ostringstream result;
    for (const std::string& line : lines) {
        result << line << "\n";
    }
    
    return result.str();
}

◆ printElement()

void Util::printElement	(	const MaterialXElement &	element,
		int	depth,
		int	max_depth )

staticprivate

                                                                                 {
    if (depth > max_depth) return;
    
    std::string indent(depth * 2, ' ');
    std::cout << indent << element.name() << " (" << element.type() << ")" << std::endl;
    
    // Print attributes
    for (const Attribute& attr : element.attributes()) {
        std::cout << indent << "  │ " << attr.key() << ": " << attr.value() << std::endl;
    }
    
    // Print children recursively
    if (element.children_size() > 0) {
        std::cout << indent << "  └─ Children (" << element.children_size() << "):" << std::endl;
        for (const MaterialXElement& child : element.children()) {
            printElement(child, depth + 2, max_depth);
        }
    }
}

◆ printElementCompact()

void Util::printElementCompact	(	const MaterialXElement &	element,
		int	depth,
		int	max_depth )

staticprivate

                                                                                        {
    if (depth > max_depth) return;
    
    std::string indent(depth * 2, ' ');
    
    // Print compact info
    std::ostringstream line;
    line << indent << element.name();
    if (!element.type().empty()) {
        line << " (" << element.type() << ")";
    }
    
    // Print first 2 attributes
    if (element.attributes_size() > 0) {
        line << " [";
        int count = 0;
        for (const Attribute& attr : element.attributes()) {
            if (count > 0) line << ", ";
            line << attr.key() << "=" << attr.value();
            if (++count >= 2) break;
        }
        line << "]";
    }
    
    std::cout << line.str() << std::endl;
    
    // Recursively print children
    for (const MaterialXElement& child : element.children()) {
        printElementCompact(child, depth + 1, max_depth);
    }
}

◆ printTree()

void Util::printTree	(	const MaterialXElement &	element,
		const std::string &	prefix,
		bool	is_last )

staticprivate

                                                                                           {
    std::string connector = is_last ? "└── " : "├── ";
    std::cout << prefix << connector << element.name() << " (" << element.type() << ")" << std::endl;
    
    // Update prefix for children
    std::string new_prefix = prefix + (is_last ? "    " : "│   ");
    
    // Print children
    int total = element.children_size();
    for (int i = 0; i < total; ++i) {
        printTree(element.children(i), new_prefix, i == total - 1);
    }
}

◆ toJson()

std::string Util::toJson	(	const MaterialXDocument &	pb_doc,
		int	indent = 2 )

static

Convert Protobuf document to JSON string.

Parameters

pb_doc	Protobuf document to convert.
indent	Number of spaces for indentation (default: 2).

Returns: JSON string representation.

                                                                  {
    google::protobuf::util::JsonPrintOptions options;
    options.add_whitespace = true;
    options.preserve_proto_field_names = true;
    
    std::string json_output;
    google::protobuf::util::MessageToJsonString(pb_doc, &json_output, options);
    return json_output;
}

◆ toString()

std::string Util::toString ( const MaterialXDocument & pb_doc )

static

Serialize Protobuf document to binary string.

Parameters

pb_doc Protobuf document to serialize.

Returns: Binary string representation.

                                                        {
    std::string result;
    if (!pb_doc.SerializeToString(&result)) {
        throw std::runtime_error("Failed to serialize protobuf document");
    }
    return result;
}

The documentation for this class was generated from the following files:

Static Public Member Functions

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ addMermaidElements()

◆ debugInspect()

◆ debugInspectCompact()

◆ debugInspectSimple()

◆ fromString()

◆ generateMermaidDiagram()

◆ printElement()

◆ printElementCompact()

◆ printTree()

◆ toJson()

◆ toString()