Générer une image d'un arbre et de ses nœuds

Inhoudsopgave

En programmation, nous manipulons souvent des arbres et des graphes, et il vient toujours un moment où nous souhaitons obtenir un affichage de la structure de l'arbre ou du graphe, que ce soit pour assurer la traçabilité (debugging), ou pour présenter la structure à d'autres personnes.

Nous pouvons utiliser l'outil Graphviz^{ref 1} pour afficher la structure d'un arbre sous forme d'image.

Exemple d'image de structure de l'arbre

Voici le code qui à été analysé par le compilateur LSD⁰10 pour afficher cette image de l'arbre.

void main()
{
	{
		integer k;
		boolean b;
	}
	k=2;
	b=3<k;
}

Code utilisé pour afficher l'arbre

L'exemple suivant nous montre le code en langage C qui permet d'afficher une image des nœuds de l'arbre syntaxique abstrait généré pour le compilateur LSD010 développé dans le cadre du cours de syntaxe et sémantique^{ref 2}

Code c (project/source/graphVizHelper.h) (19 lignes)

/*
 * graphVizHelper.h : Helper for the graphViz tool (generation of images from a tree)
 * @see http://www.graphviz.org/doc/info/command.html
 * Part of the compiler project for LSD10 language
 * Gaudry Stéphane
 * More information on http://www.gaudry.be/programmer-arbre-image-noeuds.html
 */
#ifndef GRAPHVIZ_HELPER_H
	#define GRAPHVIZ_HELPER_H
 
	#define GRAPHVIZ_CONFIG_FILE "astLSD10.dot"
 
	/**
	 * Generates an image of the AST into the current directory
	 */
	void printGraph();
 
	//void printGraph(char *xmlFileName, char *graphFileName);
#endif

Retourner au début du code

Code c (project/source/graphVizHelper.c) (235 lignes)

/*
 * graphVizHelper.c : Helper for the graphViz tool (generation of images from a tree)
 * @see http://www.graphviz.org/doc/info/command.html
 * Part of the compiler project for LSD10 language
 * Gaudry Stéphane
 * More information on http://www.gaudry.be/programmer-arbre-image-noeuds.html
 */
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include "common.h"
#include "graphVizHelper.h"
#include "y.tab.h"
#if(VERBOSE_LEVEL<=DEB_E)
	#include <errno.h>
#endif
extern AstNode *rootNode;
 
/*
 * **********************************************************
 * Internal business
 * **********************************************************
 */
 
#define GRAPH_RIGHT 0
#define GRAPH_LEFT 1
#define GRAPH_ROOT -1
 
int isGraphVisInstalled()
{
	return 1;//todo : get it dynamically
}
 
/**
 * http://www.graphviz.org/doc/info/command.html
 */
void generateImage(char *dotFileName)
{
	time_t now;
	struct tm *timeinfo;
 
	now = time(NULL);//time ( &now );
	timeinfo = localtime ( &now );
 
	char commandString[100];
//todo : set the timeinfo int values on a 2 digits format
	sprintf(
			commandString,
			"%slsd10_Img%d%d%d%d%d%d.jpg %s",
			"dot -Tjpg -o",
			timeinfo->tm_year+1900,
			timeinfo->tm_mon+1,
			timeinfo->tm_mday,
			timeinfo->tm_hour,
			timeinfo->tm_min,
			timeinfo->tm_sec,
			dotFileName);
	printf("\n;\tGenerating image from dot file : %s\n",commandString);
 
	int ret = 0;
	ret = system (commandString);
	//printf ("ret = %d\n", ret);
 
}
 
void printGraphDotHeader(FILE * graphFile)
{
 
	if(graphFile!=NULL)
	{
		fprintf(graphFile, "digraph LSD10{\n");
		fprintf(graphFile, "\tbgcolor=white \n");
		fprintf(graphFile, "\tnode [");
			fprintf(graphFile, "color=\"#9DACBF\", ");
			fprintf(graphFile, "fontcolor=\"#000000\", ");
			fprintf(graphFile, "style=filled");
		fprintf(graphFile, "];\n");
		fprintf(graphFile, "\tedge [arrowsize=2, color=\"#000000\"];\n");
	}
}
 
void printGraphDotFooter(FILE * graphFile)
{
 
	if(graphFile!=NULL)
	{
 
		time_t now;
		struct tm *timeinfo;
 
		now = time(NULL);//time ( &now );
		timeinfo = localtime ( &now );
//		fprintf(graphFile, "}\n");
//		fprintf(graphFile, "digraph INFO{\n");
		fprintf(
				graphFile,
				"\t\"Generated by the SSHD09 LSD010 compiler\\n%d/%d/%d %dHr %d\\nWith GraphViz engine\" [",
				timeinfo->tm_mday,
				timeinfo->tm_mon+1,
				timeinfo->tm_year+1900,
				timeinfo->tm_hour,
				timeinfo->tm_min,
				timeinfo->tm_sec
				);
			fprintf(graphFile, "shape=box, ");
			fprintf(graphFile, "color=\"#FF9933\", ");
			fprintf(graphFile, "fontcolor=\"#000000\"");
		fprintf(graphFile, "];\n");
		fprintf(graphFile, "}\n");
	}
}
/**
 * Prints an AST node into the graph file
 * Pre-condition : dotFile not null
 */
void printGraphNode(FILE *dotFile, AstNode *node, int depth, int psn)
{
	if(node!=NULL)
	{
		if(node->parent!=NULL)
		{
			fprintf(dotFile, "\t\"%p\" -> ", node->parent);
		}
		else
		{
			fprintf(dotFile, "\t");
		}
		fprintf(
			dotFile,
			"\"%p\";\n\t\"%p\" [shape=%s, color=\"%s\", fontcolor=\"%s\", label=\"%s%s%s%s : \\n%s %s\\nLine %d char %d\"];\n",//print position?
			node,
			node,
			//node->type>LEX_FIRST_TOKEN&&node->type<LEX_LAST_TOKEN?"polygon":"box",
			psn==GRAPH_LEFT?"hexagon":(psn==GRAPH_RIGHT?"box":"doublecircle"),
			(node->type==NODE_TYPE_DECLARATION
					|| node->type==NODE_TYPE_FUNCTION
					|| node->type==NODE_TYPE_PARAM_DECL
					)?"#677E96":psn==GRAPH_LEFT?"#e6e8f2":(psn==GRAPH_RIGHT?"#AAB5C6":"#C0C0C0"),
			(node->type==NODE_TYPE_DECLARATION
					|| node->type==NODE_TYPE_FUNCTION
					|| node->type==NODE_TYPE_PARAM_DECL
					)?"#FFFFFF":"#000000",
			typeToString(node->type),
			node->subtype!=NODE_TYPE_NOTHING?" (":"",
			node->subtype!=NODE_TYPE_NOTHING?typeToString(node->subtype):"",
			node->subtype!=NODE_TYPE_NOTHING?")":"",
			typeToString(node->info->type),
			node->info->name,
			node->debug->line,
			node->debug->linePsn
			);
		printGraphNode(dotFile, node->left, depth+1, GRAPH_LEFT);
		printGraphNode(dotFile, node->right, depth+1, GRAPH_RIGHT);
	}
	//else fprintf(dotFile, "null");
}
void printGraphDotFromXML(char *xmlFileName, char *dotFileName)
{
 
	FILE * graphFile;
	time_t genTime = time(NULL);
	if(xmlFileName==NULL)xmlFileName=AST_XML_FILE;
	if(dotFileName==NULL)dotFileName=GRAPHVIZ_CONFIG_FILE;
	graphFile = fopen(dotFileName, "w");
	if(graphFile!=NULL)
	{
		printf("\n;\tGenerating AST Graph from %s into %s file ... (%s, col %d)", xmlFileName, dotFileName, __FILE__, __LINE__);
		printGraphDotHeader(graphFile);
		//todo : read info from XML file to generate the dot file
		fprintf(graphFile, "Warning : reading from XML is not yet implemented\n");
		printGraphDotFooter(graphFile);
		fclose(graphFile);
 
		#if(VERBOSE_LEVEL<=DEB_EXEC)
			printMsg(DEB_EXEC,"...OK Graph printed", __FILE__, __LINE__);
		#endif
 
		if(isGraphVisInstalled()==1)
		{
			generateImage(dotFileName);
		}
	}
	else
	{
		#if(VERBOSE_LEVEL<=DEB_EXEC)
			printMsg(DEB_EXEC,"Printing AST into Graph file ... Can't open file", __FILE__, __LINE__);
			printMsg(DEB_E, (char *)strerror(errno), __FILE__, __LINE__);
		#endif
	}
}
 
void printGraphDotFromAST(char *dotFileName)
{
 
	FILE * graphFile;
	time_t genTime = time(NULL);
	if(dotFileName==NULL)dotFileName=GRAPHVIZ_CONFIG_FILE;
	graphFile = fopen(dotFileName, "w");
	if(graphFile!=NULL)
	{
		printf("\n;\tGenerating AST Graph from last compilation into %s file ... (%s, col %d)", dotFileName, __FILE__, __LINE__);
		printGraphDotHeader(graphFile);
		printGraphNode(graphFile, rootNode, 0, GRAPH_ROOT);
		printGraphDotFooter(graphFile);
		fclose(graphFile);
 
		#if(VERBOSE_LEVEL<=DEB_EXEC)
			printMsg(DEB_EXEC,"...OK Graph printed", __FILE__, __LINE__);
		#endif
	}
	else
	{
		#if(VERBOSE_LEVEL<=DEB_EXEC)
			printMsg(DEB_EXEC,"Printing AST into Graph file ... Can't open file", __FILE__, __LINE__);
			printMsg(DEB_E, (char *)strerror(errno), __FILE__, __LINE__);
		#endif
	}
}
 
/*
 * **********************************************************
 * Implementation of the header exposed items
 * See graphVizHelper.h for these functions comments
 * **********************************************************
 */
 
void printGraph()
{
	printGraphDotFromAST(GRAPHVIZ_CONFIG_FILE);
	if(isGraphVisInstalled()==1)
	{
		generateImage(GRAPHVIZ_CONFIG_FILE);
	}
}

Retourner au début du code

Je reviendrais plus en détails sur le code quand j'aurais plus de temps, mais voici déjà quelques explications...

Comme nous pouvons le constater dans le fichier d'en-tête, une seule fonction est proposée ici : void printGraph();. Cette fonction génère un fichier DOT défini dans l'en-tête par la constante GRAPHVIZ_CONFIG_FILE, car dans notre cas un seul fichier est utilisé et est écrasé à chaque analyse de code avec le compilateur LSD⁰10.
Ce fichier est seulement destiné à être appelé par l'outil GraphViz pour créer une image des nœuds de l'arbre. Comme nous utiliserons le style "dot" de GraphViz pour notre image, nous pouvons retenir "dot" comme extension de notre fichier temporaire, afin de nous en souvenir.

Nous pouvons aussi générer un fichier de configuration pour GraphViz au départ d'un fichier XML généré par void printXMLTree(FILE *file, pAST_NODE node, int depth) lors de la dernière analyse par le compilateur LSD010. Ce fichier contient les différentes données de notre AST [“Abstract Syntaxic Tree”²].

Exemple fichier de configuration pour GraphViz

Reprennons un instant notre exemple de code qui à été analysé par le compilateur LSD⁰10. Voici le fichier de configuration de GraphViz généré par un appel à void printGraph() pour produire l'image de l'exemple.

Code source (astLSD10.dot) (42 lignes)

digraph LSD10{
	bgcolor=white 
	node [color="#9DACBF", fontcolor="#000000", style=filled];
	edge [arrowsize=2, color="#000000"];
	"0x91789c0";
	"0x91789c0" [shape=doublecircle, color="#677E96", fontcolor="#FFFFFF", label="Functions : \nNo Type Functions\nLine 1 char 4"];
	"0x91789c0" -> "0x9178960";
	"0x9178960" [shape=hexagon, color="#e6e8f2", fontcolor="#000000", label="Function : \nvoid main\nLine 1 char 8"];
	"0x9178960" -> "0x9178900";
	"0x9178900" [shape=hexagon, color="#e6e8f2", fontcolor="#000000", label="Structural node : \nNo Type {{decl}statement}\nLine 9 char 1"];
	"0x9178900" -> "0x9178898";
	"0x9178898" [shape=hexagon, color="#e6e8f2", fontcolor="#000000", label="function body : \nNODE_TYPE_TODO Statements node\nLine 9 char 1"];
	"0x9178898" -> "0x9178830";
	"0x9178830" [shape=hexagon, color="#e6e8f2", fontcolor="#000000", label="function body : \nNODE_TYPE_TODO Statements node\nLine 9 char 1"];
	"0x9178830" -> "0x91787c8";
	"0x91787c8" [shape=box, color="#AAB5C6", fontcolor="#000000", label="Statement : \nNODE_TYPE_CHECK Statement : 'LExpr = RExpr;'\nLine 8 char 6"];
	"0x91787c8" -> "0x9178750";
	"0x9178750" [shape=hexagon, color="#e6e8f2", fontcolor="#000000", label="Right expression : \nboolean _2\nLine 8 char 6"];
	"0x9178750" -> "0x91786f0";
	"0x91786f0" [shape=hexagon, color="#e6e8f2", fontcolor="#000000", label="Right expression : \nNODE_TYPE_TODO _1\nLine 8 char 6"];
	"0x91786f0" -> "0x9178690";
	"0x9178690" [shape=box, color="#AAB5C6", fontcolor="#000000", label="Id : \nNo Type k\nLine 8 char 6"];
	"0x9178750" -> "0x9178620";
	"0x9178620" [shape=box, color="#AAB5C6", fontcolor="#000000", label="number : \ninteger CONSTANT, NUMBER\nLine 8 char 3"];
	"0x91787c8" -> "0x91785b8";
	"0x91785b8" [shape=box, color="#AAB5C6", fontcolor="#000000", label="Id : \nNo Type b\nLine 8 char 2"];
	"0x9178898" -> "0x9178548";
	"0x9178548" [shape=box, color="#AAB5C6", fontcolor="#000000", label="Statement : \nNODE_TYPE_CHECK Statement : 'LExpr = RExpr;'\nLine 7 char 4"];
	"0x9178548" -> "0x91784d0";
	"0x91784d0" [shape=hexagon, color="#e6e8f2", fontcolor="#000000", label="number : \ninteger CONSTANT, NUMBER\nLine 7 char 3"];
	"0x9178548" -> "0x9178468";
	"0x9178468" [shape=box, color="#AAB5C6", fontcolor="#000000", label="Id : \nNo Type k\nLine 7 char 2"];
	"0x9178900" -> "0x91783f8";
	"0x91783f8" [shape=box, color="#AAB5C6", fontcolor="#000000", label="Type declarations : \nNo Type Declarations node\nLine 6 char 1"];
	"0x91783f8" -> "0x9178390";
	"0x9178390" [shape=hexagon, color="#e6e8f2", fontcolor="#000000", label="Type declarations : \nNo Type Declarations node\nLine 6 char 1"];
	"0x9178390" -> "0x9178348";
	"0x9178348" [shape=box, color="#AAB5C6", fontcolor="#000000", label="Type declaration : \nboolean b\nLine 5 char 9"];
	"0x91783f8" -> "0x9178298";
	"0x9178298" [shape=box, color="#AAB5C6", fontcolor="#000000", label="Type declaration : \ninteger k\nLine 4 char 9"];
	"Generated by the SSHD09 LSD010 compiler\n22/4/2010 4Hr 1\nWith GraphViz engine" [shape=box, color="#FF9933", fontcolor="#000000"];
}

Retourner au début du code

Code source du compilateur LSD010

Vous pouvez explorer et consulter la totalité du code source de l'exemple du compilateur LSD⁰10 à cette adresse : https://www.gaudry.be/nl/langages-lsd10-source.html

Nederlandse vertaling

U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.

Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.

Bij voorbaat dank.

Document heeft de 25/04/2010 gemaakt, de laatste keer de 16/07/2024 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/programmer-arbre-image-noeuds.html

De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.

Notes

↑^a,b,c,d,e LSD⁰10 : Langage Simple et Didactique Il existe une un certain nombre d'interprétations de l'acronyme LSD (Langage Symbolique Didactique, Langage Sans Difficulté, Langage Simple et Didactique). LSD⁰10 est la version 2010 de la suite LSD80, LSD_02, LSD⁰3, LSD⁰4, LSD⁰5, LSD⁰6, LSD⁰7, LSD⁰8, et LSD⁰9.
↑^a,b Abstract Syntaxic Tree : komt overeen met « arbre syntaxique abstrait » en français
↑ AST : “Abstract Syntaxic Tree” (en français, « arbre syntaxique abstrait »)

Inhoudsopgave Haut

Referenties

Graph Visualization Software : http://www.graphviz.org/Credits.php, Graphviz (version 24/04/10)
IHDCB332 - Théorie des langages : Syntaxe et sémantique : PY Schobbens, Syntaxe et sémantique (January 2010)

Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.

Inhoudsopgave Haut