1

/*

     2

 *  matiec - a compiler for the programming languages defined in IEC 61131-3

     3

 *

     4

 *  Copyright (C) 2003-2012  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

/* Determine the data type of a variable.

    34

 * The variable may be a simple variable, a function block instance, a

    35

 * struture element within a data structured type (a struct or a fb), or

    36

 * an array element.

    37

 * A mixture of array element of a structure element of a structure element

    38

 * of a .... is also suported!

    39

 *

    40

 *  example:

    41

 *    window.points[1].coordinate.x

    42

 *    window.points[1].colour

    43

 *    etc... ARE ALLOWED!

    44

 *

    45

 * This class must be passed the scope within which the

    46

 * variable was declared, and the variable name...

    47

 *

    48

 *

    49

 *

    50

 *

    51

 *

    52

 * This class has several members, depending on the exact data the caller

    53

 * is looking for...

    54

 *

    55

 *    - item i: we can get either the name of the data type(A),

    56

 *              or it's declaration (B)

    57

 *             (notice however that some variables belong to a data type that does

    58

 *              not have a name, only a declaration as in

    59

 *              VAR a: ARRAY [1..3] of INT; END_VAR

    60

 *             )

    61

 *    - item ii: we can get either the direct data type (1), 

    62

 *               or the base type (2)

    63

 * 

    64

 *   By direct type, I mean the data type of the variable. By base type, I 

    65

 * mean the data type on which the direct type is based on. For example, in 

    66

 * a subrange on INT, the direct type is the subrange itself, while the 

    67

 * base type is INT.

    68

 * e.g.

    69

 *   This means that if we find that the variable is of type MY_INT,

    70

 *   which was previously declared to be

    71

 *   TYPE MY_INT: INT := 9;

    72

 *   option (1) will return MY_INT

    73

 *   option (2) will return INT

    74

 * 

    75

 *

    76

 * Member functions:

    77

 * ================

    78

 *   get_basetype_id()    ---> returns 2A   (implemented, although currently it is not needed! )

    79

 *   get_basetype_decl()  ---> returns 2B 

    80

 *   get_type_id()        ---> returns 1A

    81

 * 

    82

 *   Since we haven't yet needed it, we don't yet implement

    83

 *   get_type_decl()      ---> returns 1B 

    84

 */ 

    85

    86

    87

    88

#include "absyntax_utils.hh"

    89

    90

    91

void search_varfb_instance_type_c::init(void) {

    92

  this->current_type_id        = NULL;

    93

  this->current_basetype_id    = NULL;

    94

  this->current_basetype_decl  = NULL;

    95

  this->current_field_selector = NULL;

    96

  this->is_complex = false;

    97

}

    98

    99

   100

search_varfb_instance_type_c::search_varfb_instance_type_c(symbol_c *search_scope): search_var_instance_decl(search_scope) {

   101

  this->init();

   102

}

   103

   104

   105

/* We expect to be passed a symbolic_variable_c */

   106

symbol_c *search_varfb_instance_type_c::get_type_id(symbol_c *variable_name) {

   107

  this->init();

   108

  variable_name->accept(*this);

   109

  return current_type_id;

   110

}

   111

   112

   113

symbol_c *search_varfb_instance_type_c::get_basetype_id(symbol_c *variable_name) {

   114

  this->init();

   115

  variable_name->accept(*this);

   116

  return current_basetype_id;

   117

}

   118

   119

   120

symbol_c *search_varfb_instance_type_c::get_basetype_decl(symbol_c *variable_name) {

   121

  this->init();

   122

  variable_name->accept(*this);

   123

  return current_basetype_decl;

   124

}  

   125

   126

   127

   128

   129

   130

unsigned int search_varfb_instance_type_c::get_vartype(symbol_c *variable_name) {

   131

  this->init();

   132

  return search_var_instance_decl.get_vartype(variable_name);

   133

}

   134

   135

   136

   137

bool search_varfb_instance_type_c::type_is_complex(void) {

   138

  return this->is_complex;

   139

}

   140

   141

   142

   143

   166

   167

   168

   169

   170

   171

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

   172

/* B 1.3.3 - Derived data types */

   173

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

   174

/*  identifier ':' array_spec_init */

   175

/* NOTE: I don't think this will ever get called, since in the visit method for array_variable_c

   176

 * we use the basetype_decl for recursively calling this class, and the base type should never be a 

   177

 * array_type_declaration_c, but for now, let's leave it in...

   178

 */

   179

void *search_varfb_instance_type_c::visit(array_type_declaration_c *symbol) {

   180

  ERROR;

   181

  return NULL;

   182

}

   183

   184

/* array_specification [ASSIGN array_initialization] */

   185

/* array_initialization may be NULL ! */

   186

/* NOTE: I don't think this will ever get called, since in the visit method for array_variable_c

   187

 * we use the basetype_decl for recursively calling this class, and the base type should never be a 

   188

 * array_spec_init_c, but for now, let's leave it in...

   189

 */

   190

void *search_varfb_instance_type_c::visit(array_spec_init_c *symbol) {

   191

  /* Note that the 'array_specification' may be either an identifier of a previsously defined array type, 

   192

   * or an array_specification_c, so we can not stop here and simply return a array_spec_init_c, 

   193

   * especially if we are looking for the base class!

   194

   */

   195

  ERROR;

   196

  return NULL;

   197

}

   198

   199

/* ARRAY '[' array_subrange_list ']' OF non_generic_type_name */

   200

/* NOTE: This method will be reached after being called from the 

   201

 * search_varfb_instance_type_c::visit(array_variable_c *symbol)

   202

 * method, so we must return the data type of the data stored in the array, 

   203

 * and not the data type of the array itself!

   204

 */

   205

void *search_varfb_instance_type_c::visit(array_specification_c *symbol) {

   206

  /* found the type of the element we were looking for! */

   207

  current_type_id       = symbol->non_generic_type_name;

   208

  current_basetype_decl = search_base_type.get_basetype_decl(current_type_id);

   209

  current_basetype_id   = search_base_type.get_basetype_id  (current_type_id);

   210

   211

  return NULL; 

   212

}

   213

   214

   215

/*  structure_type_name ':' structure_specification */

   216

/* NOTE: this is only used inside a TYPE ... END_TYPE declaration. 

   217

 * It is never used directly when declaring a new variable! 

   218

 */

   219

/* NOTE: I don't think this will ever get called, since in the visit method for structured_variable_c

   220

 * we use the basetype_decl for recursively calling this class, and the base type should never be a 

   221

 * structure_type_declaration_c, but for now, let's leave it in...

   222

 */

   223

void *search_varfb_instance_type_c::visit(structure_type_declaration_c *symbol) {

   224

  if (NULL == current_field_selector) ERROR;

   225

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

   226

  return NULL;

   227

  /* NOTE: structure_specification will point to either a

   228

   *       initialized_structure_c

   229

   *       OR A

   230

   *       structure_element_declaration_list_c

   231

   */

   232

}

   233

   234

/* structure_type_name ASSIGN structure_initialization */

   235

/* structure_initialization may be NULL ! */

   236

// SYM_REF2(initialized_structure_c, structure_type_name, structure_initialization)

   237

/* NOTE: only the initialized structure is never used when declaring a new variable instance */

   238

/* NOTE: I don't think this will ever get called, since in the visit method for structured_variable_c

   239

 * we use the basetype_decl for recursively calling this class, and the base type should never be a 

   240

 * initialized_structure_c, but for now, let's leave it in...

   241

 */

   242

void *search_varfb_instance_type_c::visit(initialized_structure_c *symbol)	{

   243

  if (NULL != current_field_selector) ERROR;

   244

   245

  /* recursively find out the data type of current_field_selector... */

   246

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

   247

  return NULL;

   248

}

   249

   250

/* helper symbol for structure_declaration */

   251

/* structure_declaration:  STRUCT structure_element_declaration_list END_STRUCT */

   252

/* structure_element_declaration_list structure_element_declaration ';' */

   253

void *search_varfb_instance_type_c::visit(structure_element_declaration_list_c *symbol)	{

   254

  if (NULL == current_field_selector) ERROR;

   255

   256

  /* now search the structure declaration */

   257

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

   258

    symbol->elements[i]->accept(*this);

   259

  }

   260

   261

  return NULL;

   262

}

   263

   264

/*  structure_element_name ':' spec_init */

   265

void *search_varfb_instance_type_c::visit(structure_element_declaration_c *symbol) {

   266

  if (NULL == current_field_selector) ERROR;

   267

   268

  if (compare_identifiers(symbol->structure_element_name, current_field_selector) == 0) {

   269

    /* found the type of the element we were looking for! */

   270

    current_type_id       = symbol->spec_init;

   271

    current_basetype_decl = search_base_type.get_basetype_decl(current_type_id);

   272

    current_basetype_id   = search_base_type.get_basetype_id  (current_type_id);

   273

  }  

   274

   275

  /* Did not find the type of the element we were looking for! */

   276

  /* Will keep looking... */

   277

  return NULL;

   278

}

   279

   280

/* helper symbol for structure_initialization */

   281

/* structure_initialization: '(' structure_element_initialization_list ')' */

   282

/* structure_element_initialization_list ',' structure_element_initialization */

   283

void *search_varfb_instance_type_c::visit(structure_element_initialization_list_c *symbol) {ERROR; return NULL;} /* should never get called... */

   284

/*  structure_element_name ASSIGN value */

   285

void *search_varfb_instance_type_c::visit(structure_element_initialization_c *symbol) {ERROR; return NULL;} /* should never get called... */

   286

   287

   288

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

   289

/* B 1.4 - Variables */

   290

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

   291

// SYM_REF1(symbolic_variable_c, var_name)

   292

void *search_varfb_instance_type_c::visit(symbolic_variable_c *symbol) {

   294

  return NULL;

   295

}

   296

   297

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

   298

/* B.1.4.1   Directly Represented Variables */

   299

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

   300

// SYM_TOKEN(direct_variable_c)

   301

/* We do not yet handle this. Will we ever need to handle it, as the data type of the direct variable is

   302

 * directly obtainable from the syntax of the direct variable itself?

   303

 */

   304

   305

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

   306

/* B 1.4.2 - Multi-element variables */

   307

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

   308

/*  subscripted_variable '[' subscript_list ']' */

   309

// SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   310

/* NOTE: when passed a array_variable_c, which represents some IEC61131-3 code similar to X[42]

   311

 * we must return the data type of the value _stored_ in the array.

   312

 * If you want to get the data type of the array itself (i.e. just the X variable, without the [42])

   313

 * then this class must be called with the identifier_c 'X'.

   314

 */

   315

void *search_varfb_instance_type_c::visit(array_variable_c *symbol) {

   316

  this->is_complex = true;

   317

   318

  /* determine the data type of the subscripted_variable... 

   319

   * This should be an array_specification_c

   320

   *    ARRAY [xx..yy] OF Stored_Data_Type

   321

   */

   322

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

   323

   324

  /* Now we determine the 'Stored_Data_Type', i.e. the data type of the variable stored in the array. */

   325

  if (NULL != current_basetype_decl) {

   326

    current_basetype_decl->accept(*this);

   327

  }

   328

   329

  return NULL;

   330

}

   331

   332

   333

/*  record_variable '.' field_selector */

   334

/*  WARNING: input and/or output variables of function blocks

   335

 *           may be accessed as fields of a structured variable!

   336

 *           Code handling a structured_variable_c must take

   337

 *           this into account!

   338

 */

   339

// SYM_REF2(structured_variable_c, record_variable, field_selector)

   340

void *search_varfb_instance_type_c::visit(structured_variable_c *symbol) {

   341

  this->is_complex = true;

   342

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

   343

   344

  /* Now we search for the data type of the field... But only if we were able to determine the data type of the variable */

   345

  if (NULL != current_basetype_decl) {

   346

    current_field_selector = symbol->field_selector;

   347

    current_basetype_decl->accept(*this);

   348

    current_field_selector = NULL;

   349

  }

   350

   351

  return NULL;

   352

}

   353

   354

   355

   356

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

   357

/* B.1.5 - Program organization units */

   358

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

   359

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

   360

/* B 1.5.2 - Function Blocks */

   361

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

   362

   363

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   364

// SYM_REF4(function_block_declaration_c, fblock_name, var_declarations, fblock_body, unused)

   365

void *search_varfb_instance_type_c::visit(function_block_declaration_c *symbol) {

   366

  if (NULL == current_field_selector) ERROR;

   367

   368

  /* now search the function block declaration for the variable... */

   369

  /* If not found, these pointers will all be set to NULL!! */

   370

  search_var_instance_decl_c search_decl(symbol);

   371

  current_type_id       = search_decl.get_decl(current_field_selector);

   372

  current_basetype_decl = search_base_type.get_basetype_decl(current_type_id);

   373

  current_basetype_id   = search_base_type.get_basetype_id  (current_type_id);

   374

   375

  return NULL;

   376

}