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_type_name = 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_basetype_decl(symbol_c *symbol) {

    67

  create_singleton();

    68

  if (NULL == symbol)    return NULL; 

    69

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

    70

}

    71

    72

/* static method! */

    73

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

    74

  create_singleton();

    75

  if (NULL == symbol)    return NULL;

    76

    77

  search_base_type_singleton->current_type_name = NULL;

    78

  symbol->accept(*search_base_type_singleton);

    79

  return (symbol_c *)search_base_type_singleton->current_type_name;

    80

}

    81

    82

    83

/* Note by MJS: The following two functions definately do not belong in this class!! Maybe create a new utility class?

    84

 * I will need to clean this up when the opportunity arises!

    85

 */

    86

/* static method! */

    87

bool search_base_type_c::type_is_subrange(symbol_c* type_decl) {

    88

  create_singleton();

    89

  search_base_type_singleton->is_subrange = false;

    90

  type_decl->accept(*search_base_type_singleton);

    91

  return search_base_type_singleton->is_subrange;

    92

}

    93

    94

    95

/* static method! */

    96

bool search_base_type_c::type_is_enumerated(symbol_c* type_decl) {

    97

  create_singleton();

    98

  search_base_type_singleton->is_enumerated = false;

    99

  type_decl->accept(*search_base_type_singleton);

   100

  return search_base_type_singleton->is_enumerated;

   101

}

   102

   103

   104

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

   105

/* B.1 - Common elements */

   106

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

   107

   108

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

   109

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

   110

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

   111

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

   112

  symbol_c *type_decl;

   113

   114

  this->current_type_name = type_name;

   115

   116

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

   117

  type_decl = type_symtable.find_value(type_name);

   118

  if (type_decl != type_symtable.end_value())

   119

    return type_decl->accept(*this);

   120

   121

  type_decl = function_block_type_symtable.find_value(type_name);

   122

  if (type_decl != function_block_type_symtable.end_value())

   123

    return type_decl->accept(*this);

   124

   125

  /* Type declaration not found!! */

   126

    ERROR;

   127

   128

  return NULL;

   129

}

   130

   131

   132

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

   133

/* B 1.2 - Constants */

   134

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

   135

   136

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

   137

/* B 1.2.1 - Numeric Literals */

   138

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

   139

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

   140

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

   141

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

   142

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

   143

  * with all inputs of the same data type.

   144

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

   145

  */

   146

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

   147

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

   148

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

   149

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

   150

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

   151

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

   152

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

   153

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

   154

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

   155

   156

   157

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

   158

/* B 1.3.1 - Elementary Data Types */

   159

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

   160

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

   161

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

   162

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

   163

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

   164

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

   165

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

   166

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

   167

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

   168

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

   169

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

   170

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

   171

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

   172

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

   173

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

   174

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

   175

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

   176

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

   177

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

   178

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

   179

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

   180

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

   181

   182

   183

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

   184

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

   185

/* "Safety Software Technical Specification,          */

   186

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

   187

/*  Version 1.0 – Official Release"                   */

   188

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

   189

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

   190

   191

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

   192

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

   193

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

   194

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

   195

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

   196

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

   197

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

   198

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

   199

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

   200

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

   201

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

   202

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

   203

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

   204

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

   205

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

   206

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

   207

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

   208

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

   209

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

   210

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

   211

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

   212

   213

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

   214

/* B 1.3.3 - Derived data types */

   215

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

   216

/*  simple_type_name ':' simple_spec_init */

   217

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

   218

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

   219

}

   220

/* simple_specification ASSIGN constant */

   221

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

   222

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

   223

}

   224

   225

/*  subrange_type_name ':' subrange_spec_init */

   226

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

   227

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

   228

}

   229

   230

/* subrange_specification ASSIGN signed_integer */

   231

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

   232

  this->is_subrange = true;

   233

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

   234

}

   235

   236

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

   237

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

   238

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

   239

}

   240

   241

/*  signed_integer DOTDOT signed_integer */

   242

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

   243

   244

/*  enumerated_type_name ':' enumerated_spec_init */

   245

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

   246

  this->current_type_name = symbol->enumerated_type_name;

   247

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

   248

}

   249

   250

/* enumerated_specification ASSIGN enumerated_value */

   251

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

   252

  this->is_enumerated = true;

   253

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

   254

}

   255

   256

/* helper symbol for enumerated_specification->enumerated_spec_init */

   257

/* enumerated_value_list ',' enumerated_value */

   258

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

   259

  this->is_enumerated = true;

   260

  return (void *)symbol;

   261

}

   262

   263

/* enumerated_type_name '#' identifier */

   264

// SYM_REF2(enumerated_value_c, type, value)

   265

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

   266

   267

/*  identifier ':' array_spec_init */

   268

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

   269

  this->current_type_name = symbol->identifier;

   270

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

   271

}

   272

   273

/* array_specification [ASSIGN array_initialization} */

   274

/* array_initialization may be NULL ! */

   275

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

   276

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

   277

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

   278

   * especially if we are looking for the base class!

   279

   */  

   280

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

   281

}

   282

   283

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

   284

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

   285

   286

/* helper symbol for array_specification */

   287

/* array_subrange_list ',' subrange */

   288

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

   289

   290

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

   291

/* helper symbol for array_initialization */

   292

/* array_initial_elements_list ',' array_initial_elements */

   293

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

   294

   295

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

   296

/* array_initial_element may be NULL ! */

   297

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

   298

   299

/*  structure_type_name ':' structure_specification */

   300

/* NOTE: structure_specification will point to either a

   301

 *       initialized_structure_c

   302

 *       OR A

   303

 *       structure_element_declaration_list_c

   304

 */

   305

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

   306

  this->current_type_name = symbol->structure_type_name;

   307

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

   308

}

   309

   310

/*  var1_list ':' structure_type_name */

   311

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

   312

	return symbol;

   313

}

   314

   315

/* structure_type_name ASSIGN structure_initialization */

   316

/* structure_initialization may be NULL ! */

   317

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

   318

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

   319

}

   320

   321

/* helper symbol for structure_declaration */

   322

/* structure_declaration:  STRUCT structure_element_declaration_list END_STRUCT */

   323

/* structure_element_declaration_list structure_element_declaration ';' */

   324

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

   325

   326

/*  structure_element_name ':' *_spec_init */

   327

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

   328

   329

/* helper symbol for structure_initialization */

   330

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

   331

/* structure_element_initialization_list ',' structure_element_initialization */

   332

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

   333

   334

/*  structure_element_name ASSIGN value */

   335

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

   336

   337

/*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   338

/*

   339

SYM_REF4(string_type_declaration_c,	string_type_name,

   340

					elementary_string_type_name,

   341

					string_type_declaration_size,

   342

					string_type_declaration_init) // may be == NULL!

   343

*/

   344

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

   345

   346

   347

   348

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

   349

/* B 1.5.2 - Function Blocks */

   350

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

   351

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   352

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

   353

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

   354

   355

   356

   357

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

   358

/* B.1.6  Sequential function chart elements */

   359

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

   360

/* INITIAL_STEP step_name ':' action_association_list END_STEP */

   361

// SYM_REF2(initial_step_c, step_name, action_association_list)

   362

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

   363

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

   364

  return (void *)symbol;

   365

}

   366

   367

/* STEP step_name ':' action_association_list END_STEP */

   368

// SYM_REF2(step_c, step_name, action_association_list)

   369

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

   370

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

   371

  return (void *)symbol;

   372

}

   373