lbessard@70: /* lbessard@70: * (c) 2003 Mario de Sousa lbessard@70: * lbessard@70: * Offered to the public under the terms of the GNU General Public License lbessard@70: * as published by the Free Software Foundation; either version 2 of the lbessard@70: * License, or (at your option) any later version. lbessard@70: * lbessard@70: * This program is distributed in the hope that it will be useful, but lbessard@70: * WITHOUT ANY WARRANTY; without even the implied warranty of lbessard@70: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General lbessard@70: * Public License for more details. lbessard@70: * lbessard@70: * This code is made available on the understanding that it will not be lbessard@70: * used in safety-critical situations without a full and competent review. lbessard@70: */ lbessard@70: lbessard@70: /* lbessard@70: * An IEC 61131-3 IL and ST compiler. lbessard@70: * lbessard@70: * Based on the lbessard@70: * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10) lbessard@70: * lbessard@70: */ lbessard@70: lbessard@70: lbessard@70: /* lbessard@70: * Function call parameter iterator. lbessard@70: * It will iterate through the formal parameters of a function call lbessard@70: * (i.e. function calls using the foo(, , ...) syntax). lbessard@70: * and/or search through the non-formal parameters of a function call lbessard@70: * (i.e. function calls using the foo( = , = , ...) syntax). lbessard@70: * lbessard@70: * Calls to function blocks and programs are also supported. lbessard@70: * lbessard@70: * This is part of the 4th stage that generates lbessard@70: * a c++ source program equivalent to the IL and ST lbessard@70: * code. lbessard@70: */ lbessard@70: lbessard@70: lbessard@70: lbessard@70: lbessard@70: lbessard@70: lbessard@70: //#include /* required for NULL */ lbessard@70: //#include lbessard@70: //#include lbessard@70: lbessard@70: //#include "../../util/symtable.hh" lbessard@70: lbessard@70: //#include "generate_c.hh" lbessard@70: lbessard@70: lbessard@70: #include "../../absyntax/visitor.hh" lbessard@70: lbessard@70: lbessard@70: /* lbessard@70: * Function call parameter iterator. lbessard@70: * It will iterate through the formal parameters of a function call lbessard@70: * (i.e. function calls using the foo(, , ...) syntax). lbessard@70: * and/or search through the non-formal parameters of a function call lbessard@70: * (i.e. function calls using the foo( = , = , ...) syntax). lbessard@70: * lbessard@70: * Calls to function blocks and programs are also supported. lbessard@70: * lbessard@70: * Note that calls to next() will only iterate through formal parameters, lbessard@70: * and calls to search() will only serach through non-formal parameters. lbessard@70: */ lbessard@70: lbessard@70: class function_call_param_iterator_c : public null_visitor_c { lbessard@70: private: lbessard@70: /* a pointer to the function call lbessard@70: * (or function block or program call!) lbessard@70: */ lbessard@70: symbol_c *f_call; lbessard@70: int next_param, param_count; lbessard@70: identifier_c *search_param_name; lbessard@70: lbessard@70: /* Which operation of the class was called... lbessard@70: * Search a parameter, or iterate to the next parameter. lbessard@70: */ lbessard@70: typedef enum {iterate_op, search_op} operation_t; lbessard@70: operation_t current_operation; lbessard@70: lbessard@70: private: lbessard@70: void *search_list(list_c *list) { lbessard@70: switch (current_operation) { lbessard@70: case iterate_op: lbessard@70: for(int i = 0; i < list->n; i++) { lbessard@70: void *res = list->elements[i]->accept(*this); lbessard@70: if (NULL != res) { lbessard@70: /* It went through the handle_parameter_assignment() function, lbessard@70: * and is therefore a parameter assignment ( = ), lbessard@70: * and not a simple expression (). lbessard@70: */ lbessard@70: /* we do nothing... */ lbessard@70: } else { lbessard@70: param_count++; lbessard@70: if (param_count == next_param) { lbessard@70: return list->elements[i]; lbessard@70: } lbessard@70: } lbessard@70: } lbessard@70: return NULL; lbessard@70: break; lbessard@70: lbessard@70: case search_op: lbessard@70: for(int i = 0; i < list->n; i++) { lbessard@70: void *res = list->elements[i]->accept(*this); lbessard@70: if (res != NULL) lbessard@70: return res; lbessard@70: } lbessard@70: return NULL; lbessard@70: break; lbessard@70: } /* switch */ lbessard@70: return NULL; lbessard@70: } lbessard@70: lbessard@70: lbessard@70: lbessard@70: void *handle_parameter_assignment(symbol_c *variable_name, symbol_c *expression) { lbessard@70: switch (current_operation) { lbessard@70: case iterate_op: lbessard@70: /* UGLY HACK -> this will be detected in the search_list() function */ lbessard@70: return (void *)this; /* anything, as long as it is not NULL!! */ lbessard@70: break; lbessard@70: lbessard@70: case search_op: lbessard@70: identifier_c *variable_name2 = dynamic_cast(variable_name); lbessard@70: if (variable_name2 == NULL) ERROR; lbessard@70: if (strcasecmp(search_param_name->value, variable_name2->value) == 0) lbessard@70: /* FOUND! This is the same parameter!! */ lbessard@70: return (void *)expression; lbessard@70: return NULL; lbessard@70: break; lbessard@70: } lbessard@70: lbessard@70: ERROR; lbessard@70: return NULL; lbessard@70: } lbessard@70: lbessard@70: lbessard@70: lbessard@70: public: lbessard@70: /* start off at the first parameter once again... */ lbessard@70: void reset(void) { lbessard@70: next_param = param_count = 0; lbessard@70: } lbessard@70: lbessard@70: /* initialise the iterator object. lbessard@70: * We must be given a reference to the function/program/function block call lbessard@70: * that will be analysed... lbessard@70: */ lbessard@70: function_call_param_iterator_c(symbol_c *f_call) { lbessard@70: /* It is expected that f_call will reference one of the following: lbessard@70: * program_configuration_c lbessard@70: * function_invocation_c lbessard@70: * fb_invocation_c lbessard@70: * il_function_call_c lbessard@70: * il_formal_funct_call_c lbessard@70: * ... (have I missed any?) lbessard@70: */ lbessard@70: this->f_call = f_call; lbessard@70: search_param_name = NULL; lbessard@70: reset(); lbessard@70: } lbessard@70: lbessard@70: /* Skip to the next parameter. After object creation, lbessard@70: * the object references on parameter _before_ the first, so lbessard@70: * this function must be called once to get the object to lbessard@70: * reference the first parameter... lbessard@70: * lbessard@70: * Returns whatever is being passed to the parameter! lbessard@70: */ lbessard@70: symbol_c *next(void) { lbessard@70: param_count = 0; lbessard@70: next_param++; lbessard@70: current_operation = function_call_param_iterator_c::iterate_op; lbessard@70: void *res = f_call->accept(*this); lbessard@70: return (symbol_c *)res; lbessard@70: } lbessard@70: lbessard@70: /* Search for the value passed to the parameter named ... */ lbessard@70: symbol_c *search(symbol_c *param_name) { lbessard@70: if (NULL == param_name) ERROR; lbessard@70: search_param_name = dynamic_cast(param_name); lbessard@70: if (NULL == search_param_name) ERROR; lbessard@70: current_operation = function_call_param_iterator_c::search_op; lbessard@70: void *res = f_call->accept(*this); lbessard@70: return (symbol_c *)res; lbessard@70: } lbessard@70: lbessard@70: lbessard@70: lbessard@70: lbessard@70: private: lbessard@70: /********************************/ lbessard@70: /* B 1.7 Configuration elements */ lbessard@70: /********************************/ lbessard@70: lbessard@70: /* lbessard@70: CONFIGURATION configuration_name lbessard@70: optional_global_var_declarations lbessard@70: (resource_declaration_list | single_resource_declaration) lbessard@70: optional_access_declarations lbessard@70: optional_instance_specific_initializations lbessard@70: END_CONFIGURATION lbessard@70: */ lbessard@70: /* lbessard@70: SYM_REF6(configuration_declaration_c, configuration_name, global_var_declarations, resource_declarations, access_declarations, instance_specific_initializations, unused) lbessard@70: */ lbessard@70: lbessard@70: /* helper symbol for configuration_declaration */ lbessard@70: /* lbessard@70: SYM_LIST(resource_declaration_list_c) lbessard@70: */ lbessard@70: lbessard@70: /* lbessard@70: RESOURCE resource_name ON resource_type_name lbessard@70: optional_global_var_declarations lbessard@70: single_resource_declaration lbessard@70: END_RESOURCE lbessard@70: */ lbessard@70: /* lbessard@70: SYM_REF4(resource_declaration_c, resource_name, resource_type_name, global_var_declarations, resource_declaration) lbessard@70: */ lbessard@70: lbessard@70: /* task_configuration_list program_configuration_list */ lbessard@70: /* lbessard@70: SYM_REF2(single_resource_declaration_c, task_configuration_list, program_configuration_list) lbessard@70: */ lbessard@70: lbessard@70: /* helper symbol for single_resource_declaration */ lbessard@70: /* lbessard@70: SYM_LIST(task_configuration_list_c) lbessard@70: */ lbessard@70: lbessard@70: /* helper symbol for single_resource_declaration */ lbessard@70: /* lbessard@70: SYM_LIST(program_configuration_list_c) lbessard@70: */ lbessard@70: lbessard@70: /* helper symbol for lbessard@70: * - access_path lbessard@70: * - instance_specific_init lbessard@70: */ lbessard@70: /* lbessard@70: SYM_LIST(any_fb_name_list_c) lbessard@70: */ lbessard@70: lbessard@70: /* [resource_name '.'] global_var_name ['.' structure_element_name] */ lbessard@70: /* lbessard@70: SYM_REF4(global_var_reference_c, resource_name, global_var_name, structure_element_name, unused) lbessard@70: */ lbessard@70: lbessard@70: /* prev_declared_program_name '.' symbolic_variable */ lbessard@70: /* lbessard@70: SYM_REF2(program_output_reference_c, program_name, symbolic_variable) lbessard@70: */ lbessard@70: lbessard@70: /* TASK task_name task_initialization */ lbessard@70: /* lbessard@70: SYM_REF2(task_configuration_c, task_name, task_initialization) lbessard@70: */ lbessard@70: lbessard@70: /* '(' [SINGLE ASSIGN data_source ','] [INTERVAL ASSIGN data_source ','] PRIORITY ASSIGN integer ')' */ lbessard@70: /* lbessard@70: SYM_REF4(task_initialization_c, single_data_source, interval_data_source, priority_data_source, unused) lbessard@70: */ lbessard@70: lbessard@70: /* PROGRAM [RETAIN | NON_RETAIN] program_name [WITH task_name] ':' program_type_name ['(' prog_conf_elements ')'] */ lbessard@70: // SYM_REF6(program_configuration_c, retain_option, program_name, task_name, program_type_name, prog_conf_elements, unused) lbessard@70: void *visit(program_configuration_c *symbol) { lbessard@70: TRACE("program_configuration_c"); lbessard@70: return symbol->prog_conf_elements->accept(*this); lbessard@70: } lbessard@70: lbessard@70: /* prog_conf_elements ',' prog_conf_element */ lbessard@70: // SYM_LIST(prog_conf_elements_c) lbessard@70: void *visit(prog_conf_elements_c *symbol) { lbessard@70: TRACE("prog_conf_elements_c"); lbessard@70: return search_list(symbol); lbessard@70: } lbessard@70: lbessard@70: /* fb_name WITH task_name */ lbessard@70: /* lbessard@70: SYM_REF2(fb_task_c, fb_name, task_name) lbessard@70: */ lbessard@70: lbessard@70: /* any_symbolic_variable ASSIGN prog_data_source */ lbessard@70: // SYM_REF2(prog_cnxn_assign_c, symbolic_variable, prog_data_source) lbessard@70: void *visit(prog_cnxn_assign_c *symbol) { lbessard@70: TRACE("prog_cnxn_assign_c"); lbessard@70: lbessard@70: /* NOTE: symbolic_variable may be something other than a symbolic_variable_c, but I (Mario) lbessard@70: * do not understand the semantics that should be implmeneted if it is not a lbessard@70: * symbolic_variable, so for the moment we simply give up! lbessard@70: */ lbessard@70: symbolic_variable_c *symb_var = dynamic_cast(symbol->symbolic_variable); lbessard@70: if (NULL == symb_var) lbessard@70: ERROR; lbessard@70: lbessard@70: return handle_parameter_assignment(symb_var->var_name, symbol->prog_data_source); lbessard@70: } lbessard@70: lbessard@70: /* any_symbolic_variable SENDTO data_sink */ lbessard@70: // SYM_REF2(prog_cnxn_sendto_c, symbolic_variable, prog_data_source) lbessard@70: void *visit(prog_cnxn_sendto_c *symbol) { lbessard@70: TRACE("prog_cnxn_sendto_c"); lbessard@70: lbessard@70: /* NOTE: symbolic_variable may be something other than a symbolic_variable_c, but I (Mario) lbessard@70: * do not understand the semantics that should be implmeneted if it is not a lbessard@70: * symbolic_variable, so for the moment we simply give up! lbessard@70: */ lbessard@70: symbolic_variable_c *symb_var = dynamic_cast(symbol->symbolic_variable); lbessard@70: if (NULL == symb_var) lbessard@70: ERROR; lbessard@70: lbessard@70: return handle_parameter_assignment(symb_var->var_name, symbol->data_sink); lbessard@70: } lbessard@70: lbessard@70: /* VAR_CONFIG instance_specific_init_list END_VAR */ lbessard@70: /* lbessard@70: SYM_REF2(instance_specific_initializations_c, instance_specific_init_list, unused) lbessard@70: */ lbessard@70: lbessard@70: /* helper symbol for instance_specific_initializations */ lbessard@70: /* lbessard@70: SYM_LIST(instance_specific_init_list_c) lbessard@70: */ lbessard@70: lbessard@70: /* resource_name '.' program_name '.' {fb_name '.'} lbessard@70: ((variable_name [location] ':' located_var_spec_init) | (fb_name ':' fb_initialization)) lbessard@70: */ lbessard@70: /* lbessard@70: SYM_REF6(instance_specific_init_c, resource_name, program_name, any_fb_name_list, variable_name, location, initialization) lbessard@70: */ lbessard@70: lbessard@70: /* helper symbol for instance_specific_init */ lbessard@70: /* function_block_type_name ':=' structure_initialization */ lbessard@70: /* lbessard@70: SYM_REF2(fb_initialization_c, function_block_type_name, structure_initialization) lbessard@70: */ lbessard@70: lbessard@70: lbessard@70: lbessard@70: lbessard@70: lbessard@70: lbessard@70: /****************************************/ lbessard@70: /* B.2 - Language IL (Instruction List) */ lbessard@70: /****************************************/ lbessard@70: /***********************************/ lbessard@70: /* B 2.1 Instructions and Operands */ lbessard@70: /***********************************/ lbessard@70: lbessard@70: /* | function_name [il_operand_list] */ lbessard@70: // SYM_REF2(il_function_call_c, function_name, il_operand_list) lbessard@70: void *visit(il_function_call_c *symbol) { lbessard@70: TRACE("il_function_call_c"); lbessard@70: if (NULL != symbol->il_operand_list) lbessard@70: return symbol->il_operand_list->accept(*this); lbessard@70: return NULL; lbessard@70: } lbessard@70: lbessard@70: lbessard@70: /* | function_name '(' eol_list [il_param_list] ')' */ lbessard@70: // SYM_REF2(il_formal_funct_call_c, function_name, il_param_list) lbessard@70: void *visit(il_formal_funct_call_c *symbol) { lbessard@70: TRACE("il_formal_funct_call_c"); lbessard@70: if (NULL != symbol->il_param_list) lbessard@70: return symbol->il_param_list->accept(*this); lbessard@70: return NULL; lbessard@70: } lbessard@70: lbessard@70: lbessard@70: /* il_call_operator prev_declared_fb_name lbessard@70: * | il_call_operator prev_declared_fb_name '(' ')' lbessard@70: * | il_call_operator prev_declared_fb_name '(' eol_list ')' lbessard@70: * | il_call_operator prev_declared_fb_name '(' il_operand_list ')' lbessard@70: * | il_call_operator prev_declared_fb_name '(' eol_list il_param_list ')' lbessard@70: */ lbessard@70: // SYM_REF4(il_fb_call_c, il_call_operator, fb_name, il_operand_list, il_param_list) lbessard@70: void *visit(il_fb_call_c *symbol) { lbessard@70: TRACE("il_fb_call_c"); lbessard@70: /* the following should never occur. In reality the syntax parser lbessard@70: * will guarantee that they never occur, but it makes it easier to lbessard@70: * understand the remaining code :-) lbessard@70: */ lbessard@70: //if ((NULL == symbol->il_operand_list) && (NULL == symbol->il_param_list)) ERROR; lbessard@70: //if ((NULL != symbol->il_operand_list) && (NULL != symbol->il_param_list)) ERROR; lbessard@70: lbessard@70: if (NULL != symbol->il_operand_list) lbessard@70: return symbol->il_operand_list->accept(*this); lbessard@70: if (NULL != symbol->il_param_list) lbessard@70: return symbol->il_param_list->accept(*this); lbessard@70: return NULL; lbessard@70: } lbessard@70: lbessard@70: lbessard@70: lbessard@70: /* | il_operand_list ',' il_operand */ lbessard@70: // SYM_LIST(il_operand_list_c) lbessard@70: void *visit(il_operand_list_c *symbol) { lbessard@70: TRACE("il_operand_list_c"); lbessard@70: return search_list(symbol); lbessard@70: } lbessard@70: lbessard@70: lbessard@70: /* | il_initial_param_list il_param_instruction */ lbessard@70: // SYM_LIST(il_param_list_c) lbessard@70: void *visit(il_param_list_c *symbol) { lbessard@70: TRACE("il_param_list_c"); lbessard@70: return search_list(symbol); lbessard@70: } lbessard@70: lbessard@70: /* il_assign_operator il_operand lbessard@70: * | il_assign_operator '(' eol_list simple_instr_list ')' lbessard@70: */ lbessard@70: // SYM_REF4(il_param_assignment_c, il_assign_operator, il_operand, simple_instr_list, unused) lbessard@70: void *visit(il_param_assignment_c *symbol) { lbessard@70: TRACE("il_param_assignment_c"); lbessard@70: lbessard@70: // TODO : We do not yet handle a instruction list passed as parameter !!! lbessard@70: // since we do not yet support it, it is best to simply stop than to fail silently... lbessard@70: if (NULL != symbol->simple_instr_list) ERROR; lbessard@70: lbessard@70: return handle_parameter_assignment(symbol->il_assign_operator, symbol->il_operand); lbessard@70: } lbessard@70: lbessard@70: /* il_assign_out_operator variable */ lbessard@70: // SYM_REF2(il_param_out_assignment_c, il_assign_out_operator, variable); lbessard@70: void *visit(il_param_out_assignment_c *symbol) { lbessard@70: TRACE("il_param_out_assignment_c"); lbessard@70: return handle_parameter_assignment((symbol_c *)symbol->il_assign_out_operator->accept(*this), symbol->variable); lbessard@70: } lbessard@70: lbessard@70: lbessard@70: /*******************/ lbessard@70: /* B 2.2 Operators */ lbessard@70: /*******************/ lbessard@70: /*| [NOT] any_identifier SENDTO */ lbessard@70: // SYM_REF2(il_assign_out_operator_c, option, variable_name) lbessard@70: void *visit(il_assign_out_operator_c *symbol) { lbessard@70: TRACE("il_assign_out_operator_c"); lbessard@70: lbessard@70: // TODO : Handle not_param !!! lbessard@70: // we do not yet support it, so it is best to simply stop than to fail silently... lbessard@70: if (NULL != symbol->option) ERROR; lbessard@70: lbessard@70: return (void *)symbol->variable_name; lbessard@70: } lbessard@70: lbessard@70: lbessard@70: lbessard@70: lbessard@70: /***************************************/ lbessard@70: /* B.3 - Language ST (Structured Text) */ lbessard@70: /***************************************/ lbessard@70: /***********************/ lbessard@70: /* B 3.1 - Expressions */ lbessard@70: /***********************/ lbessard@70: lbessard@70: /* lbessard@70: SYM_REF2(function_invocation_c, function_name, parameter_assignment_list) lbessard@70: */ lbessard@70: void *visit(function_invocation_c *symbol) { lbessard@70: TRACE("function_invocation_c"); lbessard@70: if ((symbol_c *)symbol == f_call && symbol->parameter_assignment_list != NULL) lbessard@70: return symbol->parameter_assignment_list->accept(*this); lbessard@70: else lbessard@70: return NULL; lbessard@70: } lbessard@70: lbessard@70: lbessard@70: lbessard@70: lbessard@70: /********************/ lbessard@70: /* B 3.2 Statements */ lbessard@70: /********************/ lbessard@70: lbessard@70: /*********************************/ lbessard@70: /* B 3.2.1 Assignment Statements */ lbessard@70: /*********************************/ lbessard@70: /* lbessard@70: SYM_REF2(assignment_statement_c, l_exp, r_exp) lbessard@70: */ lbessard@70: lbessard@70: /*****************************************/ lbessard@70: /* B 3.2.2 Subprogram Control Statements */ lbessard@70: /*****************************************/ lbessard@70: /* RETURN */ lbessard@70: // SYM_REF0(return_statement_c) lbessard@70: lbessard@70: lbessard@70: /* fb_name '(' [param_assignment_list] ')' */ lbessard@70: /* param_assignment_list -> may be NULL ! */ lbessard@70: // SYM_REF2(fb_invocation_c, fb_name, param_assignment_list) lbessard@70: void *visit(fb_invocation_c *symbol) { lbessard@70: TRACE("fb_invocation_c"); lbessard@70: if (symbol->param_assignment_list != NULL) lbessard@70: return symbol->param_assignment_list->accept(*this); lbessard@70: else lbessard@70: return NULL; lbessard@70: } lbessard@70: lbessard@70: /* helper symbol for fb_invocation */ lbessard@70: /* param_assignment_list ',' param_assignment */ lbessard@70: // SYM_LIST(param_assignment_list_c) lbessard@70: void *visit(param_assignment_list_c *symbol) { lbessard@70: TRACE("param_assignment_list_c"); lbessard@70: return search_list(symbol); lbessard@70: } lbessard@70: lbessard@70: /* variable_name ASSIGN expression */ lbessard@70: // SYM_REF2(input_variable_param_assignment_c, variable_name, expression) lbessard@70: void *visit(input_variable_param_assignment_c *symbol) { lbessard@70: TRACE("input_variable_param_assignment_c"); lbessard@70: return handle_parameter_assignment(symbol->variable_name, symbol->expression); lbessard@70: } lbessard@70: lbessard@70: /* [NOT] variable_name '=>' variable */ lbessard@70: // SYM_REF4(output_variable_param_assignment_c, not_param, variable_name, variable, unused) lbessard@70: void *visit(output_variable_param_assignment_c *symbol) { lbessard@70: TRACE("output_variable_param_assignment_c"); lbessard@70: // TODO : Handle not_param !!! lbessard@70: if (NULL != symbol->not_param) ERROR; // we do not yet support it, so it is best to simply stop than to fail silently... lbessard@70: lbessard@70: return handle_parameter_assignment(symbol->variable_name, symbol->variable); lbessard@70: } lbessard@70: lbessard@70: /* helper CLASS for output_variable_param_assignment */ lbessard@70: // SYM_REF0(not_paramassign_c) lbessard@70: // TODO... ??? lbessard@70: lbessard@70: lbessard@70: lbessard@70: lbessard@70: lbessard@70: }; lbessard@70: lbessard@70: lbessard@70: lbessard@70: lbessard@70: lbessard@70: