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