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

    53

search_base_type_c::search_base_type_c(void) {current_type_name = NULL;}

    54

    55

    56

    57

    58

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

    59

  if (NULL == symbol)

    60

    return NULL;

    61

    62

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

    63

}

    64

    65

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

    66

  if (NULL == symbol)

    67

    return NULL;

    68

    69

  current_type_name = NULL; /* just to be on the safe side... */

    70

  symbol->accept(*this);

    71

  return (symbol_c *)current_type_name;

    72

}

    73

    74

    75

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

    76

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

    77

 */

    78

    79

bool search_base_type_c::type_is_subrange(symbol_c* type_decl) {

    80

  this->is_subrange = false;

    81

  type_decl->accept(*this);

    82

  return this->is_subrange;

    83

}

    84

    85

bool search_base_type_c::type_is_enumerated(symbol_c* type_decl) {

    86

  this->is_enumerated = false;

    87

  type_decl->accept(*this);

    88

  return this->is_enumerated;

    89

}

    90

    91

bool search_base_type_c::type_is_fb(symbol_c* type_decl) {

    92

  this->is_fb = false;

    93

  type_decl->accept(*this);

    94

  return this->is_fb;

    95

}

    96

    97

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

    98

/* B.1 - Common elements */

    99

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

   100

   101

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

   102

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

   103

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

   104

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

   105

  symbol_c *type_decl;

   106

   107

  this->current_type_name = type_name;

   108

   109

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

   110

  type_decl = type_symtable.find_value(type_name);

   111

  if (type_decl != type_symtable.end_value())

   112

    return type_decl->accept(*this);

   113

   114

  type_decl = function_block_type_symtable.find_value(type_name);

   115

  if (type_decl != function_block_type_symtable.end_value())

   116

    return type_decl->accept(*this);

   117

   118

  /* Type declaration not found!! */

   119

    ERROR;

   120

   121

  return NULL;

   122

}

   123

   124

   125

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

   126

/* B 1.2 - Constants */

   127

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

   128

   129

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

   130

/* B 1.2.1 - Numeric Literals */

   131

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

   132

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

   133

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

   134

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

   135

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

   136

  * with all inputs of the same data type.

   137

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

   138

  */

   139

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

   140

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

   141

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

   142

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

   143

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

   144

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

   145

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

   146

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

   147

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

   148

   149

   150

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

   151

/* B 1.3.1 - Elementary Data Types */

   152

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

   153

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

   154

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

   155

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

   156

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

   157

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

   158

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

   159

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

   160

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

   161

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

   162

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

   163

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

   164

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

   165

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

   166

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

   167

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

   168

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

   169

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

   170

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

   171

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

   172

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

   173

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

   174

   175

   176

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

   177

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

   178

/* "Safety Software Technical Specification,          */

   179

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

   180

/*  Version 1.0 – Official Release"                   */

   181

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

   182

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

   183

   184

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

   185

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

   186

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

   187

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

   188

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

   189

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

   190

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

   191

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

   192

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

   193

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

   194

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

   195

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

   196

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

   197

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

   198

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

   199

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

   200

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

   201

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

   202

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

   203

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

   204

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

   205

   206

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

   207

/* B 1.3.3 - Derived data types */

   208

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

   209

/*  simple_type_name ':' simple_spec_init */

   210

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

   211

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

   212

}

   213

/* simple_specification ASSIGN constant */

   214

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

   215

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

   216

}

   217

   218

/*  subrange_type_name ':' subrange_spec_init */

   219

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

   220

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

   221

}

   222

   223

/* subrange_specification ASSIGN signed_integer */

   224

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

   225

  this->is_subrange = true;

   226

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

   227

}

   228

   229

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

   230

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

   231

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

   232

}

   233

   234

/*  signed_integer DOTDOT signed_integer */

   235

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

   236

   237

/*  enumerated_type_name ':' enumerated_spec_init */

   238

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

   239

  this->current_type_name = symbol->enumerated_type_name;

   240

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

   241

}

   242

   243

/* enumerated_specification ASSIGN enumerated_value */

   244

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

   245

  this->is_enumerated = true;

   246

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

   247

}

   248

   249

/* helper symbol for enumerated_specification->enumerated_spec_init */

   250

/* enumerated_value_list ',' enumerated_value */

   251

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

   252

   253

/* enumerated_type_name '#' identifier */

   254

// SYM_REF2(enumerated_value_c, type, value)

   255

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

   256

   257

/*  identifier ':' array_spec_init */

   258

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

   259

  this->current_type_name = symbol->identifier;

   260

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

   261

}

   262

   263

/* array_specification [ASSIGN array_initialization} */

   264

/* array_initialization may be NULL ! */

   265

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

   266

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

   267

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

   268

   * especially if we are looking for the base class!

   269

   */  

   270

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

   271

}

   272

   273

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

   274

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

   275

   276

/* helper symbol for array_specification */

   277

/* array_subrange_list ',' subrange */

   278

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

   279

   280

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

   281

/* helper symbol for array_initialization */

   282

/* array_initial_elements_list ',' array_initial_elements */

   283

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

   284

   285

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

   286

/* array_initial_element may be NULL ! */

   287

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

   288

   289

/*  structure_type_name ':' structure_specification */

   290

/* NOTE: structure_specification will point to either a

   291

 *       initialized_structure_c

   292

 *       OR A

   293

 *       structure_element_declaration_list_c

   294

 */

   295

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

   296

  this->current_type_name = symbol->structure_type_name;

   297

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

   298

}

   299

   300

/*  var1_list ':' structure_type_name */

   301

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

   302

	return symbol;

   303

}

   304

   305

/* structure_type_name ASSIGN structure_initialization */

   306

/* structure_initialization may be NULL ! */

   307

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

   308

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

   309

}

   310

   311

/* helper symbol for structure_declaration */

   312

/* structure_declaration:  STRUCT structure_element_declaration_list END_STRUCT */

   313

/* structure_element_declaration_list structure_element_declaration ';' */

   314

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

   315

   316

/*  structure_element_name ':' *_spec_init */

   317

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

   318

   319

/* helper symbol for structure_initialization */

   320

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

   321

/* structure_element_initialization_list ',' structure_element_initialization */

   322

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

   323

   324

/*  structure_element_name ASSIGN value */

   325

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

   326

   327

/*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   328

/*

   329

SYM_REF4(string_type_declaration_c,	string_type_name,

   330

					elementary_string_type_name,

   331

					string_type_declaration_size,

   332

					string_type_declaration_init) // may be == NULL!

   333

*/

   334

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

   335

   336

   337

   338

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

   339

/* B 1.5.2 - Function Blocks */

   340

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

   341

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   342

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

   343

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

   344

	this->is_fb = true;

   345

	return (void *)symbol;

   346

}

   347

   348

   349

   350

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

   351

/* B.1.6  Sequential function chart elements */

   352

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

   353

/* INITIAL_STEP step_name ':' action_association_list END_STEP */

   354

// SYM_REF2(initial_step_c, step_name, action_association_list)

   355

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

   356

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

   357

  return (void *)symbol;

   358

}

   359

   360

/* STEP step_name ':' action_association_list END_STEP */

   361

// SYM_REF2(step_c, step_name, action_association_list)

   362

void *search_base_type_c::visit(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