# HG changeset patch
# User mjsousa
# Date 1414232155 -3600
# Node ID 5074236fb3c495c401803db5cdb88e03c45cea40
# Parent  31e3b3f2eff162ccbb21a91619a3486cf16e224b
fill_candidate_datatypes_c now uses search_varinstance_decl_c instead of search_varfb_instance_type_c (moving towards deprecation of search_varfb_instance_type_c)

diff -r 31e3b3f2eff1 -r 5074236fb3c4 absyntax_utils/get_datatype_info.cc
--- a/absyntax_utils/get_datatype_info.cc	Sun Oct 19 21:30:58 2014 +0100
+++ b/absyntax_utils/get_datatype_info.cc	Sat Oct 25 11:15:55 2014 +0100
@@ -417,6 +417,17 @@
   return get_struct_info_c::get_field_type_id(struct_datatype, struct_fieldname);
 }
 
+symbol_c *get_datatype_info_c::get_array_storedtype_id(symbol_c *type_symbol) {
+  // returns the datatype of the variables stored in the array
+  symbol_c *basetype = search_base_type_c::get_basetype_decl(type_symbol);
+  array_specification_c *symbol = dynamic_cast<array_specification_c *>(basetype);
+
+  if (NULL != symbol) 
+    return symbol->non_generic_type_name;
+  return NULL; // this is not an array!
+}
+  
+  
 /* Returns true if both datatypes are equivalent (not necessarily equal!).
  * WARNING: May return true even though the datatypes are not the same/identicial!!!
  *          This occurs when at least one of the datatypes is of a generic
diff -r 31e3b3f2eff1 -r 5074236fb3c4 absyntax_utils/get_datatype_info.hh
--- a/absyntax_utils/get_datatype_info.hh	Sun Oct 19 21:30:58 2014 +0100
+++ b/absyntax_utils/get_datatype_info.hh	Sat Oct 25 11:15:55 2014 +0100
@@ -60,7 +60,8 @@
     static symbol_c   *get_id    (symbol_c *datatype); /* get the identifier (name) of the datatype); returns NULL if anonymous datatype! Does not work for elementary datatypes!*/
     static const char *get_id_str(symbol_c *datatype); /* get the identifier (name) of the datatype); returns NULL if anonymous datatype! */
 
-    static symbol_c *get_struct_field_type_id      (symbol_c *struct_datatype, symbol_c *struct_fieldname);
+    static symbol_c *get_struct_field_type_id      (symbol_c *struct_datatype, symbol_c *struct_fieldname); // returns datatype of a field in a structure
+    static symbol_c *get_array_storedtype_id       (symbol_c *type_symbol);    // returns the datatype of the variables stored in the array
     static symbol_c *get_ref_to                    (symbol_c *type_symbol);    // Defined in IEC 61131-3 v3 (returns the type that is being referenced/pointed to)        
     
     /* Returns true if both datatypes are equivalent (not necessarily equal!).
diff -r 31e3b3f2eff1 -r 5074236fb3c4 absyntax_utils/search_var_instance_decl.cc
--- a/absyntax_utils/search_var_instance_decl.cc	Sun Oct 19 21:30:58 2014 +0100
+++ b/absyntax_utils/search_var_instance_decl.cc	Sat Oct 25 11:15:55 2014 +0100
@@ -109,6 +109,10 @@
   return (symbol_c *)search_scope->accept(*this);
 }
 
+symbol_c *search_var_instance_decl_c::get_basetype_decl(symbol_c *variable) {
+  return search_base_type_c::get_basetype_decl(get_decl(variable));
+}
+
 search_var_instance_decl_c::vt_t search_var_instance_decl_c::get_vartype(symbol_c *variable) {
   this->current_vartype = none_vt;
   this->current_option  = none_opt;
diff -r 31e3b3f2eff1 -r 5074236fb3c4 absyntax_utils/search_var_instance_decl.hh
--- a/absyntax_utils/search_var_instance_decl.hh	Sun Oct 19 21:30:58 2014 +0100
+++ b/absyntax_utils/search_var_instance_decl.hh	Sat Oct 25 11:15:55 2014 +0100
@@ -130,9 +130,10 @@
     static const unsigned int non_retain_opt  = 0x0003;
 #endif    
     
-    symbol_c *   get_decl   (symbol_c *variable_instance_name); 
-    vt_t         get_vartype(symbol_c *variable_instance_name);
-    opt_t        get_option (symbol_c *variable_instance_name);
+    symbol_c *get_decl          (symbol_c *variable_instance_name); 
+    symbol_c *get_basetype_decl (symbol_c *variable_instance_name); 
+    vt_t      get_vartype       (symbol_c *variable_instance_name);
+    opt_t     get_option        (symbol_c *variable_instance_name);
 
   private:
     symbol_c *search_scope;
diff -r 31e3b3f2eff1 -r 5074236fb3c4 stage3/fill_candidate_datatypes.cc
--- a/stage3/fill_candidate_datatypes.cc	Sun Oct 19 21:30:58 2014 +0100
+++ b/stage3/fill_candidate_datatypes.cc	Sat Oct 25 11:15:55 2014 +0100
@@ -271,7 +271,7 @@
 fill_candidate_datatypes_c::fill_candidate_datatypes_c(symbol_c *ignore) {
 	il_operand = NULL;
 	prev_il_instruction = NULL;
-	search_varfb_instance_type = NULL;
+	search_var_instance_decl = NULL;
 	current_enumerated_spec_type = NULL;
 }
 
@@ -555,7 +555,7 @@
  *        CU counter_var
  */
 void *fill_candidate_datatypes_c::handle_implicit_il_fb_call(symbol_c *il_instruction, const char *param_name, symbol_c *&called_fb_declaration) {
-	symbol_c *fb_decl = (NULL == il_operand)? NULL : search_varfb_instance_type->get_basetype_decl(il_operand);
+	symbol_c *fb_decl = (NULL == il_operand)? NULL : search_var_instance_decl->get_basetype_decl(il_operand);
 	if (! get_datatype_info_c::is_function_block(fb_decl)) fb_decl = NULL;
 
 	/* Although a call to a non-declared FB is a semantic error, this is currently caught by stage 2! */
@@ -1173,10 +1173,11 @@
 	/*  NOTE: We need to fully determine the datatype of each element in the structured_variable inside this fill_candidate_datatypes class!
 	 *        Basically, for variables (be they symbolic_variable, structured_variable, array_variable), we do the narrow algorithm
 	 *        in this fill_candidate_datatypes_c itself!
-	 *        This is needed because we need to know in which scope (i.e. the datatype of the recor_variable in a structtured_variable_c)
-	 *        we will search for the field_variable of the structured_variable_c
+	 *        This is needed because we need to know in which scope (i.e. the datatype of the record_variable in a structtured_variable_c)
+	 *        we will search for the field_variable of the structured_variable_c. Similarly, it is also used to determine the datatype 
+	 *        to which a REF_TO variable points to. 
 	 */
-	symbol->datatype = search_varfb_instance_type->get_basetype_decl(symbol); // Do the narrow algorithm in this fill_candidate_datatypes_c!!
+	symbol->datatype = search_var_instance_decl->get_basetype_decl(symbol); // Do the narrow algorithm in this fill_candidate_datatypes_c!!
 	add_datatype_to_candidate_list(symbol, symbol->datatype); /* will only add if non NULL */
 	if (debug) std::cout << "VAR [" << symbol->candidate_datatypes.size() << "]\n";
 	return NULL;
@@ -1213,25 +1214,6 @@
 /*  subscripted_variable '[' subscript_list ']' */
 // SYM_REF2(array_variable_c, subscripted_variable, subscript_list)
 void *fill_candidate_datatypes_c::visit(array_variable_c *symbol) {
-	/* get the declaration of the data type __stored__ in the array... */
-	/* if we were to want the data type of the array itself, then we should call_param_name
-	 * search_varfb_instance_type->get_basetype_decl(symbol->subscripted_variable)
-	 */
-	add_datatype_to_candidate_list(symbol, search_varfb_instance_type->get_basetype_decl(symbol));   /* will only add if non NULL */
-
-	/*  NOTE: We need to fully determine the datatype of each element in the structured_variable inside this fill_candidate_datatypes class!
-	 *        Basically, for variables (be they symbolic_variable, structured_variable, array_variable), we do the narrow algorithm
-	 *        in this fill_candidate_datatypes_c itself!
-	 *        This is needed because we need to know in which scope (i.e. the datatype of the recor_variable in a structtured_variable_c)
-	 *        we will search for the field_variable of the structured_variable_c
-	 */
-	if (symbol->candidate_datatypes.size() == 1)
-	  // narrow the symbol->datatype for this strcutured_variable as explained above!
-	  symbol->datatype = symbol->candidate_datatypes[0];
-
-	/* recursively call the subscript list, so we can check the data types of the expressions used for the subscripts */
-	symbol->subscript_list->accept(*this);
-
 	/* recursively call the subscripted_variable. We need to do this since the array variable may be stored inside a structured
 	 * variable (i.e. if it is an element inside a struct), in which case we want to recursively visit every element of the struct,
 	 * as it may contain more arrays whose subscripts must also be visited!
@@ -1250,6 +1232,22 @@
 	 */
 	symbol->subscripted_variable->accept(*this);
 
+	add_datatype_to_candidate_list(symbol, search_base_type_c::get_basetype_decl(get_datatype_info_c::get_array_storedtype_id(symbol->subscripted_variable->datatype)));   /* will only add if non NULL */
+
+	/*  NOTE: We need to fully determine the datatype of each element in the structured_variable inside this fill_candidate_datatypes class!
+	 *        Basically, for variables (be they symbolic_variable, structured_variable, array_variable), we do the narrow algorithm
+	 *        in this fill_candidate_datatypes_c itself!
+	 *        This is needed because we need to know in which scope (i.e. the datatype of the record_variable in a structtured_variable_c)
+	 *        we will search for the field_variable of the structured_variable_c. Similarly, it is also used to determine the datatype 
+	 *        to which a REF_TO variable points to. 
+	 */
+	if (symbol->candidate_datatypes.size() == 1)
+	  // narrow the symbol->datatype for this array_variable as explained above!
+	  symbol->datatype = symbol->candidate_datatypes[0];
+
+	/* recursively call the subscript list, so we can check the data types of the expressions used for the subscripts */
+	symbol->subscript_list->accept(*this);
+
 	if (debug) std::cout << "ARRAY_VAR [" << symbol->candidate_datatypes.size() << "]\n";	
 	return NULL;
 }
@@ -1279,8 +1277,9 @@
 	/*  NOTE: We need to fully determine the datatype of each element in the structured_variable inside this fill_candidate_datatypes class!
 	 *        Basically, for variables (be they symbolic_variable, structured_variable, array_variable), we do the narrow algorithm
 	 *        in this fill_candidate_datatypes_c itself!
-	 *        This is needed because we need to know in which scope (i.e. the datatype of the recor_variable in a structtured_variable_c)
-	 *        we will search for the field_variable of the structured_variable_c
+	 *        This is needed because we need to know in which scope (i.e. the datatype of the record_variable in a structtured_variable_c)
+	 *        we will search for the field_variable of the structured_variable_c. Similarly, it is also used to determine the datatype 
+	 *        to which a REF_TO variable points to. 
 	 */
 	if (NULL != symbol->record_variable->datatype) 
 	  // We relly on the fact that we have already narrowed the symbol->datatype for the record variable, and use it as the scope in which the filed_variable is declared!
@@ -1299,9 +1298,6 @@
 
 void *fill_candidate_datatypes_c::visit(var1_list_c *symbol) {
   for(int i = 0; i < symbol->n; i++) {
-    /* We don't really need to set the datatype of each variable. We just check the declaration itself! 
-    add_datatype_to_candidate_list(symbol->elements[i], search_varfb_instance_type->get_basetype_decl(symbol->elements[i])); // will only add if non NULL 
-    */
     symbol->elements[i]->accept(*this); // handle the extensible_input_parameter_c, etc...
   }
   return NULL;
@@ -1418,11 +1414,11 @@
 	local_enumerated_value_symtable.reset();
 	symbol->var_declarations_list->accept(populate_enumvalue_symtable);
 
-	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);
+	search_var_instance_decl = new search_var_instance_decl_c(symbol);
 	symbol->var_declarations_list->accept(*this);
 	symbol->function_body->accept(*this);
-	delete search_varfb_instance_type;
-	search_varfb_instance_type = NULL;
+	delete search_var_instance_decl;
+	search_var_instance_decl = NULL;
 
 	local_enumerated_value_symtable.reset();
 	return NULL;
@@ -1436,11 +1432,11 @@
 	local_enumerated_value_symtable.reset();
 	symbol->var_declarations->accept(populate_enumvalue_symtable);
 
-	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);
+	search_var_instance_decl = new search_var_instance_decl_c(symbol);
 	symbol->var_declarations->accept(*this);
 	symbol->fblock_body->accept(*this);
-	delete search_varfb_instance_type;
-	search_varfb_instance_type = NULL;
+	delete search_var_instance_decl;
+	search_var_instance_decl = NULL;
 
 	local_enumerated_value_symtable.reset();
 	
@@ -1460,11 +1456,11 @@
 	local_enumerated_value_symtable.reset();
 	symbol->var_declarations->accept(populate_enumvalue_symtable);
 	
-	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);
+	search_var_instance_decl = new search_var_instance_decl_c(symbol);
 	symbol->var_declarations->accept(*this);
 	symbol->function_block_body->accept(*this);
-	delete search_varfb_instance_type;
-	search_varfb_instance_type = NULL;
+	delete search_var_instance_decl;
+	search_var_instance_decl = NULL;
 
 	local_enumerated_value_symtable.reset();
 	return NULL;
@@ -1679,7 +1675,7 @@
 /* NOTE: The parameter 'called_fb_declaration'is used to pass data between stage 3 and stage4 */
 // SYM_REF4(il_fb_call_c, il_call_operator, fb_name, il_operand_list, il_param_list, symbol_c *called_fb_declaration)
 void *fill_candidate_datatypes_c::visit(il_fb_call_c *symbol) {
-	symbol_c *fb_decl = search_varfb_instance_type->get_basetype_decl(symbol->fb_name);
+	symbol_c *fb_decl = search_var_instance_decl->get_basetype_decl(symbol->fb_name);
 	if (! get_datatype_info_c::is_function_block(fb_decl)) fb_decl = NULL;
 
 	/* Although a call to a non-declared FB is a semantic error, this is currently caught by stage 2! */
@@ -1948,8 +1944,9 @@
   /*  NOTE: We need to fully determine the datatype of each element in the structured_variable inside this fill_candidate_datatypes class!
    *        Basically, for variables (be they symbolic_variable, structured_variable, array_variable), we do the narrow algorithm
    *        in this fill_candidate_datatypes_c itself!
-   *        This is needed because we need to know in which scope (i.e. the datatype of the recor_variable in a structtured_variable_c)
-   *        we will search for the field_variable of the structured_variable_c
+   *        This is needed because we need to know in which scope (i.e. the datatype of the record_variable in a structtured_variable_c)
+   *        we will search for the field_variable of the structured_variable_c. Similarly, it is also used to determine the datatype 
+   *        to which a REF_TO variable points to. 
    * 
    *        Since the deref_operator_c may be used inside structures, we must narrow it here, if possible!
    */
@@ -2120,7 +2117,7 @@
 /* B 3.2.2 Subprogram Control Statements */
 /*****************************************/
 void *fill_candidate_datatypes_c::visit(fb_invocation_c *symbol) {
-	symbol_c *fb_decl = search_varfb_instance_type->get_basetype_decl(symbol->fb_name);
+	symbol_c *fb_decl = search_var_instance_decl->get_basetype_decl(symbol->fb_name);
 	if (! get_datatype_info_c::is_function_block(fb_decl )) fb_decl = NULL;
 	if (NULL == fb_decl) ERROR; /* Although a call to a non-declared FB is a semantic error, this is currently caught by stage 2! */
 	
diff -r 31e3b3f2eff1 -r 5074236fb3c4 stage3/fill_candidate_datatypes.hh
--- a/stage3/fill_candidate_datatypes.hh	Sun Oct 19 21:30:58 2014 +0100
+++ b/stage3/fill_candidate_datatypes.hh	Sat Oct 25 11:15:55 2014 +0100
@@ -56,7 +56,7 @@
 class fill_candidate_datatypes_c: public iterator_visitor_c {
 
   private:
-    search_varfb_instance_type_c *search_varfb_instance_type;
+    search_var_instance_decl_c *search_var_instance_decl;
     /* When calling a function block, we must first find it's type,
      * by searching through the declarations of the variables currently
      * in scope.