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

/* 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_decl()  ---> returns 2B 

    79

 *   get_type_id()        ---> returns 1A

    80

 * 

    81

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

    82

 *   get_basetype_id()    ----> would return 2A

    83

 *   get_type_decl()      ----> would return 1B

    84

 */ 

    85

    86

    87

/*

    88

 * TODO: this code has a memory leak...

    89

 *       We call 'new' in several locations, but bever get to 'delete' the object instances...

    90

 */

    91

#include "absyntax_utils.hh"

    92

    93

    94

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

    95

  this->decompose_var_instance_name = NULL;

    96

  this->current_structelement_name = NULL;

    97

  this->current_typeid = NULL;

    98

  this->current_basetypeid = NULL;

    99

}

   100

   101

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

   102

  this->current_structelement_name = NULL;

   103

  this->current_typeid = NULL;

   104

  this->current_basetypeid = NULL;

   105

  this->decompose_var_instance_name = new decompose_var_instance_name_c(variable_name);

   106

  if (NULL == decompose_var_instance_name) ERROR;

   107

   108

  /* find the part of the variable name that will appear in the

   109

   * variable declaration, for e.g., in window.point.x, this would be

   110

   * window!

   111

   */

   112

  symbol_c *var_name_part = decompose_var_instance_name->next_part();

   113

  if (NULL == var_name_part) ERROR;

   114

   115

  /* Now we try to find the variable instance declaration, to determine its type... */

   116

  symbol_c *var_decl = search_var_instance_decl.get_decl(var_name_part);

   117

  if (NULL == var_decl) ERROR;

   118

   119

  /* if it is a struct or function block, we must search the type

   120

   * of the struct or function block member.

   121

   * This is done by this class visiting the var_decl.

   122

   * This class, while visiting, will recursively call

   123

   * decompose_var_instance_name->get_next() when and if required...

   124

   */

   125

  symbol_c *res = (symbol_c *)var_decl->accept(*this);

   126

  /* NOTE: A Null result is not really an internal compiler error, but rather an error in 

   127

   * the IEC 61131-3 source code being compiled. This means we cannot just abort the compiler with ERROR.

   128

   * //   if (NULL == res) ERROR;

   129

   */

   130

  if (NULL == res) return NULL;

   131

   132

  /* make sure that we have decomposed all structure elements of the variable name */

   133

  symbol_c *var_name = decompose_var_instance_name->next_part();

   134

  /* NOTE: A non-NULL result is not really an internal compiler error, but rather an error in 

   135

   * the IEC 61131-3 source code being compiled. 

   136

   *  (for example, 'int_var.struct_elem' in the source code, when 'int_var' is a simple integer,

   137

   *   and not a structure, will result in this result being non-NULL!)

   138

   * This means we cannot just abort the compiler with ERROR.

   139

   * //   if (NULL != var_name) ERROR;

   140

   */

   141

  if (NULL != var_name) return NULL;

   142

   143

  return res;

   144

}

   145

   146

   147

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

   148

  symbol_c *res = get_type_decl(variable_name);

   149

  if (NULL == res) return NULL;

   150

  return (symbol_c *)base_type(res);

   151

}  

   152

   153

   154

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

   155

  this->current_structelement_name = NULL;

   156

  this->current_typeid = NULL;

   157

  this->current_basetypeid = NULL;

   158

  this->is_complex = false;

   159

  this->decompose_var_instance_name = new decompose_var_instance_name_c(variable_name);

   160

  if (NULL == decompose_var_instance_name) ERROR;

   161

   162

  /* find the part of the variable name that will appear in the

   163

   * variable declaration, for e.g., in window.point.x, this would be

   164

   * window!

   165

   */

   166

  symbol_c *var_name_part = decompose_var_instance_name->next_part();

   167

  if (NULL == var_name_part) ERROR;

   168

   169

  /* Now we try to find the variable instance declaration, to determine its type... */

   170

  symbol_c *var_decl = search_var_instance_decl.get_decl(var_name_part);

   171

  if (NULL == var_decl) {

   172

    /* variable instance declaration not found! */

   173

    return 0;

   174

  }

   175

   176

  /* if it is a struct or function block, we must search the type

   177

   * of the struct or function block member.

   178

   * This is done by this class visiting the var_decl.

   179

   * This class, while visiting, will recursively call

   180

   * decompose_var_instance_name->get_next() when and if required...

   181

   */

   182

  var_decl->accept(*this);

   183

  unsigned int res = search_var_instance_decl.get_vartype();

   184

   185

  /* make sure that we have decomposed all structure elements of the variable name */

   186

  symbol_c *var_name = decompose_var_instance_name->next_part();

   187

  if (NULL != var_name) ERROR;

   188

   189

  return res;

   190

}

   191

   192

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

   193

  this->current_typeid = NULL;

   194

  symbol_c *vartype = this->get_type_decl(variable_name);

   195

  if (this->current_typeid != NULL)

   196

    return this->current_typeid;

   197

  else

   198

    return vartype;

   199

}

   200

   201

bool search_varfb_instance_type_c::type_is_complex(void) {

   202

  return this->is_complex;

   203

}

   204

   205

/* a helper function... */

   206

void *search_varfb_instance_type_c::visit_list(list_c *list)	{

   207

  if (NULL == current_structelement_name) ERROR;

   208

   209

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

   210

    void *res = list->elements[i]->accept(*this);

   211

    if (res != NULL)

   212

      return res;

   213

  }

   214

  /* not found! */

   215

  return NULL;

   216

}

   217

   218

/* a helper function... */

   219

void *search_varfb_instance_type_c::base_type(symbol_c *symbol)	{

   220

    search_base_type_c search_base_type;

   221

    return symbol->accept(search_base_type);

   222

}

   223

   224

/* We override the base class' visitor to identifier_c.

   225

 * This is so because the base class does not consider a function block

   226

 * to be a type, unlike this class that allows a variable instance

   227

 * of a function block type...

   228

 */

   229

void *search_varfb_instance_type_c::visit(identifier_c *type_name) {

   230

  /* we only store the new type id if none had been found yet.

   231

   * Since we will recursively carry on looking at the base type 

   232

   * to determine the base type declaration and id, we must only set this variable

   233

   * the first time.

   234

   * e.g. TYPE myint1_t : int    := 1;

   235

   *           myint2_t : int1_t := 2;

   236

   *           myint3_t : int2_t := 3;

   237

   *      END_TYPE;

   238

   *      VAR

   239

   *          myint1 : myint1_t;

   240

   *          myint2 : myint2_t;

   241

   *          myint3 : myint3_t;

   242

   *      END_VAR

   243

   *        

   244

   *     If we ask for typeid of     myint3, it must return myint3_t

   245

   *     If we ask for basetypeid of myint3, it must return int

   246

   *

   247

   *     When determining the data type of myint3, we will recursively go all the way

   248

   *     down to int, but we must still only store myint3_t as the base type id.

   249

   */

   250

  if (NULL == this->current_typeid)

   251

    this->current_typeid = type_name;

   252

  this->current_basetypeid = type_name;

   253

   254

  /* look up the type declaration... */

   255

  symbol_c *fb_decl = function_block_type_symtable.find_value(type_name);

   256

  if (fb_decl != function_block_type_symtable.end_value())

   257

    /* Type declaration found!! */

   258

    return fb_decl->accept(*this);

   259

   260

  /* No. It is not a function block, so we let

   261

   * the base class take care of it...

   262

   */

   263

  return search_base_type_c::visit(type_name);

   264

}

   265

   266

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

   267

/* B 1.3.3 - Derived data types */

   268

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

   269

   270

/*  identifier ':' array_spec_init */

   271

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

   272

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

   273

}

   274

   275

/* array_specification [ASSIGN array_initialization] */

   276

/* array_initialization may be NULL ! */

   277

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

   278

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

   279

}

   280

   281

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

   282

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

   283

  this->is_complex = true;

   285

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

   286

}

   287

   288

/*  structure_type_name ':' structure_specification */

   289

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

   290

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

   291

 */

   292

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

   293

  this->is_complex = true;

   294

   295

  if (NULL == current_structelement_name) ERROR;

   296

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

   297

  /* NOTE: structure_specification will point to either a

   298

   *       initialized_structure_c

   299

   *       OR A

   300

   *       structure_element_declaration_list_c

   301

   */

   302

}

   303

   304

/* structure_type_name ASSIGN structure_initialization */

   305

/* structure_initialization may be NULL ! */

   306

// SYM_REF2(initialized_structure_c, structure_type_name, structure_initialization)

   307

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

   308

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

   309

  this->is_complex = true;

   310

  if (NULL != current_structelement_name) ERROR;

   311

   312

  /* make sure that we have decomposed all strcuture elements of the variable name */

   313

  symbol_c *var_name = decompose_var_instance_name->next_part();

   314

  if (NULL == var_name) {

   315

    /* this is it... !

   316

     * No need to look any further...

   317

     * Note also that, unlike for the struct types, a function block may

   318

     * not be defined based on another (i.e. no inheritance is allowed),

   319

     * so this function block is already the most base type.

   320

     * We simply return it.

   321

     */

   322

    return (void *)symbol;

   323

   }

   324

   325

  /* look for the var_name in the structure declaration */

   326

  current_structelement_name = var_name;

   327

   328

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

   329

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

   330

}

   331

   332

/* helper symbol for structure_declaration */

   333

/* structure_declaration:  STRUCT structure_element_declaration_list END_STRUCT */

   334

/* structure_element_declaration_list structure_element_declaration ';' */

   335

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

   336

  if (NULL == current_structelement_name) ERROR;

   337

  /* now search the structure declaration */

   338

  return visit_list(symbol);

   339

}

   340

   341

/*  structure_element_name ':' spec_init */

   342

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

   343

  if (NULL == current_structelement_name) ERROR;

   344

   345

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

   346

    current_structelement_name = NULL;

   347

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

   348

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

   349

  }  

   350

   351

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

   352

  /* Will keep looking... */

   353

  return NULL;

   354

}

   355

   356

/* helper symbol for structure_initialization */

   357

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

   358

/* structure_element_initialization_list ',' structure_element_initialization */

   359

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

   360

/*  structure_element_name ASSIGN value */

   361

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

   362

   363

   364

   365

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

   366

/* B.1.5 - Program organization units */

   367

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

   368

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

   369

/* B 1.5.2 - Function Blocks */

   370

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

   371

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   372

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

   373

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

   374

  /* make sure that we have decomposed all strcuture elements of the variable name */

   375

  symbol_c *var_name = decompose_var_instance_name->next_part();

   376

  if (NULL == var_name) {

   377

    /* this is it... !

   378

     * No need to look any further...

   379

     * Note also that, unlike for the struct types, a function block may

   380

     * not be defined based on another (i.e. no inheritance is allowed),

   381

     * so this function block is already the most base type.

   382

     * We simply return it.

   383

     */

   384

    return (void *)symbol;

   385

   }

   386

   387

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

   388

   search_var_instance_decl_c search_decl(symbol);

   389

   symbol_c *var_decl = search_decl.get_decl(var_name);

   390

   if (NULL == var_decl) {

   391

     /* variable instance declaration not found! */

   392

     return NULL;

   393

   }

   394

#if 0

   395

   /* We have found the declaration.

   396

    * Should we look any further?

   397

    */

   398

   var_name = decompose_var_instance_name->next_part();

   399

   if (NULL == var_name) {

   400

     /* this is it... ! */

   401

     return base_type(var_decl);

   402

   }

   403

   404

  current_structelement_name = var_name;

   405

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

   406

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

   407

#endif  

   408

  /* carry on recursively, in case the variable has more elements to be decomposed... */

   409

  return var_decl->accept(*this);

   410

}