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

    49

#include "function_call_param_iterator.hh"

    50

#include <strings.h>

    51

#include "../main.hh" // required for ERROR() and ERROR_MSG() macros.

    52

    53

    54

//#define DEBUG

    55

#ifdef DEBUG

    56

#define TRACE(classname) printf("\n____%s____\n",classname);

    57

#else

    58

#define TRACE(classname)

    59

#endif

    60

    61

    62

    63

    64

    65

    66

void *function_call_param_iterator_c::search_list(list_c *list) {

    67

  switch (current_operation) {

    68

    case iterate_nf_op:

    69

      for(int i = 0; i < list->n; i++) {

    70

        void *res = list->elements[i]->accept(*this);

    71

        if (NULL != res) {

    72

          /* It went through the handle_parameter_assignment() function,

    73

           * and is therefore a parameter assignment (<param> = <value>),

    74

           * and not a simple expression (<value>).

    75

           */

    76

          /* we do nothing... */

    77

        } else {

    78

          param_count++;

    79

          if (param_count == iterate_nf_next_param) {

    80

            return list->elements[i];

    81

          }

    82

        }

    83

      }

    84

      return NULL;

    85

      break;

    86

    87

    case iterate_f_op:

    88

      for(int i = 0; i < list->n; i++) {

    89

        void *res = list->elements[i]->accept(*this);

    90

        if (NULL != res) {

    91

          /* It went through the handle_parameter_assignment() function,

    92

           * and is therefore a parameter assignment (<param> = <value>),

    93

           * and not a simple expression (<value>).

    94

           */

    95

          param_count++;

    96

          if (param_count == iterate_f_next_param) {

    97

            return res;

    98

          }

    99

        } else {

   100

          /* we do nothing... */

   101

        }

   102

      }

   103

      return NULL;

   104

      break;

   105

   106

    case search_f_op:

   107

      for(int i = 0; i < list->n; i++) {

   108

        void *res = list->elements[i]->accept(*this);

   109

        if (res != NULL)

   110

          return res;

   111

      }

   112

      return NULL;

   113

      break;

   114

  } /* switch */

   115

  return NULL;

   116

}

   117

   118

   119

   120

void *function_call_param_iterator_c::handle_parameter_assignment(symbol_c *variable_name, symbol_c *expression) {

   121

  switch (current_operation) {

   122

    case iterate_nf_op:

   123

          /* UGLY HACK -> this will be detected in the search_list() function */

   124

      return (void *)variable_name; /* anything, as long as it is not NULL!! */

   125

      break;

   126

   127

    case iterate_f_op:

   128

      current_value = expression;

   129

      return (void *)variable_name;

   130

      break;

   131

   132

    case search_f_op:

   133

      identifier_c *variable_name2 = dynamic_cast<identifier_c *>(variable_name);

   134

   135

      if (variable_name2 == NULL) ERROR;

   136

   137

      if (strcasecmp(search_param_name->value, variable_name2->value) == 0)

   138

        /* FOUND! This is the same parameter!! */

   139

        return (void *)expression;

   140

      return NULL;

   141

      break;

   142

  }

   143

   144

  ERROR;

   145

  return NULL;

   146

}

   147

   148

   149

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

   150

void function_call_param_iterator_c::reset(void) {

   151

  iterate_nf_next_param = 0;

   152

  iterate_f_next_param  = 0;

   153

  param_count = 0;

   154

}

   155

   156

/* initialise the iterator object.

   157

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

   158

 * that will be analysed...

   159

 */

   160

function_call_param_iterator_c::function_call_param_iterator_c(symbol_c *f_call) {

   161

  /* It is expected that f_call will reference one of the following:

   162

   *  program_configuration_c

   163

   *  function_invocation_c

   164

   *  fb_invocation_c

   165

   *  il_function_call_c

   166

   *  il_formal_funct_call_c

   167

   *  ... (have I missed any?)

   168

   */

   169

  this->f_call = f_call;

   170

  search_param_name = NULL;

   171

  reset();

   172

}

   173

   174

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

   175

 * the object references on parameter _before_ the first, so

   176

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

   177

 * reference the first parameter...

   178

 *

   179

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

   180

 * You can determine the value being passed by calling 

   181

 * function_call_param_iterator_c::search_f()

   182

 */

   183

symbol_c *function_call_param_iterator_c::next_f(void) {

   184

  current_value = NULL;

   185

  current_assign_direction = assign_none;

   186

  param_count = 0;

   187

  iterate_f_next_param++;

   188

  current_operation = function_call_param_iterator_c::iterate_f_op;

   189

  void *res = f_call->accept(*this);

   190

  return (symbol_c *)res;

   191

}

   192

   193

   194

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

   195

 * the object references on parameter _before_ the first, so

   196

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

   197

 * reference the first parameter...

   198

 *

   199

 * Returns whatever is being passed to the parameter!

   200

 */

   201

symbol_c *function_call_param_iterator_c::next_nf(void) {

   202

  current_value = NULL;

   203

  current_assign_direction = assign_none;

   204

  param_count = 0;

   205

  iterate_nf_next_param++;

   206

  current_operation = function_call_param_iterator_c::iterate_nf_op;

   207

  void *res = f_call->accept(*this);

   208

  current_value = (symbol_c *)res;

   209

  return (symbol_c *)res;

   210

}

   211

   212

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

   213

symbol_c *function_call_param_iterator_c::search_f(symbol_c *param_name) {

   214

  current_value = NULL;

   215

  current_assign_direction = assign_none;

   216

  if (NULL == param_name) ERROR;

   217

  search_param_name = dynamic_cast<identifier_c *>(param_name);

   218

  if (NULL == search_param_name) ERROR;

   219

  current_operation = function_call_param_iterator_c::search_f_op;

   220

  void *res = f_call->accept(*this);

   221

  current_value = (symbol_c *)res;

   222

  return (symbol_c *)res;

   223

}

   224

   225

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

   226

symbol_c *function_call_param_iterator_c::search_f(const char *param_name) {

   227

  identifier_c tmp_indentifier(param_name);

   228

  return search_f(&tmp_indentifier);

   229

}

   230

   231

   232

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

   233

symbol_c *function_call_param_iterator_c::get_current_value(void) {

   234

  return current_value;

   235

}

   236

   237

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

   238

function_call_param_iterator_c::assign_direction_t function_call_param_iterator_c::get_assign_direction(void) {

   239

  return current_assign_direction;

   240

}

   241

   242

   243

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

   244

/* B 1.7 Configuration elements */

   245

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

   246

   247

/*

   248

CONFIGURATION configuration_name

   249

   optional_global_var_declarations

   250

   (resource_declaration_list | single_resource_declaration)

   251

   optional_access_declarations

   252

   optional_instance_specific_initializations

   253

END_CONFIGURATION

   254

*/

   255

/*

   256

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

   257

*/

   258

   259

/* helper symbol for configuration_declaration */

   260

/*

   261

SYM_LIST(resource_declaration_list_c)

   262

*/

   263

   264

/*

   265

RESOURCE resource_name ON resource_type_name

   266

   optional_global_var_declarations

   267

   single_resource_declaration

   268

END_RESOURCE

   269

*/

   270

/*

   271

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

   272

*/

   273

   274

/* task_configuration_list program_configuration_list */

   275

/*

   276

SYM_REF2(single_resource_declaration_c, task_configuration_list, program_configuration_list)

   277

*/

   278

   279

/* helper symbol for single_resource_declaration */

   280

/*

   281

SYM_LIST(task_configuration_list_c)

   282

*/

   283

   284

/* helper symbol for single_resource_declaration */

   285

/*

   286

SYM_LIST(program_configuration_list_c)

   287

*/

   288

   289

/* helper symbol for

   290

 *  - access_path

   291

 *  - instance_specific_init

   292

 */

   293

/*

   294

SYM_LIST(any_fb_name_list_c)

   295

*/

   296

   297

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

   298

/*

   299

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

   300

*/

   301

   302

/*  prev_declared_program_name '.' symbolic_variable */

   303

/*

   304

SYM_REF2(program_output_reference_c, program_name, symbolic_variable)

   305

*/

   306

   307

/*  TASK task_name task_initialization */

   308

/*

   309

SYM_REF2(task_configuration_c, task_name, task_initialization)

   310

*/

   311

   312

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

   313

/*

   314

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

   315

*/

   316

   317

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

   318

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

   319

void *function_call_param_iterator_c::visit(program_configuration_c *symbol) {

   320

  TRACE("program_configuration_c");

   321

  return symbol->prog_conf_elements->accept(*this);

   322

}

   323

   324

/* prog_conf_elements ',' prog_conf_element */

   325

// SYM_LIST(prog_conf_elements_c)

   326

void *function_call_param_iterator_c::visit(prog_conf_elements_c *symbol) {

   327

  TRACE("prog_conf_elements_c");

   328

  return search_list(symbol);

   329

}

   330

   331

/*  fb_name WITH task_name */

   332

/*

   333

SYM_REF2(fb_task_c, fb_name, task_name)

   334

*/

   335

   336

/*  any_symbolic_variable ASSIGN prog_data_source */

   337

// SYM_REF2(prog_cnxn_assign_c, symbolic_variable, prog_data_source)

   338

void *function_call_param_iterator_c::visit(prog_cnxn_assign_c *symbol) {

   339

  TRACE("prog_cnxn_assign_c");

   340

   341

  /* NOTE: symbolic_variable may be something other than a symbolic_variable_c, but I (Mario)

   342

   *       do not understand the semantics that should be implmeneted if it is not a

   343

   *        symbolic_variable, so for the moment we simply give up!

   344

   */

   345

  symbolic_variable_c *symb_var = dynamic_cast<symbolic_variable_c *>(symbol->symbolic_variable);

   346

  if (NULL == symb_var)

   347

    ERROR;

   348

   349

  current_assign_direction = assign_in;

   350

  return handle_parameter_assignment(symb_var->var_name, symbol->prog_data_source);

   351

}

   352

   353

/* any_symbolic_variable SENDTO data_sink */

   354

// SYM_REF2(prog_cnxn_sendto_c, symbolic_variable, prog_data_source)

   355

void *function_call_param_iterator_c::visit(prog_cnxn_sendto_c *symbol) {

   356

  TRACE("prog_cnxn_sendto_c");

   357

   358

  /* NOTE: symbolic_variable may be something other than a symbolic_variable_c, but I (Mario)

   359

   *       do not understand the semantics that should be implmeneted if it is not a

   360

   *        symbolic_variable, so for the moment we simply give up!

   361

   */

   362

  symbolic_variable_c *symb_var = dynamic_cast<symbolic_variable_c *>(symbol->symbolic_variable);

   363

  if (NULL == symb_var)

   364

    ERROR;

   365

   366

  current_assign_direction = assign_out;

   367

  return handle_parameter_assignment(symb_var->var_name, symbol->data_sink);

   368

}

   369

   370

/* VAR_CONFIG instance_specific_init_list END_VAR */

   371

/*

   372

SYM_REF2(instance_specific_initializations_c, instance_specific_init_list, unused)

   373

*/

   374

   375

/* helper symbol for instance_specific_initializations */

   376

/*

   377

SYM_LIST(instance_specific_init_list_c)

   378

*/

   379

   380

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

   381

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

   382

*/

   383

/*

   384

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

   385

*/

   386

   387

/* helper symbol for instance_specific_init */

   388

/* function_block_type_name ':=' structure_initialization */

   389

/*

   390

SYM_REF2(fb_initialization_c, function_block_type_name, structure_initialization)

   391

*/

   392

   393

   394

   395

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

   396

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

   397

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

   398

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

   399

/* B 2.1 Instructions and Operands */

   400

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

   401

   402

/* | function_name [il_operand_list] */

   403

// SYM_REF2(il_function_call_c, function_name, il_operand_list)

   404

void *function_call_param_iterator_c::visit(il_function_call_c *symbol) {

   405

  TRACE("il_function_call_c");

   406

  if (NULL != symbol->il_operand_list)

   407

    return symbol->il_operand_list->accept(*this);

   408

  return NULL;

   409

}

   410

   411

   412

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

   413

// SYM_REF2(il_formal_funct_call_c, function_name, il_param_list)

   414

void *function_call_param_iterator_c::visit(il_formal_funct_call_c *symbol) {

   415

  TRACE("il_formal_funct_call_c");

   416

  if (NULL != symbol->il_param_list)

   417

    return symbol->il_param_list->accept(*this);

   418

  return NULL;

   419

}

   420

   421

   422

/*   il_call_operator prev_declared_fb_name

   423

 * | il_call_operator prev_declared_fb_name '(' ')'

   424

 * | il_call_operator prev_declared_fb_name '(' eol_list ')'

   425

 * | il_call_operator prev_declared_fb_name '(' il_operand_list ')'

   426

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

   427

 */

   428

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

   429

void *function_call_param_iterator_c::visit(il_fb_call_c *symbol) {

   430

  TRACE("il_fb_call_c");

   431

  /* the following should never occur. In reality the syntax parser

   432

   * will guarantee that they never occur, but it makes it easier to

   433

   * understand the remaining code :-)

   434

   */

   435

  //if ((NULL == symbol->il_operand_list) && (NULL == symbol->il_param_list)) ERROR;

   436

  //if ((NULL != symbol->il_operand_list) && (NULL != symbol->il_param_list)) ERROR;

   437

   438

  if (NULL != symbol->il_operand_list)

   439

    return symbol->il_operand_list->accept(*this);

   440

  if (NULL != symbol->il_param_list)

   441

    return symbol->il_param_list->accept(*this);

   442

  return NULL;

   443

}

   444

   445

/* | il_operand_list ',' il_operand */

   446

// SYM_LIST(il_operand_list_c)

   447

void *function_call_param_iterator_c::visit(il_operand_list_c *symbol) {

   448

  TRACE("il_operand_list_c");

   449

  return search_list(symbol);

   450

}

   451

   452

   453

/* | il_initial_param_list il_param_instruction */

   454

// SYM_LIST(il_param_list_c)

   455

void *function_call_param_iterator_c::visit(il_param_list_c *symbol) {

   456

  TRACE("il_param_list_c");

   457

  return search_list(symbol);

   458

}

   459

   460

/*  il_assign_operator il_operand

   461

 * | il_assign_operator '(' eol_list simple_instr_list ')'

   462

 */

   463

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

   464

void *function_call_param_iterator_c::visit(il_param_assignment_c *symbol) {

   465

  TRACE("il_param_assignment_c");

   466

   467

  // TODO : We do not yet handle a instruction list passed as parameter !!!

   468

  // since we do not yet support it, it is best to simply stop than to fail silently...

   469

  if (NULL != symbol->simple_instr_list) ERROR;

   470

   471

  current_assign_direction = assign_in;

   472

  return handle_parameter_assignment((symbol_c *)symbol->il_assign_operator->accept(*this), symbol->il_operand);

   473

}

   474

   475

/*  il_assign_out_operator variable */

   476

// SYM_REF2(il_param_out_assignment_c, il_assign_out_operator, variable);

   477

void *function_call_param_iterator_c::visit(il_param_out_assignment_c *symbol) {

   478

  TRACE("il_param_out_assignment_c");

   479

  current_assign_direction = assign_out;

   480

  return handle_parameter_assignment((symbol_c *)symbol->il_assign_out_operator->accept(*this), symbol->variable);

   481

}

   482

   483

   484

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

   485

/* B 2.2 Operators */

   486

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

   487

/*  any_identifier ASSIGN */

   488

// SYM_REF1(il_assign_operator_c, variable_name)

   489

void *function_call_param_iterator_c::visit(il_assign_operator_c *symbol) {

   490

  TRACE("il_assign_operator_c");

   491

  return (void *)symbol->variable_name;

   492

}

   493

   494

/*| [NOT] any_identifier SENDTO */

   495

// SYM_REF2(il_assign_out_operator_c, option, variable_name)

   496

void *function_call_param_iterator_c::visit(il_assign_out_operator_c *symbol) {

   497

  TRACE("il_assign_out_operator_c");

   498

   499

  // TODO : Handle not_param !!!

   500

  // we do not yet support it, so it is best to simply stop than to fail silently...

   501

  // if (NULL != symbol->option) ERROR;

   502

   503

  return (void *)symbol->variable_name;

   504

}

   505

   506

   507

   508

   509

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

   510

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

   511

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

   512

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

   513

/* B 3.1 - Expressions */

   514

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

   515

   516

/*

   517

SYM_REF2(function_invocation_c, function_name, parameter_assignment_list)