/*
 * ast.h : generation of an Abstract Syntaxic Tree,
 * and LSD10 constraints checks (data types, etc.).
 * Part of the compiler project for LSD10 language
 * Gaudry Stéphane
 * More information on http://www.gaudry.be/langages-analyse-syntaxique-ast.html
 */
#ifndef AST_H
	#define AST_H
	#include "common.h"
	#include "const.h"
	#include "astDataRepresentation.h" //todo : don't include this to hide real data representation
 
	/*
	 * **********************************************************
	 * AST creation and destruction functions
	 * **********************************************************
	 */
 
	/**
	 * Allocates memory space and creates an AST node information
	 */
	AstNodeInfo* createASTNodeInfo(char *name, int type, int value);
 
	/**
	 * Allocates memory space and creates an AST node
	 */
	AstNode* createASTNode(debugYacc yaccPsn, int type, AstNodeInfo *info, AstNode *right, AstNode *left);
 
	/**
	 * Creates a default initialized debug structure
	 * Exposed Method
	 */
	DebugInfo* createDebug();
 
	/**
	 * Cleans memory allocated for the AST
	 */
	void finalizeAST();
 
	/*
	 * **********************************************************
	 * AST functions
	 * **********************************************************
	 */
	/**
	 * Sets a node type type
	 */
	void setNodeType(AstNode *node, int type);
	/**
	 * Sets a node subtype
	 */
	void setNodeSubType(AstNode *node, int subtype);
	/**
	 * Sets a definitive var type or function type to avoid check later
	 * Pre-condition: node not null
	 */
	void setComputedType(AstNode *node, int varType);
 
	/**
	 * Returns a human readable string from a given type constant value
	 * Expected : one of the NODE_TYPE_xxx or LEXICAL_VAR_TYPE_xxx or Yacc(yytokentype) constants
	 */
	char* typeToString(int type);
 
	/**
	 * Performs some verifications into the AST for types matching,
	 * validity of main function, etc.
	 */
	void checkAST();
 
	/**
	 * Checks if the first given node is before the second, based on the source code position
	 * Returns one of the AST_CMP_BEFORE, AST_CMP_EQUALS, AST_CMP_AFTER constants, or other values on NULL arg
	 * Pre-condition: node1 and node2 not modified
	 */
	int isBefore(AstNode *node1, AstNode *node2);
 
	/**
	 * Returns the main function node
	 * Pre-condition: a call to checkAST() must be done before, or returns NULL
	 */
	AstNode* getMain();
 
#endif