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

/* Search in a VAR* END_VAR declaration for the delcration of the specified variable instance. 

    34

 * Will return:

    35

 *     - the declaration itself (get_decl() )

    36

 *     - the type of declaration in which the variable was declared (get_vartype() )

    37

 *

    38

 * The variable instance may NOT be a member of a structure of a memeber

    39

 * of a structure of an element of an array of ...

    40

 *

    41

 * For example, considering the following 'variables':

    42

 *    window.points[1].coordinate.x

    43

 *    window.points[1].colour

    44

 *    offset[99]

    45

 *

    46

 *   passing a reference to 'points', 'points[1]', 'points[1].colour', 'colour'

    47

 *    ARE NOT ALLOWED!

    48

 *

    49

 * This class must only be passed the name of the variable that will appear

    50

 * in the variable declaration. In the above examples, this would be

    51

 *   'window.points[1].coordinate.x'

    52

 *   'window.points[1].coordinate'

    53

 *   'window.points[1]'

    54

 *   'window'

    55

 *   'window.points[1].colour'

    56

 *   'offset'

    57

 *   'offset[99]'

    58

 *

    59

 *

    60

 */

    61

    62

/* Note: 

    63

 * Determining the declaration type of a specific variable instance (including

    64

 * function block instances) really means determining whether the variable was declared in a

    65

 *  VAR_INPUT

    66

 *  VAR_OUTPUT

    67

 *  VAR_IN_OUT

    68

 *  VAR

    69

 *  VAR_TEMP

    70

 *  VAR_EXTERNAL

    71

 *  VAR_GLOBAL

    72

 *  VAR <var_name> AT <location>   -> Located variable!

    73

 * 

    74

 */

    75

    76

/* Note:

    77

 *  The current_type_decl that this class returns may reference the

    78

 * name of a type, or the type declaration itself!

    79

 * For an example of the first, consider a variable declared as ...

    80

 * x : AAA;

    81

 * where the AAA type is previously declared as whatever.

    82

 * For an example of the second, consider a variable declared as ...

    83

 * x : array of int [10];  ---->  is allowed

    84

 *

    85

 * If it is the first, we will return a reference to the name, if the second

    86

 * we return a reference to the declaration!!

    87

 */

    88

    89

    90

#include "absyntax_utils.hh"

    91

    92

    93

    94

    95

    96

search_var_instance_decl_c::search_var_instance_decl_c(symbol_c *search_scope) {

    97

  this->current_vartype = none_vt;

    98

  this->search_scope = search_scope;

    99

  this->search_name = NULL;

   100

  this->current_type_decl = NULL;

   101

  this->current_option = none_opt;

   102

}

   103

   104

symbol_c *search_var_instance_decl_c::get_decl(symbol_c *variable) {

   105

  this->current_vartype = none_vt;

   106

  this->current_option  = none_opt;

   107

  this->search_name = get_var_name_c::get_name(variable);

   108

  if (NULL == search_scope) return NULL; // NOTE: This is not an ERROR! declaration_check_c, for e.g., relies on this returning NULL!

   109

  return (symbol_c *)search_scope->accept(*this);

   110

}

   111

   112

symbol_c *search_var_instance_decl_c::get_basetype_decl(symbol_c *variable) {

   113

  return search_base_type_c::get_basetype_decl(get_decl(variable));

   114

}

   115

   116

search_var_instance_decl_c::vt_t search_var_instance_decl_c::get_vartype(symbol_c *variable) {

   117

  this->current_vartype = none_vt;

   118

  this->current_option  = none_opt;

   119

  this->search_name = get_var_name_c::get_name(variable);

   120

  if (NULL == search_scope) ERROR;

   121

  search_scope->accept(*this);

   122

  return this->current_vartype;

   123

}

   124

   125

search_var_instance_decl_c::opt_t search_var_instance_decl_c::get_option(symbol_c *variable) {

   126

  this->current_vartype = none_vt;

   127

  this->current_option  = none_opt;

   128

  this->search_name = get_var_name_c::get_name(variable);

   129

  if (NULL == search_scope) ERROR;

   130

  search_scope->accept(*this);

   131

  return this->current_option;

   132

}

   133

   134

   135

   136

   137

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

   138

/* B 0 - Programming Model */

   139

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

   140

void *search_var_instance_decl_c::visit(library_c *symbol) {

   141

  /* we do not want to search multiple declaration scopes,

   142

   * so we do not visit all the functions, function blocks, etc...

   143

   */

   144

  return NULL;

   145

}

   146

   147

   148

   149

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

   150

/* B 1.4.3 - Declaration & Initialization */

   151

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

   152

   153

/* edge -> The F_EDGE or R_EDGE directive */

   154

// SYM_REF2(edge_declaration_c, edge, var1_list)

   155

// TODO

   156

void *search_var_instance_decl_c::visit(constant_option_c *symbol) {

   157

  current_option = constant_opt;

   158

  return NULL;

   159

}

   160

   161

void *search_var_instance_decl_c::visit(retain_option_c *symbol) {

   162

  current_option = retain_opt;

   163

  return NULL;

   164

}

   165

   166

void *search_var_instance_decl_c::visit(non_retain_option_c *symbol) {

   167

  current_option = non_retain_opt;

   168

  return NULL;

   169

}

   170

   171

void *search_var_instance_decl_c::visit(input_declarations_c *symbol) {

   172

  current_vartype = input_vt;

   173

  current_option  = none_opt; /* not really required. Just to make the code more readable */

   174

  if (NULL != symbol->option)  

   175

    symbol->option->accept(*this);

   176

  void *res = symbol->input_declaration_list->accept(*this);

   177

  if (res == NULL) {

   178

    current_vartype = none_vt;

   179

    current_option  = none_opt;

   180

  }

   181

  return res;

   182

}

   183

   184

/* VAR_OUTPUT [RETAIN | NON_RETAIN] var_init_decl_list END_VAR */

   185

/* option -> may be NULL ! */

   186

void *search_var_instance_decl_c::visit(output_declarations_c *symbol) {

   187

  current_vartype = output_vt;

   188

  current_option  = none_opt; /* not really required. Just to make the code more readable */

   189

  if (NULL != symbol->option)

   190

    symbol->option->accept(*this);

   191

  void *res = symbol->var_init_decl_list->accept(*this);

   192

  if (res == NULL) {

   193

    current_vartype = none_vt;

   194

    current_option  = none_opt;

   195

  }

   196

  return res;

   197

}

   198

   199

/*  VAR_IN_OUT var_declaration_list END_VAR */

   200

void *search_var_instance_decl_c::visit(input_output_declarations_c *symbol) {

   201

  current_vartype = inoutput_vt;

   202

  current_option  = none_opt; /* not really required. Just to make the code more readable */

   203

  void *res = symbol->var_declaration_list->accept(*this);

   204

  if (res == NULL) {

   205

    current_vartype = none_vt;

   206

  }

   207

  return res;

   208

}

   209

   210

/* ENO : BOOL */

   211

void *search_var_instance_decl_c::visit(eno_param_declaration_c *symbol) {

   212

  if (compare_identifiers(symbol->name, search_name) == 0)

   213

    return symbol->type;

   214

  return NULL;

   215

}

   216

   217

/* EN : BOOL */

   218

void *search_var_instance_decl_c::visit(en_param_declaration_c *symbol) {

   219

  if (compare_identifiers(symbol->name, search_name) == 0)

   220

    return symbol->type_decl;

   221

  return NULL;

   222

}

   223

   224

/* VAR [CONSTANT] var_init_decl_list END_VAR */

   225

/* option -> may be NULL ! */

   226

/* helper symbol for input_declarations */

   227

void *search_var_instance_decl_c::visit(var_declarations_c *symbol) {

   228

  current_vartype = private_vt;

   229

  current_option  = none_opt; /* not really required. Just to make the code more readable */

   230

  if (NULL != symbol->option)

   231

    symbol->option->accept(*this);

   232

  void *res = symbol->var_init_decl_list->accept(*this);

   233

  if (res == NULL) {

   234

    current_vartype = none_vt;

   235

    current_option = none_opt;

   236

  }

   237

  return res;

   238

}

   239

   240

/*  VAR RETAIN var_init_decl_list END_VAR */

   241

void *search_var_instance_decl_c::visit(retentive_var_declarations_c *symbol) {

   242

  current_vartype = private_vt;

   243

  current_option  = retain_opt;

   244

  void *res = symbol->var_init_decl_list->accept(*this);

   245

  if (res == NULL) {

   246

    current_vartype = none_vt;

   247

    current_option = none_opt;

   248

  }

   249

  return res;

   250

}

   251

   252

/*  VAR [CONSTANT|RETAIN|NON_RETAIN] located_var_decl_list END_VAR */

   253

/* option -> may be NULL ! */

   254

//SYM_REF2(located_var_declarations_c, option, located_var_decl_list)

   255

void *search_var_instance_decl_c::visit(located_var_declarations_c *symbol) {

   256

  current_vartype = located_vt;

   257

  current_option  = none_opt; /* not really required. Just to make the code more readable */

   258

  if (NULL != symbol->option)

   259

    symbol->option->accept(*this);

   260

  void *res = symbol->located_var_decl_list->accept(*this);

   261

  if (res == NULL) {

   262

    current_vartype = none_vt;

   263

    current_option  = none_opt;

   264

  }

   265

  return res;

   266

}

   267

   268

/*| VAR_EXTERNAL [CONSTANT] external_declaration_list END_VAR */

   269

/* option -> may be NULL ! */

   270

//SYM_REF2(external_var_declarations_c, option, external_declaration_list)

   271

void *search_var_instance_decl_c::visit(external_var_declarations_c *symbol) {

   272

  current_vartype = external_vt;

   273

  current_option  = none_opt; /* not really required. Just to make the code more readable */

   274

  if (NULL != symbol->option)

   275

    symbol->option->accept(*this);

   276

  void *res = symbol->external_declaration_list->accept(*this);

   277

  if (res == NULL) {

   278

    current_vartype = none_vt;

   279

    current_option = none_opt;

   280

  }

   281

  return res;

   282

}

   283

   284

/*| VAR_GLOBAL [CONSTANT|RETAIN] global_var_decl_list END_VAR */

   285

/* option -> may be NULL ! */

   286

//SYM_REF2(global_var_declarations_c, option, global_var_decl_list)

   287

void *search_var_instance_decl_c::visit(global_var_declarations_c *symbol) {

   288

  current_vartype = global_vt;

   289

  current_option  = none_opt; /* not really required. Just to make the code more readable */

   290

  if (NULL != symbol->option)

   291

    symbol->option->accept(*this);

   292

  void *res = symbol->global_var_decl_list->accept(*this);

   293

  if (res == NULL) {

   294

    current_vartype = none_vt;

   295

    current_option = none_opt;

   296

  }

   297

  return res;

   298

}

   299

   300

/* var1_list is one of the following...

   301

 *    simple_spec_init_c *

   302

 *    subrange_spec_init_c *

   303

 *    enumerated_spec_init_c *

   304

 */

   305

// SYM_REF2(var1_init_decl_c, var1_list, spec_init)

   306

void *search_var_instance_decl_c::visit(var1_init_decl_c *symbol) {

   307

  current_type_decl = symbol->spec_init;

   308

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

   309

}

   310

   311

/* var1_list ',' variable_name */

   312

// SYM_LIST(var1_list_c)

   313

void *search_var_instance_decl_c::visit(var1_list_c *symbol) {

   314

  list_c *list = symbol;

   315

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

   316

    if (compare_identifiers(list->get_element(i), search_name) == 0)

   317

   /* by now, current_type_decl should be != NULL */

   318

      return current_type_decl;

   319

  }

   320

  return NULL;

   321

}

   322

   323

/* name_list ':' function_block_type_name ASSIGN structure_initialization */

   324

/* structure_initialization -> may be NULL ! */

   325

void *search_var_instance_decl_c::visit(fb_name_decl_c *symbol) {

   326

  // TODO: The following line is wrong! It should be

   327

  // current_type_decl = symbol->fb_spec_init;

   328

  //  However, this change will require a check of all callers, to see if they would handle this correctly.

   329

  //  For now, just keep what we have had historically, and seems to be working.

   330

  current_type_decl = spec_init_sperator_c::get_spec(symbol->fb_spec_init);

   331

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

   332

}

   333

   334

/* name_list ',' fb_name */

   335

void *search_var_instance_decl_c::visit(fb_name_list_c *symbol) {

   336

  list_c *list = symbol;

   337

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

   338

    if (compare_identifiers(list->get_element(i), search_name) == 0)

   339

    /* by now, current_fb_declaration should be != NULL */

   340

      return current_type_decl;

   341

  }

   342

  return NULL;

   343

}

   344

   345

/* var1_list ':' array_spec_init */

   346

// SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   347

void *search_var_instance_decl_c::visit(array_var_init_decl_c *symbol) {

   348

  current_type_decl = symbol->array_spec_init;

   349

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

   350

}

   351

   352

/*  var1_list ':' initialized_structure */

   353

// SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   354

void *search_var_instance_decl_c::visit(structured_var_init_decl_c *symbol) {

   355

  current_type_decl = symbol->initialized_structure;

   356

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

   357

}

   358

   359

/*  var1_list ':' array_specification */

   360

// SYM_REF2(array_var_declaration_c, var1_list, array_specification)

   361

void *search_var_instance_decl_c::visit(array_var_declaration_c *symbol) {

   362

  current_type_decl = symbol->array_specification;

   363

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

   364

}

   365

   366

/*  var1_list ':' structure_type_name */

   367

// SYM_REF2(structured_var_declaration_c, var1_list, structure_type_name)

   368

void *search_var_instance_decl_c::visit(structured_var_declaration_c *symbol) {

   369

  current_type_decl = symbol->structure_type_name;

   370

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

   371

}

   372

   373

/*  [variable_name] location ':' located_var_spec_init */

   374

/* variable_name -> may be NULL ! */

   375

// SYM_REF4(located_var_decl_c, variable_name, location, located_var_spec_init, unused)

   376

// TODO!!

   377

   378

/*  global_var_name ':' (simple_specification|subrange_specification|enumerated_specification|array_specification|prev_declared_structure_type_name|function_block_type_name */

   379

// SYM_REF2(external_declaration_c, global_var_name, specification)

   380

void *search_var_instance_decl_c::visit(external_declaration_c *symbol) {

   381

  if (compare_identifiers(symbol->global_var_name, search_name) == 0)

   382

      return symbol->specification;

   383

  return NULL;

   384

}

   385

   386

/*| global_var_spec ':' [located_var_spec_init|function_block_type_name] */

   387

/* type_specification ->may be NULL ! */

   388

// SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   389

void *search_var_instance_decl_c::visit(global_var_decl_c *symbol) {

   390

  if (symbol->type_specification != NULL) {

   391

    current_type_decl = symbol->type_specification;

   392

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

   393

  }

   394

  else

   395

    return NULL;

   396

}

   397

   398

/*| global_var_name location */

   399

//SYM_REF2(global_var_spec_c, global_var_name, location)

   400

void *search_var_instance_decl_c::visit(global_var_spec_c *symbol) {

   401

  if (symbol->global_var_name != NULL && compare_identifiers(symbol->global_var_name, search_name) == 0)

   402

      return current_type_decl;

   403

  else

   404

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

   405

}

   406

   407

/*| global_var_list ',' global_var_name */

   408

//SYM_LIST(global_var_list_c)

   409

void *search_var_instance_decl_c::visit(global_var_list_c *symbol) {

   410

  list_c *list = symbol;

   411

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

   412

    if (compare_identifiers(list->get_element(i), search_name) == 0)

   413

      /* by now, current_type_decl should be != NULL */

   414

      return current_type_decl;

   415

  }

   416

  return NULL;

   417

}

   418

   419

/*  [variable_name] location ':' located_var_spec_init */

   420

/* variable_name -> may be NULL ! */

   421

//SYM_REF4(located_var_decl_c, variable_name, location, located_var_spec_init, unused)

   422

void *search_var_instance_decl_c::visit(located_var_decl_c *symbol) {

   423

  if (symbol->variable_name != NULL && compare_identifiers(symbol->variable_name, search_name) == 0)

   424

    return symbol->located_var_spec_init;

   425

  else {

   426

    current_type_decl = symbol->located_var_spec_init;

   427

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

   428

  }

   429

}

   430

   431

/*| global_var_spec ':' [located_var_spec_init|function_block_type_name] */

   432

/* type_specification ->may be NULL ! */

   433

// SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   434

// TODO!!

   435

   436

/*  AT direct_variable */

   437

// SYM_REF2(location_c, direct_variable, unused)

   438

void *search_var_instance_decl_c::visit(location_c *symbol) {

   439

  if (compare_identifiers(symbol->direct_variable, search_name) == 0)

   440

    return current_type_decl;

   441

  else

   442

    return NULL;

   443

}

   444

   445

/*| global_var_list ',' global_var_name */

   446

// SYM_LIST(global_var_list_c)

   447

// TODO!!

   448

   449

/*  var1_list ':' single_byte_string_spec */

   450

// SYM_REF2(single_byte_string_var_declaration_c, var1_list, single_byte_string_spec)

   451

void *search_var_instance_decl_c::visit(single_byte_string_var_declaration_c *symbol) {

   452

  current_type_decl = symbol->single_byte_string_spec;

   453

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

   454

}

   455

   456

/*  STRING ['[' integer ']'] [ASSIGN single_byte_character_string] */

   457

/* integer ->may be NULL ! */

   458

/* single_byte_character_string ->may be NULL ! */

   459

// SYM_REF2(single_byte_string_spec_c, integer, single_byte_character_string)

   460

// TODO!!

   461

   462

/*  var1_list ':' double_byte_string_spec */

   463

// SYM_REF2(double_byte_string_var_declaration_c, var1_list, double_byte_string_spec)

   464

void *search_var_instance_decl_c::visit(double_byte_string_var_declaration_c *symbol) {

   465

  current_type_decl = symbol->double_byte_string_spec;

   466

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

   467

}

   468

   469

/*  WSTRING ['[' integer ']'] [ASSIGN double_byte_character_string] */

   470

/* integer ->may be NULL ! */

   471

/* double_byte_character_string ->may be NULL ! */

   472

// SYM_REF2(double_byte_string_spec_c, integer, double_byte_character_string)

   473

// TODO!!

   474

   475

/*  variable_name incompl_location ':' var_spec */

   476

// SYM_REF4(incompl_located_var_decl_c, variable_name, incompl_location, var_spec, unused)

   477

// TODO!!

   478

   479

/*  AT incompl_location_token */

   480

// SYM_TOKEN(incompl_location_c)

   481

// TODO!!

   482

   483

   484

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

   485

/* B.1.5 - Program organization units */

   486

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

   487

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

   488

/* B 1.5.1 - Functions */

   489

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

   490

// SYM_REF4(function_declaration_c, derived_function_name, type_name, var_declarations_list, function_body)

   491

void *search_var_instance_decl_c::visit(function_declaration_c *symbol) {

   492

  /* functions have a variable named after themselves, to store

   493

   * the variable that will be returned!!

   494

   */

   495

  if (compare_identifiers(symbol->derived_function_name, search_name) == 0)

   496

      return symbol->type_name;

   497

   498

  /* no need to search through all the body, so we only

   499

   * visit the variable declarations...!

   500

   */

   501

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

   502

}

   503

   504

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

   505

/* B 1.5.2 - Function Blocks */

   506

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

   507

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   508

// SYM_REF3(function_block_declaration_c, fblock_name, var_declarations, fblock_body)

   509

void *search_var_instance_decl_c::visit(function_block_declaration_c *symbol) {

   510

  /* visit the variable declarations...! */

   511

  void *res = symbol->var_declarations->accept(*this);

   512

  if (NULL != res)