Depsgraph: Make it more clear that we dump relations into graphviz

We might implement other things to dump into graphviz, so better to
start having explicit names.

1 files changed, 0 insertions, 552 deletions

diff --git a/source/blender/depsgraph/intern/debug/deg_debug_graphviz.cc b/source/blender/depsgraph/intern/debug/deg_debug_graphviz.cc
deleted file mode 100644
index 88954f6f0dc..00000000000
--- a/source/blender/depsgraph/intern/debug/deg_debug_graphviz.cc
+++ /dev/null
@@ -1,552 +0,0 @@
-/*
- * ***** BEGIN GPL LICENSE BLOCK *****
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- *
- * The Original Code is Copyright (C) 2014 Blender Foundation.
- * All rights reserved.
- *
- * Original Author: Lukas Toenne
- * Contributor(s): None Yet
- *
- * ***** END GPL LICENSE BLOCK *****
- */
-
-/** \file blender/depsgraph/intern/debug/deg_debug_graphviz.cc
- *  \ingroup depsgraph
- *
- * Implementation of tools for debugging the depsgraph
- */
-
-#include "BLI_utildefines.h"
-#include "BLI_ghash.h"
-
-extern "C" {
-#include "DNA_listBase.h"
-}  /* extern "C" */
-
-#include "DEG_depsgraph.h"
-#include "DEG_depsgraph_debug.h"
-
-#include "intern/depsgraph_intern.h"
-#include "intern/nodes/deg_node_id.h"
-#include "intern/nodes/deg_node_time.h"
-
-#include "util/deg_util_foreach.h"
-
-/* ****************** */
-/* Graphviz Debugging */
-
-namespace DEG {
-
-#define NL "\r\n"
-
-/* Only one should be enabled, defines whether graphviz nodes
- * get colored by individual types or classes.
- */
-#define COLOR_SCHEME_NODE_CLASS 1
-//#define COLOR_SCHEME_NODE_TYPE  2
-
-static const char *deg_debug_graphviz_fontname = "helvetica";
-static float deg_debug_graphviz_graph_label_size = 20.0f;
-static float deg_debug_graphviz_node_label_size = 14.0f;
-static const int deg_debug_max_colors = 12;
-#ifdef COLOR_SCHEME_NODE_TYPE
-static const char *deg_debug_colors[] = {
-    "#a6cee3", "#1f78b4", "#b2df8a",
-    "#33a02c", "#fb9a99", "#e31a1c",
-    "#fdbf6f", "#ff7f00", "#cab2d6",
-    "#6a3d9a", "#ffff99", "#b15928",
-};
-#endif
-static const char *deg_debug_colors_light[] = {
-    "#8dd3c7", "#ffffb3", "#bebada",
-    "#fb8072", "#80b1d3", "#fdb462",
-    "#b3de69", "#fccde5", "#d9d9d9",
-    "#bc80bd", "#ccebc5", "#ffed6f",
-};
-
-#ifdef COLOR_SCHEME_NODE_TYPE
-static const int deg_debug_node_type_color_map[][2] = {
-    {DEG_NODE_TYPE_TIMESOURCE,   0},
-    {DEG_NODE_TYPE_ID_REF,       2},
-
-    /* Outer Types */
-    {DEG_NODE_TYPE_PARAMETERS,   2},
-    {DEG_NODE_TYPE_PROXY,        3},
-    {DEG_NODE_TYPE_ANIMATION,    4},
-    {DEG_NODE_TYPE_TRANSFORM,    5},
-    {DEG_NODE_TYPE_GEOMETRY,     6},
-    {DEG_NODE_TYPE_SEQUENCER,    7},
-    {DEG_NODE_TYPE_SHADING,      8},
-    {DEG_NODE_TYPE_CACHE,        9},
-    {-1,                         0}
-};
-#endif
-
-static int deg_debug_node_color_index(const DepsNode *node)
-{
-#ifdef COLOR_SCHEME_NODE_CLASS
-	/* Some special types. */
-	switch (node->type) {
-		case DEG_NODE_TYPE_ID_REF:
-			return 5;
-		case DEG_NODE_TYPE_OPERATION:
-		{
-			OperationDepsNode *op_node = (OperationDepsNode *)node;
-			if (op_node->is_noop())
-				return 8;
-			break;
-		}
-
-		default:
-			break;
-	}
-	/* Do others based on class. */
-	switch (node->get_class()) {
-		case DEG_NODE_CLASS_OPERATION:
-			return 4;
-		case DEG_NODE_CLASS_COMPONENT:
-			return 1;
-		default:
-			return 9;
-	}
-#endif
-
-#ifdef COLOR_SCHEME_NODE_TYPE
-	const int (*pair)[2];
-	for (pair = deg_debug_node_type_color_map; (*pair)[0] >= 0; ++pair) {
-		if ((*pair)[0] == node->type) {
-			return (*pair)[1];
-		}
-	}
-	return -1;
-#endif
-}
-
-struct DebugContext {
-	FILE *file;
-	bool show_tags;
-};
-
-static void deg_debug_fprintf(const DebugContext &ctx, const char *fmt, ...) ATTR_PRINTF_FORMAT(2, 3);
-static void deg_debug_fprintf(const DebugContext &ctx, const char *fmt, ...)
-{
-	va_list args;
-	va_start(args, fmt);
-	vfprintf(ctx.file, fmt, args);
-	va_end(args);
-}
-
-static void deg_debug_graphviz_legend_color(const DebugContext &ctx,
-                                            const char *name,
-                                            const char *color)
-{
-	deg_debug_fprintf(ctx, "<TR>");
-	deg_debug_fprintf(ctx, "<TD>%s</TD>", name);
-	deg_debug_fprintf(ctx, "<TD BGCOLOR=\"%s\"></TD>", color);
-	deg_debug_fprintf(ctx, "</TR>" NL);
-}
-
-static void deg_debug_graphviz_legend(const DebugContext &ctx)
-{
-	deg_debug_fprintf(ctx, "{" NL);
-	deg_debug_fprintf(ctx, "rank = sink;" NL);
-	deg_debug_fprintf(ctx, "Legend [shape=none, margin=0, label=<" NL);
-	deg_debug_fprintf(ctx, "  <TABLE BORDER=\"0\" CELLBORDER=\"1\" CELLSPACING=\"0\" CELLPADDING=\"4\">" NL);
-	deg_debug_fprintf(ctx, "<TR><TD COLSPAN=\"2\"><B>Legend</B></TD></TR>" NL);
-
-#ifdef COLOR_SCHEME_NODE_CLASS
-	const char **colors = deg_debug_colors_light;
-	deg_debug_graphviz_legend_color(ctx, "Operation", colors[4]);
-	deg_debug_graphviz_legend_color(ctx, "Component", colors[1]);
-	deg_debug_graphviz_legend_color(ctx, "ID Node", colors[5]);
-	deg_debug_graphviz_legend_color(ctx, "NOOP", colors[8]);
-#endif
-
-#ifdef COLOR_SCHEME_NODE_TYPE
-	const int (*pair)[2];
-	for (pair = deg_debug_node_type_color_map; (*pair)[0] >= 0; ++pair) {
-		DepsNodeFactory *nti = deg_type_get_factory((eDepsNode_Type)(*pair)[0]);
-		deg_debug_graphviz_legend_color(ctx,
-		                                nti->tname().c_str(),
-		                                deg_debug_colors_light[(*pair)[1] % deg_debug_max_colors]);
-	}
-#endif
-
-	deg_debug_fprintf(ctx, "</TABLE>" NL);
-	deg_debug_fprintf(ctx, ">" NL);
-	deg_debug_fprintf(ctx, ",fontname=\"%s\"", deg_debug_graphviz_fontname);
-	deg_debug_fprintf(ctx, "];" NL);
-	deg_debug_fprintf(ctx, "}" NL);
-}
-
-static void deg_debug_graphviz_node_color(const DebugContext &ctx,
-                                          const DepsNode *node)
-{
-	const char *color_default = "black";
-	const char *color_modified = "orangered4";
-	const char *color_update = "dodgerblue3";
-	const char *color = color_default;
-	if (ctx.show_tags) {
-		if (node->get_class() == DEG_NODE_CLASS_OPERATION) {
-			OperationDepsNode *op_node = (OperationDepsNode *)node;
-			if (op_node->flag & DEPSOP_FLAG_DIRECTLY_MODIFIED) {
-				color = color_modified;
-			}
-			else if (op_node->flag & DEPSOP_FLAG_NEEDS_UPDATE) {
-				color = color_update;
-			}
-		}
-	}
-	deg_debug_fprintf(ctx, "\"%s\"", color);
-}
-
-static void deg_debug_graphviz_node_penwidth(const DebugContext &ctx,
-                                             const DepsNode *node)
-{
-	float penwidth_default = 1.0f;
-	float penwidth_modified = 4.0f;
-	float penwidth_update = 4.0f;
-	float penwidth = penwidth_default;
-	if (ctx.show_tags) {
-		if (node->get_class() == DEG_NODE_CLASS_OPERATION) {
-			OperationDepsNode *op_node = (OperationDepsNode *)node;
-			if (op_node->flag & DEPSOP_FLAG_DIRECTLY_MODIFIED) {
-				penwidth = penwidth_modified;
-			}
-			else if (op_node->flag & DEPSOP_FLAG_NEEDS_UPDATE) {
-				penwidth = penwidth_update;
-			}
-		}
-	}
-	deg_debug_fprintf(ctx, "\"%f\"", penwidth);
-}
-
-static void deg_debug_graphviz_node_fillcolor(const DebugContext &ctx,
-                                              const DepsNode *node)
-{
-	const char *defaultcolor = "gainsboro";
-	int color_index = deg_debug_node_color_index(node);
-	const char *fillcolor = color_index < 0 ? defaultcolor : deg_debug_colors_light[color_index % deg_debug_max_colors];
-	deg_debug_fprintf(ctx, "\"%s\"", fillcolor);
-}
-
-static void deg_debug_graphviz_relation_color(const DebugContext &ctx,
-                                              const DepsRelation *rel)
-{
-	const char *color_default = "black";
-	const char *color_error = "red4";
-	const char *color = color_default;
-	if (rel->flag & DEPSREL_FLAG_CYCLIC) {
-		color = color_error;
-	}
-	deg_debug_fprintf(ctx, "%s", color);
-}
-
-static void deg_debug_graphviz_node_style(const DebugContext &ctx, const DepsNode *node)
-{
-	const char *base_style = "filled"; /* default style */
-	if (ctx.show_tags) {
-		if (node->get_class() == DEG_NODE_CLASS_OPERATION) {
-			OperationDepsNode *op_node = (OperationDepsNode *)node;
-			if (op_node->flag & (DEPSOP_FLAG_DIRECTLY_MODIFIED | DEPSOP_FLAG_NEEDS_UPDATE)) {
-				base_style = "striped";
-			}
-		}
-	}
-	switch (node->get_class()) {
-		case DEG_NODE_CLASS_GENERIC:
-			deg_debug_fprintf(ctx, "\"%s\"", base_style);
-			break;
-		case DEG_NODE_CLASS_COMPONENT:
-			deg_debug_fprintf(ctx, "\"%s\"", base_style);
-			break;
-		case DEG_NODE_CLASS_OPERATION:
-			deg_debug_fprintf(ctx, "\"%s,rounded\"", base_style);
-			break;
-	}
-}
-
-static void deg_debug_graphviz_node_single(const DebugContext &ctx,
-                                           const DepsNode *node)
-{
-	const char *shape = "box";
-	string name = node->identifier();
-	if (node->type == DEG_NODE_TYPE_ID_REF) {
-		IDDepsNode *id_node = (IDDepsNode *)node;
-		char buf[256];
-		BLI_snprintf(buf, sizeof(buf), " (Layers: %u)", id_node->layers);
-		name += buf;
-	}
-	deg_debug_fprintf(ctx, "// %s\n", name.c_str());
-	deg_debug_fprintf(ctx, "\"node_%p\"", node);
-	deg_debug_fprintf(ctx, "[");
-//	deg_debug_fprintf(ctx, "label=<<B>%s</B>>", name);
-	deg_debug_fprintf(ctx, "label=<%s>", name.c_str());
-	deg_debug_fprintf(ctx, ",fontname=\"%s\"", deg_debug_graphviz_fontname);
-	deg_debug_fprintf(ctx, ",fontsize=%f", deg_debug_graphviz_node_label_size);
-	deg_debug_fprintf(ctx, ",shape=%s", shape);
-	deg_debug_fprintf(ctx, ",style="); deg_debug_graphviz_node_style(ctx, node);
-	deg_debug_fprintf(ctx, ",color="); deg_debug_graphviz_node_color(ctx, node);
-	deg_debug_fprintf(ctx, ",fillcolor="); deg_debug_graphviz_node_fillcolor(ctx, node);
-	deg_debug_fprintf(ctx, ",penwidth="); deg_debug_graphviz_node_penwidth(ctx, node);
-	deg_debug_fprintf(ctx, "];" NL);
-	deg_debug_fprintf(ctx, NL);
-}
-
-static void deg_debug_graphviz_node_cluster_begin(const DebugContext &ctx,
-                                                  const DepsNode *node)
-{
-	string name = node->identifier();
-	if (node->type == DEG_NODE_TYPE_ID_REF) {
-		IDDepsNode *id_node = (IDDepsNode *)node;
-		char buf[256];
-		BLI_snprintf(buf, sizeof(buf), " (Layers: %u)", id_node->layers);
-		name += buf;
-	}
-	deg_debug_fprintf(ctx, "// %s\n", name.c_str());
-	deg_debug_fprintf(ctx, "subgraph \"cluster_%p\" {" NL, node);
-//	deg_debug_fprintf(ctx, "label=<<B>%s</B>>;" NL, name);
-	deg_debug_fprintf(ctx, "label=<%s>;" NL, name.c_str());
-	deg_debug_fprintf(ctx, "fontname=\"%s\";" NL, deg_debug_graphviz_fontname);
-	deg_debug_fprintf(ctx, "fontsize=%f;" NL, deg_debug_graphviz_node_label_size);
-	deg_debug_fprintf(ctx, "margin=\"%d\";" NL, 16);
-	deg_debug_fprintf(ctx, "style="); deg_debug_graphviz_node_style(ctx, node); deg_debug_fprintf(ctx, ";" NL);
-	deg_debug_fprintf(ctx, "color="); deg_debug_graphviz_node_color(ctx, node); deg_debug_fprintf(ctx, ";" NL);
-	deg_debug_fprintf(ctx, "fillcolor="); deg_debug_graphviz_node_fillcolor(ctx, node); deg_debug_fprintf(ctx, ";" NL);
-	deg_debug_fprintf(ctx, "penwidth="); deg_debug_graphviz_node_penwidth(ctx, node); deg_debug_fprintf(ctx, ";" NL);
-	/* dummy node, so we can add edges between clusters */
-	deg_debug_fprintf(ctx, "\"node_%p\"", node);
-	deg_debug_fprintf(ctx, "[");
-	deg_debug_fprintf(ctx, "shape=%s", "point");
-	deg_debug_fprintf(ctx, ",style=%s", "invis");
-	deg_debug_fprintf(ctx, "];" NL);
-	deg_debug_fprintf(ctx, NL);
-}
-
-static void deg_debug_graphviz_node_cluster_end(const DebugContext &ctx)
-{
-	deg_debug_fprintf(ctx, "}" NL);
-	deg_debug_fprintf(ctx, NL);
-}
-
-static void deg_debug_graphviz_graph_nodes(const DebugContext &ctx,
-                                           const Depsgraph *graph);
-static void deg_debug_graphviz_graph_relations(const DebugContext &ctx,
-                                               const Depsgraph *graph);
-
-static void deg_debug_graphviz_node(const DebugContext &ctx,
-                                    const DepsNode *node)
-{
-	switch (node->type) {
-		case DEG_NODE_TYPE_ID_REF:
-		{
-			const IDDepsNode *id_node = (const IDDepsNode *)node;
-			if (BLI_ghash_size(id_node->components) == 0) {
-				deg_debug_graphviz_node_single(ctx, node);
-			}
-			else {
-				deg_debug_graphviz_node_cluster_begin(ctx, node);
-				GHASH_FOREACH_BEGIN(const ComponentDepsNode *, comp, id_node->components)
-				{
-					deg_debug_graphviz_node(ctx, comp);
-				}
-				GHASH_FOREACH_END();
-				deg_debug_graphviz_node_cluster_end(ctx);
-			}
-			break;
-		}
-		case DEG_NODE_TYPE_PARAMETERS:
-		case DEG_NODE_TYPE_ANIMATION:
-		case DEG_NODE_TYPE_TRANSFORM:
-		case DEG_NODE_TYPE_PROXY:
-		case DEG_NODE_TYPE_GEOMETRY:
-		case DEG_NODE_TYPE_SEQUENCER:
-		case DEG_NODE_TYPE_EVAL_POSE:
-		case DEG_NODE_TYPE_BONE:
-		case DEG_NODE_TYPE_SHADING:
-		case DEG_NODE_TYPE_CACHE:
-		case DEG_NODE_TYPE_EVAL_PARTICLES:
-		{
-			ComponentDepsNode *comp_node = (ComponentDepsNode *)node;
-			if (!comp_node->operations.empty()) {
-				deg_debug_graphviz_node_cluster_begin(ctx, node);
-				foreach (DepsNode *op_node, comp_node->operations) {
-					deg_debug_graphviz_node(ctx, op_node);
-				}
-				deg_debug_graphviz_node_cluster_end(ctx);
-			}
-			else {
-				deg_debug_graphviz_node_single(ctx, node);
-			}
-			break;
-		}
-		default:
-			deg_debug_graphviz_node_single(ctx, node);
-			break;
-	}
-}
-
-static bool deg_debug_graphviz_is_cluster(const DepsNode *node)
-{
-	switch (node->type) {
-		case DEG_NODE_TYPE_ID_REF:
-		{
-			const IDDepsNode *id_node = (const IDDepsNode *)node;
-			return BLI_ghash_size(id_node->components) > 0;
-		}
-		case DEG_NODE_TYPE_PARAMETERS:
-		case DEG_NODE_TYPE_ANIMATION:
-		case DEG_NODE_TYPE_TRANSFORM:
-		case DEG_NODE_TYPE_PROXY:
-		case DEG_NODE_TYPE_GEOMETRY:
-		case DEG_NODE_TYPE_SEQUENCER:
-		case DEG_NODE_TYPE_EVAL_POSE:
-		case DEG_NODE_TYPE_BONE:
-		{
-			ComponentDepsNode *comp_node = (ComponentDepsNode *)node;
-			return !comp_node->operations.empty();
-		}
-		default:
-			return false;
-	}
-}
-
-static bool deg_debug_graphviz_is_owner(const DepsNode *node,
-                                        const DepsNode *other)
-{
-	switch (node->get_class()) {
-		case DEG_NODE_CLASS_COMPONENT:
-		{
-			ComponentDepsNode *comp_node = (ComponentDepsNode *)node;
-			if (comp_node->owner == other)
-				return true;
-			break;
-		}
-		case DEG_NODE_CLASS_OPERATION:
-		{
-			OperationDepsNode *op_node = (OperationDepsNode *)node;
-			if (op_node->owner == other)
-				return true;
-			else if (op_node->owner->owner == other)
-				return true;
-			break;
-		}
-		default: break;
-	}
-	return false;
-}
-
-static void deg_debug_graphviz_node_relations(const DebugContext &ctx,
-                                              const DepsNode *node)
-{
-	foreach (DepsRelation *rel, node->inlinks) {
-		float penwidth = 2.0f;
-
-		const DepsNode *tail = rel->to; /* same as node */
-		const DepsNode *head = rel->from;
-		deg_debug_fprintf(ctx, "// %s -> %s\n",
-		                 head->identifier().c_str(),
-		                 tail->identifier().c_str());
-		deg_debug_fprintf(ctx, "\"node_%p\"", head);
-		deg_debug_fprintf(ctx, " -> ");
-		deg_debug_fprintf(ctx, "\"node_%p\"", tail);
-
-		deg_debug_fprintf(ctx, "[");
-		/* Note: without label an id seem necessary to avoid bugs in graphviz/dot */
-		deg_debug_fprintf(ctx, "id=\"%s\"", rel->name);
-		deg_debug_fprintf(ctx, ",color="); deg_debug_graphviz_relation_color(ctx, rel);
-		deg_debug_fprintf(ctx, ",penwidth=\"%f\"", penwidth);
-		/* NOTE: edge from node to own cluster is not possible and gives graphviz
-		 * warning, avoid this here by just linking directly to the invisible
-		 * placeholder node
-		 */
-		if (deg_debug_graphviz_is_cluster(tail) && !deg_debug_graphviz_is_owner(head, tail)) {
-			deg_debug_fprintf(ctx, ",ltail=\"cluster_%p\"", tail);
-		}
-		if (deg_debug_graphviz_is_cluster(head) && !deg_debug_graphviz_is_owner(tail, head)) {
-			deg_debug_fprintf(ctx, ",lhead=\"cluster_%p\"", head);
-		}
-		deg_debug_fprintf(ctx, "];" NL);
-		deg_debug_fprintf(ctx, NL);
-	}
-}
-
-static void deg_debug_graphviz_graph_nodes(const DebugContext &ctx,
-                                           const Depsgraph *graph)
-{
-	foreach (DepsNode *node, graph->id_nodes) {
-		deg_debug_graphviz_node(ctx, node);
-	}
-	TimeSourceDepsNode *time_source = graph->find_time_source();
-	if (time_source != NULL) {
-		deg_debug_graphviz_node(ctx, time_source);
-	}
-}
-
-static void deg_debug_graphviz_graph_relations(const DebugContext &ctx,
-                                               const Depsgraph *graph)
-{
-	foreach (IDDepsNode *id_node, graph->id_nodes) {
-		GHASH_FOREACH_BEGIN(ComponentDepsNode *, comp_node, id_node->components)
-		{
-			foreach (OperationDepsNode *op_node, comp_node->operations) {
-				deg_debug_graphviz_node_relations(ctx, op_node);
-			}
-		}
-		GHASH_FOREACH_END();
-	}
-
-	TimeSourceDepsNode *time_source = graph->find_time_source();
-	if (time_source != NULL) {
-		deg_debug_graphviz_node_relations(ctx, time_source);
-	}
-}
-
-}  // namespace DEG
-
-void DEG_debug_graphviz(const Depsgraph *graph, FILE *f, const char *label)
-{
-	if (!graph) {
-		return;
-	}
-
-	const DEG::Depsgraph *deg_graph = reinterpret_cast<const DEG::Depsgraph *>(graph);
-
-	DEG::DebugContext ctx;
-	ctx.file = f;
-
-	DEG::deg_debug_fprintf(ctx, "digraph depgraph {" NL);
-	DEG::deg_debug_fprintf(ctx, "rankdir=LR;" NL);
-	DEG::deg_debug_fprintf(ctx, "graph [");
-	DEG::deg_debug_fprintf(ctx, "compound=true");
-	DEG::deg_debug_fprintf(ctx, ",labelloc=\"t\"");
-	DEG::deg_debug_fprintf(ctx, ",fontsize=%f", DEG::deg_debug_graphviz_graph_label_size);
-	DEG::deg_debug_fprintf(ctx, ",fontname=\"%s\"", DEG::deg_debug_graphviz_fontname);
-	DEG::deg_debug_fprintf(ctx, ",label=\"%s\"", label);
-	DEG::deg_debug_fprintf(ctx, ",splines=ortho");
-	DEG::deg_debug_fprintf(ctx, ",overlap=scalexy"); // XXX: only when using neato
-	DEG::deg_debug_fprintf(ctx, "];" NL);
-
-	DEG::deg_debug_graphviz_graph_nodes(ctx, deg_graph);
-	DEG::deg_debug_graphviz_graph_relations(ctx, deg_graph);
-
-	DEG::deg_debug_graphviz_legend(ctx);
-
-	DEG::deg_debug_fprintf(ctx, "}" NL);
-}
-
-#undef NL