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

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

   113

  this->current_vartype = none_vt;

   114

  this->current_option  = none_opt;

   115

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

   116

  if (NULL == search_scope) ERROR;

   117

  search_scope->accept(*this);

   118

  return this->current_vartype;

   119

}

   120

   121

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

   122

  this->current_vartype = none_vt;

   123

  this->current_option  = none_opt;

   124

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

   125

  if (NULL == search_scope) ERROR;

   126

  search_scope->accept(*this);

   127

  return this->current_option;

   128

}

   129

   130

   131

   132

/* This is a temporary fix. Hopefully, once I clean up stage4 code, and I change the way

   133

 * we generate C code, this function will no longer be needed!

   134

 */

   135

#include <typeinfo>  /* required for typeid() */

   136

bool search_var_instance_decl_c::type_is_complex(symbol_c *symbol) {

   137

  symbol_c *decl;

   138

   139

  decl = this->get_decl(symbol);

   140

  if (NULL == decl) ERROR;

   141

  decl = search_base_type_c::get_basetype_decl(decl);

   142

  if (NULL == decl) ERROR;

   143

   144

  return ((typeid( *(decl) ) == typeid( array_specification_c                )) ||

   145

//        (typeid( *(decl) ) == typeid( array_spec_init_c                    )) ||  /* does not seem to be necessary */

   146

          (typeid( *(decl) ) == typeid( structure_type_declaration_c         )) ||  

   147

          (typeid( *(decl) ) == typeid( structure_element_declaration_list_c )) ||

   148

//        (typeid( *(decl) ) == typeid( structure_type_declaration_c         )) ||  /* does not seem to be necessary */

   149

          (typeid( *(decl) ) == typeid( initialized_structure_c              )) ||

   150

          (search_base_type_c::type_is_fb(decl) && current_vartype == external_vt)

   151

         );

   152

}

   153

   154

bool search_var_instance_decl_c::type_is_fb(symbol_c *symbol) {

   155

    symbol_c *decl;

   156

    search_base_type_c search_base_type;

   157

   158

    decl = this->get_decl(symbol);

   159

    if (NULL == decl) ERROR;

   160

    return search_base_type.type_is_fb(decl);

   161

}

   162

   163

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

   164

/* B 0 - Programming Model */

   165

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

   166

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

   167

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

   168

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

   169

   */

   170

  return NULL;

   171

}

   172

   173

   174

   175

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

   176

/* B 1.4.3 - Declaration & Initialization */

   177

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

   178

   179

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

   180

// SYM_REF2(edge_declaration_c, edge, var1_list)

   181

// TODO

   182

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

   183

  current_option = constant_opt;

   184

  return NULL;

   185

}

   186

   187

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

   188

  current_option = retain_opt;

   189

  return NULL;

   190

}

   191

   192

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

   193

  current_option = non_retain_opt;

   194

  return NULL;

   195

}

   196

   197

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

   198

  current_vartype = input_vt;

   199

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

   200

  if (NULL != symbol->option)  

   201

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

   202

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

   203

  if (res == NULL) {

   204

    current_vartype = none_vt;

   205

    current_option  = none_opt;

   206

  }

   207

  return res;

   208

}

   209

   210

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

   211

/* option -> may be NULL ! */

   212

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

   213

  current_vartype = output_vt;

   214

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

   215

  if (NULL != symbol->option)

   216

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

   217

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

   218

  if (res == NULL) {

   219

    current_vartype = none_vt;

   220

    current_option  = none_opt;

   221

  }

   222

  return res;

   223

}

   224

   225

/*  VAR_IN_OUT var_declaration_list END_VAR */

   226

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

   227

  current_vartype = inoutput_vt;

   228

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

   229

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

   230

  if (res == NULL) {

   231

    current_vartype = none_vt;

   232

  }

   233

  return res;

   234

}

   235

   236

/* ENO : BOOL */

   237

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

   238

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

   239

    return symbol->type;

   240

  return NULL;

   241

}

   242

   243

   244

/* VAR [CONSTANT] var_init_decl_list END_VAR */

   245

/* option -> may be NULL ! */

   246

/* helper symbol for input_declarations */

   247

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

   248

  current_vartype = private_vt;

   249

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

   250

  if (NULL != symbol->option)

   251

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

   252

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

   253

  if (res == NULL) {

   254

    current_vartype = none_vt;

   255

    current_option = none_opt;

   256

  }

   257

  return res;

   258

}

   259

   260

/*  VAR RETAIN var_init_decl_list END_VAR */

   261

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

   262

  current_vartype = private_vt;

   263

  current_option  = retain_opt;

   264

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

   265

  if (res == NULL) {

   266

    current_vartype = none_vt;

   267

    current_option = none_opt;

   268

  }

   269

  return res;

   270

}

   271

   272

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

   273

/* option -> may be NULL ! */

   274

//SYM_REF2(located_var_declarations_c, option, located_var_decl_list)

   275

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

   276

  current_vartype = located_vt;

   277

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

   278

  if (NULL != symbol->option)

   279

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

   280

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

   281

  if (res == NULL) {

   282

    current_vartype = none_vt;

   283

    current_option  = none_opt;

   284

  }

   285

  return res;

   286

}

   287

   288

/*| VAR_EXTERNAL [CONSTANT] external_declaration_list END_VAR */

   289

/* option -> may be NULL ! */

   290

//SYM_REF2(external_var_declarations_c, option, external_declaration_list)

   291

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

   292

  current_vartype = external_vt;

   293

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

   294

  if (NULL != symbol->option)

   295

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

   296

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

   297

  if (res == NULL) {

   298

    current_vartype = none_vt;

   299

    current_option = none_opt;

   300

  }

   301

  return res;

   302

}

   303

   304

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

   305

/* option -> may be NULL ! */

   306

//SYM_REF2(global_var_declarations_c, option, global_var_decl_list)

   307

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

   308

  current_vartype = global_vt;

   309

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

   310

  if (NULL != symbol->option)

   311

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

   312

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

   313

  if (res == NULL) {

   314

    current_vartype = none_vt;

   315

    current_option = none_opt;

   316

  }

   317

  return res;

   318

}

   319

   320

/* var1_list is one of the following...

   321

 *    simple_spec_init_c *

   322

 *    subrange_spec_init_c *

   323

 *    enumerated_spec_init_c *

   324

 */

   325

// SYM_REF2(var1_init_decl_c, var1_list, spec_init)

   326

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

   327

  current_type_decl = symbol->spec_init;

   328

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

   329

}

   330

   331

/* var1_list ',' variable_name */

   332

// SYM_LIST(var1_list_c)

   333

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

   334

  list_c *list = symbol;

   335

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

   336

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

   337

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

   338

      return current_type_decl;

   339

  }

   340

  return NULL;

   341

}

   342

   343

/* name_list ':' function_block_type_name ASSIGN structure_initialization */

   344

/* structure_initialization -> may be NULL ! */

   345

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

   346

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

   347

  // current_type_decl = symbol->fb_spec_init;

   348

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

   349

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

   350

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

   351

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

   352

}

   353

   354

/* name_list ',' fb_name */

   355

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

   356

  list_c *list = symbol;

   357

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

   358

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

   359

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

   360

      return current_type_decl;

   361

  }

   362

  return NULL;

   363

}

   364

   365

/* var1_list ':' array_spec_init */

   366

// SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   367

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

   368

  current_type_decl = symbol->array_spec_init;

   369

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

   370

}

   371

   372

/*  var1_list ':' initialized_structure */

   373

// SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   374

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

   375

  current_type_decl = symbol->initialized_structure;

   376

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

   377

}

   378

   379

/*  var1_list ':' array_specification */

   380

// SYM_REF2(array_var_declaration_c, var1_list, array_specification)

   381

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

   382

  current_type_decl = symbol->array_specification;

   383

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

   384

}

   385

   386

/*  var1_list ':' structure_type_name */

   387

// SYM_REF2(structured_var_declaration_c, var1_list, structure_type_name)

   388

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

   389

  current_type_decl = symbol->structure_type_name;

   390

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

   391

}

   392

   393

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

   394

/* variable_name -> may be NULL ! */

   395

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

   396

// TODO!!

   397

   398

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

   399

// SYM_REF2(external_declaration_c, global_var_name, specification)

   400

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

   401

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

   402

      return symbol->specification;

   403

  return NULL;

   404

}

   405

   406

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

   407

/* type_specification ->may be NULL ! */

   408

// SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   409

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

   410

  if (symbol->type_specification != NULL) {

   411

    current_type_decl = symbol->type_specification;

   412

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

   413

  }

   414

  else

   415

    return NULL;

   416

}

   417

   418

/*| global_var_name location */

   419

//SYM_REF2(global_var_spec_c, global_var_name, location)

   420

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

   421

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

   422

      return current_type_decl;

   423

  else

   424

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

   425

}

   426

   427

/*| global_var_list ',' global_var_name */

   428

//SYM_LIST(global_var_list_c)

   429

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

   430

  list_c *list = symbol;

   431

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

   432

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

   433

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

   434

      return current_type_decl;

   435

  }

   436

  return NULL;

   437

}

   438

   439

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

   440

/* variable_name -> may be NULL ! */

   441

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

   442

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

   443

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

   444

    return symbol->located_var_spec_init;

   445

  else {

   446

    current_type_decl = symbol->located_var_spec_init;

   447

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

   448

  }

   449

}

   450

   451

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

   452

/* type_specification ->may be NULL ! */

   453

// SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   454

// TODO!!

   455

   456

/*  AT direct_variable */

   457

// SYM_REF2(location_c, direct_variable, unused)

   458

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

   459

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

   460

    return current_type_decl;

   461

  else

   462

    return NULL;

   463

}

   464

   465

/*| global_var_list ',' global_var_name */

   466

// SYM_LIST(global_var_list_c)

   467

// TODO!!

   468

   469

/*  var1_list ':' single_byte_string_spec */

   470

// SYM_REF2(single_byte_string_var_declaration_c, var1_list, single_byte_string_spec)

   471

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

   472

  current_type_decl = symbol->single_byte_string_spec;

   473

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

   474

}

   475

   476

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

   477

/* integer ->may be NULL ! */

   478

/* single_byte_character_string ->may be NULL ! */

   479

// SYM_REF2(single_byte_string_spec_c, integer, single_byte_character_string)

   480

// TODO!!

   481

   482

/*  var1_list ':' double_byte_string_spec */

   483

// SYM_REF2(double_byte_string_var_declaration_c, var1_list, double_byte_string_spec)

   484

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

   485

  current_type_decl = symbol->double_byte_string_spec;

   486

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

   487

}

   488

   489

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

   490

/* integer ->may be NULL ! */

   491

/* double_byte_character_string ->may be NULL ! */

   492

// SYM_REF2(double_byte_string_spec_c, integer, double_byte_character_string)

   493

// TODO!!

   494

   495

/*  variable_name incompl_location ':' var_spec */

   496

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

   497

// TODO!!

   498

   499

/*  AT incompl_location_token */

   500

// SYM_TOKEN(incompl_location_c)

   501

// TODO!!

   502

   503

   504

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

   505

/* B.1.5 - Program organization units */

   506

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

   507

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

   508

/* B 1.5.1 - Functions */

   509

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

   510

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

   511

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

   512