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

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 Graphvizref 1  pour afficher la structure d'un arbre sous forme d'image.

Exemple d'image de structure de l'arbre

AST d'une fonction main LSD010

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

  1. void main()
  2. {
  3.   {
  4.     integer k;
  5.     boolean b;
  6.   }
  7.   k=2;
  8.   b=3<k;
  9. }

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émantiqueref 2

  1. /*
  2.  * graphVizHelper.h : Helper for the graphViz tool (generation of images from a tree)
  3.  * @see http://www.graphviz.org/doc/info/command.html
  4.  * Part of the compiler project for LSD10 language
  5.  * Gaudry Stéphane
  6.  * More information on http://www.gaudry.be/programmer-arbre-image-noeuds.html
  7.  */
  8. #ifndef GRAPHVIZ_HELPER_H
  9. #define GRAPHVIZ_HELPER_H
  10.  
  11. #define GRAPHVIZ_CONFIG_FILE "astLSD10.dot"
  12.  
  13. /**
  14. * Generates an image of the AST into the current directory
  15. */
  16. void printGraph();
  17.  
  18. //void printGraph(char *xmlFileName, char *graphFileName);
  19. #endif

Code c (project/source/graphVizHelper.c) (235 lignes) :
  1. /*
  2.  * graphVizHelper.c : Helper for the graphViz tool (generation of images from a tree)
  3.  * @see http://www.graphviz.org/doc/info/command.html
  4.  * Part of the compiler project for LSD10 language
  5.  * Gaudry Stéphane
  6.  * More information on http://www.gaudry.be/programmer-arbre-image-noeuds.html
  7.  */
  8. #include <stdio.h>
  9. #include <stdlib.h>
  10. #include <string.h>
  11. #include <time.h>
  12. #include "common.h"
  13. #include "graphVizHelper.h"
  14. #include "y.tab.h"
  15. #if(VERBOSE_LEVEL<=DEB_E)
  16.   #include <errno.h>
  17. #endif
  18. extern AstNode *rootNode;
  19.  
  20. /*
  21.  * **********************************************************
  22.  * Internal business
  23.  * **********************************************************
  24.  */
  25.  
  26. #define GRAPH_RIGHT 0
  27. #define GRAPH_LEFT 1
  28. #define GRAPH_ROOT -1
  29.  
  30. int isGraphVisInstalled()
  31. {
  32.   return 1;//todo : get it dynamically
  33. }
  34.  
  35. /**
  36.  * http://www.graphviz.org/doc/info/command.html
  37.  */
  38. void generateImage(char *dotFileName)
  39. {
  40.   time_t now;
  41.   struct tm *timeinfo;
  42.  
  43.   now = time(NULL);//time ( &now );
  44.   timeinfo = localtime ( &now );
  45.  
  46.   char commandString[100];
  47. //todo : set the timeinfo int values on a 2 digits format
  48.       commandString,
  49.       "%slsd10_Img%d%d%d%d%d%d.jpg %s",
  50.       "dot -Tjpg -o",
  51.       timeinfo->tm_year+1900,
  52.       timeinfo->tm_mon+1,
  53.       timeinfo->tm_mday,
  54.       timeinfo->tm_hour,
  55.       timeinfo->tm_min,
  56.       timeinfo->tm_sec,
  57.       dotFileName);
  58.   printf("\n;\tGenerating image from dot file : %s\n",commandString);
  59.  
  60.   int ret = 0;
  61.   ret = system (commandString);
  62.   //printf ("ret = %d\n", ret);
  63.  
  64. }
  65.  
  66. void printGraphDotHeader(FILE * graphFile)
  67. {
  68.  
  69.   if(graphFile!=NULL)
  70.   {
  71.     fprintf(graphFile, "digraph LSD10{\n");
  72.     fprintf(graphFile, "\tbgcolor=white \n");
  73.     fprintf(graphFile, "\tnode [");
  74.       fprintf(graphFile, "color=\"#9DACBF\", ");
  75.       fprintf(graphFile, "fontcolor=\"#000000\", ");
  76.       fprintf(graphFile, "style=filled");
  77.     fprintf(graphFile, "];\n");
  78.     fprintf(graphFile, "\tedge [arrowsize=2, color=\"#000000\"];\n");
  79.   }
  80. }
  81.  
  82. void printGraphDotFooter(FILE * graphFile)
  83. {
  84.  
  85.   if(graphFile!=NULL)
  86.   {
  87.  
  88.     time_t now;
  89.     struct tm *timeinfo;
  90.  
  91.     now = time(NULL);//time ( &now );
  92.     timeinfo = localtime ( &now );
  93. //    fprintf(graphFile, "}\n");
  94. //    fprintf(graphFile, "digraph INFO{\n");
  95.     fprintf(
  96.         graphFile,
  97.         "\t\"Generated by the SSHD09 LSD010 compiler\\n%d/%d/%d %dHr %d\\nWith GraphViz engine\" [",
  98.         timeinfo->tm_mday,
  99.         timeinfo->tm_mon+1,
  100.         timeinfo->tm_year+1900,
  101.         timeinfo->tm_hour,
  102.         timeinfo->tm_min,
  103.         timeinfo->tm_sec
  104.         );
  105.       fprintf(graphFile, "shape=box, ");
  106.       fprintf(graphFile, "color=\"#FF9933\", ");
  107.       fprintf(graphFile, "fontcolor=\"#000000\"");
  108.     fprintf(graphFile, "];\n");
  109.     fprintf(graphFile, "}\n");
  110.   }
  111. }
  112. /**
  113.  * Prints an AST node into the graph file
  114.  * Pre-condition : dotFile not null
  115.  */
  116. void printGraphNode(FILE *dotFile, AstNode *node, int depth, int psn)
  117. {
  118.   if(node!=NULL)
  119.   {
  120.     if(node->parent!=NULL)
  121.     {
  122.       fprintf(dotFile, "\t\"%p\" -> ", node->parent);
  123.     }
  124.     else
  125.     {
  126.       fprintf(dotFile, "\t");
  127.     }
  128.     fprintf(
  129.       dotFile,
  130.       "\"%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?
  131.       node,
  132.       node,
  133.       //node->type>LEX_FIRST_TOKEN&&node->type<LEX_LAST_TOKEN?"polygon":"box",
  134.       psn==GRAPH_LEFT?"hexagon":(psn==GRAPH_RIGHT?"box":"doublecircle"),
  135.       (node->type==NODE_TYPE_DECLARATION
  136.           || node->type==NODE_TYPE_FUNCTION
  137.           || node->type==NODE_TYPE_PARAM_DECL
  138.           )?"#677E96":psn==GRAPH_LEFT?"#e6e8f2":(psn==GRAPH_RIGHT?"#AAB5C6":"#C0C0C0"),
  139.       (node->type==NODE_TYPE_DECLARATION
  140.           || node->type==NODE_TYPE_FUNCTION
  141.           || node->type==NODE_TYPE_PARAM_DECL
  142.           )?"#FFFFFF":"#000000",
  143.       typeToString(node->type),
  144.       node->subtype!=NODE_TYPE_NOTHING?" (":"",
  145.       node->subtype!=NODE_TYPE_NOTHING?typeToString(node->subtype):"",
  146.       node->subtype!=NODE_TYPE_NOTHING?")":"",
  147.       typeToString(node->info->type),
  148.       node->info->name,
  149.       node->debug->line,
  150.       node->debug->linePsn
  151.       );
  152.     printGraphNode(dotFile, node->left, depth+1, GRAPH_LEFT);
  153.     printGraphNode(dotFile, node->right, depth+1, GRAPH_RIGHT);
  154.   }
  155.   //else fprintf(dotFile, "null");
  156. }
  157. void printGraphDotFromXML(char *xmlFileName, char *dotFileName)
  158. {
  159.  
  160.   FILE * graphFile;
  161.   time_t genTime = time(NULL);
  162.   if(xmlFileName==NULL)xmlFileName=AST_XML_FILE;
  163.   if(dotFileName==NULL)dotFileName=GRAPHVIZ_CONFIG_FILE;
  164.   graphFile = fopen(dotFileName, "w");
  165.   if(graphFile!=NULL)
  166.   {
  167.     printf("\n;\tGenerating AST Graph from %s into %s file ... (%s, col %d)", xmlFileName, dotFileName, __FILE__, __LINE__);
  168.     printGraphDotHeader(graphFile);
  169.     //todo : read info from XML file to generate the dot file
  170.     fprintf(graphFile, "Warning : reading from XML is not yet implemented\n");
  171.     printGraphDotFooter(graphFile);
  172.     fclose(graphFile);
  173.  
  174.     #if(VERBOSE_LEVEL<=DEB_EXEC)
  175.       printMsg(DEB_EXEC,"...OK Graph printed", __FILE__, __LINE__);
  176.     #endif
  177.  
  178.     if(isGraphVisInstalled()==1)
  179.     {
  180.       generateImage(dotFileName);
  181.     }
  182.   }
  183.   else
  184.   {
  185.     #if(VERBOSE_LEVEL<=DEB_EXEC)
  186.       printMsg(DEB_EXEC,"Printing AST into Graph file ... Can't open file", __FILE__, __LINE__);
  187.       printMsg(DEB_E, (char *)strerror(errno), __FILE__, __LINE__);
  188.     #endif
  189.   }
  190. }
  191.  
  192. void printGraphDotFromAST(char *dotFileName)
  193. {
  194.  
  195.   FILE * graphFile;
  196.   time_t genTime = time(NULL);
  197.   if(dotFileName==NULL)dotFileName=GRAPHVIZ_CONFIG_FILE;
  198.   graphFile = fopen(dotFileName, "w");
  199.   if(graphFile!=NULL)
  200.   {
  201.     printf("\n;\tGenerating AST Graph from last compilation into %s file ... (%s, col %d)", dotFileName, __FILE__, __LINE__);
  202.     printGraphDotHeader(graphFile);
  203.     printGraphNode(graphFile, rootNode, 0, GRAPH_ROOT);
  204.     printGraphDotFooter(graphFile);
  205.     fclose(graphFile);
  206.  
  207.     #if(VERBOSE_LEVEL<=DEB_EXEC)
  208.       printMsg(DEB_EXEC,"...OK Graph printed", __FILE__, __LINE__);
  209.     #endif
  210.   }
  211.   else
  212.   {
  213.     #if(VERBOSE_LEVEL<=DEB_EXEC)
  214.       printMsg(DEB_EXEC,"Printing AST into Graph file ... Can't open file", __FILE__, __LINE__);
  215.       printMsg(DEB_E, (char *)strerror(errno), __FILE__, __LINE__);
  216.     #endif
  217.   }
  218. }
  219.  
  220. /*
  221.  * **********************************************************
  222.  * Implementation of the header exposed items
  223.  * See graphVizHelper.h for these functions comments
  224.  * **********************************************************
  225.  */
  226.  
  227. void printGraph()
  228. {
  229.   printGraphDotFromAST(GRAPHVIZ_CONFIG_FILE);
  230.   if(isGraphVisInstalled()==1)
  231.   {
  232.     generateImage(GRAPHVIZ_CONFIG_FILE);
  233.   }
  234. }

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 LSD010.
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”2].

Exemple fichier de configuration pour GraphViz

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

  1. digraph LSD10{
  2. bgcolor=white
  3. node [color="#9DACBF", fontcolor="#000000", style=filled];
  4. edge [arrowsize=2, color="#000000"];
  5. "0x91789c0";
  6. "0x91789c0" [shape=doublecircle, color="#677E96", fontcolor="#FFFFFF", label="Functions : \nNo Type Functions\nLine 1 char 4"];
  7. "0x91789c0" -> "0x9178960";
  8. "0x9178960" [shape=hexagon, color="#e6e8f2", fontcolor="#000000", label="Function : \nvoid main\nLine 1 char 8"];
  9. "0x9178960" -> "0x9178900";
  10. "0x9178900" [shape=hexagon, color="#e6e8f2", fontcolor="#000000", label="Structural node : \nNo Type {{decl}statement}\nLine 9 char 1"];
  11. "0x9178900" -> "0x9178898";
  12. "0x9178898" [shape=hexagon, color="#e6e8f2", fontcolor="#000000", label="function body : \nNODE_TYPE_TODO Statements node\nLine 9 char 1"];
  13. "0x9178898" -> "0x9178830";
  14. "0x9178830" [shape=hexagon, color="#e6e8f2", fontcolor="#000000", label="function body : \nNODE_TYPE_TODO Statements node\nLine 9 char 1"];
  15. "0x9178830" -> "0x91787c8";
  16. "0x91787c8" [shape=box, color="#AAB5C6", fontcolor="#000000", label="Statement : \nNODE_TYPE_CHECK Statement : 'LExpr = RExpr;'\nLine 8 char 6"];
  17. "0x91787c8" -> "0x9178750";
  18. "0x9178750" [shape=hexagon, color="#e6e8f2", fontcolor="#000000", label="Right expression : \nboolean _2\nLine 8 char 6"];
  19. "0x9178750" -> "0x91786f0";
  20. "0x91786f0" [shape=hexagon, color="#e6e8f2", fontcolor="#000000", label="Right expression : \nNODE_TYPE_TODO _1\nLine 8 char 6"];
  21. "0x91786f0" -> "0x9178690";
  22. "0x9178690" [shape=box, color="#AAB5C6", fontcolor="#000000", label="Id : \nNo Type k\nLine 8 char 6"];
  23. "0x9178750" -> "0x9178620";
  24. "0x9178620" [shape=box, color="#AAB5C6", fontcolor="#000000", label="number : \ninteger CONSTANT, NUMBER\nLine 8 char 3"];
  25. "0x91787c8" -> "0x91785b8";
  26. "0x91785b8" [shape=box, color="#AAB5C6", fontcolor="#000000", label="Id : \nNo Type b\nLine 8 char 2"];
  27. "0x9178898" -> "0x9178548";
  28. "0x9178548" [shape=box, color="#AAB5C6", fontcolor="#000000", label="Statement : \nNODE_TYPE_CHECK Statement : 'LExpr = RExpr;'\nLine 7 char 4"];
  29. "0x9178548" -> "0x91784d0";
  30. "0x91784d0" [shape=hexagon, color="#e6e8f2", fontcolor="#000000", label="number : \ninteger CONSTANT, NUMBER\nLine 7 char 3"];
  31. "0x9178548" -> "0x9178468";
  32. "0x9178468" [shape=box, color="#AAB5C6", fontcolor="#000000", label="Id : \nNo Type k\nLine 7 char 2"];
  33. "0x9178900" -> "0x91783f8";
  34. "0x91783f8" [shape=box, color="#AAB5C6", fontcolor="#000000", label="Type declarations : \nNo Type Declarations node\nLine 6 char 1"];
  35. "0x91783f8" -> "0x9178390";
  36. "0x9178390" [shape=hexagon, color="#e6e8f2", fontcolor="#000000", label="Type declarations : \nNo Type Declarations node\nLine 6 char 1"];
  37. "0x9178390" -> "0x9178348";
  38. "0x9178348" [shape=box, color="#AAB5C6", fontcolor="#000000", label="Type declaration : \nboolean b\nLine 5 char 9"];
  39. "0x91783f8" -> "0x9178298";
  40. "0x9178298" [shape=box, color="#AAB5C6", fontcolor="#000000", label="Type declaration : \ninteger k\nLine 4 char 9"];
  41. "Generated by the SSHD09 LSD010 compiler\n22/4/2010 4Hr 1\nWith GraphViz engine" [shape=box, color="#FF9933", fontcolor="#000000"];
  42. }

Code source du compilateur LSD010

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

Contents Haut

English translation

You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.

If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.

Thank you in advance.

Document created the 25/04/2010, last modified the 28/10/2018
Source of the printed document:https://www.gaudry.be/en/programmer-arbre-image-noeuds.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

Notes

  1. a,b,c,d,e LSD010 : 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). LSD010 est la version 2010 de la suite LSD80, LSD_02, LSD03, LSD04, LSD05, LSD06, LSD07, LSD08, et LSD09.

  2. a,b Abstract Syntaxic Tree : corresponds to « arbre syntaxique abstrait » en français

  3.  AST : “Abstract Syntaxic Tree” (en français, « arbre syntaxique abstrait »)

Contents Haut

References

  1. View the nbsp;document Language of the document:uk Graph Visualization Software : http://www.graphviz.org/Credits.php, Graphviz (version 24/04/10)
  2. book Language of the document:fr IHDCB332 - Théorie des langages : Syntaxe et sémantique : PY Schobbens, Syntaxe et sémantique (January 2010)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut