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

   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

   218

/* VAR [CONSTANT] var_init_decl_list END_VAR */

   219

/* option -> may be NULL ! */

   220

/* helper symbol for input_declarations */

   221

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

   222

  current_vartype = private_vt;

   223

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

   224

  if (NULL != symbol->option)

   225

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

   226

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

   227

  if (res == NULL) {

   228

    current_vartype = none_vt;

   229

    current_option = none_opt;

   230

  }

   231

  return res;

   232

}

   233

   234

/*  VAR RETAIN var_init_decl_list END_VAR */

   235

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

   236

  current_vartype = private_vt;

   237

  current_option  = retain_opt;

   238

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

   239

  if (res == NULL) {

   240

    current_vartype = none_vt;

   241

    current_option = none_opt;

   242

  }

   243

  return res;

   244

}

   245

   246

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

   247

/* option -> may be NULL ! */

   248

//SYM_REF2(located_var_declarations_c, option, located_var_decl_list)

   249

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

   250

  current_vartype = located_vt;

   251

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

   252

  if (NULL != symbol->option)

   253

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

   254

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

   255

  if (res == NULL) {

   256

    current_vartype = none_vt;

   257

    current_option  = none_opt;

   258

  }

   259

  return res;

   260

}

   261

   262

/*| VAR_EXTERNAL [CONSTANT] external_declaration_list END_VAR */

   263

/* option -> may be NULL ! */

   264

//SYM_REF2(external_var_declarations_c, option, external_declaration_list)

   265

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

   266

  current_vartype = external_vt;

   267

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

   268

  if (NULL != symbol->option)

   269

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

   270

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

   271

  if (res == NULL) {

   272

    current_vartype = none_vt;

   273

    current_option = none_opt;

   274

  }

   275

  return res;

   276

}

   277

   278

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

   279

/* option -> may be NULL ! */

   280

//SYM_REF2(global_var_declarations_c, option, global_var_decl_list)

   281

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

   282

  current_vartype = global_vt;

   283

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

   284

  if (NULL != symbol->option)

   285

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

   286

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

   287

  if (res == NULL) {

   288

    current_vartype = none_vt;

   289

    current_option = none_opt;

   290

  }

   291

  return res;

   292

}

   293

   294

/* var1_list is one of the following...

   295

 *    simple_spec_init_c *

   296

 *    subrange_spec_init_c *

   297

 *    enumerated_spec_init_c *

   298

 */

   299

// SYM_REF2(var1_init_decl_c, var1_list, spec_init)

   300

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

   301

  current_type_decl = symbol->spec_init;

   302

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

   303

}

   304

   305

/* var1_list ',' variable_name */

   306

// SYM_LIST(var1_list_c)

   307

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

   308

  list_c *list = symbol;

   309

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

   310

    if (compare_identifiers(list->elements[i], search_name) == 0)

   311

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

   312

      return current_type_decl;

   313

  }

   314

  return NULL;

   315

}

   316

   317

/* name_list ':' function_block_type_name ASSIGN structure_initialization */

   318

/* structure_initialization -> may be NULL ! */

   319

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

   320

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

   321

  // current_type_decl = symbol->fb_spec_init;

   322

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

   323

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

   324

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

   325

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

   326

}

   327

   328

/* name_list ',' fb_name */

   329

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

   330

  list_c *list = symbol;

   331

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

   332

    if (compare_identifiers(list->elements[i], search_name) == 0)

   333

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

   334

      return current_type_decl;

   335

  }

   336

  return NULL;

   337

}

   338

   339

/* var1_list ':' array_spec_init */

   340

// SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   341

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

   342

  current_type_decl = symbol->array_spec_init;

   343

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

   344

}

   345

   346

/*  var1_list ':' initialized_structure */

   347

// SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   348

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

   349

  current_type_decl = symbol->initialized_structure;

   350

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

   351

}

   352

   353

/*  var1_list ':' array_specification */

   354

// SYM_REF2(array_var_declaration_c, var1_list, array_specification)

   355

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

   356

  current_type_decl = symbol->array_specification;

   357

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

   358

}

   359

   360

/*  var1_list ':' structure_type_name */

   361

// SYM_REF2(structured_var_declaration_c, var1_list, structure_type_name)

   362

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

   363

  current_type_decl = symbol->structure_type_name;

   364

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

   365

}

   366

   367

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

   368

/* variable_name -> may be NULL ! */

   369

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

   370

// TODO!!

   371

   372

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

   373

// SYM_REF2(external_declaration_c, global_var_name, specification)

   374

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

   375

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

   376

      return symbol->specification;

   377

  return NULL;

   378

}

   379

   380

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

   381

/* type_specification ->may be NULL ! */

   382

// SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   383

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

   384

  if (symbol->type_specification != NULL) {

   385

    current_type_decl = symbol->type_specification;

   386

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

   387

  }

   388

  else

   389

    return NULL;

   390

}

   391

   392

/*| global_var_name location */

   393

//SYM_REF2(global_var_spec_c, global_var_name, location)

   394

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

   395

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

   396

      return current_type_decl;

   397

  else

   398

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

   399

}

   400

   401

/*| global_var_list ',' global_var_name */

   402

//SYM_LIST(global_var_list_c)

   403

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

   404

  list_c *list = symbol;

   405

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

   406

    if (compare_identifiers(list->elements[i], search_name) == 0)

   407

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

   408

      return current_type_decl;

   409

  }

   410

  return NULL;

   411

}

   412

   413

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

   414

/* variable_name -> may be NULL ! */

   415

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

   416

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

   417

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

   418

    return symbol->located_var_spec_init;

   419

  else {

   420

    current_type_decl = symbol->located_var_spec_init;

   421

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

   422

  }

   423

}

   424

   425

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

   426

/* type_specification ->may be NULL ! */

   427

// SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   428

// TODO!!

   429

   430

/*  AT direct_variable */

   431

// SYM_REF2(location_c, direct_variable, unused)

   432

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

   433

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

   434

    return current_type_decl;

   435

  else

   436

    return NULL;

   437

}

   438

   439

/*| global_var_list ',' global_var_name */

   440

// SYM_LIST(global_var_list_c)

   441

// TODO!!

   442

   443

/*  var1_list ':' single_byte_string_spec */

   444

// SYM_REF2(single_byte_string_var_declaration_c, var1_list, single_byte_string_spec)

   445

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

   446

  current_type_decl = symbol->single_byte_string_spec;

   447

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

   448

}

   449

   450

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

   451

/* integer ->may be NULL ! */

   452

/* single_byte_character_string ->may be NULL ! */

   453

// SYM_REF2(single_byte_string_spec_c, integer, single_byte_character_string)

   454

// TODO!!

   455

   456

/*  var1_list ':' double_byte_string_spec */

   457

// SYM_REF2(double_byte_string_var_declaration_c, var1_list, double_byte_string_spec)

   458

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

   459

  current_type_decl = symbol->double_byte_string_spec;

   460

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

   461

}

   462

   463

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

   464

/* integer ->may be NULL ! */

   465

/* double_byte_character_string ->may be NULL ! */

   466

// SYM_REF2(double_byte_string_spec_c, integer, double_byte_character_string)

   467

// TODO!!

   468

   469

/*  variable_name incompl_location ':' var_spec */

   470

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

   471

// TODO!!

   472

   473

/*  AT incompl_location_token */

   474

// SYM_TOKEN(incompl_location_c)

   475

// TODO!!

   476

   477

   478

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

   479

/* B.1.5 - Program organization units */

   480

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

   481

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

   482

/* B 1.5.1 - Functions */

   483

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

   484

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

   485

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

   486

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

   487

   * the variable that will be returned!!

   488

   */

   489

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

   490

      return symbol->type_name;

   491

   492

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

   493

   * visit the variable declarations...!

   494

   */

   495

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

   496

}

   497

   498

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

   499

/* B 1.5.2 - Function Blocks */

   500

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

   501

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   502

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

   503

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

   504

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

   505

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

   506

  if (NULL != res)

   507

    return res;

   508

   509

  /* not yet found, so we look into the body, to see if it is an SFC step! */

   510

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

   511

}

   512

   513

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