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

search_var_instance_decl_c::vt_t 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

search_var_instance_decl_c::opt_t 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

   129

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

   130

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

   131

 */

   132

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

   133

bool search_var_instance_decl_c::type_is_complex(symbol_c *symbol) {

   134

  symbol_c *decl;

   135

  search_base_type_c search_base_type;

   136

   137

  decl = this->get_decl(symbol);

   138

  if (NULL == decl) ERROR;

   139

  decl = search_base_type.get_basetype_decl(decl);

   140

  if (NULL == decl) ERROR;

   141

   142

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

   143

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

   144

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

   145

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

   146

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

   147

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

   148

          (search_base_type.type_is_fb(decl) && current_vartype == external_vt)

   149

         );

   150

}

   151

   152

bool search_var_instance_decl_c::type_is_fb(symbol_c *symbol) {

   153

    symbol_c *decl;

   154

    search_base_type_c search_base_type;

   155

   156

    decl = this->get_decl(symbol);

   157

    if (NULL == decl) ERROR;

   158

    return search_base_type.type_is_fb(decl);

   159

}

   160

   161

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

   162

/* B 0 - Programming Model */

   163

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

   164

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

   165

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

   166

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

   167

   */

   168

  return NULL;

   169

}

   170

   171

   172

   173

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

   174

/* B 1.4.3 - Declaration & Initialization */

   175

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

   176

   177

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

   178

// SYM_REF2(edge_declaration_c, edge, var1_list)

   179

// TODO

   180

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

   181

  current_option = constant_opt;

   182

  return NULL;

   183

}

   184

   185

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

   186

  current_option = retain_opt;

   187

  return NULL;

   188

}

   189

   190

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

   191

  current_option = non_retain_opt;

   192

  return NULL;

   193

}

   194

   195

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

   196

  current_vartype = input_vt;

   197

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

   198

  if (NULL != symbol->option)  

   199

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

   200

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

   201

  if (res == NULL) {

   202

    current_vartype = none_vt;

   203

    current_option  = none_opt;

   204

  }

   205

  return res;

   206

}

   207

   208

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

   209

/* option -> may be NULL ! */

   210

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

   211

  current_vartype = output_vt;

   212

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

   213

  if (NULL != symbol->option)

   214

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

   215

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

   216

  if (res == NULL) {

   217

    current_vartype = none_vt;

   218

    current_option  = none_opt;

   219

  }

   220

  return res;

   221

}

   222

   223

/*  VAR_IN_OUT var_declaration_list END_VAR */

   224

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

   225

  current_vartype = inoutput_vt;

   226

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

   227

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

   228

  if (res == NULL) {

   229

    current_vartype = none_vt;

   230

  }

   231

  return res;

   232

}

   233

   234

/* ENO : BOOL */

   235

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

   236

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

   237

    return symbol->type;

   238

  return NULL;

   239

}

   240

   241

   242

/* VAR [CONSTANT] var_init_decl_list END_VAR */

   243

/* option -> may be NULL ! */

   244

/* helper symbol for input_declarations */

   245

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

   246

  current_vartype = private_vt;

   247

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

   248

  if (NULL != symbol->option)

   249

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

   250

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

   251

  if (res == NULL) {

   252

    current_vartype = none_vt;

   253

    current_option = none_opt;

   254

  }

   255

  return res;

   256

}

   257

   258

/*  VAR RETAIN var_init_decl_list END_VAR */

   259

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

   260

  current_vartype = private_vt;

   261

  current_option  = retain_opt;

   262

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

   263

  if (res == NULL) {

   264

    current_vartype = none_vt;

   265

    current_option = none_opt;

   266

  }

   267

  return res;

   268

}

   269

   270

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

   271

/* option -> may be NULL ! */

   272

//SYM_REF2(located_var_declarations_c, option, located_var_decl_list)

   273

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

   274

  current_vartype = located_vt;

   275

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

   276

  if (NULL != symbol->option)

   277

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

   278

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

   279

  if (res == NULL) {

   280

    current_vartype = none_vt;

   281

    current_option  = none_opt;

   282

  }

   283

  return res;

   284

}

   285

   286

/*| VAR_EXTERNAL [CONSTANT] external_declaration_list END_VAR */

   287

/* option -> may be NULL ! */

   288

//SYM_REF2(external_var_declarations_c, option, external_declaration_list)

   289

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

   290

  current_vartype = external_vt;

   291

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

   292

  if (NULL != symbol->option)

   293

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

   294

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

   295

  if (res == NULL) {

   296

    current_vartype = none_vt;

   297

    current_option = none_opt;

   298

  }

   299

  return res;

   300

}

   301

   302

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

   303

/* option -> may be NULL ! */

   304

//SYM_REF2(global_var_declarations_c, option, global_var_decl_list)

   305

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

   306

  current_vartype = global_vt;

   307

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

   308

  if (NULL != symbol->option)

   309

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

   310

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

   311

  if (res == NULL) {

   312

    current_vartype = none_vt;

   313

    current_option = none_opt;

   314

  }

   315

  return res;

   316

}

   317

   318

/* var1_list is one of the following...

   319

 *    simple_spec_init_c *

   320

 *    subrange_spec_init_c *

   321

 *    enumerated_spec_init_c *

   322

 */

   323

// SYM_REF2(var1_init_decl_c, var1_list, spec_init)

   324

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

   325

  current_type_decl = symbol->spec_init;

   326

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

   327

}

   328

   329

/* var1_list ',' variable_name */

   330

// SYM_LIST(var1_list_c)

   331

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

   332

  list_c *list = symbol;

   333

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

   334

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

   335

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

   336

      return current_type_decl;

   337

  }

   338

  return NULL;

   339

}

   340

   341

/* name_list ':' function_block_type_name ASSIGN structure_initialization */

   342

/* structure_initialization -> may be NULL ! */

   343

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

   344

  current_type_decl = symbol->function_block_type_name;

   345

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

   346

}

   347

   348

/* name_list ',' fb_name */

   349

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

   350

  list_c *list = symbol;

   351

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

   352

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

   353

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

   354

      return current_type_decl;

   355

  }

   356

  return NULL;

   357

}

   358

   359

/* var1_list ':' array_spec_init */

   360

// SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   361

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

   362

  current_type_decl = symbol->array_spec_init;

   363

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

   364

}

   365

   366

/*  var1_list ':' initialized_structure */

   367

// SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   368

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

   369

  current_type_decl = symbol->initialized_structure;

   370

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

   371

}

   372

   373

/*  var1_list ':' array_specification */

   374

// SYM_REF2(array_var_declaration_c, var1_list, array_specification)

   375

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

   376

  current_type_decl = symbol->array_specification;

   377

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

   378

}

   379

   380

/*  var1_list ':' structure_type_name */

   381

// SYM_REF2(structured_var_declaration_c, var1_list, structure_type_name)

   382

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

   383

  current_type_decl = symbol->structure_type_name;

   384

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

   385

}

   386

   387

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

   388

/* variable_name -> may be NULL ! */

   389

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

   390

// TODO!!

   391

   392

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

   393

// SYM_REF2(external_declaration_c, global_var_name, specification)

   394

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

   395

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

   396

      return symbol->specification;

   397

  return NULL;

   398

}

   399

   400

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

   401

/* type_specification ->may be NULL ! */

   402

// SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   403

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

   404

  if (symbol->type_specification != NULL) {

   405

    current_type_decl = symbol->type_specification;

   406

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

   407

  }

   408

  else

   409

    return NULL;

   410

}

   411

   412

/*| global_var_name location */

   413

//SYM_REF2(global_var_spec_c, global_var_name, location)

   414

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

   415

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

   416

      return current_type_decl;

   417

  else

   418

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

   419

}

   420

   421

/*| global_var_list ',' global_var_name */

   422

//SYM_LIST(global_var_list_c)

   423

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

   424

  list_c *list = symbol;

   425

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

   426

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

   427

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

   428

      return current_type_decl;

   429

  }

   430

  return NULL;

   431

}

   432

   433

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

   434

/* variable_name -> may be NULL ! */

   435

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

   436

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

   437

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

   438

    return symbol->located_var_spec_init;

   439

  else {

   440

    current_type_decl = symbol->located_var_spec_init;

   441

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

   442

  }

   443

}

   444

   445

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

   446

/* type_specification ->may be NULL ! */

   447

// SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   448

// TODO!!

   449

   450

/*  AT direct_variable */

   451

// SYM_REF2(location_c, direct_variable, unused)

   452

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

   453

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

   454

    return current_type_decl;

   455

  else

   456

    return NULL;

   457

}

   458

   459

/*| global_var_list ',' global_var_name */

   460

// SYM_LIST(global_var_list_c)

   461

// TODO!!

   462

   463

/*  var1_list ':' single_byte_string_spec */

   464

// SYM_REF2(single_byte_string_var_declaration_c, var1_list, single_byte_string_spec)

   465

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

   466

  current_type_decl = symbol->single_byte_string_spec;

   467

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

   468

}

   469

   470

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

   471

/* integer ->may be NULL ! */

   472

/* single_byte_character_string ->may be NULL ! */

   473

// SYM_REF2(single_byte_string_spec_c, integer, single_byte_character_string)

   474

// TODO!!

   475

   476

/*  var1_list ':' double_byte_string_spec */

   477

// SYM_REF2(double_byte_string_var_declaration_c, var1_list, double_byte_string_spec)

   478

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

   479

  current_type_decl = symbol->double_byte_string_spec;

   480

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

   481

}

   482

   483

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

   484

/* integer ->may be NULL ! */

   485

/* double_byte_character_string ->may be NULL ! */

   486

// SYM_REF2(double_byte_string_spec_c, integer, double_byte_character_string)

   487

// TODO!!

   488

   489

/*  variable_name incompl_location ':' var_spec */

   490

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

   491

// TODO!!

   492

   493

/*  AT incompl_location_token */

   494

// SYM_TOKEN(incompl_location_c)

   495

// TODO!!

   496

   497

   498

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

   499

/* B.1.5 - Program organization units */

   500

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

   501

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

   502

/* B 1.5.1 - Functions */

   503

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

   504

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

   505

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

   506

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

   507

   * the variable that will be returned!!

   508

   */

   509

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

   510

      return symbol->type_name;

   511

   512

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

   513

   * visit the variable declarations...!