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              ))

   147

   148

         );

   149

}

   150

   151

   152

   153

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

   154

/* B 0 - Programming Model */

   155

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

   156

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

   157

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

   158

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

   159

   */

   160

  return NULL;

   161

}

   162

   163

   164

   165

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

   166

/* B 1.4.3 - Declaration & Initialization */

   167

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

   168

   169

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

   170

// SYM_REF2(edge_declaration_c, edge, var1_list)

   171

// TODO

   172

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

   173

  current_option = constant_opt;

   174

  return NULL;

   175

}

   176

   177

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

   178

  current_option = retain_opt;

   179

  return NULL;

   180

}

   181

   182

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

   183

  current_option = non_retain_opt;

   184

  return NULL;

   185

}

   186

   187

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

   188

  current_vartype = input_vt;

   189

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

   190

  if (NULL != symbol->option)  

   191

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

   192

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

   193

  if (res == NULL) {

   194

    current_vartype = none_vt;

   195

    current_option  = none_opt;

   196

  }

   197

  return res;

   198

}

   199

   200

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

   201

/* option -> may be NULL ! */

   202

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

   203

  current_vartype = output_vt;

   204

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

   205

  if (NULL != symbol->option)

   206

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

   207

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

   208

  if (res == NULL) {

   209

    current_vartype = none_vt;

   210

    current_option  = none_opt;

   211

  }

   212

  return res;

   213

}

   214

   215

/*  VAR_IN_OUT var_declaration_list END_VAR */

   216

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

   217

  current_vartype = inoutput_vt;

   218

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

   219

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

   220

  if (res == NULL) {

   221

    current_vartype = none_vt;

   222

  }

   223

  return res;

   224

}

   225

   226

/* ENO : BOOL */

   227

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

   228

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

   229

    return symbol->type;

   230

  return NULL;

   231

}

   232

   233

   234

/* VAR [CONSTANT] var_init_decl_list END_VAR */

   235

/* option -> may be NULL ! */

   236

/* helper symbol for input_declarations */

   237

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

   238

  current_vartype = private_vt;

   239

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

   240

  if (NULL != symbol->option)

   241

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

   242

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

   243

  if (res == NULL) {

   244

    current_vartype = none_vt;

   245

    current_option = none_opt;

   246

  }

   247

  return res;

   248

}

   249

   250

/*  VAR RETAIN var_init_decl_list END_VAR */

   251

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

   252

  current_vartype = private_vt;

   253

  current_option  = retain_opt;

   254

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

   255

  if (res == NULL) {

   256

    current_vartype = none_vt;

   257

    current_option = none_opt;

   258

  }

   259

  return res;

   260

}

   261

   262

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

   263

/* option -> may be NULL ! */

   264

//SYM_REF2(located_var_declarations_c, option, located_var_decl_list)

   265

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

   266

  current_vartype = located_vt;

   267

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

   268

  if (NULL != symbol->option)

   269

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

   270

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

   271

  if (res == NULL) {

   272

    current_vartype = none_vt;

   273

    current_option  = none_opt;

   274

  }

   275

  return res;

   276

}

   277

   278

/*| VAR_EXTERNAL [CONSTANT] external_declaration_list END_VAR */

   279

/* option -> may be NULL ! */

   280

//SYM_REF2(external_var_declarations_c, option, external_declaration_list)

   281

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

   282

  current_vartype = external_vt;

   283

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

   284

  if (NULL != symbol->option)

   285

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

   286

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

   287

  if (res == NULL) {

   288

    current_vartype = none_vt;

   289

    current_option = none_opt;

   290

  }

   291

  return res;

   292

}

   293

   294

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

   295

/* option -> may be NULL ! */

   296

//SYM_REF2(global_var_declarations_c, option, global_var_decl_list)

   297

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

   298

  current_vartype = global_vt;

   299

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

   300

  if (NULL != symbol->option)

   301

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

   302

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

   303

  if (res == NULL) {

   304

    current_vartype = none_vt;

   305

    current_option = none_opt;

   306

  }

   307

  return res;

   308

}

   309

   310

/* var1_list is one of the following...

   311

 *    simple_spec_init_c *

   312

 *    subrange_spec_init_c *

   313

 *    enumerated_spec_init_c *

   314

 */

   315

// SYM_REF2(var1_init_decl_c, var1_list, spec_init)

   316

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

   317

  current_type_decl = symbol->spec_init;

   318

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

   319

}

   320

   321

/* var1_list ',' variable_name */

   322

// SYM_LIST(var1_list_c)

   323

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

   324

  list_c *list = symbol;

   325

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

   326

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

   327

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

   328

      return current_type_decl;

   329

  }

   330

  return NULL;

   331

}

   332

   333

/* name_list ':' function_block_type_name ASSIGN structure_initialization */

   334

/* structure_initialization -> may be NULL ! */

   335

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

   336

  current_type_decl = symbol->function_block_type_name;

   337

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

   338

}

   339

   340

/* name_list ',' fb_name */

   341

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

   342

  list_c *list = symbol;

   343

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

   344

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

   345

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

   346

      return current_type_decl;

   347

  }

   348

  return NULL;

   349

}

   350

   351

/* var1_list ':' array_spec_init */

   352

// SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   353

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

   354

  current_type_decl = symbol->array_spec_init;

   355

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

   356

}

   357

   358

/*  var1_list ':' initialized_structure */

   359

// SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   360

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

   361

  current_type_decl = symbol->initialized_structure;

   362

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

   363

}

   364

   365

/*  var1_list ':' array_specification */

   366

// SYM_REF2(array_var_declaration_c, var1_list, array_specification)

   367

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

   368

  current_type_decl = symbol->array_specification;

   369

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

   370

}

   371

   372

/*  var1_list ':' structure_type_name */

   373

// SYM_REF2(structured_var_declaration_c, var1_list, structure_type_name)

   374

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

   375

  current_type_decl = symbol->structure_type_name;

   376

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

   377

}

   378

   379

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

   380

/* variable_name -> may be NULL ! */

   381

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

   382

// TODO!!

   383

   384

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

   385

// SYM_REF2(external_declaration_c, global_var_name, specification)

   386

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

   387

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

   388

      return symbol->specification;

   389

  return NULL;

   390

}

   391

   392

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

   393

/* type_specification ->may be NULL ! */

   394

// SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   395

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

   396

  if (symbol->type_specification != NULL) {

   397

    current_type_decl = symbol->type_specification;

   398

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

   399

  }

   400

  else

   401

    return NULL;

   402

}

   403

   404

/*| global_var_name location */

   405

//SYM_REF2(global_var_spec_c, global_var_name, location)

   406

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

   407

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

   408

      return current_type_decl;

   409

  else

   410

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

   411

}

   412

   413

/*| global_var_list ',' global_var_name */

   414

//SYM_LIST(global_var_list_c)

   415

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

   416

  list_c *list = symbol;

   417

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

   418

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

   419

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

   420

      return current_type_decl;

   421

  }

   422

  return NULL;

   423

}

   424

   425

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

   426

/* variable_name -> may be NULL ! */

   427

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

   428

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

   429

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

   430

    return symbol->located_var_spec_init;

   431

  else {

   432

    current_type_decl = symbol->located_var_spec_init;

   433

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

   434

  }

   435

}

   436

   437

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

   438

/* type_specification ->may be NULL ! */

   439

// SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   440

// TODO!!

   441

   442

/*  AT direct_variable */

   443

// SYM_REF2(location_c, direct_variable, unused)

   444

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

   445

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

   446

    return current_type_decl;

   447

  else

   448

    return NULL;

   449

}

   450

   451

/*| global_var_list ',' global_var_name */

   452

// SYM_LIST(global_var_list_c)

   453

// TODO!!

   454

   455

/*  var1_list ':' single_byte_string_spec */

   456

// SYM_REF2(single_byte_string_var_declaration_c, var1_list, single_byte_string_spec)

   457

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

   458

  current_type_decl = symbol->single_byte_string_spec;

   459

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

   460

}

   461

   462

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

   463

/* integer ->may be NULL ! */

   464

/* single_byte_character_string ->may be NULL ! */

   465

// SYM_REF2(single_byte_string_spec_c, integer, single_byte_character_string)

   466

// TODO!!

   467

   468

/*  var1_list ':' double_byte_string_spec */

   469

// SYM_REF2(double_byte_string_var_declaration_c, var1_list, double_byte_string_spec)

   470

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

   471

  current_type_decl = symbol->double_byte_string_spec;

   472

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

   473

}

   474

   475

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

   476

/* integer ->may be NULL ! */

   477

/* double_byte_character_string ->may be NULL ! */

   478

// SYM_REF2(double_byte_string_spec_c, integer, double_byte_character_string)

   479

// TODO!!

   480

   481

/*  variable_name incompl_location ':' var_spec */

   482

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

   483

// TODO!!

   484

   485

/*  AT incompl_location_token */

   486

// SYM_TOKEN(incompl_location_c)

   487

// TODO!!

   488

   489

   490

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

   491

/* B.1.5 - Program organization units */

   492

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

   493

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

   494

/* B 1.5.1 - Functions */

   495

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

   496

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

   497

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

   498

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

   499

   * the variable that will be returned!!

   500

   */

   501

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

   502

      return symbol->type_name;

   503

   504

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

   505

   * visit the variable declarations...!

   506

   */

   507

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

   508

}

   509

   510

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

   511

/* B 1.5.2 - Function Blocks */

   512

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

   513

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */