1

/*

     2

 *  matiec - a compiler for the programming languages defined in IEC 61131-3

     3

 *

     4

 *  Copyright (C) 2003-2011  Mario de Sousa (msousa@fe.up.pt)

     5

 *  Copyright (C) 2007-2011  Laurent Bessard and Edouard Tisserant

     6

 *

     7

 *  This program is free software: you can redistribute it and/or modify

     8

 *  it under the terms of the GNU General Public License as published by

     9

 *  the Free Software Foundation, either version 3 of the License, or

    10

 *  (at your option) any later version.

    11

 *

    12

 *  This program is distributed in the hope that it will be useful,

    13

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    14

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    15

 *  GNU General Public License for more details.

    16

 *

    17

 *  You should have received a copy of the GNU General Public License

    18

 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.

    19

 *

    20

 *

    21

 * This code is made available on the understanding that it will not be

    22

 * used in safety-critical situations without a full and competent review.

    23

 */

    24

    25

/*

    26

 * An IEC 61131-3 compiler.

    27

 *

    28

 * Based on the

    29

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    30

 *

    31

 */

    32

    33

/*

    34

 * Function call parameter iterator.

    35

 * It will iterate through the non-formal parameters of a function call

    36

 * (i.e. function calls using the foo(<param1>, <param2>, ...) syntax).

    37

 * and/or search through the formal parameters of a function call

    38

 * (i.e. function calls using the foo(<name1> = <param1>, <name2> = <param2>, ...) syntax).

    39

 *

    40

 * Calls to function blocks and programs are also supported.

    41

 *

    42

 * Note that calls to next_nf() will only iterate through non-formal parameters,

    43

 * calls to next_f() will only iterate through formal parameters,

    44

 * and calls to search_f() will only serach through formal parameters.

    45

 */

    46

    47

    48

#include "../absyntax/visitor.hh"

    49

    50

    51

class function_call_param_iterator_c : public null_visitor_c {

    52

    53

  private:

    54

      /* a pointer to the function call

    55

       * (or function block or program call!)

    56

       */

    57

    symbol_c *f_call;

    58

    int iterate_f_next_param, iterate_nf_next_param, param_count;

    59

    identifier_c *search_param_name;

    60

    symbol_c *current_value;

    61

    62

    /* Which operation of the class was called:

    63

     *  - iterate to the next non-formal parameter. 

    64

     *  - iterate to the next formal parameter. 

    65

     *  - search a formal parameter, 

    66

     */

    67

    typedef enum {iterate_nf_op, iterate_f_op, search_f_op} operation_t;

    68

    operation_t current_operation;

    69

    70

  private:

    71

    void *search_list(list_c *list);

    72

    void *handle_parameter_assignment(symbol_c *variable_name, symbol_c *expression) ;

    73

    74

    75

  public:

    76

    /* start off at the first parameter once again... */

    77

    void reset(void);

    78

    79

    /* initialise the iterator object.

    80

     * We must be given a reference to the function/program/function block call

    81

     * that will be analysed...

    82

     */

    83

    function_call_param_iterator_c(symbol_c *f_call);

    84

    85

    /* Skip to the next formal parameter. After object creation,

    86

     * the object references on parameter _before_ the first, so

    87

     * this function must be called once to get the object to

    88

     * reference the first parameter...

    89

     *

    90

     * Returns the paramater name to which a value is being passed!

    91

     * You can determine the value being passed by calling 

    92

     * function_call_param_iterator_c::search_f()

    93

     */

    94

    symbol_c *next_f(void);

    95

    96

    /* Skip to the next non-formal parameter. After object creation,

    97

     * the object references on parameter _before_ the first, so

    98

     * this function must be called once to get the object to

    99

     * reference the first parameter...

   100

     *

   101

     * Returns whatever is being passed to the parameter!

   102

     */

   103

    symbol_c *next_nf(void);

   104

   105

    /* Search for the value passed to the parameter named <param_name>...  */

   106

    symbol_c *search_f(symbol_c *param_name);

   107

    symbol_c *search_f(const char *param_name);

   108

   109

    /* Returns the value being passed to the current parameter. */

   110

    symbol_c *get_current_value(void);

   111

   112

   113

  private:

   114

  /********************************/

   115

  /* B 1.7 Configuration elements */

   116

  /********************************/

   117

   118

  /*

   119

  CONFIGURATION configuration_name

   120

     optional_global_var_declarations

   121

   (resource_declaration_list | single_resource_declaration)

   122

   optional_access_declarations

   123

   optional_instance_specific_initializations

   124

  END_CONFIGURATION

   125

  */

   126

  /*

   127

  SYM_REF6(configuration_declaration_c, configuration_name, global_var_declarations, resource_declarations, access_declarations, instance_specific_initializations, unused)

   128

  */

   129

   130

  /* helper symbol for configuration_declaration */

   131

  /*

   132

  SYM_LIST(resource_declaration_list_c)

   133

  */

   134

   135

  /*

   136

  RESOURCE resource_name ON resource_type_name

   137

     optional_global_var_declarations

   138

   single_resource_declaration

   139

  END_RESOURCE

   140

  */

   141

  /*

   142

  SYM_REF4(resource_declaration_c, resource_name, resource_type_name, global_var_declarations, resource_declaration)

   143

  */

   144

   145

  /* task_configuration_list program_configuration_list */

   146

  /*

   147

  SYM_REF2(single_resource_declaration_c, task_configuration_list, program_configuration_list)

   148

  */

   149

   150

  /* helper symbol for single_resource_declaration */

   151

  /*

   152

  SYM_LIST(task_configuration_list_c)

   153

  */

   154

   155

  /* helper symbol for single_resource_declaration */

   156

  /*

   157

  SYM_LIST(program_configuration_list_c)

   158

  */

   159

   160

  /* helper symbol for

   161

   *  - access_path

   162

   *  - instance_specific_init

   163

   */

   164

  /*

   165

  SYM_LIST(any_fb_name_list_c)

   166

  */

   167

   168

  /*  [resource_name '.'] global_var_name ['.' structure_element_name] */

   169

  /*

   170

  SYM_REF4(global_var_reference_c, resource_name, global_var_name, structure_element_name, unused)

   171

  */

   172

   173

  /*  prev_declared_program_name '.' symbolic_variable */

   174

  /*

   175

  SYM_REF2(program_output_reference_c, program_name, symbolic_variable)

   176

  */

   177

   178

  /*  TASK task_name task_initialization */

   179

  /*

   180

  SYM_REF2(task_configuration_c, task_name, task_initialization)

   181

  */

   182

   183

  /*  '(' [SINGLE ASSIGN data_source ','] [INTERVAL ASSIGN data_source ','] PRIORITY ASSIGN integer ')' */

   184

  /*

   185

  SYM_REF4(task_initialization_c, single_data_source, interval_data_source, priority_data_source, unused)

   186

  */

   187

   188

  /*  PROGRAM [RETAIN | NON_RETAIN] program_name [WITH task_name] ':' program_type_name ['(' prog_conf_elements ')'] */

   189

  // SYM_REF6(program_configuration_c, retain_option, program_name, task_name, program_type_name, prog_conf_elements, unused)

   190

    void *visit(program_configuration_c *symbol);

   191

   192

  /* prog_conf_elements ',' prog_conf_element */

   193

  // SYM_LIST(prog_conf_elements_c)

   194

    void *visit(prog_conf_elements_c *symbol);

   195

   196

  /*  fb_name WITH task_name */

   197

  /*

   198

  SYM_REF2(fb_task_c, fb_name, task_name)

   199

  */

   200

   201

  /*  any_symbolic_variable ASSIGN prog_data_source */

   202

  // SYM_REF2(prog_cnxn_assign_c, symbolic_variable, prog_data_source)

   203

    void *visit(prog_cnxn_assign_c *symbol);

   204

   205

  /* any_symbolic_variable SENDTO data_sink */

   206

  // SYM_REF2(prog_cnxn_sendto_c, symbolic_variable, prog_data_source)

   207

    void *visit(prog_cnxn_sendto_c *symbol);

   208

   209

  /* VAR_CONFIG instance_specific_init_list END_VAR */

   210

  /*

   211

  SYM_REF2(instance_specific_initializations_c, instance_specific_init_list, unused)

   212

  */

   213

   214

  /* helper symbol for instance_specific_initializations */

   215

  /*

   216

  SYM_LIST(instance_specific_init_list_c)

   217

  */

   218

   219

  /* resource_name '.' program_name '.' {fb_name '.'}

   220

      ((variable_name [location] ':' located_var_spec_init) | (fb_name ':' fb_initialization))

   221

  */

   222

  /*

   223

  SYM_REF6(instance_specific_init_c, resource_name, program_name, any_fb_name_list, variable_name, location, initialization)

   224

  */

   225

   226

  /* helper symbol for instance_specific_init */

   227

  /* function_block_type_name ':=' structure_initialization */

   228

  /*

   229

  SYM_REF2(fb_initialization_c, function_block_type_name, structure_initialization)

   230

  */

   231

   232

   233

  /****************************************/

   234

  /* B.2 - Language IL (Instruction List) */

   235

  /****************************************/

   236

  /***********************************/

   237

  /* B 2.1 Instructions and Operands */

   238

  /***********************************/

   239

   240

  /* | function_name [il_operand_list] */

   241

  // SYM_REF2(il_function_call_c, function_name, il_operand_list)

   242

    void *visit(il_function_call_c *symbol);

   243

   244

   245

  /* | function_name '(' eol_list [il_param_list] ')' */

   246

  // SYM_REF2(il_formal_funct_call_c, function_name, il_param_list)

   247

    void *visit(il_formal_funct_call_c *symbol);

   248

   249

   250

  /*   il_call_operator prev_declared_fb_name

   251

   * | il_call_operator prev_declared_fb_name '(' ')'

   252

   * | il_call_operator prev_declared_fb_name '(' eol_list ')'

   253

   * | il_call_operator prev_declared_fb_name '(' il_operand_list ')'

   254

   * | il_call_operator prev_declared_fb_name '(' eol_list il_param_list ')'

   255

   */

   256

  // SYM_REF4(il_fb_call_c, il_call_operator, fb_name, il_operand_list, il_param_list)

   257

    void *visit(il_fb_call_c *symbol);

   258

   259

   260

   261

  /* | il_operand_list ',' il_operand */

   262

  // SYM_LIST(il_operand_list_c)

   263

    void *visit(il_operand_list_c *symbol);

   264

   265

   266

  /* | il_initial_param_list il_param_instruction */

   267

  // SYM_LIST(il_param_list_c)

   268

    void *visit(il_param_list_c *symbol);

   269

   270

  /*  il_assign_operator il_operand

   271

   * | il_assign_operator '(' eol_list simple_instr_list ')'

   272

   */

   273

  // SYM_REF4(il_param_assignment_c, il_assign_operator, il_operand, simple_instr_list, unused)

   274

    void *visit(il_param_assignment_c *symbol);

   275

   276

  /*  il_assign_out_operator variable */

   277

  // SYM_REF2(il_param_out_assignment_c, il_assign_out_operator, variable);

   278

    void *visit(il_param_out_assignment_c *symbol);

   279

   280

   281

  /*******************/

   282

  /* B 2.2 Operators */

   283

  /*******************/

   284

  /*  any_identifier ASSIGN */

   285

  // SYM_REF1(il_assign_operator_c, variable_name)

   286

    void *visit(il_assign_operator_c *symbol);

   287

   288

  /*| [NOT] any_identifier SENDTO */

   289

  // SYM_REF2(il_assign_out_operator_c, option, variable_name)

   290

    void *visit(il_assign_out_operator_c *symbol);

   291

   292

   293

   294

   295

  /***************************************/

   296

  /* B.3 - Language ST (Structured Text) */

   297

  /***************************************/

   298

  /***********************/

   299

  /* B 3.1 - Expressions */

   300

  /***********************/

   301

   302

  /*

   303

  SYM_REF2(function_invocation_c, function_name, parameter_assignment_list)

   304

  */

   305

    void *visit(function_invocation_c *symbol);

   306

   307

   308

  /********************/

   309

  /* B 3.2 Statements */

   310

  /********************/

   311

   312

  /*********************************/

   313

  /* B 3.2.1 Assignment Statements */

   314

  /*********************************/

   315

  /*

   316

  SYM_REF2(assignment_statement_c, l_exp, r_exp)

   317

  */

   318

   319

  /*****************************************/

   320

  /* B 3.2.2 Subprogram Control Statements */

   321

  /*****************************************/

   322

  /*  RETURN */

   323

  // SYM_REF0(return_statement_c)

   324

   325

   326

  /* fb_name '(' [param_assignment_list] ')' */

   327

  /* param_assignment_list -> may be NULL ! */

   328

  // SYM_REF2(fb_invocation_c, fb_name, param_assignment_list)

   329

    void *visit(fb_invocation_c *symbol);

   330

   331

  /* helper symbol for fb_invocation */

   332

  /* param_assignment_list ',' param_assignment */

   333

  // SYM_LIST(param_assignment_list_c)

   334

    void *visit(param_assignment_list_c *symbol);

   335

   336

  /*  variable_name ASSIGN expression */

   337

  // SYM_REF2(input_variable_param_assignment_c, variable_name, expression)

   338

    void *visit(input_variable_param_assignment_c *symbol);

   339

   340

  /* [NOT] variable_name '=>' variable */

   341

  // SYM_REF4(output_variable_param_assignment_c, not_param, variable_name, variable, unused)

   342

    void *visit(output_variable_param_assignment_c *symbol);

   343

   344

  /* helper CLASS for output_variable_param_assignment */

   345

  // SYM_REF0(not_paramassign_c)

   346

  // TODO... ???

   347

   348

};  // function_call_param_iterator_c

   349

   350

   351

   352