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 on which another data type is based on.

    34

 * If a new default initial value is given, we DO NOT consider it a

    35

 * new base class, and continue looking further!

    36

 *

    37

 * E.g. TYPE new_int_t : INT; END_TYPE;

    38

 *      TYPE new_int2_t : INT = 2; END_TYPE;

    39

 *      TYPE new_subr_t : INT (4..5); END_TYPE;

    40

 *

    41

 *    new_int_t is really an INT!!

    42

 *    new_int2_t is also really an INT!!

    43

 *    new_subr_t is also really an INT!!

    44

 *

    45

 * Note that a FB declaration is also considered a base type, as

    46

 * we may have FB instances declared of a specific FB type.

    47

 */

    48

#include "absyntax_utils.hh"

    49

#include "../main.hh" // required for ERROR() and ERROR_MSG() macros.

    50

    51

    52

/* pointer to singleton instance */

    53

search_base_type_c *search_base_type_c::search_base_type_singleton = NULL;

    54

    55

    56

    57

search_base_type_c::search_base_type_c(void) {current_basetype_name = NULL; current_basetype = NULL; current_equivtype = NULL;}

    58

    59

/* static method! */

    60

void search_base_type_c::create_singleton(void) {

    61

  if (NULL == search_base_type_singleton)   search_base_type_singleton = new search_base_type_c();

    62

  if (NULL == search_base_type_singleton)   ERROR;

    63

}

    64

    65

/* static method! */

    66

symbol_c *search_base_type_c::get_equivtype_decl(symbol_c *symbol) {

    67

  create_singleton();

    68

  if (NULL == symbol)    return NULL; 

    69

  search_base_type_singleton->current_basetype_name = NULL;

    70

  search_base_type_singleton->current_basetype  = NULL; 

    71

  search_base_type_singleton->current_equivtype = NULL; 

    72

  symbol_c *basetype = (symbol_c *)symbol->accept(*search_base_type_singleton);

    73

  if (NULL != search_base_type_singleton->current_equivtype)

    74

    return search_base_type_singleton->current_equivtype;

    75

  return basetype;

    76

}

    77

    78

/* static method! */

    79

symbol_c *search_base_type_c::get_basetype_decl(symbol_c *symbol) {

    80

  create_singleton();

    81

  if (NULL == symbol)    return NULL; 

    82

  search_base_type_singleton->current_basetype_name = NULL;

    83

  search_base_type_singleton->current_basetype  = NULL; 

    84

  search_base_type_singleton->current_equivtype = NULL; 

    85

  return (symbol_c *)symbol->accept(*search_base_type_singleton);

    86

}

    87

    88

/* static method! */

    89

symbol_c *search_base_type_c::get_basetype_id  (symbol_c *symbol) {

    90

  create_singleton();

    91

  if (NULL == symbol)    return NULL; 

    92

  search_base_type_singleton->current_basetype_name = NULL;

    93

  search_base_type_singleton->current_basetype  = NULL; 

    94

  search_base_type_singleton->current_equivtype = NULL; 

    95

  symbol->accept(*search_base_type_singleton);

    96

  return (symbol_c *)search_base_type_singleton->current_basetype_name;

    97

}

    98

    99

   100

   101

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

   102

/* B.1 - Common elements */

   103

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

   104

   105

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

   106

/* B 1.1 - Letters, digits and identifiers */

   107

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

   108

   109

   110

void *search_base_type_c::handle_datatype_identifier(token_c *type_name) {

   111

  symbol_c *type_decl;

   112

   113

  this->current_basetype_name = type_name;

   114

  /* if we have reached this point, it is because the current_basetype is not yet pointing to the base datatype we are looking for,

   115

   * so we will be searching for the delcaration of the type named in type_name, which might be the base datatype (we search recursively!)

   116

   */

   117

  this->current_basetype  = NULL; 

   118

   119

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

   120

  type_decl = type_symtable.find_value(type_name);

   121

  if (type_decl != type_symtable.end_value())

   122

    return type_decl->accept(*this);

   123

   124

  type_decl = function_block_type_symtable.find_value(type_name);

   125

  if (type_decl != function_block_type_symtable.end_value())

   126

    return type_decl->accept(*this);

   127

   128

  /* Type declaration not found!! */

   129

    ERROR;

   130

   131

  return NULL;

   132

}

   133

   134

void *search_base_type_c::visit(                 identifier_c *type_name) {return handle_datatype_identifier(type_name);}  // still needed to handle FB and program datatypes!

   135

void *search_base_type_c::visit(derived_datatype_identifier_c *type_name) {return handle_datatype_identifier(type_name);}

   136

   137

   138

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

   139

/* B 1.2 - Constants */

   140

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

   141

   142

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

   143

/* B 1.2.1 - Numeric Literals */

   144

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

   145

 /* Numeric literals without any explicit type cast have unknown data type, 

   146

  * so we continue considering them as their own basic data types until

   147

  * they can be resolved (for example, when using '30+x' where 'x' is a LINT variable, the

   148

  * numeric literal '30' must then be considered a LINT so the ADD function may be called

   149

  * with all inputs of the same data type.

   150

  * If 'x' were a SINT, then the '30' would have to be a SINT too!

   151

  */

   152

void *search_base_type_c::visit(real_c *symbol)                   {return (void *)symbol;}

   153

void *search_base_type_c::visit(neg_real_c *symbol)               {return (void *)symbol;}

   154

void *search_base_type_c::visit(integer_c *symbol)                {return (void *)symbol;}

   155

void *search_base_type_c::visit(neg_integer_c *symbol)            {return (void *)symbol;}

   156

void *search_base_type_c::visit(binary_integer_c *symbol)         {return (void *)symbol;}

   157

void *search_base_type_c::visit(octal_integer_c *symbol)          {return (void *)symbol;}

   158

void *search_base_type_c::visit(hex_integer_c *symbol)            {return (void *)symbol;}

   159

void *search_base_type_c::visit(boolean_true_c *symbol)           {return (void *)symbol;}

   160

void *search_base_type_c::visit(boolean_false_c *symbol)          {return (void *)symbol;}

   161

   162

   163

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

   164

/* B 1.3.1 - Elementary Data Types */

   165

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

   166

void *search_base_type_c::visit(time_type_name_c *symbol)         {return (void *)symbol;}

   167

void *search_base_type_c::visit(bool_type_name_c *symbol)         {return (void *)symbol;}

   168

void *search_base_type_c::visit(sint_type_name_c *symbol)         {return (void *)symbol;}

   169

void *search_base_type_c::visit(int_type_name_c *symbol)          {return (void *)symbol;}

   170

void *search_base_type_c::visit(dint_type_name_c *symbol)         {return (void *)symbol;}

   171

void *search_base_type_c::visit(lint_type_name_c *symbol)         {return (void *)symbol;}

   172

void *search_base_type_c::visit(usint_type_name_c *symbol)        {return (void *)symbol;}

   173

void *search_base_type_c::visit(uint_type_name_c *symbol)         {return (void *)symbol;}

   174

void *search_base_type_c::visit(udint_type_name_c *symbol)        {return (void *)symbol;}

   175

void *search_base_type_c::visit(ulint_type_name_c *symbol)        {return (void *)symbol;}

   176

void *search_base_type_c::visit(real_type_name_c *symbol)         {return (void *)symbol;}

   177

void *search_base_type_c::visit(lreal_type_name_c *symbol)        {return (void *)symbol;}

   178

void *search_base_type_c::visit(date_type_name_c *symbol)         {return (void *)symbol;}

   179

void *search_base_type_c::visit(tod_type_name_c *symbol)          {return (void *)symbol;}

   180

void *search_base_type_c::visit(dt_type_name_c *symbol)           {return (void *)symbol;}

   181

void *search_base_type_c::visit(byte_type_name_c *symbol)         {return (void *)symbol;}

   182

void *search_base_type_c::visit(word_type_name_c *symbol)         {return (void *)symbol;}

   183

void *search_base_type_c::visit(dword_type_name_c *symbol)        {return (void *)symbol;}

   184

void *search_base_type_c::visit(lword_type_name_c *symbol)        {return (void *)symbol;}

   185

void *search_base_type_c::visit(string_type_name_c *symbol)       {return (void *)symbol;}

   186

void *search_base_type_c::visit(wstring_type_name_c *symbol)      {return (void *)symbol;}

   187

   188

   189

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

   190

/* Extensions to the base standard as defined in      */

   191

/* "Safety Software Technical Specification,          */

   192

/*  Part 1: Concepts and Function Blocks,             */

   193

/*  Version 1.0 – Official Release"                   */

   194

/* by PLCopen - Technical Committee 5 - 2006-01-31    */

   195

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

   196

   197

void *search_base_type_c::visit(safetime_type_name_c *symbol)     {return (void *)symbol;}

   198

void *search_base_type_c::visit(safebool_type_name_c *symbol)     {return (void *)symbol;}

   199

void *search_base_type_c::visit(safesint_type_name_c *symbol)     {return (void *)symbol;}

   200

void *search_base_type_c::visit(safeint_type_name_c *symbol)      {return (void *)symbol;}

   201

void *search_base_type_c::visit(safedint_type_name_c *symbol)     {return (void *)symbol;}

   202

void *search_base_type_c::visit(safelint_type_name_c *symbol)     {return (void *)symbol;}

   203

void *search_base_type_c::visit(safeusint_type_name_c *symbol)    {return (void *)symbol;}

   204

void *search_base_type_c::visit(safeuint_type_name_c *symbol)     {return (void *)symbol;}

   205

void *search_base_type_c::visit(safeudint_type_name_c *symbol)    {return (void *)symbol;}

   206

void *search_base_type_c::visit(safeulint_type_name_c *symbol)    {return (void *)symbol;}

   207

void *search_base_type_c::visit(safereal_type_name_c *symbol)     {return (void *)symbol;}

   208

void *search_base_type_c::visit(safelreal_type_name_c *symbol)    {return (void *)symbol;}

   209

void *search_base_type_c::visit(safedate_type_name_c *symbol)     {return (void *)symbol;}

   210

void *search_base_type_c::visit(safetod_type_name_c *symbol)      {return (void *)symbol;}

   211

void *search_base_type_c::visit(safedt_type_name_c *symbol)       {return (void *)symbol;}

   212

void *search_base_type_c::visit(safebyte_type_name_c *symbol)     {return (void *)symbol;}

   213

void *search_base_type_c::visit(safeword_type_name_c *symbol)     {return (void *)symbol;}

   214

void *search_base_type_c::visit(safedword_type_name_c *symbol)    {return (void *)symbol;}

   215

void *search_base_type_c::visit(safelword_type_name_c *symbol)    {return (void *)symbol;}

   216

void *search_base_type_c::visit(safestring_type_name_c *symbol)   {return (void *)symbol;}

   217

void *search_base_type_c::visit(safewstring_type_name_c *symbol)  {return (void *)symbol;}

   218

   219

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

   220

/* B.1.3.2 - Generic data types */

   221

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

   222

void *search_base_type_c::visit(generic_type_any_c *symbol)       {return (void *)symbol;}

   223

   224

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

   225

/* B 1.3.3 - Derived data types */

   226

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

   227

/*  simple_type_name ':' simple_spec_init */

   228

void *search_base_type_c::visit(simple_type_declaration_c *symbol) {

   229

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

   230

}

   231

/* simple_specification ASSIGN constant */

   232

void *search_base_type_c::visit(simple_spec_init_c *symbol) {

   233

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

   234

}

   235

   236

/*  subrange_type_name ':' subrange_spec_init */

   237

void *search_base_type_c::visit(subrange_type_declaration_c *symbol) {

   238

  this->current_equivtype = symbol;

   239

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

   240

}

   241

   242

/* subrange_specification ASSIGN signed_integer */

   243

void *search_base_type_c::visit(subrange_spec_init_c *symbol) {

   244

  if (NULL == this->current_equivtype)

   245

    this->current_equivtype = symbol;

   246

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

   247

}

   248

   249

/*  integer_type_name '(' subrange')' */

   250

void *search_base_type_c::visit(subrange_specification_c *symbol) {

   251

  if (NULL == this->current_equivtype)

   252

    this->current_equivtype = symbol;

   253

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

   254

}

   255

   256

/*  signed_integer DOTDOT signed_integer */

   257

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

   258

   259

/*  enumerated_type_name ':' enumerated_spec_init */

   260

void *search_base_type_c::visit(enumerated_type_declaration_c *symbol) {

   261

  this->current_basetype_name = symbol->enumerated_type_name;

   262

  /* NOTE: We want search_base_type_c to return a enumerated_type_declaration_c as the base datatpe if possible

   263

   *       (i.e. if it is a named datatype declared inside a TYPE ... END_TYPE declarations, as opposed to an

   264

   *        anonymous datatype declared in a VAR ... AND_VAR declaration).

   265

   *       However, we cannot return this symbol just yet, as it may not be the final base datatype.

   266

   *       So we store it in a temporary current_basetype variable!

   267

   */

   268

  this->current_basetype  = symbol; 

   269

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

   270

}

   271

   272

/* enumerated_specification ASSIGN enumerated_value */

   273

void *search_base_type_c::visit(enumerated_spec_init_c *symbol) {

   274

  // current_basetype may have been set in the previous enumerated_type_declaration_c visitor, in which case we do not want to overwrite the value!

   275

  if (NULL == this->current_basetype)

   276

    this->current_basetype  = symbol; 

   277

  /* NOTE: the following line may call either the visitor to 

   278

   *         - identifier_c, in which case this is not yet the base datatype we are looking for (it will set current_basetype to NULL!)

   279

   *         - enumerated_value_list_c, in which case we have found the base datatype.

   280

   */

   281

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

   282

}

   283

   284

/* helper symbol for enumerated_specification->enumerated_spec_init */

   285

/* enumerated_value_list ',' enumerated_value */

   286

void *search_base_type_c::visit(enumerated_value_list_c *symbol) {

   287

  // current_basetype may have been set in the previous enumerated_type_declaration_c or enumerated_spec_init_c visitors, in which case we do not want to overwrite the value!

   288

  if (NULL == this->current_basetype) 

   289

    this->current_basetype  = symbol; 

   290

  return (void *)current_basetype;

   291

}

   292

   293

/* enumerated_type_name '#' identifier */

   294

// SYM_REF2(enumerated_value_c, type, value)

   295

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

   296

   297

/*  identifier ':' array_spec_init */

   298

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

   299

  this->current_basetype_name = symbol->identifier;

   300

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

   301

}

   302

   303

/* array_specification [ASSIGN array_initialization} */

   304

/* array_initialization may be NULL ! */

   305

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

   306

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

   307

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

   308

   * especially if we are looking for the base class!

   309

   */  

   310

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

   311

}

   312

   313

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

   314

void *search_base_type_c::visit(array_specification_c *symbol)                          {return (void *)symbol;}

   315

   316

/* helper symbol for array_specification */

   317

/* array_subrange_list ',' subrange */

   318

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

   319

   320

/* array_initialization:  '[' array_initial_elements_list ']' */

   321

/* helper symbol for array_initialization */

   322

/* array_initial_elements_list ',' array_initial_elements */

   323

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

   324

   325

/* integer '(' [array_initial_element] ')' */

   326

/* array_initial_element may be NULL ! */

   327

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

   328

   329

/*  structure_type_name ':' structure_specification */

   330

/* NOTE: structure_specification will point to either a

   331

 *       initialized_structure_c

   332

 *       OR A

   333

 *       structure_element_declaration_list_c

   334

 */

   335

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

   336

  this->current_basetype_name = symbol->structure_type_name;

   337

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

   338

}

   339

   340

/*  var1_list ':' structure_type_name */

   341

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

   342

	return symbol;

   343

}

   344

   345

/* structure_type_name ASSIGN structure_initialization */

   346

/* structure_initialization may be NULL ! */

   347

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

   348

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

   349

}

   350

   351

/* helper symbol for structure_declaration */

   352

/* structure_declaration:  STRUCT structure_element_declaration_list END_STRUCT */

   353

/* structure_element_declaration_list structure_element_declaration ';' */

   354

void *search_base_type_c::visit(structure_element_declaration_list_c *symbol)           {return (void *)symbol;}

   355

   356

/*  structure_element_name ':' *_spec_init */

   357

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

   358

   359

/* helper symbol for structure_initialization */

   360

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

   361

/* structure_element_initialization_list ',' structure_element_initialization */

   362

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

   363

   364

/*  structure_element_name ASSIGN value */

   365

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

   366

   367

/*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   368

/*

   369

SYM_REF4(string_type_declaration_c,	string_type_name,

   370

					elementary_string_type_name,

   371

					string_type_declaration_size,

   372

					string_type_declaration_init) // may be == NULL!

   373

*/

   374

void *search_base_type_c::visit(string_type_declaration_c *symbol)                      {return (void *)symbol;}

   375

   376

   377

/*  function_block_type_name ASSIGN structure_initialization */

   378

/* structure_initialization -> may be NULL ! */

   379

// SYM_REF2(fb_spec_init_c, function_block_type_name, structure_initialization)

   380

void *search_base_type_c::visit(fb_spec_init_c *symbol)	{

   381

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

   382

}

   383

   384

   385

   386

/* ref_spec:  REF_TO (non_generic_type_name | function_block_type_name) */

   387

// SYM_REF1(ref_spec_c, type_name)

   388

void *search_base_type_c::visit(ref_spec_c *symbol)                                     {return (void *)symbol;}

   389

   390

/* For the moment, we do not support initialising reference data types */

   391

/* ref_spec_init: ref_spec [ ASSIGN ref_initialization ]; */ 

   392

/* NOTE: ref_initialization may be NULL!! */

   393

// SYM_REF2(ref_spec_init_c, ref_spec, ref_initialization)

   394

void *search_base_type_c::visit(ref_spec_init_c *symbol) {

   395

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

   396

}

   397

   398

/* ref_type_decl: identifier ':' ref_spec_init */

   399

// SYM_REF2(ref_type_decl_c, ref_type_name, ref_spec_init)

   400

void *search_base_type_c::visit(ref_type_decl_c *symbol)  {

   401

  this->current_basetype_name = symbol->ref_type_name;

   402

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

   403

}

   404

   405

   406

   407

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

   408

/* B 1.5.2 - Function Blocks */

   409

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

   410

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   411

// SYM_REF3(function_block_declaration_c, fblock_name, var_declarations, fblock_body)

   412

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

   413

	return (void *)symbol;

   414

}

   415

   416

   417

   418

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

   419

/* B.1.6  Sequential function chart elements */

   420

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

   421

/* INITIAL_STEP step_name ':' action_association_list END_STEP */

   422

// SYM_REF2(initial_step_c, step_name, action_association_list)

   423

void *search_base_type_c::visit(initial_step_c *symbol) {

   424

  this->current_basetype_name = NULL; /* this pseudo data type does not have a type name! */

   425

  return (void *)symbol;

   426

}

   427

   428

/* STEP step_name ':' action_association_list END_STEP */

   429

// SYM_REF2(step_c, step_name, action_association_list)

   430

void *search_base_type_c::visit(step_c *symbol) {

   431

  this->current_basetype_name = NULL; /* this pseudo data type does not have a type name! */

   432

  return (void *)symbol;

   433

}

   434