1

/*

     2

 * (c) 2003 Mario de Sousa

     3

 *

     4

 * Offered to the public under the terms of the GNU General Public License

     5

 * as published by the Free Software Foundation; either version 2 of the

     6

 * License, or (at your option) any later version.

     7

 *

     8

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

     9

 * WITHOUT ANY WARRANTY; without even the implied warranty of

    10

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General

    11

 * Public License for more details.

    12

 *

    13

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

    14

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

    15

 */

    16

    17

/*

    18

 * An IEC 61131-3 IL and ST compiler.

    19

 *

    20

 * Based on the

    21

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

    22

 *

    23

 */

    24

    25

/* Determine the data type of a variable.

    26

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

    27

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

    28

 * an array element.

    29

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

    30

 * of a .... is also suported!

    31

 *

    32

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

    33

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

    34

 * which was previously declared to be

    35

 * TYPE MY_INT: INT := 9;

    36

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

    37

 *

    38

 *

    39

 *  example:

    40

 *    window.points[1].coordinate.x

    41

 *    window.points[1].colour

    42

 *    etc... ARE ALLOWED!

    43

 *

    44

 * This class must be passed the scope within which the

    45

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

    46

 */

    47

    48

    53

#include "absyntax_utils.hh"

    54

    55

    56

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

    57

  this->decompose_var_instance_name = NULL;

    58

  this->current_structelement_name = NULL;

    59

  this->search_base_type = false;

    60

}

    61

    62

symbol_c *search_varfb_instance_type_c::get_type(symbol_c *variable_name, bool base_type) {

    63

  this->current_structelement_name = NULL;

    64

  this->decompose_var_instance_name = new decompose_var_instance_name_c(variable_name);

    65

  this->search_base_type = base_type;

    66

  if (NULL == decompose_var_instance_name) ERROR;

    67

    68

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

    69

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

    70

   * window!

    71

   */

    72

  symbol_c *var_name_part = decompose_var_instance_name->next_part();

    73

  if (NULL == var_name_part) ERROR;

    75

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

    76

  symbol_c *var_decl = search_var_instance_decl.get_decl(var_name_part);

    77

  if (NULL == var_decl) {

    78

    /* variable instance declaration not found! */

    79

      ERROR;

    80

  }

    81

    82

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

    83

   * of the struct or function block member.

    84

   * This is done by this class visiting the var_decl.

    85

   * This class, while visiting, will recursively call

    86

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

    87

   */

    88

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

    89

  if (NULL == res) ERROR;

    90

    91

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

    92

  symbol_c *var_name = decompose_var_instance_name->next_part();

    93

  if (NULL != var_name) ERROR;

    94

    95

  return res;

    96

}

    97

    98

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

    99

  this->current_structelement_name = NULL;

   100

  this->decompose_var_instance_name = new decompose_var_instance_name_c(variable_name);

   101

  if (NULL == decompose_var_instance_name) ERROR;

   102

   103

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

   104

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

   105

   * window!

   106

   */

   107

  symbol_c *var_name_part = decompose_var_instance_name->next_part();

   108

  if (NULL == var_name_part) ERROR;

   109

   110

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

   111

  symbol_c *var_decl = search_var_instance_decl.get_decl(var_name_part);

   112

  if (NULL == var_decl) {

   113

    /* variable instance declaration not found! */

   114

    return 0;

   115

  }

   116

   117

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

   118

   * of the struct or function block member.

   119

   * This is done by this class visiting the var_decl.

   120

   * This class, while visiting, will recursively call

   121

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

   122

   */

   123

  unsigned int res = search_var_instance_decl.get_vartype();

   124

   125

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

   126

  symbol_c *var_name = decompose_var_instance_name->next_part();

   127

  if (NULL != var_name) ERROR;

   128

   129

  return res;

   130

}

   131

   132

/* a helper function... */

   133

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

   134

  if (NULL == current_structelement_name) ERROR;

   135

   136

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

   137

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

   138

    if (res != NULL)

   139

      return res;

   140

  }

   141

  /* not found! */

   142

  return NULL;

   143

}

   144

   145

/* a helper function... */

   146

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

   147

    search_base_type_c search_base_type;

   148

    return symbol->accept(search_base_type);

   149

}

   150

   151

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

   152

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

   153

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

   154

 * of a function block type...

   155

 */

   156

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

   157

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

   158

  symbol_c *fb_decl = function_block_type_symtable.find_value(type_name);

   159

  if (fb_decl != function_block_type_symtable.end_value())

   160

    /* Type declaration found!! */

   161

    return fb_decl->accept(*this);

   162

   163

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

   164

   * the base class take care of it...

   165

   */

   166

  if (this->search_base_type)

   167

    return search_base_type_c::visit(type_name);

   168

  else

   169

    return type_name;

   170

}

   171

   172

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

   173

/* B 1.3.3 - Derived data types */

   174

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

   175

   176

/*  identifier ':' array_spec_init */

   177

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

   178

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

   179

}

   180

   181

/* array_specification [ASSIGN array_initialization} */

   182

/* array_initialization may be NULL ! */

   183

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

   184

  symbol_c *var_name = decompose_var_instance_name->next_part();

   185

  if (NULL != var_name)

   186

    current_structelement_name = var_name;

   187

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

   188

}

   189

   190

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

   191

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

   192

  symbol_c *var_name = decompose_var_instance_name->next_part();

   193

  if (NULL != var_name)

   194

    current_structelement_name = var_name;

   195

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

   196

}

   197

   198

/*  structure_type_name ':' structure_specification */

   199

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

   200

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

   201

  /* NOTE: structure_specification will point to either a

   202

   *       initialized_structure_c

   203

   *       OR A

   204

   *       structure_element_declaration_list_c

   205

   */

   206

}

   207

   208

/* structure_type_name ASSIGN structure_initialization */

   209

/* structure_initialization may be NULL ! */

   210

// SYM_REF2(initialized_structure_c, structure_type_name, structure_initialization)

   211

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

   212

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

   213

  symbol_c *var_name = decompose_var_instance_name->next_part();

   214

  if (NULL == var_name) {

   215

    /* this is it... !

   216

     * No need to look any further...

   217

     */

   218

    /* NOTE: we could simply do a

   219

    *   return (void *)symbol;

   220

    *       nevertheless, note that this search_varfb_instance_type_c

   221

    *       class inherits from the search_base_type_c class,

   222

    *       which means that it will usually return the base type,

   223

    *       and not the derived type (*). If we are to be consistent,

   224

    *       we should guarantee that we always return the base type.

   225

    *       To do this we could use

   226

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

   227

    *       since this class inherits from the search_base_type_c.

   228

    *       However, in this case we don't want it to follow

   229

    *       the structs as this search_varfb_instance_type_c does.

   230

    *       We therefore have to create a new search_base_type_c

   231

    *       instance to search through this type without going

   232

    *       through the structs...

   233

    */

   234

      return base_type(symbol->structure_type_name);

   235

  }

   236

   237

  /* now search the structure declaration */

   238

  current_structelement_name = var_name;

   239

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

   240

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

   241

}

   242

   243

/* helper symbol for structure_declaration */

   244

/* structure_declaration:  STRUCT structure_element_declaration_list END_STRUCT */

   245

/* structure_element_declaration_list structure_element_declaration ';' */

   246

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

   247

  return visit_list(symbol);

   248

}

   249

   250

/*  structure_element_name ':' spec_init */

   251

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

   252

  if (NULL == current_structelement_name) ERROR;

   253

   254

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

   255

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

   256

   257

  return NULL;

   258

}

   259

   260

/* helper symbol for structure_initialization */

   261

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

   262

/* structure_element_initialization_list ',' structure_element_initialization */

   263

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

   264

/*  structure_element_name ASSIGN value */

   265

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

   266

   267

   268

   269

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

   270

/* B.1.5 - Program organization units */

   271

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

   272

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

   273

/* B 1.5.2 - Function Blocks */

   274

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

   275

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   276

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

   277

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

   278

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

   279

   280

  symbol_c *var_name = decompose_var_instance_name->next_part();

   281

  if (NULL == var_name) {

   282

    /* this is it... !

   283

     * No need to look any further...

   284

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

   285

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

   286

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

   287

     * We simply return it.

   288

     */

   289

    return (void *)symbol;

   290

   }

   291

   292

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

   293

   search_var_instance_decl_c search_decl(symbol);

   294

   symbol_c *var_decl = search_decl.get_decl(var_name);

   295

   if (NULL == var_decl) {

   296

     /* variable instance declaration not found! */

   297

     return NULL;

   298

   }

   299

   300

   /* We have found the declaration.

   301

    * Should we look any further?

   302

    */

   303

   var_name = decompose_var_instance_name->next_part();

   304

   if (NULL == var_name) {

   305

     /* this is it... ! */

   306

     return base_type(var_decl);

   307

   }

   308

   309

  current_structelement_name = var_name;

   310

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

   311

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

   312

}