/*
 *  matiec - a compiler for the programming languages defined in IEC 61131-3
 *
 *  Copyright (C) 2009-2011  Mario de Sousa (msousa@fe.up.pt)
 *  Copyright (C) 2007-2011  Laurent Bessard and Edouard Tisserant
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *
 * This code is made available on the understanding that it will not be
 * used in safety-critical situations without a full and competent review.
 */

/*
 * An IEC 61131-3 compiler.
 *
 * Based on the
 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)
 *
 */


/*
 * This is the main stage 3a file.
 *
 * In stage 3a some helpful symbol tables are instanciated and populated.
 * These symbol tables wll then be used by stage3b and atage4 code generators.
 */




#ifndef _SEARCH_UTILS_HH
#define _SEARCH_UTILS_HH

// #include <stdio.h>  /* required for NULL */
#include "../util/symtable.hh"
#include "../util/dsymtable.hh"
#include "../absyntax/absyntax.hh"
#include "../absyntax/visitor.hh"



/* returns 0 if the names are equal!! Case is ignored. */
int compare_identifiers(symbol_c *ident1, symbol_c *ident2);

/* extract the value of an integer from an integer_c object !! */
int extract_integer(symbol_c *integer);
  
/* A symbol table with all globally declared functions... */
extern function_declaration_c null_symbol1;
typedef dsymtable_c<function_declaration_c *, &null_symbol1> function_symtable_t;
extern function_symtable_t function_symtable;

/* A symbol table with all globally declared functions block types... */
extern function_block_declaration_c null_symbol2;
extern symtable_c<function_block_declaration_c *, &null_symbol2> function_block_type_symtable;

/* A symbol table with all globally declared program types... */
extern program_declaration_c null_symbol3;
extern symtable_c<program_declaration_c *, &null_symbol3> program_type_symtable;

/* A symbol table with all user declared type definitions... */
/* Note that function block types and program types have their
 * own symbol tables, so do not get placed in this symbol table!
 *
 * The symbol_c * associated to the value will point to the data type declaration.
 */
extern symbol_c null_symbol4;
extern symtable_c<symbol_c *, &null_symbol4> type_symtable;

/* A symbol table with all values declared for enumerated type... */
/* Notes:
 * - if the value is defined multiple times the value
 * is the null pointer.
 *
 * - The stored symbol_c * associated to the value points to the enumerated_type_name
 * (i.e. the name of the enumerated data type) in which the the value/identifier
 * is used/declared.
 *
 * - We could re-use the null_symbol4 object, but it is safer to use a distinct object
 *   (i.e. it might make it easier to find strange bugs).
 */
extern symbol_c null_symbol5;
extern symtable_c<symbol_c *, &null_symbol5> enumerated_value_symtable;


/***********************************************************************/
/***********************************************************************/
/***********************************************************************/
/***********************************************************************/

#include "spec_init_separator.hh"
#include "array_dimension_iterator.hh"
#include "case_element_iterator.hh"
#include "function_param_iterator.hh"
#include "function_call_iterator.hh"
#include "function_call_param_iterator.hh"
#include "type_initial_value.hh"
#include "search_fb_instance_decl.hh"
#include "search_fb_typedecl.hh"
#include "search_base_type.hh"
#include "search_var_instance_decl.hh"
#include "decompose_var_instance_name.hh"
#include "search_varfb_instance_type.hh"
#include "search_constant_type.hh"
#include "search_il_operand_type.hh"
#include "search_expression_type.hh"
#include "add_en_eno_param_decl.hh"
#include "get_sizeof_datatype.hh"
#include "get_function_type.h"


/***********************************************************************/
/***********************************************************************/
/***********************************************************************/
/***********************************************************************/
/***********************************************************************/




void absyntax_utils_init(symbol_c *tree_root);


#endif /* _SEARCH_UTILS_HH */