mario@181: /*
mario@181:  * (c) 2003 Mario de Sousa
mario@181:  *
mario@181:  * Offered to the public under the terms of the GNU General Public License
mario@181:  * as published by the Free Software Foundation; either version 2 of the
mario@181:  * License, or (at your option) any later version.
mario@181:  *
mario@181:  * This program is distributed in the hope that it will be useful, but
mario@181:  * WITHOUT ANY WARRANTY; without even the implied warranty of
mario@181:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
mario@181:  * Public License for more details.
mario@181:  *
mario@181:  * This code is made available on the understanding that it will not be
mario@181:  * used in safety-critical situations without a full and competent review.
mario@181:  */
mario@181: 
mario@181: /*
mario@181:  * An IEC 61131-3 IL and ST compiler.
mario@181:  *
mario@181:  * Based on the
mario@181:  * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)
mario@181:  *
mario@181:  */
mario@181: 
mario@181: 
mario@181: /* Determine the data type of an ST expression.
mario@181:  * A reference to the relevant type definition is returned.
mario@181:  *
mario@181:  * For example:
mario@181:  *       2 + 3       -> returns reference to a int_type_name_c object.
mario@181:  *       22.2 - 5    -> returns reference to a real_type_name_c object.
mario@181:  *       etc...
mario@181:  */
mario@181: 
mario@181: 
mario@181: 
mario@181: #include "absyntax_utils.hh"
mario@181: #include <typeinfo>
mario@181: 
mario@181: search_expression_type_c::search_expression_type_c(symbol_c *search_scope) {
mario@181:   search_varfb_instance_type = new search_varfb_instance_type_c(search_scope);
mario@181: }
mario@181: 
mario@181: search_expression_type_c::~search_expression_type_c(void) {
mario@181:   delete search_varfb_instance_type;
mario@181: }
mario@181: 
mario@181: /* A helper function... */
mario@181: bool search_expression_type_c::is_bool_type(symbol_c *type_symbol) {
mario@181:   bool_type_name_c tt;
mario@181:   if (type_symbol == NULL) {return true;}
mario@181:   return (typeid(*type_symbol) == typeid(bool_type_name_c));
mario@181: }
mario@181: 
mario@181: /* A helper function... */
mario@181: bool search_expression_type_c::is_time_type(symbol_c *type_symbol) {
mario@181:   if (type_symbol == NULL) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(time_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(date_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(tod_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(dt_type_name_c)) {return true;}
mario@181:   return false;
mario@181: }
mario@181: 
mario@181: /* A helper function... */
mario@181: bool search_expression_type_c::is_string_type(symbol_c *type_symbol) {
mario@181:   if (type_symbol == NULL) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(string_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(wstring_type_name_c)) {return true;}
mario@181:   return false;
mario@181: }
mario@181: 
mario@181: /* A helper function... */
mario@181: bool search_expression_type_c::is_integer_type(symbol_c *type_symbol) {
mario@181:   if (type_symbol == NULL) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(sint_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(int_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(dint_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(lint_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(usint_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(uint_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(udint_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(ulint_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(constant_int_type_name_c)) {return true;}
mario@181:   return false;
mario@181: }
mario@181: 
mario@181: bool search_expression_type_c::is_real_type(symbol_c *type_symbol) {
mario@181:   if (type_symbol == NULL) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(real_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(lreal_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(constant_real_type_name_c)) {return true;}
mario@181:   return false;
mario@181: }
mario@181: 
mario@181: bool search_expression_type_c::is_num_type(symbol_c *type_symbol) {
mario@181:   if (type_symbol == NULL) {return true;}
mario@181:   return is_real_type(type_symbol) || is_integer_type(type_symbol);
mario@181: }
mario@181: 
mario@181: bool search_expression_type_c::is_nbinary_type(symbol_c *type_symbol) {
mario@181:   if (type_symbol == NULL) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(byte_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(word_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(dword_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(lword_type_name_c)) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(constant_int_type_name_c)) {return true;}
mario@181:   return false;
mario@181: }
mario@181: 
mario@181: bool search_expression_type_c::is_binary_type(symbol_c *type_symbol) {
mario@181:   if (type_symbol == NULL) {return true;}
mario@181:   if (typeid(*type_symbol) == typeid(bool_type_name_c)) {return true;}
mario@181:   return is_nbinary_type(type_symbol);
mario@181: }
mario@181: 
mario@181: bool search_expression_type_c::is_same_type(symbol_c *first_type, symbol_c *second_type) {
mario@181:   if (first_type == NULL || second_type == NULL) {return true;}
mario@181:   if (typeid(*first_type) == typeid(*second_type)) {return true;}
mario@181:   if (is_integer_type(first_type) && (typeid(*second_type) == typeid(constant_int_type_name_c))) {return true;}
mario@181:   if ((typeid(*first_type) == typeid(constant_int_type_name_c) && is_integer_type(second_type))) {return true;}
mario@181:   if (is_binary_type(first_type) && (typeid(*second_type) == typeid(constant_int_type_name_c))) {return true;}
mario@181:   if ((typeid(*first_type) == typeid(constant_int_type_name_c) && is_binary_type(second_type))) {return true;}
mario@181:   if (is_real_type(first_type) && (typeid(*second_type) == typeid(constant_real_type_name_c))) {return true;}
mario@181:   if ((typeid(*first_type) == typeid(constant_real_type_name_c) && is_real_type(second_type))) {return true;}
mario@181:   return false;
mario@181: }
mario@181: 
mario@181: symbol_c* search_expression_type_c::common_type(symbol_c *first_type, symbol_c *second_type) {
mario@181:   if (first_type == NULL && second_type == NULL) {return NULL;}
mario@181:   if (first_type == NULL) {return second_type;}
mario@181:   if (second_type == NULL) {return first_type;}
mario@181:   if (typeid(*first_type) == typeid(*second_type)) {return first_type;}
mario@194:   if (is_integer_type(first_type) && (typeid(*second_type) == typeid(constant_int_type_name_c))) {return first_type;}
mario@194:   if ((typeid(*first_type) == typeid(constant_int_type_name_c)) && is_integer_type(second_type)) {return second_type;}
mario@194:   if (is_binary_type(first_type) && (typeid(*second_type) == typeid(constant_int_type_name_c)))  {return first_type;}
mario@194:   if ((typeid(*first_type) == typeid(constant_int_type_name_c)) && is_binary_type(second_type)) {return second_type;}
mario@194:   if (is_real_type(first_type) && (typeid(*second_type) == typeid(constant_real_type_name_c))) {return first_type;}
mario@194:   if ((typeid(*first_type) == typeid(constant_real_type_name_c)) && is_real_type(second_type)) {return second_type;}
mario@181:   return NULL;
mario@181: }
mario@181: 
mario@181: #define compute_standard_function_default search_expression_type_c::compute_standard_function_default
mario@181: #define compute_standard_function_il search_expression_type_c::compute_standard_function_il
mario@181: #include "search_type_code.c"
mario@181: #undef compute_standard_function_default
mario@181: #undef compute_standard_function_il
mario@181: 
mario@181: /*static bool_type_name_c bool_type_name;*/
mario@181: 
mario@181: /* A helper function... */
mario@181: void *search_expression_type_c::compute_boolean_expression(symbol_c *left_type, symbol_c *right_type) {
mario@181:   if (!is_same_type(left_type, right_type))
mario@181:     ERROR;
mario@181:   if (!is_bool_type(left_type) && !is_binary_type(left_type))
mario@181:     ERROR;
mario@181:   if (typeid(*left_type) == typeid(constant_int_type_name_c)) {return (void *)right_type;}
mario@181:   else {return (void *)left_type;}
mario@181: }
mario@181: 
mario@181: /* A helper function... */
mario@181: void *search_expression_type_c::compute_numeric_expression(symbol_c *left_type, symbol_c *right_type) {
mario@181:   if (!is_same_type(left_type, right_type))
mario@181:     ERROR;
mario@181:   if (!is_integer_type(left_type) && !is_real_type(left_type))
mario@181:     ERROR;
mario@181:   if ((typeid(*left_type) == typeid(constant_int_type_name_c)) || (typeid(*left_type) == typeid(constant_real_type_name_c))) {return (void *)right_type;}
mario@181:   else {return (void *)left_type;}
mario@181:   return NULL;
mario@181: }
mario@181: 
mario@181: /* a helper function... */
mario@181: symbol_c *search_expression_type_c::base_type(symbol_c *symbol) {
mario@181:   return (symbol_c *)symbol->accept(search_base_type);
mario@181: }
mario@181: 
mario@181: /*********************/
mario@181: /* B 1.4 - Variables */
mario@181: /*********************/
mario@181: 
mario@181: void *search_expression_type_c::visit(symbolic_variable_c *symbol) {
mario@181:   symbol_c *res;
mario@181:   
mario@181:   /* Nope, now we assume it is a variable, and determine its type... */
mario@181:   res = search_varfb_instance_type->get_type(symbol);
mario@181:   if (NULL != res) return res;
mario@181:   
mario@181:   return NULL;
mario@181: }
mario@181: 
mario@181: /********************************************/
mario@181: /* B 1.4.1 - Directly Represented Variables */
mario@181: /********************************************/
mario@181: void *search_expression_type_c::visit(direct_variable_c *symbol) {
mario@181:   switch (symbol->value[2]) {
mario@194:     case 'X': // bit - 1 bit
mario@181:       return (void *)&bool_type_name;
mario@194:     case 'B': // byte - 8 bits
mario@194:       return (void *)&byte_type_name;
mario@194:     case 'W': // word - 16 bits
mario@194:       return (void *)&word_type_name;
mario@194:     case 'D': // double word - 32 bits
mario@194:       return (void *)&dword_type_name;
mario@194:     case 'L': // long word - 64 bits
mario@194:       return (void *)&lword_type_name;
mario@194:     default:  // if none of the above, then the empty string was used <=> boolean 
mario@194:       return (void *)&bool_type_name;
mario@194:   }
mario@181: }
mario@181: 
mario@181: /*************************************/
mario@181: /* B 1.4.2 - Multi-element variables */
mario@181: /*************************************/
mario@181: 
mario@181: void *search_expression_type_c::visit(array_variable_c *symbol) {
mario@181:   symbol_c *res;
mario@181:   
mario@181:   /* Nope, now we assume it is a variable, and determine its type... */
mario@181:   res = search_varfb_instance_type->get_type(symbol);
mario@181:   if (NULL != res) return res;
mario@181:   
mario@181:   return NULL;
mario@181: }
mario@181: 
mario@181: void *search_expression_type_c::visit(structured_variable_c *symbol) {
mario@181:   symbol_c *res;
mario@181:   
mario@181:   /* Nope, now we assume it is a variable, and determine its type... */
mario@181:   res = search_varfb_instance_type->get_type(symbol);
mario@181:   if (NULL != res) return res;
mario@181:   
mario@181:   return NULL;
mario@181: }
mario@181: 
mario@181: /***************************************/
mario@181: /* B.3 - Language ST (Structured Text) */
mario@181: /***************************************/
mario@181: /***********************/
mario@181: /* B 3.1 - Expressions */
mario@181: /***********************/
mario@181: void *search_expression_type_c::visit(or_expression_c *symbol) {
mario@181:   symbol_c *left_type = base_type((symbol_c *)symbol->l_exp->accept(*this));
mario@181:   symbol_c *right_type = base_type((symbol_c *)symbol->r_exp->accept(*this));
mario@181:   return compute_boolean_expression(left_type, right_type);
mario@181: }
mario@181: 
mario@181: void *search_expression_type_c::visit(xor_expression_c *symbol) {
mario@181:   symbol_c *left_type = base_type((symbol_c *)symbol->l_exp->accept(*this));
mario@181:   symbol_c *right_type = base_type((symbol_c *)symbol->r_exp->accept(*this));
mario@181:   return compute_boolean_expression(left_type, right_type);
mario@181: }
mario@181: 
mario@181: void *search_expression_type_c::visit(and_expression_c *symbol) {
mario@181:   symbol_c *left_type = base_type((symbol_c *)symbol->l_exp->accept(*this));
mario@181:   symbol_c *right_type = base_type((symbol_c *)symbol->r_exp->accept(*this));
mario@181:   return compute_boolean_expression(left_type, right_type); 
mario@181: }
mario@181: 
mario@181: void *search_expression_type_c::visit(equ_expression_c *symbol) {return (void *)&bool_type_name;}
mario@181: void *search_expression_type_c::visit(notequ_expression_c *symbol) {return (void *)&bool_type_name;}
mario@181: void *search_expression_type_c::visit(lt_expression_c *symbol) {return (void *)&bool_type_name;}
mario@181: void *search_expression_type_c::visit(gt_expression_c *symbol) {return (void *)&bool_type_name;}
mario@181: void *search_expression_type_c::visit(le_expression_c *symbol) {return (void *)&bool_type_name;}
mario@181: void *search_expression_type_c::visit(ge_expression_c *symbol) {return (void *)&bool_type_name;}
mario@181: 
mario@181: void *search_expression_type_c::visit(add_expression_c *symbol) {
mario@181:   symbol_c *left_type = base_type((symbol_c *)symbol->l_exp->accept(*this));
mario@181:   symbol_c *right_type = base_type((symbol_c *)symbol->r_exp->accept(*this));
mario@181:   if (typeid(*left_type) == typeid(time_type_name_c) && typeid(*right_type) == typeid(time_type_name_c)) {return (void *)&time_type_name;}
mario@181:   if (typeid(*left_type) == typeid(tod_type_name_c) && typeid(*right_type) == typeid(time_type_name_c)) {return (void *)&tod_type_name;}
mario@181:   if (typeid(*left_type) == typeid(dt_type_name_c) && typeid(*right_type) == typeid(time_type_name_c)) {return (void *)&dt_type_name;}
mario@181:   return compute_numeric_expression(left_type, right_type);
mario@181: }
mario@181: 
mario@181: void *search_expression_type_c::visit(sub_expression_c *symbol) {
mario@181:   symbol_c *left_type = base_type((symbol_c *)symbol->l_exp->accept(*this));
mario@181:   symbol_c *right_type = base_type((symbol_c *)symbol->r_exp->accept(*this));
mario@181:   if (typeid(*left_type) == typeid(time_type_name_c) && typeid(*right_type) == typeid(time_type_name_c)) {return (void *)&time_type_name;}
mario@181:   if (typeid(*left_type) == typeid(date_type_name_c) && typeid(*right_type) == typeid(date_type_name_c)) {return (void *)&time_type_name;}
mario@181:   if (typeid(*left_type) == typeid(tod_type_name_c) && typeid(*right_type) == typeid(time_type_name_c)) {return (void *)&tod_type_name;}
mario@181:   if (typeid(*left_type) == typeid(tod_type_name_c) && typeid(*right_type) == typeid(tod_type_name_c)) {return (void *)&time_type_name;}
mario@181:   if (typeid(*left_type) == typeid(dt_type_name_c) && typeid(*right_type) == typeid(time_type_name_c)) {return (void *)&dt_type_name;}
mario@181:   if (typeid(*left_type) == typeid(dt_type_name_c) && typeid(*right_type) == typeid(dt_type_name_c)) {return (void *)&time_type_name;}
mario@181:   return compute_numeric_expression(left_type, right_type);
mario@181: }
mario@181: 
mario@181: void *search_expression_type_c::visit(mul_expression_c *symbol) {
mario@181:   symbol_c *left_type = base_type((symbol_c *)symbol->l_exp->accept(*this));
mario@181:   symbol_c *right_type = base_type((symbol_c *)symbol->r_exp->accept(*this));
mario@181:   if (typeid(*left_type) == typeid(time_type_name_c) && is_num_type(right_type)) {
mario@181:       return (void *)&time_type_name;
mario@181:   }
mario@181:   return compute_numeric_expression(left_type, right_type);
mario@181: }
mario@181: 
mario@181: void *search_expression_type_c::visit(div_expression_c *symbol) {
mario@181:   symbol_c *left_type = base_type((symbol_c *)symbol->l_exp->accept(*this));
mario@181:   symbol_c *right_type = base_type((symbol_c *)symbol->r_exp->accept(*this));
mario@181:   if (typeid(*left_type) == typeid(time_type_name_c) && is_num_type(right_type)){
mario@181:       return (void *)&time_type_name;
mario@181:   }
mario@181:   return compute_numeric_expression(left_type, right_type);
mario@181: }
mario@181: 
mario@181: void *search_expression_type_c::visit(mod_expression_c *symbol) {
mario@181:   symbol_c *left_type = base_type((symbol_c *)symbol->l_exp->accept(*this));
mario@181:   symbol_c *right_type = base_type((symbol_c *)symbol->r_exp->accept(*this));
mario@181:   return compute_numeric_expression(left_type, right_type);
mario@181: }
mario@181: 
mario@181: void *search_expression_type_c::visit(power_expression_c *symbol) {
mario@181:   symbol_c *left_type = base_type((symbol_c *)symbol->l_exp->accept(*this));
mario@181:   symbol_c *right_type = base_type((symbol_c *)symbol->r_exp->accept(*this));
mario@181:   if (is_real_type(left_type) && is_num_type(right_type)) {
mario@181:       return (void *)left_type;
mario@181:   }
mario@181:   ERROR;
mario@181:   return NULL;
mario@181: }
mario@181: 
mario@181: void *search_expression_type_c::visit(neg_expression_c *symbol) {
mario@181:   symbol_c *exp_type = base_type((symbol_c *)symbol->exp->accept(*this));
mario@181:   if (is_num_type(exp_type) || typeid(*exp_type) == typeid(time_type_name_c)){
mario@181:       return (void *)exp_type;
mario@181:   }
mario@181:   ERROR;
mario@181:   return NULL;
mario@181: }
mario@181: 
mario@181: void *search_expression_type_c::visit(not_expression_c *symbol) {
mario@181:   symbol_c *exp_type = base_type((symbol_c *)symbol->exp->accept(*this));
mario@181:   return compute_boolean_expression(exp_type, exp_type);
mario@181: }
mario@181: 
mario@181: void *search_expression_type_c::visit(function_invocation_c *symbol) {
mario@181:   function_declaration_c *f_decl = function_symtable.find_value(symbol->function_name);
mario@181:   if (f_decl == function_symtable.end_value()) {
mario@181:     void *res = compute_standard_function_default(symbol);
mario@181:     if (res == NULL)
mario@181:        ERROR;
mario@181:     return res;
mario@181:   }
mario@181:   return base_type(f_decl->type_name);
mario@181: }
mario@181: 
mario@181: /*bool_type_name_c     search_expression_type_c::bool_type_name;*/
mario@181: