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

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

   109

}

   110

   111

unsigned int search_var_instance_decl_c::get_vartype(symbol_c *variable) {

   112

  this->current_vartype = none_vt;

   113

  this->current_option  = none_opt;

   114

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

   115

  search_scope->accept(*this);

   116

  return this->current_vartype;

   117

}

   118

   119

unsigned int search_var_instance_decl_c::get_option(symbol_c *variable) {

   120

  this->current_vartype = none_vt;

   121

  this->current_option  = none_opt;

   122

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

   123

  search_scope->accept(*this);

   124

  return this->current_option;

   125

}

   126

   127

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

   128

/* B 0 - Programming Model */

   129

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

   130

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

   131

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

   132

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

   133

   */

   134

  return NULL;

   135

}

   136

   137

   138

   139

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

   140

/* B 1.4.3 - Declaration & Initialization */

   141

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

   142

   143

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

   144

// SYM_REF2(edge_declaration_c, edge, var1_list)

   145

// TODO

   146

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

   147

  current_option = constant_opt;

   148

  return NULL;

   149

}

   150

   151

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

   152

  current_option = retain_opt;

   153

  return NULL;

   154

}

   155

   156

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

   157

  current_option = non_retain_opt;

   158

  return NULL;

   159

}

   160

   161

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

   162

  current_vartype = input_vt;

   163

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

   164

  if (NULL != symbol->option)  

   165

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

   166

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

   167

  if (res == NULL) {

   168

    current_vartype = none_vt;

   169

    current_option  = none_opt;

   170

  }

   171

  return res;

   172

}

   173

   174

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

   175

/* option -> may be NULL ! */

   176

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

   177

  current_vartype = output_vt;

   178

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

   179

  if (NULL != symbol->option)

   180

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

   181

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

   182

  if (res == NULL) {

   183

    current_vartype = none_vt;

   184

    current_option  = none_opt;

   185

  }

   186

  return res;

   187

}

   188

   189

/*  VAR_IN_OUT var_declaration_list END_VAR */

   190

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

   191

  current_vartype = inoutput_vt;

   192

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

   193

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

   194

  if (res == NULL) {

   195

    current_vartype = none_vt;

   196

  }

   197

  return res;

   198

}

   199

   200

/* ENO : BOOL */

   201

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

   202

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

   203

    return symbol->type;

   204

  return NULL;

   205

}

   206

   207

   208

/* VAR [CONSTANT] var_init_decl_list END_VAR */

   209

/* option -> may be NULL ! */

   210

/* helper symbol for input_declarations */

   211

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

   212

  current_vartype = private_vt;

   213

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

   214

  if (NULL != symbol->option)

   215

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

   216

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

   217

  if (res == NULL) {

   218

    current_vartype = none_vt;

   219

    current_option = none_opt;

   220

  }

   221

  return res;

   222

}

   223

   224

/*  VAR RETAIN var_init_decl_list END_VAR */

   225

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

   226

  current_vartype = private_vt;

   227

  current_option  = retain_opt;

   228

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

   229

  if (res == NULL) {

   230

    current_vartype = none_vt;

   231

    current_option = none_opt;

   232

  }

   233

  return res;

   234

}

   235

   236

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

   237

/* option -> may be NULL ! */

   238

//SYM_REF2(located_var_declarations_c, option, located_var_decl_list)

   239

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

   240

  current_vartype = located_vt;

   241

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

   242

  if (NULL != symbol->option)

   243

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

   244

  void *res = symbol->located_var_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_EXTERNAL [CONSTANT] external_declaration_list END_VAR */

   253

/* option -> may be NULL ! */

   254

//SYM_REF2(external_var_declarations_c, option, external_declaration_list)

   255

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

   256

  current_vartype = external_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->external_declaration_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_GLOBAL [CONSTANT|RETAIN] global_var_decl_list END_VAR */

   269

/* option -> may be NULL ! */

   270

//SYM_REF2(global_var_declarations_c, option, global_var_decl_list)

   271

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

   272

  current_vartype = global_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->global_var_decl_list->accept(*this);

   277

  if (res == NULL) {

   278

    current_vartype = none_vt;

   279

    current_option = none_opt;

   280

  }

   281

  return res;

   282

}

   283

   284

/* var1_list is one of the following...

   285

 *    simple_spec_init_c *

   286

 *    subrange_spec_init_c *

   287

 *    enumerated_spec_init_c *

   288

 */

   289

// SYM_REF2(var1_init_decl_c, var1_list, spec_init)

   290

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

   291

  current_type_decl = symbol->spec_init;

   292

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

   293

}

   294

   295

/* var1_list ',' variable_name */

   296

// SYM_LIST(var1_list_c)

   297

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

   298

  list_c *list = symbol;

   299

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

   300

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

   301

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

   302

      return current_type_decl;

   303

  }

   304

  return NULL;

   305

}

   306

   307

/* name_list ':' function_block_type_name ASSIGN structure_initialization */

   308

/* structure_initialization -> may be NULL ! */

   309

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

   310

  current_type_decl = symbol->function_block_type_name;

   311

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

   312

}

   313

   314

/* name_list ',' fb_name */

   315

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

   316

  list_c *list = symbol;

   317

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

   318

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

   319

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

   320

      return current_type_decl;

   321

  }

   322

  return NULL;

   323

}

   324

   325

/* var1_list ':' array_spec_init */

   326

// SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   327

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

   328

  current_type_decl = symbol->array_spec_init;

   329

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

   330

}

   331

   332

/*  var1_list ':' initialized_structure */

   333

// SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   334

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

   335

  current_type_decl = symbol->initialized_structure;

   336

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

   337

}

   338

   339

/*  var1_list ':' array_specification */

   340

// SYM_REF2(array_var_declaration_c, var1_list, array_specification)

   341

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

   342

  current_type_decl = symbol->array_specification;

   343

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

   344

}

   345

   346

/*  var1_list ':' structure_type_name */

   347

// SYM_REF2(structured_var_declaration_c, var1_list, structure_type_name)

   348

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

   349

  current_type_decl = symbol->structure_type_name;

   350

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

   351

}

   352

   353

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

   354

/* variable_name -> may be NULL ! */

   355

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

   356

// TODO!!

   357

   358

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

   359

// SYM_REF2(external_declaration_c, global_var_name, specification)

   360

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

   361

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

   362

      return symbol->specification;

   363

  return NULL;

   364

}

   365

   366

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

   367

/* type_specification ->may be NULL ! */

   368

// SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   369

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

   370

  if (symbol->type_specification != NULL) {

   371

    current_type_decl = symbol->type_specification;

   372

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

   373

  }

   374

  else

   375

    return NULL;

   376

}

   377

   378

/*| global_var_name location */

   379

//SYM_REF2(global_var_spec_c, global_var_name, location)

   380

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

   381

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

   382

      return current_type_decl;

   383

  else

   384

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

   385

}

   386

   387

/*| global_var_list ',' global_var_name */

   388

//SYM_LIST(global_var_list_c)

   389

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

   390

  list_c *list = symbol;

   391

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

   392

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

   393

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

   394

      return current_type_decl;

   395

  }

   396

  return NULL;

   397

}

   398

   399

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

   400

/* variable_name -> may be NULL ! */

   401

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

   402

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

   403

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

   404

    return symbol->located_var_spec_init;

   405

  else {

   406

    current_type_decl = symbol->located_var_spec_init;

   407

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

   408

  }

   409

}

   410

   411

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

   412

/* type_specification ->may be NULL ! */

   413

// SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   414

// TODO!!

   415

   416

/*  AT direct_variable */

   417

// SYM_REF2(location_c, direct_variable, unused)

   418

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

   419

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

   420

    return current_type_decl;

   421

  else

   422

    return NULL;

   423

}

   424

   425

/*| global_var_list ',' global_var_name */

   426

// SYM_LIST(global_var_list_c)

   427

// TODO!!

   428

   429

/*  var1_list ':' single_byte_string_spec */

   430

// SYM_REF2(single_byte_string_var_declaration_c, var1_list, single_byte_string_spec)

   431

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

   432

  current_type_decl = symbol->single_byte_string_spec;

   433

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

   434

}

   435

   436

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

   437

/* integer ->may be NULL ! */

   438

/* single_byte_character_string ->may be NULL ! */

   439

// SYM_REF2(single_byte_string_spec_c, integer, single_byte_character_string)

   440

// TODO!!

   441

   442

/*  var1_list ':' double_byte_string_spec */

   443

// SYM_REF2(double_byte_string_var_declaration_c, var1_list, double_byte_string_spec)

   444

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

   445

  current_type_decl = symbol->double_byte_string_spec;

   446

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

   447

}

   448

   449

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

   450

/* integer ->may be NULL ! */

   451

/* double_byte_character_string ->may be NULL ! */

   452

// SYM_REF2(double_byte_string_spec_c, integer, double_byte_character_string)

   453

// TODO!!

   454

   455

/*  variable_name incompl_location ':' var_spec */

   456

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

   457

// TODO!!

   458

   459

/*  AT incompl_location_token */

   460

// SYM_TOKEN(incompl_location_c)

   461

// TODO!!

   462

   463

   464

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

   465

/* B.1.5 - Program organization units */

   466

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

   467

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

   468

/* B 1.5.1 - Functions */

   469

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

   470

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

   471

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

   472

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

   473

   * the variable that will be returned!!

   474

   */

   475

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

   476

      return symbol->type_name;

   477

   478

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

   479

   * visit the variable declarations...!

   480

   */

   481

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

   482

}

   483

   484

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

   485

/* B 1.5.2 - Function Blocks */

   486

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

   487

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

   488

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

   489

   * visit the variable declarations...!

   490

   */

   491

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

   492

}

   493

   494

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

   495

/* B 1.5.3 - Programs */

   496

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

   497

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

   498

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

   499

   * visit the variable declarations...!

   500

   */

   501

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

   502

}

   503

   504

   505

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

   506

/* B 1.7 Configuration elements */

   507

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

   508

   509

/*

   510

CONFIGURATION configuration_name

   511

   optional_global_var_declarations

   512

   (resource_declaration_list | single_resource_declaration)

   513

   optional_access_declarations

   514

   optional_instance_specific_initializations

   515

END_CONFIGURATION