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 parameter iterator.
lbessard@70:  * Iterate through the in/out parameters of a function declaration.
lbessard@70:  * Function blocks are also suported.
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 <stdio.h>  /* required for NULL */
lbessard@70: //#include <string>
lbessard@70: //#include <iostream>
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: /* given a function_declaration_c, iterate through each
lbessard@70:  * function in/out/inout parameter, returning the name
lbessard@70:  * of each parameter...function_param_iterator_c
lbessard@70:  */
lbessard@70: class function_param_iterator_c : public null_visitor_c {
lbessard@70:   public:
lbessard@70:     /* A type to specify the type of parameter.
lbessard@70:      * VAR_INPUT => direction_in
lbessard@70:      * VAR_OUTPUT => direction_out
lbessard@70:      * VAR_IN_OUT => direction_inout
lbessard@70:      * VAR_EXTERNAL => direction_extref
lbessard@70:      *
lbessard@70:      * Note that VAR_EXTERNAL declares variables that are in reality references
lbessard@70:      * to global variables. This is used only inside programs!
lbessard@70:      * These references to external variables must be correctly initialised to refer
lbessard@70:      * to the correct global variable. Note that the user may define which variable is to be
lbessard@70:      * referenced in a CONFIGURATION, and that different instantiations of a program
lbessard@70:      * may have the same external variable reference diffenrent global variables!
lbessard@70:      * The references must therefore be correctly initialised when the program instance
lbessard@70:      * is created. This may be done by the PROGRAM class constructor since the ST and IL
lbessard@70:      * languages do not allow the VAR_EXTERNAL reference to change at runtime
lbessard@70:      * for a specific instance.
lbessard@70:      *
lbessard@70:      * We therefore need to call a PROGRAM class constructor with the variables
lbessard@70:      * that should be refernced by the VAR_EXTERNAL variables. The direction_extref will
lbessard@70:      * be used to identify these parameters!
lbessard@70:      */
lbessard@70:     typedef enum {direction_in, direction_out, direction_inout, direction_extref} param_direction_t ;
lbessard@70: 
lbessard@70: 
lbessard@70:   private:
lbessard@70:       /* a pointer to the function_block_declaration_c
lbessard@70:        * or function_declaration_c currently being analysed.
lbessard@70:        */
lbessard@70:     symbol_c *f_decl;
lbessard@70:     int next_param, param_count;
lbessard@70:     identifier_c *current_param_name;
lbessard@70:     symbol_c *current_param_type;
lbessard@70:     symbol_c *current_param_default_value;
lbessard@70:     param_direction_t current_param_direction;
lbessard@146:     bool en_declared;
lbessard@146:     bool eno_declared;
lbessard@70: 
lbessard@70:   private:
lbessard@70:     void* handle_param_list(list_c *list) {
lbessard@70:       if (next_param <= param_count + list->n)
lbessard@70:         return list->elements[next_param - param_count - 1];
lbessard@70: 
lbessard@70:       /* the desired param is not on this list... */
lbessard@70:       param_count += list->n;
lbessard@70:      return NULL;
lbessard@70:     }
lbessard@70: 
lbessard@70:     void* handle_single_param(symbol_c *var_name) {
lbessard@70:       param_count++;
lbessard@70:       if (next_param == param_count)
lbessard@70:         return var_name;
lbessard@70: 
lbessard@70:       /* not yet the desired param... */
lbessard@70:      return NULL;
lbessard@70:     }
lbessard@70: 
lbessard@70:     void* iterate_list(list_c *list) {
lbessard@70:       void *res;
lbessard@70:       for (int i = 0; i < list->n; i++) {
lbessard@70:         res = list->elements[i]->accept(*this);
lbessard@146:         if (res != NULL)
lbessard@146: 	        return res;
lbessard@70:       }
lbessard@70:       return NULL;
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:       current_param_name = NULL;
lbessard@70:       current_param_type = current_param_default_value = NULL;
lbessard@146:       en_declared = false;
lbessard@146:       eno_declared = false;
lbessard@70:     }
lbessard@70: 
lbessard@70:     /* initialise the iterator object.
lbessard@70:      * We must be given a reference to the function declaration
lbessard@70:      * that will be analysed...
lbessard@70:      */
lbessard@70:     function_param_iterator_c(function_declaration_c *f_decl) {
lbessard@70:       this->f_decl = f_decl;
lbessard@70:       reset();
lbessard@70:     }
lbessard@70: 
lbessard@70:     /* initialise the iterator object.
lbessard@70:      * We must be given a reference to the function block declaration
lbessard@70:      * that will be analysed...
lbessard@70:      */
lbessard@70:     function_param_iterator_c(function_block_declaration_c *fb_decl) {
lbessard@70:       this->f_decl = fb_decl;
lbessard@70:       reset();
lbessard@70:     }
lbessard@70: 
lbessard@70:     /* initialise the iterator object.
lbessard@70:      * We must be given a reference to the program declaration
lbessard@70:      * that will be analysed...
lbessard@70:      */
lbessard@70:     function_param_iterator_c(program_declaration_c *p_decl) {
lbessard@70:       this->f_decl = p_decl;
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 the parameter's name!
lbessard@70:      */
lbessard@70:     identifier_c *next(void) {
lbessard@70:       void *res;
lbessard@146:       identifier_c *identifier;
lbessard@70:       param_count = 0;
lbessard@70:       next_param++;
lbessard@70:       res = f_decl->accept(*this);
lbessard@146:       if (res != NULL) {
lbessard@146:         symbol_c *sym = (symbol_c *)res;
lbessard@146:         identifier = dynamic_cast<identifier_c *>(sym);
lbessard@146:         if (identifier == NULL)
lbessard@146:           ERROR;
lbessard@146:       }
lbessard@146:       else if (!en_declared) {
lbessard@146:         current_param_direction = direction_in;
lbessard@146:         identifier = declare_en_param();
lbessard@146:       }
lbessard@146:       else if (!eno_declared) {
lbessard@146:         current_param_direction = direction_out;
lbessard@146:         identifier = declare_eno_param();
lbessard@146:       }
lbessard@146:       else
lbessard@70:         return NULL;
lbessard@146:       
lbessard@70:       current_param_name = identifier;
lbessard@70:       return current_param_name;
lbessard@70:     }
lbessard@70: 
lbessard@146:     identifier_c *declare_en_param(void) {
lbessard@146:       en_declared = true;
lbessard@146:       identifier_c *identifier = new identifier_c("EN");
lbessard@146:       current_param_type = (symbol_c*)(new bool_type_name_c());
lbessard@146:       current_param_default_value = (symbol_c*)(new boolean_literal_c(current_param_type, new boolean_true_c()));
lbessard@146:       return identifier;
lbessard@146:     }
lbessard@146: 
lbessard@146:     identifier_c *declare_eno_param(void) {
lbessard@146:       eno_declared = true;
lbessard@146:       identifier_c *identifier = new identifier_c("ENO");
lbessard@146:       current_param_type = (symbol_c*)(new bool_type_name_c());
lbessard@146:       current_param_default_value = NULL;
lbessard@146:       return identifier;
lbessard@146:     }
lbessard@146: 
lbessard@70:     /* Returns the currently referenced parameter's default value,
lbessard@70:      * or NULL if none is specified in the function declrataion itself.
lbessard@70:      */
lbessard@70:     symbol_c *default_value(void) {
lbessard@70:       return current_param_default_value;
lbessard@70:     }
lbessard@70: 
lbessard@70:     /* Returns the currently referenced parameter's type name. */
lbessard@70:     symbol_c *param_type(void) {
lbessard@70:       return current_param_type;
lbessard@70:     }
lbessard@70: 
lbessard@70:     /* Returns the currently referenced parameter's data passing direction.
lbessard@70:      * i.e. VAR_INPUT, VAR_OUTPUT or VAR_INOUT
lbessard@70:      */
lbessard@70:     param_direction_t param_direction(void) {
lbessard@70:       return current_param_direction;
lbessard@70:     }
lbessard@70: 
lbessard@70: /******************************************/
lbessard@70: /* B 1.4.3 - Declaration & Initialisation */
lbessard@70: /******************************************/
lbessard@70:     void *visit(input_declarations_c *symbol) {
lbessard@70:       TRACE("input_declarations_c");
lbessard@70:       current_param_direction = direction_in;
lbessard@70:       return symbol->input_declaration_list->accept(*this);
lbessard@70:     }
lbessard@70:     void *visit(input_declaration_list_c *symbol) {TRACE("input_declaration_list_c"); return iterate_list(symbol);}
lbessard@70:     void *visit(edge_declaration_c *symbol) {TRACE("edge_declaration_c"); return symbol->var1_list->accept(*this);}
lbessard@146:     void *visit(en_param_declaration_c *symbol) {
lbessard@146:       TRACE("en_param_declaration_c");
lbessard@146:       if (en_declared) ERROR;
lbessard@146:       return (void *)declare_en_param();
lbessard@146:     }
lbessard@70: #if 0
lbessard@70: /* var1_list ':' array_spec_init */
lbessard@70: SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)
lbessard@70: 
lbessard@70: /*  var1_list ':' initialized_structure */
lbessard@70: SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)
lbessard@70: 
lbessard@70: /* name_list ':' function_block_type_name ASSIGN structure_initialization */
lbessard@70: /* structure_initialization -> may be NULL ! */
lbessard@70: SYM_REF4(fb_name_decl_c, fb_name_list, function_block_type_name, structure_initialization, unused)
lbessard@70: 
lbessard@70: /* name_list ',' fb_name */
lbessard@70: SYM_LIST(fb_name_list_c)
lbessard@70: #endif
lbessard@70: 
lbessard@70:     void *visit(output_declarations_c *symbol) {
lbessard@70:       TRACE("output_declarations_c");
lbessard@70:       current_param_direction = direction_out;
lbessard@70:       return symbol->var_init_decl_list->accept(*this);
lbessard@70:     }
lbessard@146:     void *visit(eno_param_declaration_c *symbol) {
lbessard@146:       TRACE("eno_param_declaration_c");
lbessard@146:       if (eno_declared) ERROR;
lbessard@146:       return (void *)declare_eno_param();
lbessard@146:     }
lbessard@70:     void *visit(input_output_declarations_c *symbol) {
lbessard@70:       TRACE("input_output_declarations_c");
lbessard@70:       current_param_direction = direction_inout;
lbessard@70:       return symbol->var_declaration_list->accept(*this);
lbessard@70:     }
lbessard@70:     void *visit(var_declaration_list_c *symbol) {TRACE("var_declaration_list_c"); return iterate_list(symbol);}
lbessard@70: 
lbessard@70: #if 0
lbessard@70: /*  var1_list ':' array_specification */
lbessard@70: SYM_REF2(array_var_declaration_c, var1_list, array_specification)
lbessard@70: 
lbessard@70: /*  var1_list ':' structure_type_name */
lbessard@70: SYM_REF2(structured_var_declaration_c, var1_list, structure_type_name)
lbessard@70: #endif
lbessard@70: 
lbessard@70: /* VAR [CONSTANT] var_init_decl_list END_VAR */
lbessard@70:     void *visit(var_declarations_c *symbol) {TRACE("var_declarations_c"); return NULL;}
lbessard@70: 
lbessard@70: #if 0
lbessard@70: /*  VAR RETAIN var_init_decl_list END_VAR */
lbessard@70: SYM_REF2(retentive_var_declarations_c, var_init_decl_list, unused)
lbessard@70: 
lbessard@70: /*  VAR [CONSTANT|RETAIN|NON_RETAIN] located_var_decl_list END_VAR */
lbessard@70: /* option -> may be NULL ! */
lbessard@70: SYM_REF2(located_var_declarations_c, option, located_var_decl_list)
lbessard@70: 
lbessard@70: /* helper symbol for located_var_declarations */
lbessard@70: /* located_var_decl_list located_var_decl ';' */
lbessard@70: SYM_LIST(located_var_decl_list_c)
lbessard@70: 
lbessard@70: /*  [variable_name] location ':' located_var_spec_init */
lbessard@70: /* variable_name -> may be NULL ! */
lbessard@70: SYM_REF4(located_var_decl_c, variable_name, location, located_var_spec_init, unused)
lbessard@70: #endif
lbessard@70: 
lbessard@70: /*| VAR_EXTERNAL [CONSTANT] external_declaration_list END_VAR */
lbessard@70: /* option -> may be NULL ! */
lbessard@70: // SYM_REF2(external_var_declarations_c, option, external_declaration_list)
lbessard@70:     void *visit(external_var_declarations_c *symbol) {
lbessard@70:       TRACE("external_var_declarations_c");
lbessard@70:       current_param_direction = direction_extref;
lbessard@70:       return symbol->external_declaration_list->accept(*this);
lbessard@70:     }
lbessard@70: 
lbessard@70: /* helper symbol for external_var_declarations */
lbessard@70: /*| external_declaration_list external_declaration';' */
lbessard@70: // SYM_LIST(external_declaration_list_c)
lbessard@70:     void *visit(external_declaration_list_c *symbol) {TRACE("external_declaration_list_c"); return iterate_list(symbol);}
lbessard@70: 
lbessard@70: /*  global_var_name ':' (simple_specification|subrange_specification|enumerated_specification|array_specification|prev_declared_structure_type_name|function_block_type_name */
lbessard@70: //SYM_REF2(external_declaration_c, global_var_name, specification)
lbessard@70:     void *visit(external_declaration_c *symbol) {
lbessard@70:       TRACE("external_declaration_c");
lbessard@70:       /* It is OK to store these values in the current_param_XXX
lbessard@70:        * variables, because if the desired parameter is not in the
lbessard@70:        * variable list we will be analysing, the current_param_XXXX
lbessard@70:        * variables will get overwritten when we visit the next
lbessard@70:        * var1_init_decl_c list!
lbessard@70:        */
lbessard@70:       current_param_default_value = spec_init_sperator_c::get_init(symbol->specification);
lbessard@70:       current_param_type = spec_init_sperator_c::get_spec(symbol->specification);
lbessard@70: 
lbessard@70:       return handle_single_param(symbol->global_var_name);
lbessard@70:     }
lbessard@70: 
lbessard@70: 
lbessard@70: #if 0
lbessard@70: /*| VAR_GLOBAL [CONSTANT|RETAIN] global_var_decl_list END_VAR */
lbessard@70: /* option -> may be NULL ! */
lbessard@70: SYM_REF2(global_var_declarations_c, option, global_var_decl_list)
lbessard@70: 
lbessard@70: /* helper symbol for global_var_declarations */
lbessard@70: /*| global_var_decl_list global_var_decl ';' */
lbessard@70: SYM_LIST(global_var_decl_list_c)
lbessard@70: 
lbessard@70: /*| global_var_spec ':' [located_var_spec_init|function_block_type_name] */
lbessard@70: /* type_specification ->may be NULL ! */
lbessard@70: SYM_REF2(global_var_decl_c, global_var_spec, type_specification)
lbessard@70: 
lbessard@70: /*| global_var_name location */
lbessard@70: SYM_REF2(global_var_spec_c, global_var_name, location)
lbessard@70: 
lbessard@70: /*  AT direct_variable */
lbessard@70: SYM_REF2(location_c, direct_variable, unused)
lbessard@70: 
lbessard@70: /*| global_var_list ',' global_var_name */
lbessard@70: SYM_LIST(global_var_list_c)
lbessard@70: 
lbessard@70: /*  var1_list ':' single_byte_string_spec */
lbessard@70: SYM_REF2(single_byte_string_var_declaration_c, var1_list, single_byte_string_spec)
lbessard@70: 
lbessard@70: /*  STRING ['[' integer ']'] [ASSIGN single_byte_character_string] */
lbessard@70: /* integer ->may be NULL ! */
lbessard@70: /* single_byte_character_string ->may be NULL ! */
lbessard@70: SYM_REF2(single_byte_string_spec_c, integer, single_byte_character_string)
lbessard@70: 
lbessard@70: /*  var1_list ':' double_byte_string_spec */
lbessard@70: SYM_REF2(double_byte_string_var_declaration_c, var1_list, double_byte_string_spec)
lbessard@70: 
lbessard@70: /*  WSTRING ['[' integer ']'] [ASSIGN double_byte_character_string] */
lbessard@70: /* integer ->may be NULL ! */
lbessard@70: /* double_byte_character_string ->may be NULL ! */
lbessard@70: SYM_REF2(double_byte_string_spec_c, integer, double_byte_character_string)
lbessard@70: 
lbessard@70: /*| VAR [RETAIN|NON_RETAIN] incompl_located_var_decl_list END_VAR */
lbessard@70: /* option ->may be NULL ! */
lbessard@70: SYM_REF2(incompl_located_var_declarations_c, option, incompl_located_var_decl_list)
lbessard@70: 
lbessard@70: /* helper symbol for incompl_located_var_declarations */
lbessard@70: /*| incompl_located_var_decl_list incompl_located_var_decl ';' */
lbessard@70: SYM_LIST(incompl_located_var_decl_list_c)
lbessard@70: 
lbessard@70: /*  variable_name incompl_location ':' var_spec */
lbessard@70: SYM_REF4(incompl_located_var_decl_c, variable_name, incompl_location, var_spec, unused)
lbessard@70: 
lbessard@70: /*  AT incompl_location_token */
lbessard@70: SYM_TOKEN(incompl_location_c)
lbessard@70: #endif
lbessard@70: 
lbessard@70: 
lbessard@70:     void *visit(var1_init_decl_c *symbol) {
lbessard@70:       TRACE("var1_init_decl_c");
lbessard@70:       /* It is OK to store these values in the current_param_XXX
lbessard@70:        * variables, because if the desired parameter is not in the
lbessard@70:        * variable list we will be analysing, the current_param_XXXX
lbessard@70:        * variables will get overwritten when we visit the next
lbessard@70:        * var1_init_decl_c list!
lbessard@70:        */
lbessard@70:       current_param_default_value = spec_init_sperator_c::get_init(symbol->spec_init);
lbessard@70:       current_param_type = spec_init_sperator_c::get_spec(symbol->spec_init);
lbessard@70: 
lbessard@70:       return symbol->var1_list->accept(*this);
lbessard@70:     }
lbessard@70: 
lbessard@70: 
lbessard@70: 
lbessard@70:     void *visit(var1_list_c *symbol) {
lbessard@70:       TRACE("var1_list_c");
lbessard@70:       return handle_param_list(symbol);
lbessard@70:     }
lbessard@70: 
lbessard@70:     void *visit(var_init_decl_list_c *symbol) {TRACE("var_init_decl_list_c"); return iterate_list(symbol);}
lbessard@70: 
lbessard@70: 
lbessard@70: /***********************/
lbessard@70: /* B 1.5.1 - Functions */
lbessard@70: /***********************/
lbessard@70:     void *visit(function_declaration_c *symbol) {TRACE("function_declaration_c"); return symbol->var_declarations_list->accept(*this);}
lbessard@70:     /* intermediate helper symbol for function_declaration */
lbessard@70:     void *visit(var_declarations_list_c *symbol) {TRACE("var_declarations_list_c"); return iterate_list(symbol);}
lbessard@70:     void *visit(function_var_decls_c *symbol) {TRACE("function_var_decls_c"); /* ignore */ return NULL;}
lbessard@70: 
lbessard@70: 
lbessard@70: /*****************************/
lbessard@70: /* B 1.5.2 - Function Blocks */
lbessard@70: /*****************************/
lbessard@70: /*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */
lbessard@70:     void *visit(function_block_declaration_c *symbol) {TRACE("function_block_declaration_c"); return symbol->var_declarations->accept(*this);}
lbessard@70: 
lbessard@70: /* intermediate helper symbol for function_declaration */
lbessard@70: /*  { io_var_declarations | other_var_declarations }   */
lbessard@70: /*
lbessard@70:  * NOTE: we re-use the var_declarations_list_c
lbessard@70:  */
lbessard@70: 
lbessard@70: /*  VAR_TEMP temp_var_decl_list END_VAR */
lbessard@70:     void *visit(temp_var_decls_c *symbol) {TRACE("temp_var_decls_c"); /* ignore */ return NULL;}
lbessard@70:     void *visit(temp_var_decls_list_c *symbol) {TRACE("temp_var_decls_list_c"); /* ignore */ return NULL;}
lbessard@70: 
lbessard@70: /*  VAR NON_RETAIN var_init_decl_list END_VAR */
lbessard@70:     void *visit(non_retentive_var_decls_c *symbol) {TRACE("non_retentive_var_decls_c"); /* ignore */ return NULL;}
lbessard@70: 
lbessard@70: 
lbessard@70: /**********************/
lbessard@70: /* B 1.5.3 - Programs */
lbessard@70: /**********************/
lbessard@70: /*  PROGRAM program_type_name program_var_declarations_list function_block_body END_PROGRAM */
lbessard@70: // SYM_REF4(program_declaration_c, program_type_name, var_declarations, function_block_body, unused)
lbessard@70:     void *visit(program_declaration_c *symbol) {TRACE("program_declaration_c"); return symbol->var_declarations->accept(*this);}
lbessard@70: 
lbessard@70: /* intermediate helper symbol for program_declaration_c */
lbessard@70: /*  { io_var_declarations | other_var_declarations }   */
lbessard@70: /*
lbessard@70:  * NOTE: we re-use the var_declarations_list_c
lbessard@70:  */
lbessard@70: 
lbessard@70: };
lbessard@70: 
lbessard@70: 
lbessard@70: 
lbessard@70: 
lbessard@70: 
lbessard@70: 
lbessard@70: