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

   136

  decl = this->get_decl(symbol);

   137

  if (NULL == decl) ERROR;

   138

  decl = search_base_type_c::get_basetype_decl(decl);

   139

  if (NULL == decl) ERROR;

   140

   141

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

   142

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

   143

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

   144

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

   145

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

   146

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

   148

         );

   149

}

   150

   151

bool search_var_instance_decl_c::type_is_fb(symbol_c *symbol) {

   152

    symbol_c *decl;

   153

    search_base_type_c search_base_type;

   154

   155

    decl = this->get_decl(symbol);

   156

    if (NULL == decl) ERROR;

   157

    return search_base_type.type_is_fb(decl);

   158

}

   159

   160

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

   161

/* B 0 - Programming Model */

   162

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

   163

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

   164

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

   165

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

   166

   */

   167

  return NULL;

   168

}

   169

   170

   171

   172

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

   173

/* B 1.4.3 - Declaration & Initialization */

   174

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

   175

   176

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

   177

// SYM_REF2(edge_declaration_c, edge, var1_list)

   178

// TODO

   179

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

   180

  current_option = constant_opt;

   181

  return NULL;

   182

}

   183

   184

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

   185

  current_option = retain_opt;

   186

  return NULL;

   187

}

   188

   189

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

   190

  current_option = non_retain_opt;

   191

  return NULL;

   192

}

   193

   194

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

   195

  current_vartype = input_vt;

   196

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

   197

  if (NULL != symbol->option)  

   198

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

   199

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

   200

  if (res == NULL) {

   201

    current_vartype = none_vt;

   202

    current_option  = none_opt;

   203

  }

   204

  return res;

   205

}

   206

   207

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

   208

/* option -> may be NULL ! */

   209

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

   210

  current_vartype = output_vt;

   211

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

   212

  if (NULL != symbol->option)

   213

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

   214

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

   215

  if (res == NULL) {

   216

    current_vartype = none_vt;

   217

    current_option  = none_opt;

   218

  }

   219

  return res;

   220

}

   221

   222

/*  VAR_IN_OUT var_declaration_list END_VAR */

   223

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

   224

  current_vartype = inoutput_vt;

   225

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

   226

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

   227

  if (res == NULL) {

   228

    current_vartype = none_vt;

   229

  }

   230

  return res;

   231

}

   232

   233

/* ENO : BOOL */

   234

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

   235

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

   236

    return symbol->type;

   237

  return NULL;

   238

}

   239

   240

   241

/* VAR [CONSTANT] var_init_decl_list END_VAR */

   242

/* option -> may be NULL ! */

   243

/* helper symbol for input_declarations */

   244

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

   245

  current_vartype = private_vt;

   246

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

   247

  if (NULL != symbol->option)

   248

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

   249

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

   250

  if (res == NULL) {

   251

    current_vartype = none_vt;

   252

    current_option = none_opt;

   253

  }

   254

  return res;

   255

}

   256

   257

/*  VAR RETAIN var_init_decl_list END_VAR */

   258

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

   259

  current_vartype = private_vt;

   260

  current_option  = retain_opt;

   261

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

   262

  if (res == NULL) {

   263

    current_vartype = none_vt;

   264

    current_option = none_opt;

   265

  }

   266

  return res;

   267

}

   268

   269

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

   270

/* option -> may be NULL ! */

   271

//SYM_REF2(located_var_declarations_c, option, located_var_decl_list)

   272

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

   273

  current_vartype = located_vt;

   274

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

   275

  if (NULL != symbol->option)

   276

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

   277

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

   278

  if (res == NULL) {

   279

    current_vartype = none_vt;

   280

    current_option  = none_opt;

   281

  }

   282

  return res;

   283

}

   284

   285

/*| VAR_EXTERNAL [CONSTANT] external_declaration_list END_VAR */

   286

/* option -> may be NULL ! */

   287

//SYM_REF2(external_var_declarations_c, option, external_declaration_list)

   288

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

   289

  current_vartype = external_vt;

   290

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

   291

  if (NULL != symbol->option)

   292

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

   293

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

   294

  if (res == NULL) {

   295

    current_vartype = none_vt;

   296

    current_option = none_opt;

   297

  }

   298

  return res;

   299

}

   300

   301

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

   302

/* option -> may be NULL ! */

   303

//SYM_REF2(global_var_declarations_c, option, global_var_decl_list)

   304

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

   305

  current_vartype = global_vt;

   306

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

   307

  if (NULL != symbol->option)

   308

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

   309

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

   310

  if (res == NULL) {

   311

    current_vartype = none_vt;

   312

    current_option = none_opt;

   313

  }

   314

  return res;

   315

}

   316

   317

/* var1_list is one of the following...

   318

 *    simple_spec_init_c *

   319

 *    subrange_spec_init_c *

   320

 *    enumerated_spec_init_c *

   321

 */

   322

// SYM_REF2(var1_init_decl_c, var1_list, spec_init)

   323

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

   324

  current_type_decl = symbol->spec_init;

   325

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

   326

}

   327

   328

/* var1_list ',' variable_name */

   329

// SYM_LIST(var1_list_c)

   330

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

   331

  list_c *list = symbol;

   332

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

   333

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

   334

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

   335

      return current_type_decl;

   336

  }

   337

  return NULL;

   338

}

   339

   340

/* name_list ':' function_block_type_name ASSIGN structure_initialization */

   341

/* structure_initialization -> may be NULL ! */

   342

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

   343

  current_type_decl = symbol->function_block_type_name;

   344

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

   345

}

   346

   347

/* name_list ',' fb_name */

   348

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

   349

  list_c *list = symbol;

   350

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

   351

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

   352

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

   353

      return current_type_decl;

   354

  }

   355

  return NULL;

   356

}

   357

   358

/* var1_list ':' array_spec_init */

   359

// SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   360

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

   361

  current_type_decl = symbol->array_spec_init;

   362

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

   363

}

   364

   365

/*  var1_list ':' initialized_structure */

   366

// SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   367

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

   368

  current_type_decl = symbol->initialized_structure;

   369

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

   370

}

   371

   372

/*  var1_list ':' array_specification */

   373

// SYM_REF2(array_var_declaration_c, var1_list, array_specification)

   374

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

   375

  current_type_decl = symbol->array_specification;

   376

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

   377

}

   378

   379

/*  var1_list ':' structure_type_name */

   380

// SYM_REF2(structured_var_declaration_c, var1_list, structure_type_name)

   381

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

   382

  current_type_decl = symbol->structure_type_name;

   383

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

   384

}

   385

   386

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

   387

/* variable_name -> may be NULL ! */

   388

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

   389

// TODO!!

   390

   391

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

   392

// SYM_REF2(external_declaration_c, global_var_name, specification)

   393

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

   394

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

   395

      return symbol->specification;

   396

  return NULL;

   397

}

   398

   399

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

   400

/* type_specification ->may be NULL ! */

   401

// SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   402

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

   403

  if (symbol->type_specification != NULL) {

   404

    current_type_decl = symbol->type_specification;

   405

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

   406

  }

   407

  else

   408

    return NULL;

   409

}

   410

   411

/*| global_var_name location */

   412

//SYM_REF2(global_var_spec_c, global_var_name, location)

   413

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

   414

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

   415

      return current_type_decl;

   416

  else

   417

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

   418

}

   419

   420

/*| global_var_list ',' global_var_name */

   421

//SYM_LIST(global_var_list_c)

   422

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

   423

  list_c *list = symbol;

   424

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

   425

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

   426

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

   427

      return current_type_decl;

   428

  }

   429

  return NULL;

   430

}

   431

   432

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

   433

/* variable_name -> may be NULL ! */

   434

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

   435

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

   436

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

   437

    return symbol->located_var_spec_init;

   438

  else {

   439

    current_type_decl = symbol->located_var_spec_init;

   440

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

   441

  }

   442

}

   443

   444

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

   445

/* type_specification ->may be NULL ! */

   446

// SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   447

// TODO!!

   448

   449

/*  AT direct_variable */

   450

// SYM_REF2(location_c, direct_variable, unused)

   451

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

   452

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

   453

    return current_type_decl;

   454

  else

   455

    return NULL;

   456

}

   457

   458

/*| global_var_list ',' global_var_name */

   459

// SYM_LIST(global_var_list_c)

   460

// TODO!!

   461

   462

/*  var1_list ':' single_byte_string_spec */

   463

// SYM_REF2(single_byte_string_var_declaration_c, var1_list, single_byte_string_spec)

   464

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

   465

  current_type_decl = symbol->single_byte_string_spec;

   466

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

   467

}

   468

   469

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

   470

/* integer ->may be NULL ! */

   471

/* single_byte_character_string ->may be NULL ! */

   472

// SYM_REF2(single_byte_string_spec_c, integer, single_byte_character_string)

   473

// TODO!!

   474

   475

/*  var1_list ':' double_byte_string_spec */

   476

// SYM_REF2(double_byte_string_var_declaration_c, var1_list, double_byte_string_spec)

   477

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

   478

  current_type_decl = symbol->double_byte_string_spec;

   479

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

   480

}

   481

   482

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

   483

/* integer ->may be NULL ! */

   484

/* double_byte_character_string ->may be NULL ! */

   485

// SYM_REF2(double_byte_string_spec_c, integer, double_byte_character_string)

   486

// TODO!!

   487

   488

/*  variable_name incompl_location ':' var_spec */

   489

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

   490

// TODO!!

   491

   492

/*  AT incompl_location_token */

   493

// SYM_TOKEN(incompl_location_c)

   494

// TODO!!

   495

   496

   497

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

   498

/* B.1.5 - Program organization units */

   499

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

   500

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

   501

/* B 1.5.1 - Functions */

   502

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

   503

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

   504

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

   505

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

   506

   * the variable that will be returned!!

   507

   */

   508

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

   509

      return symbol->type_name;

   510

   511

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

   512

   * visit the variable declarations...!