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

   108

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

   109

    symbol_c *get_current_value(void);

   110

   111

   112

  private:

   113

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

   114

  /* B 1.7 Configuration elements */

   115

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

   116

   117

  /*

   118

  CONFIGURATION configuration_name

   119

     optional_global_var_declarations

   120

   (resource_declaration_list | single_resource_declaration)

   121

   optional_access_declarations

   122

   optional_instance_specific_initializations

   123

  END_CONFIGURATION

   124

  */

   125

  /*

   126

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

   127

  */

   128

   129

  /* helper symbol for configuration_declaration */

   130

  /*

   131

  SYM_LIST(resource_declaration_list_c)

   132

  */

   133

   134

  /*

   135

  RESOURCE resource_name ON resource_type_name

   136

     optional_global_var_declarations

   137

   single_resource_declaration

   138

  END_RESOURCE

   139

  */

   140

  /*

   141

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

   142

  */

   143

   144

  /* task_configuration_list program_configuration_list */

   145

  /*

   146

  SYM_REF2(single_resource_declaration_c, task_configuration_list, program_configuration_list)

   147

  */

   148

   149

  /* helper symbol for single_resource_declaration */

   150

  /*

   151

  SYM_LIST(task_configuration_list_c)

   152

  */

   153

   154

  /* helper symbol for single_resource_declaration */

   155

  /*

   156

  SYM_LIST(program_configuration_list_c)

   157

  */

   158

   159

  /* helper symbol for

   160

   *  - access_path

   161

   *  - instance_specific_init

   162

   */

   163

  /*

   164

  SYM_LIST(any_fb_name_list_c)

   165

  */

   166

   167

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

   168

  /*

   169

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

   170

  */

   171

   172

  /*  prev_declared_program_name '.' symbolic_variable */

   173

  /*

   174

  SYM_REF2(program_output_reference_c, program_name, symbolic_variable)

   175

  */

   176

   177

  /*  TASK task_name task_initialization */

   178

  /*

   179

  SYM_REF2(task_configuration_c, task_name, task_initialization)

   180

  */

   181

   182

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

   183

  /*

   184

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

   185

  */

   186

   187

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

   188

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

   189

    void *visit(program_configuration_c *symbol);

   190

   191

  /* prog_conf_elements ',' prog_conf_element */

   192

  // SYM_LIST(prog_conf_elements_c)

   193

    void *visit(prog_conf_elements_c *symbol);

   194

   195

  /*  fb_name WITH task_name */

   196

  /*

   197

  SYM_REF2(fb_task_c, fb_name, task_name)

   198

  */

   199

   200

  /*  any_symbolic_variable ASSIGN prog_data_source */

   201

  // SYM_REF2(prog_cnxn_assign_c, symbolic_variable, prog_data_source)

   202

    void *visit(prog_cnxn_assign_c *symbol);

   203

   204

  /* any_symbolic_variable SENDTO data_sink */

   205

  // SYM_REF2(prog_cnxn_sendto_c, symbolic_variable, prog_data_source)

   206

    void *visit(prog_cnxn_sendto_c *symbol);

   207

   208

  /* VAR_CONFIG instance_specific_init_list END_VAR */

   209

  /*

   210

  SYM_REF2(instance_specific_initializations_c, instance_specific_init_list, unused)

   211

  */

   212

   213

  /* helper symbol for instance_specific_initializations */

   214

  /*

   215

  SYM_LIST(instance_specific_init_list_c)

   216

  */

   217

   218

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

   219

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

   220

  */

   221

  /*

   222

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

   223

  */

   224

   225

  /* helper symbol for instance_specific_init */

   226

  /* function_block_type_name ':=' structure_initialization */

   227

  /*

   228

  SYM_REF2(fb_initialization_c, function_block_type_name, structure_initialization)

   229

  */

   230

   231

   232

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

   233

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

   234

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

   235

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

   236

  /* B 2.1 Instructions and Operands */

   237

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

   238

   239

  /* | function_name [il_operand_list] */

   240

  // SYM_REF2(il_function_call_c, function_name, il_operand_list)

   241

    void *visit(il_function_call_c *symbol);

   242

   243

   244

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

   245

  // SYM_REF2(il_formal_funct_call_c, function_name, il_param_list)

   246

    void *visit(il_formal_funct_call_c *symbol);

   247

   248

   249

  /*   il_call_operator prev_declared_fb_name

   250

   * | il_call_operator prev_declared_fb_name '(' ')'

   251

   * | il_call_operator prev_declared_fb_name '(' eol_list ')'

   252

   * | il_call_operator prev_declared_fb_name '(' il_operand_list ')'

   253

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

   254

   */

   255

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

   256

    void *visit(il_fb_call_c *symbol);

   257

   258

   259

   260

  /* | il_operand_list ',' il_operand */

   261

  // SYM_LIST(il_operand_list_c)

   262

    void *visit(il_operand_list_c *symbol);

   263

   264

   265

  /* | il_initial_param_list il_param_instruction */

   266

  // SYM_LIST(il_param_list_c)

   267

    void *visit(il_param_list_c *symbol);

   268

   269

  /*  il_assign_operator il_operand

   270

   * | il_assign_operator '(' eol_list simple_instr_list ')'

   271

   */

   272

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

   273

    void *visit(il_param_assignment_c *symbol);

   274

   275

  /*  il_assign_out_operator variable */

   276

  // SYM_REF2(il_param_out_assignment_c, il_assign_out_operator, variable);

   277

    void *visit(il_param_out_assignment_c *symbol);

   278

   279

   280

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

   281

  /* B 2.2 Operators */

   282

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

   283

  /*  any_identifier ASSIGN */

   284

  // SYM_REF1(il_assign_operator_c, variable_name)

   285

    void *visit(il_assign_operator_c *symbol);

   286

   287

  /*| [NOT] any_identifier SENDTO */

   288

  // SYM_REF2(il_assign_out_operator_c, option, variable_name)

   289

    void *visit(il_assign_out_operator_c *symbol);

   290

   291

   292

   293

   294

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

   295

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

   296

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

   297

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

   298

  /* B 3.1 - Expressions */

   299

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

   300

   301

  /*

   302

  SYM_REF2(function_invocation_c, function_name, parameter_assignment_list)

   303

  */

   304

    void *visit(function_invocation_c *symbol);

   305

   306

   307

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

   308

  /* B 3.2 Statements */

   309

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

   310

   311

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

   312

  /* B 3.2.1 Assignment Statements */

   313

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

   314

  /*

   315

  SYM_REF2(assignment_statement_c, l_exp, r_exp)

   316

  */

   317

   318

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

   319

  /* B 3.2.2 Subprogram Control Statements */

   320

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

   321

  /*  RETURN */

   322

  // SYM_REF0(return_statement_c)

   323

   324

   325

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

   326

  /* param_assignment_list -> may be NULL ! */

   327

  // SYM_REF2(fb_invocation_c, fb_name, param_assignment_list)

   328

    void *visit(fb_invocation_c *symbol);

   329

   330

  /* helper symbol for fb_invocation */

   331

  /* param_assignment_list ',' param_assignment */

   332

  // SYM_LIST(param_assignment_list_c)

   333

    void *visit(param_assignment_list_c *symbol);

   334

   335

  /*  variable_name ASSIGN expression */

   336

  // SYM_REF2(input_variable_param_assignment_c, variable_name, expression)

   337

    void *visit(input_variable_param_assignment_c *symbol);

   338

   339

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

   340

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

   341

    void *visit(output_variable_param_assignment_c *symbol);

   342

   343

  /* helper CLASS for output_variable_param_assignment */

   344

  // SYM_REF0(not_paramassign_c)

   345

  // TODO... ???

   346

   347

};  // function_call_param_iterator_c

   348

   349

   350

   351