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

    void *search_list(list_c *list);

    55

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

    56

    57

    58

  public:

    59

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

    60

    void reset(void);

    61

    62

    /* initialise the iterator object.

    63

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

    64

     * that will be analysed...

    65

     */

    66

    function_call_param_iterator_c(symbol_c *f_call);

    67

    68

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

    69

     * the object references on parameter _before_ the first, so

    70

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

    71

     * reference the first parameter...

    72

     *

    73

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

    74

     * You can determine the value being passed by calling 

    75

     * function_call_param_iterator_c::search_f()

    76

     */

    77

    symbol_c *next_f(void);

    78

    79

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

    80

     * the object references on parameter _before_ the first, so

    81

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

    82

     * reference the first parameter...

    83

     *

    84

     * Returns whatever is being passed to the parameter!

    85

     */

    86

    symbol_c *next_nf(void);

    87

    88

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

    89

    symbol_c *search_f(symbol_c *param_name);

    90

    symbol_c *search_f(const char *param_name);

    91

    92

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

    93

    symbol_c *get_current_value(void);

    94

    95

    /* A type to specify how the current parameter was assigned.

    96

     * param_name := var   -> assign_in

    97

     * param_name => var   -> assign_out

    98

     *                     -> assign_none  (used when handling non formal calls, when no assignment type is used)

    99

     */

   100

    typedef enum {assign_in, assign_out, assign_none} assign_direction_t ;

   101

    /* Returns the assignment direction of the current parameter. */

   102

    assign_direction_t get_assign_direction(void);

   103

   104

   105

  private:

   106

      /* a pointer to the function call

   107

       * (or function block or program call!)

   108

       */

   109

    symbol_c *f_call;

   110

    int iterate_f_next_param, iterate_nf_next_param, param_count;

   111

    identifier_c *search_param_name;

   112

    symbol_c *current_value;

   113

    assign_direction_t current_assign_direction;

   114

   115

    /* Which operation of the class was called:

   116

     *  - iterate to the next non-formal parameter. 

   117

     *  - iterate to the next formal parameter. 

   118

     *  - search a formal parameter, 

   119

     */

   120

    typedef enum {iterate_nf_op, iterate_f_op, search_f_op} operation_t;

   121

    operation_t current_operation;

   122

   123

   124

  private:

   125

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

   126

  /* B 1.7 Configuration elements */

   127

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

   128

   129

  /*

   130

  CONFIGURATION configuration_name

   131

     optional_global_var_declarations

   132

   (resource_declaration_list | single_resource_declaration)

   133

   optional_access_declarations

   134

   optional_instance_specific_initializations

   135

  END_CONFIGURATION

   136

  */

   137

  /*

   138

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

   139

  */

   140

   141

  /* helper symbol for configuration_declaration */

   142

  /*

   143

  SYM_LIST(resource_declaration_list_c)

   144

  */

   145

   146

  /*

   147

  RESOURCE resource_name ON resource_type_name

   148

     optional_global_var_declarations

   149

   single_resource_declaration

   150

  END_RESOURCE

   151

  */

   152

  /*

   153

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

   154

  */

   155

   156

  /* task_configuration_list program_configuration_list */

   157

  /*

   158

  SYM_REF2(single_resource_declaration_c, task_configuration_list, program_configuration_list)

   159

  */

   160

   161

  /* helper symbol for single_resource_declaration */

   162

  /*

   163

  SYM_LIST(task_configuration_list_c)

   164

  */

   165

   166

  /* helper symbol for single_resource_declaration */

   167

  /*

   168

  SYM_LIST(program_configuration_list_c)

   169

  */

   170

   171

  /* helper symbol for

   172

   *  - access_path

   173

   *  - instance_specific_init

   174

   */

   175

  /*

   176

  SYM_LIST(any_fb_name_list_c)

   177

  */

   178

   179

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

   180

  /*

   181

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

   182

  */

   183

   184

  /*  prev_declared_program_name '.' symbolic_variable */

   185

  /*

   186

  SYM_REF2(program_output_reference_c, program_name, symbolic_variable)

   187

  */

   188

   189

  /*  TASK task_name task_initialization */

   190

  /*

   191

  SYM_REF2(task_configuration_c, task_name, task_initialization)

   192

  */

   193

   194

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

   195

  /*

   196

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

   197

  */

   198

   199

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

   200

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

   201

    void *visit(program_configuration_c *symbol);

   202

   203

  /* prog_conf_elements ',' prog_conf_element */

   204

  // SYM_LIST(prog_conf_elements_c)

   205

    void *visit(prog_conf_elements_c *symbol);

   206

   207

  /*  fb_name WITH task_name */

   208

  /*

   209

  SYM_REF2(fb_task_c, fb_name, task_name)

   210

  */

   211

   212

  /*  any_symbolic_variable ASSIGN prog_data_source */

   213

  // SYM_REF2(prog_cnxn_assign_c, symbolic_variable, prog_data_source)

   214

    void *visit(prog_cnxn_assign_c *symbol);

   215

   216

  /* any_symbolic_variable SENDTO data_sink */

   217

  // SYM_REF2(prog_cnxn_sendto_c, symbolic_variable, prog_data_source)

   218

    void *visit(prog_cnxn_sendto_c *symbol);

   219

   220

  /* VAR_CONFIG instance_specific_init_list END_VAR */

   221

  /*

   222

  SYM_REF2(instance_specific_initializations_c, instance_specific_init_list, unused)

   223

  */

   224

   225

  /* helper symbol for instance_specific_initializations */

   226

  /*

   227

  SYM_LIST(instance_specific_init_list_c)

   228

  */

   229

   230

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

   231

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

   232

  */

   233

  /*

   234

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

   235

  */

   236

   237

  /* helper symbol for instance_specific_init */

   238

  /* function_block_type_name ':=' structure_initialization */

   239

  /*

   240

  SYM_REF2(fb_initialization_c, function_block_type_name, structure_initialization)

   241

  */

   242

   243

   244

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

   245

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

   246

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

   247

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

   248

  /* B 2.1 Instructions and Operands */

   249

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

   250

   251

  /* | function_name [il_operand_list] */

   252

  // SYM_REF2(il_function_call_c, function_name, il_operand_list)

   253

    void *visit(il_function_call_c *symbol);

   254

   255

   256

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

   257

  // SYM_REF2(il_formal_funct_call_c, function_name, il_param_list)

   258

    void *visit(il_formal_funct_call_c *symbol);

   259

   260

   261

  /*   il_call_operator prev_declared_fb_name

   262

   * | il_call_operator prev_declared_fb_name '(' ')'

   263

   * | il_call_operator prev_declared_fb_name '(' eol_list ')'

   264

   * | il_call_operator prev_declared_fb_name '(' il_operand_list ')'

   265

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

   266

   */

   267

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

   268

    void *visit(il_fb_call_c *symbol);

   269

   270

   271

   272

  /* | il_operand_list ',' il_operand */

   273

  // SYM_LIST(il_operand_list_c)

   274

    void *visit(il_operand_list_c *symbol);

   275

   276

   277

  /* | il_initial_param_list il_param_instruction */

   278

  // SYM_LIST(il_param_list_c)

   279

    void *visit(il_param_list_c *symbol);

   280

   281

  /*  il_assign_operator il_operand

   282

   * | il_assign_operator '(' eol_list simple_instr_list ')'

   283

   */

   284

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

   285

    void *visit(il_param_assignment_c *symbol);

   286

   287

  /*  il_assign_out_operator variable */

   288

  // SYM_REF2(il_param_out_assignment_c, il_assign_out_operator, variable);

   289

    void *visit(il_param_out_assignment_c *symbol);

   290

   291

   292

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

   293

  /* B 2.2 Operators */

   294

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

   295

  /*  any_identifier ASSIGN */

   296

  // SYM_REF1(il_assign_operator_c, variable_name)

   297

    void *visit(il_assign_operator_c *symbol);

   298

   299

  /*| [NOT] any_identifier SENDTO */

   300

  // SYM_REF2(il_assign_out_operator_c, option, variable_name)

   301

    void *visit(il_assign_out_operator_c *symbol);

   302

   303

   304

   305

   306

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

   307

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

   308

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

   309

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

   310

  /* B 3.1 - Expressions */

   311

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

   312

   313

  /*

   314

  SYM_REF2(function_invocation_c, function_name, parameter_assignment_list)

   315

  */

   316

    void *visit(function_invocation_c *symbol);

   317

   318

   319

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

   320

  /* B 3.2 Statements */

   321

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

   322

   323

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

   324

  /* B 3.2.1 Assignment Statements */

   325

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

   326

  /*

   327

  SYM_REF2(assignment_statement_c, l_exp, r_exp)

   328

  */

   329

   330

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

   331

  /* B 3.2.2 Subprogram Control Statements */

   332

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

   333

  /*  RETURN */

   334

  // SYM_REF0(return_statement_c)

   335

   336

   337

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

   338

  /* param_assignment_list -> may be NULL ! */

   339

  // SYM_REF2(fb_invocation_c, fb_name, param_assignment_list)

   340

    void *visit(fb_invocation_c *symbol);

   341

   342

  /* helper symbol for fb_invocation */

   343

  /* param_assignment_list ',' param_assignment */

   344

  // SYM_LIST(param_assignment_list_c)

   345

    void *visit(param_assignment_list_c *symbol);

   346

   347

  /*  variable_name ASSIGN expression */

   348

  // SYM_REF2(input_variable_param_assignment_c, variable_name, expression)

   349

    void *visit(input_variable_param_assignment_c *symbol);

   350

   351

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

   352

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

   353

    void *visit(output_variable_param_assignment_c *symbol);

   354

   355

  /* helper CLASS for output_variable_param_assignment */

   356

  // SYM_REF0(not_paramassign_c)

   357

  // TODO... ???

   358

   359

};  // function_call_param_iterator_c

   360

   361

   362

   363