/*
 * scopeStack.h : Exposed items to manage a stack of scopes
 * for a declaration symbol and his re-declarations
 * Part of the compiler project for LSD10 language
 * Gaudry Stéphane
 * More information on http://www.gaudry.be/langages-lex-yacc-intro.html
 * **********************************************************
 */
#ifndef SCOPE_STACK_H
	#define SCOPE_STACK_H
	#include "common.h"
 
	/**
	 * Stack of scopes for a declaration symbol and his re-declarations
	 * @todo: This exposes the internal data representations, must be hidden
	 */
	typedef struct ScopeStackStruct
	{
		/**
		 * AST node of the variable or function declaration
		 */
		struct astNode *declarationNode;
		VariableUsage usage;
		struct astNode *functionNode;
		struct ScopeStackStruct *parentPtr;
	}ScopeStack;
 
	/**
	 * Builds a scope stack instance
	 */
	ScopeStack *createScopeStack();
	/**
	 * Free resources of the scope stack
	 */
	void finalizeScopeStack(ScopeStack **scopeStack);
	/**
	 * Adds an inner scope into the stack (enter into a new subscope from the current scope)
	 * @param scopeStack current scope where the new scope is defined
	 * @param scopeId id of the subscope
	 * @param declarationNode declaration of the symbol for this scope
	 *
	 * Pre-condition: scopeStack argument not null
	 */
	void pushScopesStack(ScopeStack **scopeStack, int scopeId, AstNode *declarationNode);
	/**
	 * Removes a scope from the stack (exit a scope and return to the parent scope)
	 * @param scopeStack current scope to remove (this pointer will address the parent scope after)
	 * @returns current declaration node from the AST
	 * Pre-condition: scopeStack argument not null
	 */
	AstNode *popScopeStack(ScopeStack **scopeStack);
	/**
	 * Sets scopeDepth for a given ScopeStack item (Not for all of the stack)
	 * @param scopeStack ScopeStack where to set the depth
	 * @param scopeDepth depth value to set
	 * Pre-condition: scopeStack argument not null
	 */
	void setScopesStackDepth(ScopeStack *scopeStack, int scopeDepth);
	/**
	 * Returns the depth of a scopeStack, or ERROR_INT on error
	 * @param scopeStack ScopeStack where to find the depth
	 */
	int getScopeDepth(ScopeStack *scopeStack);
 
#endif