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

 *

     6

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

     7

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

     8

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

     9

 *  (at your option) any later version.

    10

 *

    11

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

    12

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

    13

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    14

 *  GNU General Public License for more details.

    15

 *

    16

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

    17

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

    18

 *

    19

 *

    20

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

    21

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

    22

 */

    23

    24

/*

    25

 * An IEC 61131-3 compiler.

    26

 *

    27

 * Based on the

    28

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

    29

 *

    30

 */

    31

    32

/*

    33

 * Function call parameter iterator.

    34

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

    35

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

    36

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

    37

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

    38

 *

    39

 * Calls to function blocks and programs are also supported.

    40

 *

    41

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

    42

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

    43

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

    44

 */

    45

    46

    47

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

    48

    49

    50

class function_call_param_iterator_c : public null_visitor_c {

    51

    52

  private:

    53

      /* a pointer to the function call

    54

       * (or function block or program call!)

    55

       */

    56

    symbol_c *f_call;

    57

    int iterate_f_next_param, iterate_nf_next_param, param_count;

    58

    identifier_c *search_param_name;

    59

    symbol_c *current_value;

    60

    61

    /* Which operation of the class was called:

    62

     *  - iterate to the next non-formal parameter. 

    63

     *  - iterate to the next formal parameter. 

    64

     *  - search a formal parameter, 

    65

     */

    66

    typedef enum {iterate_nf_op, iterate_f_op, search_f_op} operation_t;

    67

    operation_t current_operation;

    68

    69

  private:

    70

    void *search_list(list_c *list);

    71

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

    72

    73

    74

  public:

    75

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

    76

    void reset(void);

    77

    78

    /* initialise the iterator object.

    79

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

    80

     * that will be analysed...

    81

     */

    82

    function_call_param_iterator_c(symbol_c *f_call);

    83

    84

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

    85

     * the object references on parameter _before_ the first, so

    86

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

    87

     * reference the first parameter...

    88

     *

    89

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

    90

     * You can determine the value being passed by calling 

    91

     * function_call_param_iterator_c::search_f()

    92

     */

    93

    symbol_c *next_f(void);

    94

    95

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

    96

     * the object references on parameter _before_ the first, so

    97

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

    98

     * reference the first parameter...

    99

     *

   100

     * Returns whatever is being passed to the parameter!

   101

     */

   102

    symbol_c *next_nf(void);

   103

   104

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

   105

    symbol_c *search_f(symbol_c *param_name);

   106

   107

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

   108

    symbol_c *get_current_value(void);

   109

   110

   111

  private:

   112

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

   113

  /* B 1.7 Configuration elements */

   114

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

   115

   116

  /*

   117

  CONFIGURATION configuration_name

   118

     optional_global_var_declarations

   119

   (resource_declaration_list | single_resource_declaration)

   120

   optional_access_declarations

   121

   optional_instance_specific_initializations

   122

  END_CONFIGURATION

   123

  */

   124

  /*

   125

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

   126

  */

   127

   128

  /* helper symbol for configuration_declaration */

   129

  /*

   130

  SYM_LIST(resource_declaration_list_c)

   131

  */

   132

   133

  /*

   134

  RESOURCE resource_name ON resource_type_name

   135

     optional_global_var_declarations

   136

   single_resource_declaration

   137

  END_RESOURCE

   138

  */

   139

  /*

   140

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

   141

  */

   142

   143

  /* task_configuration_list program_configuration_list */

   144

  /*

   145

  SYM_REF2(single_resource_declaration_c, task_configuration_list, program_configuration_list)

   146

  */

   147

   148

  /* helper symbol for single_resource_declaration */

   149

  /*

   150

  SYM_LIST(task_configuration_list_c)

   151

  */

   152

   153

  /* helper symbol for single_resource_declaration */

   154

  /*

   155

  SYM_LIST(program_configuration_list_c)

   156

  */

   157

   158

  /* helper symbol for

   159

   *  - access_path

   160

   *  - instance_specific_init

   161

   */

   162

  /*

   163

  SYM_LIST(any_fb_name_list_c)

   164

  */

   165

   166

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

   167

  /*

   168

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

   169

  */

   170

   171

  /*  prev_declared_program_name '.' symbolic_variable */

   172

  /*

   173

  SYM_REF2(program_output_reference_c, program_name, symbolic_variable)

   174

  */

   175

   176

  /*  TASK task_name task_initialization */

   177

  /*

   178

  SYM_REF2(task_configuration_c, task_name, task_initialization)

   179

  */

   180

   181

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

   182

  /*

   183

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

   184

  */

   185

   186

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

   187

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

   188

    void *visit(program_configuration_c *symbol);

   189

   190

  /* prog_conf_elements ',' prog_conf_element */

   191

  // SYM_LIST(prog_conf_elements_c)

   192

    void *visit(prog_conf_elements_c *symbol);

   193

   194

  /*  fb_name WITH task_name */

   195

  /*

   196

  SYM_REF2(fb_task_c, fb_name, task_name)

   197

  */

   198

   199

  /*  any_symbolic_variable ASSIGN prog_data_source */

   200

  // SYM_REF2(prog_cnxn_assign_c, symbolic_variable, prog_data_source)

   201

    void *visit(prog_cnxn_assign_c *symbol);

   202

   203

  /* any_symbolic_variable SENDTO data_sink */

   204

  // SYM_REF2(prog_cnxn_sendto_c, symbolic_variable, prog_data_source)

   205

    void *visit(prog_cnxn_sendto_c *symbol);

   206

   207

  /* VAR_CONFIG instance_specific_init_list END_VAR */

   208

  /*

   209

  SYM_REF2(instance_specific_initializations_c, instance_specific_init_list, unused)

   210

  */

   211

   212

  /* helper symbol for instance_specific_initializations */

   213

  /*

   214

  SYM_LIST(instance_specific_init_list_c)

   215

  */

   216

   217

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

   218

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

   219

  */

   220

  /*

   221

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

   222

  */

   223

   224

  /* helper symbol for instance_specific_init */

   225

  /* function_block_type_name ':=' structure_initialization */

   226

  /*

   227

  SYM_REF2(fb_initialization_c, function_block_type_name, structure_initialization)

   228

  */

   229

   230

   231

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

   232

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

   233

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

   234

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

   235

  /* B 2.1 Instructions and Operands */

   236

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

   237

   238

  /* | function_name [il_operand_list] */

   239

  // SYM_REF2(il_function_call_c, function_name, il_operand_list)

   240

    void *visit(il_function_call_c *symbol);

   241

   242

   243

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

   244

  // SYM_REF2(il_formal_funct_call_c, function_name, il_param_list)

   245

    void *visit(il_formal_funct_call_c *symbol);

   246

   247

   248

  /*   il_call_operator prev_declared_fb_name

   249

   * | il_call_operator prev_declared_fb_name '(' ')'

   250

   * | il_call_operator prev_declared_fb_name '(' eol_list ')'

   251

   * | il_call_operator prev_declared_fb_name '(' il_operand_list ')'

   252

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

   253

   */

   254

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

   255

    void *visit(il_fb_call_c *symbol);

   256

   257

   258

   259

  /* | il_operand_list ',' il_operand */

   260

  // SYM_LIST(il_operand_list_c)

   261

    void *visit(il_operand_list_c *symbol);

   262

   263

   264

  /* | il_initial_param_list il_param_instruction */

   265

  // SYM_LIST(il_param_list_c)

   266

    void *visit(il_param_list_c *symbol);

   267

   268

  /*  il_assign_operator il_operand

   269

   * | il_assign_operator '(' eol_list simple_instr_list ')'

   270

   */

   271

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

   272

    void *visit(il_param_assignment_c *symbol);

   273

   274

  /*  il_assign_out_operator variable */

   275

  // SYM_REF2(il_param_out_assignment_c, il_assign_out_operator, variable);

   276

    void *visit(il_param_out_assignment_c *symbol);

   277

   278

   279

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

   280

  /* B 2.2 Operators */

   281

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

   282

  /*  any_identifier ASSIGN */

   283

  // SYM_REF1(il_assign_operator_c, variable_name)

   284

    void *visit(il_assign_operator_c *symbol);

   285

   286

  /*| [NOT] any_identifier SENDTO */

   287

  // SYM_REF2(il_assign_out_operator_c, option, variable_name)

   288

    void *visit(il_assign_out_operator_c *symbol);

   289

   290

   291

   292

   293

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

   294

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

   295

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

   296

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

   297

  /* B 3.1 - Expressions */

   298

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

   299

   300

  /*

   301

  SYM_REF2(function_invocation_c, function_name, parameter_assignment_list)

   302

  */

   303

    void *visit(function_invocation_c *symbol);

   304

   305

   306

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

   307

  /* B 3.2 Statements */

   308

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

   309

   310

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

   311

  /* B 3.2.1 Assignment Statements */

   312

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

   313

  /*

   314

  SYM_REF2(assignment_statement_c, l_exp, r_exp)

   315

  */

   316

   317

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

   318

  /* B 3.2.2 Subprogram Control Statements */

   319

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

   320

  /*  RETURN */

   321

  // SYM_REF0(return_statement_c)

   322

   323

   324

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

   325

  /* param_assignment_list -> may be NULL ! */

   326

  // SYM_REF2(fb_invocation_c, fb_name, param_assignment_list)

   327

    void *visit(fb_invocation_c *symbol);

   328

   329

  /* helper symbol for fb_invocation */

   330

  /* param_assignment_list ',' param_assignment */

   331

  // SYM_LIST(param_assignment_list_c)

   332

    void *visit(param_assignment_list_c *symbol);

   333

   334

  /*  variable_name ASSIGN expression */

   335

  // SYM_REF2(input_variable_param_assignment_c, variable_name, expression)

   336

    void *visit(input_variable_param_assignment_c *symbol);

   337

   338

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

   339

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

   340

    void *visit(output_variable_param_assignment_c *symbol);

   341

   342

  /* helper CLASS for output_variable_param_assignment */

   343

  // SYM_REF0(not_paramassign_c)

   344

  // TODO... ???

   345

   346

};  // function_call_param_iterator_c

   347

   348

   349

   350