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

 *

     6

 *  This program is free software: you can redistribute it and/or modify

     7

 *  it under the terms of the GNU General Public License as published by

     8

 *  the Free Software Foundation, either version 3 of the License, or

     9

 *  (at your option) any later version.

    10

 *

    11

 *  This program is distributed in the hope that it will be useful,

    12

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    13

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    14

 *  GNU General Public License for more details.

    15

 *

    16

 *  You should have received a copy of the GNU General Public License

    17

 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.

    18

 *

    19

 *

    20

 * This code is made available on the understanding that it will not be

    21

 * used in safety-critical situations without a full and competent review.

    22

 */

    23

    24

/*

    25

 * An IEC 61131-3 compiler.

    26

 *

    27

 * Based on the

    28

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    29

 *

    30

 */

    31

    32

/* Determine the data type of a variable.

    33

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

    34

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

    35

 * an array element.

    36

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

    37

 * of a .... is also suported!

    38

 *

    39

 * A reference to the relevant base type __definition__ is returned.

    40

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

    41

 * which was previously declared to be

    42

 * TYPE MY_INT: INT := 9;

    43

 * this class wil return INT, and __not__ MY_INT !!

    44

 *

    45

 *

    46

 *  example:

    47

 *    window.points[1].coordinate.x

    48

 *    window.points[1].colour

    49

 *    etc... ARE ALLOWED!

    50

 *

    51

 * This class must be passed the scope within which the

    52

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

    53

 */

    54

    55

    56

/*

    57

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

    58

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

    59

 */

    60

#include "absyntax_utils.hh"

    61

    62

    63

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

    64

  this->decompose_var_instance_name = NULL;

    65

  this->current_structelement_name = NULL;

    66

  this->current_rawtype = NULL;

    67

}

    68

    69

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

    70

  this->current_structelement_name = NULL;

    71

  this->current_rawtype = NULL;

    72

  this->decompose_var_instance_name = new decompose_var_instance_name_c(variable_name);

    73

  if (NULL == decompose_var_instance_name) ERROR;

    74

    75

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

    76

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

    77

   * window!

    78

   */

    79

  symbol_c *var_name_part = decompose_var_instance_name->next_part();

    80

  if (NULL == var_name_part) ERROR;

    81

    82

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

    83

  symbol_c *var_decl = search_var_instance_decl.get_decl(var_name_part);

    84

  if (NULL == var_decl) {

    85

    /* variable instance declaration not found! */

    86

      ERROR;

    87

  }

    88

    89

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

    90

   * of the struct or function block member.

    91

   * This is done by this class visiting the var_decl.

    92

   * This class, while visiting, will recursively call

    93

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

    94

   */

    95

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

    96

  if (NULL == res) ERROR;

    97

    98

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

    99

  symbol_c *var_name = decompose_var_instance_name->next_part();

   100

  if (NULL != var_name) ERROR;

   101

   102

  return res;

   103

}

   104

   105

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

   106

  this->current_structelement_name = NULL;

   107

  this->current_rawtype = NULL;

   108

  this->is_complex = false;

   109

  this->decompose_var_instance_name = new decompose_var_instance_name_c(variable_name);

   110

  if (NULL == decompose_var_instance_name) ERROR;

   111

   112

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

   113

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

   114

   * window!

   115

   */

   116

  symbol_c *var_name_part = decompose_var_instance_name->next_part();

   117

  if (NULL == var_name_part) ERROR;

   118

   119

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

   120

  symbol_c *var_decl = search_var_instance_decl.get_decl(var_name_part);

   121

  if (NULL == var_decl) {

   122

    /* variable instance declaration not found! */

   123

    return 0;

   124

  }

   125

   126

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

   127

   * of the struct or function block member.

   128

   * This is done by this class visiting the var_decl.

   129

   * This class, while visiting, will recursively call

   130

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

   131

   */

   132

  var_decl->accept(*this);

   133

  unsigned int res = search_var_instance_decl.get_vartype();

   134

   135

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

   136

  symbol_c *var_name = decompose_var_instance_name->next_part();

   137

  if (NULL != var_name) ERROR;

   138

   139

  return res;

   140

}

   141

   142

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

   143

  symbol_c *rawtype = this->get_type(variable_name);

   144

  if (this->current_rawtype != NULL)

   145

    return this->current_rawtype;

   146

  else

   147

	return rawtype;

   148

}

   149

   150

bool search_varfb_instance_type_c::type_is_complex(void) {

   151

  return this->is_complex;

   152

}

   153

   154

/* a helper function... */

   155

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

   156

  if (NULL == current_structelement_name) ERROR;

   157

   158

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

   159

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

   160

    if (res != NULL)

   161

      return res;

   162

  }

   163

  /* not found! */

   164

  return NULL;

   165

}

   166

   167

/* a helper function... */

   168

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

   169

    search_base_type_c search_base_type;

   170

    return symbol->accept(search_base_type);

   171

}

   172

   173

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

   174

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

   175

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

   176

 * of a function block type...

   177

 */

   178

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

   179

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

   180

  symbol_c *fb_decl = function_block_type_symtable.find_value(type_name);

   181

  if (fb_decl != function_block_type_symtable.end_value())

   182

    /* Type declaration found!! */

   183

    return fb_decl->accept(*this);

   184

   185

  this->current_rawtype = type_name;

   186

   187

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

   188

   * the base class take care of it...

   189

   */

   190

  if (NULL == decompose_var_instance_name->next_part(false)) {

   191

    return base_type(type_name);

   192

  }

   193

  else {

   194

	return search_base_type_c::visit(type_name);

   195

  }

   196

}

   197

   198

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

   199

/* B 1.3.3 - Derived data types */

   200

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

   201

   202

/*  identifier ':' array_spec_init */

   203

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

   204

  this->is_complex = true;

   205

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

   206

}

   207

   208

/* array_specification [ASSIGN array_initialization] */

   209

/* array_initialization may be NULL ! */

   210

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

   211

  this->is_complex = true;

   212

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

   213

}

   214

   215

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

   216

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

   217

  this->is_complex = true;

   218

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

   219

}

   220

   221

/*  structure_type_name ':' structure_specification */

   222

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

   223

  this->is_complex = true;

   224

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

   225

  /* NOTE: structure_specification will point to either a

   226

   *       initialized_structure_c

   227

   *       OR A

   228

   *       structure_element_declaration_list_c

   229

   */

   230

}

   231

   232

/* structure_type_name ASSIGN structure_initialization */

   233

/* structure_initialization may be NULL ! */

   234

// SYM_REF2(initialized_structure_c, structure_type_name, structure_initialization)

   235

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

   236

  this->is_complex = true;

   237

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

   238

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

   239

}

   240

   241

/* helper symbol for structure_declaration */

   242

/* structure_declaration:  STRUCT structure_element_declaration_list END_STRUCT */

   243

/* structure_element_declaration_list structure_element_declaration ';' */

   244

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

   245

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

   246

  current_structelement_name = decompose_var_instance_name->next_part();

   247

  /* now search the structure declaration */

   248

  return visit_list(symbol);

   249

}

   250

   251

/*  structure_element_name ':' spec_init */

   252

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

   253

  if (NULL == current_structelement_name) ERROR;

   254

   255

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

   256

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

   257

   258

  return NULL;

   259

}

   260

   261

/* helper symbol for structure_initialization */

   262

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

   263

/* structure_element_initialization_list ',' structure_element_initialization */

   264

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

   265

/*  structure_element_name ASSIGN value */

   266

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

   267

   268

   269

   270

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

   271

/* B.1.5 - Program organization units */

   272

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

   273

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

   274

/* B 1.5.2 - Function Blocks */

   275

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

   276

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   277

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

   278

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

   279

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

   280

   281

  symbol_c *var_name = decompose_var_instance_name->next_part();

   282

  if (NULL == var_name) {

   283

    /* this is it... !

   284

     * No need to look any further...

   285

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

   286

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

   287

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

   288

     * We simply return it.

   289

     */

   290

    return (void *)symbol;

   291

   }

   292

   293

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

   294

   search_var_instance_decl_c search_decl(symbol);

   295

   symbol_c *var_decl = search_decl.get_decl(var_name);

   296

   if (NULL == var_decl) {

   297

     /* variable instance declaration not found! */

   298

     return NULL;

   299

   }

   300

   301

   /* We have found the declaration.

   302

    * Should we look any further?

   303

    */

   304

   var_name = decompose_var_instance_name->next_part();

   305

   if (NULL == var_name) {

   306

     /* this is it... ! */

   307

     return base_type(var_decl);

   308

   }

   309

   310

  current_structelement_name = var_name;

   311

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

   312

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

   313

}