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

   149

         );

   150

}

   151

   152

   153

   154

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

   155

/* B 0 - Programming Model */

   156

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

   157

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

   158

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

   159

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

   160

   */

   161

  return NULL;

   162

}

   163

   164

   165

   166

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

   167

/* B 1.4.3 - Declaration & Initialization */

   168

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

   169

   170

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

   171

// SYM_REF2(edge_declaration_c, edge, var1_list)

   172

// TODO

   173

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

   174

  current_option = constant_opt;

   175

  return NULL;

   176

}

   177

   178

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

   179

  current_option = retain_opt;

   180

  return NULL;

   181

}

   182

   183

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

   184

  current_option = non_retain_opt;

   185

  return NULL;

   186

}

   187

   188

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

   189

  current_vartype = input_vt;

   190

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

   191

  if (NULL != symbol->option)  

   192

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

   193

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

   194

  if (res == NULL) {

   195

    current_vartype = none_vt;

   196

    current_option  = none_opt;

   197

  }

   198

  return res;

   199

}

   200

   201

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

   202

/* option -> may be NULL ! */

   203

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

   204

  current_vartype = output_vt;

   205

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

   206

  if (NULL != symbol->option)

   207

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

   208

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

   209

  if (res == NULL) {

   210

    current_vartype = none_vt;

   211

    current_option  = none_opt;

   212

  }

   213

  return res;

   214

}

   215

   216

/*  VAR_IN_OUT var_declaration_list END_VAR */

   217

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

   218

  current_vartype = inoutput_vt;

   219

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

   220

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

   221

  if (res == NULL) {

   222

    current_vartype = none_vt;

   223

  }

   224

  return res;

   225

}

   226

   227

/* ENO : BOOL */

   228

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

   229

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

   230

    return symbol->type;

   231

  return NULL;

   232

}

   233

   234

   235

/* VAR [CONSTANT] var_init_decl_list END_VAR */

   236

/* option -> may be NULL ! */

   237

/* helper symbol for input_declarations */

   238

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

   239

  current_vartype = private_vt;

   240

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

   241

  if (NULL != symbol->option)

   242

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

   243

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

   244

  if (res == NULL) {

   245

    current_vartype = none_vt;

   246

    current_option = none_opt;

   247

  }

   248

  return res;

   249

}

   250

   251

/*  VAR RETAIN var_init_decl_list END_VAR */

   252

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

   253

  current_vartype = private_vt;

   254

  current_option  = retain_opt;

   255

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

   256

  if (res == NULL) {

   257

    current_vartype = none_vt;

   258

    current_option = none_opt;

   259

  }

   260

  return res;

   261

}

   262

   263

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

   264

/* option -> may be NULL ! */

   265

//SYM_REF2(located_var_declarations_c, option, located_var_decl_list)

   266

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

   267

  current_vartype = located_vt;

   268

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

   269

  if (NULL != symbol->option)

   270

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

   271

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

   272

  if (res == NULL) {

   273

    current_vartype = none_vt;

   274

    current_option  = none_opt;

   275

  }

   276

  return res;

   277

}

   278

   279

/*| VAR_EXTERNAL [CONSTANT] external_declaration_list END_VAR */

   280

/* option -> may be NULL ! */

   281

//SYM_REF2(external_var_declarations_c, option, external_declaration_list)

   282

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

   283

  current_vartype = external_vt;

   284

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

   285

  if (NULL != symbol->option)

   286

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

   287

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

   288

  if (res == NULL) {

   289

    current_vartype = none_vt;

   290

    current_option = none_opt;

   291

  }

   292

  return res;

   293

}

   294

   295

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

   296

/* option -> may be NULL ! */

   297

//SYM_REF2(global_var_declarations_c, option, global_var_decl_list)

   298

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

   299

  current_vartype = global_vt;

   300

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

   301

  if (NULL != symbol->option)

   302

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

   303

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

   304

  if (res == NULL) {

   305

    current_vartype = none_vt;

   306

    current_option = none_opt;

   307

  }

   308

  return res;

   309

}

   310

   311

/* var1_list is one of the following...

   312

 *    simple_spec_init_c *

   313

 *    subrange_spec_init_c *

   314

 *    enumerated_spec_init_c *

   315

 */

   316

// SYM_REF2(var1_init_decl_c, var1_list, spec_init)

   317

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

   318

  current_type_decl = symbol->spec_init;

   319

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

   320

}

   321

   322

/* var1_list ',' variable_name */

   323

// SYM_LIST(var1_list_c)

   324

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

   325

  list_c *list = symbol;

   326

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

   327

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

   328

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

   329

      return current_type_decl;

   330

  }

   331

  return NULL;

   332

}

   333

   334

/* name_list ':' function_block_type_name ASSIGN structure_initialization */

   335

/* structure_initialization -> may be NULL ! */

   336

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

   337

  current_type_decl = symbol->function_block_type_name;

   338

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

   339

}

   340

   341

/* name_list ',' fb_name */

   342

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

   343

  list_c *list = symbol;

   344

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

   345

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

   346

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

   347

      return current_type_decl;

   348

  }

   349

  return NULL;

   350

}

   351

   352

/* var1_list ':' array_spec_init */

   353

// SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   354

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

   355

  current_type_decl = symbol->array_spec_init;

   356

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

   357

}

   358

   359

/*  var1_list ':' initialized_structure */

   360

// SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   361

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

   362

  current_type_decl = symbol->initialized_structure;

   363

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

   364

}

   365

   366

/*  var1_list ':' array_specification */

   367

// SYM_REF2(array_var_declaration_c, var1_list, array_specification)

   368

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

   369

  current_type_decl = symbol->array_specification;

   370

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

   371

}

   372

   373

/*  var1_list ':' structure_type_name */

   374

// SYM_REF2(structured_var_declaration_c, var1_list, structure_type_name)

   375

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

   376

  current_type_decl = symbol->structure_type_name;

   377

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

   378

}

   379

   380

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

   381

/* variable_name -> may be NULL ! */

   382

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

   383

// TODO!!

   384

   385

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

   386

// SYM_REF2(external_declaration_c, global_var_name, specification)

   387

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

   388

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

   389

      return symbol->specification;

   390

  return NULL;

   391

}

   392

   393

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

   394

/* type_specification ->may be NULL ! */

   395

// SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   396

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

   397

  if (symbol->type_specification != NULL) {

   398

    current_type_decl = symbol->type_specification;

   399

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

   400

  }

   401

  else

   402

    return NULL;

   403

}

   404

   405

/*| global_var_name location */

   406

//SYM_REF2(global_var_spec_c, global_var_name, location)

   407

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

   408

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

   409

      return current_type_decl;

   410

  else

   411

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

   412

}

   413

   414

/*| global_var_list ',' global_var_name */

   415

//SYM_LIST(global_var_list_c)

   416

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

   417

  list_c *list = symbol;

   418

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

   419

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

   420

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

   421

      return current_type_decl;

   422

  }

   423

  return NULL;

   424

}

   425

   426

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

   427

/* variable_name -> may be NULL ! */

   428

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

   429

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

   430

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

   431

    return symbol->located_var_spec_init;

   432

  else {

   433

    current_type_decl = symbol->located_var_spec_init;

   434

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

   435

  }

   436

}

   437

   438

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

   439

/* type_specification ->may be NULL ! */

   440

// SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   441

// TODO!!

   442

   443

/*  AT direct_variable */

   444

// SYM_REF2(location_c, direct_variable, unused)

   445

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

   446

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

   447

    return current_type_decl;

   448

  else

   449

    return NULL;

   450

}

   451

   452

/*| global_var_list ',' global_var_name */

   453

// SYM_LIST(global_var_list_c)

   454

// TODO!!

   455

   456

/*  var1_list ':' single_byte_string_spec */

   457

// SYM_REF2(single_byte_string_var_declaration_c, var1_list, single_byte_string_spec)

   458

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

   459

  current_type_decl = symbol->single_byte_string_spec;

   460

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

   461

}

   462

   463

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

   464

/* integer ->may be NULL ! */

   465

/* single_byte_character_string ->may be NULL ! */

   466

// SYM_REF2(single_byte_string_spec_c, integer, single_byte_character_string)

   467

// TODO!!

   468

   469

/*  var1_list ':' double_byte_string_spec */

   470

// SYM_REF2(double_byte_string_var_declaration_c, var1_list, double_byte_string_spec)

   471

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

   472

  current_type_decl = symbol->double_byte_string_spec;

   473

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

   474

}

   475

   476

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

   477

/* integer ->may be NULL ! */

   478

/* double_byte_character_string ->may be NULL ! */

   479

// SYM_REF2(double_byte_string_spec_c, integer, double_byte_character_string)

   480

// TODO!!

   481

   482

/*  variable_name incompl_location ':' var_spec */

   483

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

   484

// TODO!!

   485

   486

/*  AT incompl_location_token */

   487

// SYM_TOKEN(incompl_location_c)

   488

// TODO!!

   489

   490

   491

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

   492

/* B.1.5 - Program organization units */

   493

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

   494

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

   495

/* B 1.5.1 - Functions */

   496

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

   497

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

   498

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

   499

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

   500

   * the variable that will be returned!!

   501

   */

   502

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

   503

      return symbol->type_name;

   504

   505

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

   506

   * visit the variable declarations...!

   507

   */

   508

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

   509

}

   510

   511

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

   512

/* B 1.5.2 - Function Blocks */

   513

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