graphVizHelper.c

/*
 * 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);
	}
}