1

/*

     2

 *  matiec - a compiler for the programming languages defined in IEC 61131-3

     3

 *

     4

 *  Copyright (C) 2009-2011  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

    34

/*

    35

 * This is the main stage 3a file.

    36

 *

    37

 * In stage 3a some helpful symbol tables are instanciated and populated.

    38

 * These symbol tables wll then be used by stage3b and atage4 code generators.

    39

 */

    40

    41

    42

    43

    44

    45

    46

// #include <stdio.h>  /* required for NULL */

    47

#include <string>

    48

#include <iostream>

    49

#include <sstream>

    50

#include <typeinfo>

    51

#include <list>

    52

#include <strings.h>

    53

#include <string.h>  /* required for strlen() */

    54

#include <stdlib.h>  /* required for atoi() */

    55

#include <errno.h>   /* required for errno */

    56

    57

#include "../util/symtable.hh"

    58

#include "../util/dsymtable.hh"

    59

#include "../absyntax/visitor.hh"

    60

    61

    62

    63

//#define DEBUG

    64

#ifdef DEBUG

    65

#define TRACE(classname) printf("\n____%s____\n",classname);

    66

#else

    67

#define TRACE(classname)

    68

#endif

    69

    70

#define ERROR error_exit(__FILE__,__LINE__)

    71

/* function defined in main.cc */

    72

extern void error_exit(const char *file_name, int line_no);

    73

    74

    75

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

    76

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

    77

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

    78

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

    79

    80

    81

/* returns 0 if the names are equal!! */

    82

/* NOTE: it must ignore case!! */

    83

int compare_identifiers(symbol_c *ident1, symbol_c *ident2) {

    84

    85

  token_c *name1 = dynamic_cast<token_c *>(ident1);

    86

  token_c *name2 = dynamic_cast<token_c *>(ident2);

    87

    88

  if ((name1 == NULL) || (name2 == NULL))

    89

    /* invalid identifiers... */

    90

    return -1;

    91

    92

  if (strcasecmp(name1->value, name2->value) == 0)

    93

    return 0;

    94

    95

  /* identifiers do not match! */

    96

  return 1;

    97

}

    98

    99

   100

/* extract the value of an integer from an integer_c object !! */

   101

/* NOTE: it must ignore underscores! */

   102

int64_t extract_int64_value(symbol_c *sym, bool *overflow) {

   103

  std::string str = "";

   104

  integer_c *integer;

   105

  neg_integer_c * neg_integer;

   106

  char *endptr;

   107

  int64_t ret;

   108

   109

  if ((neg_integer = dynamic_cast<neg_integer_c *>(sym)) != NULL)

   110

    return - extract_int64_value(neg_integer->exp, overflow);

   111

   112

  if ((integer = dynamic_cast<integer_c *>(sym)) == NULL) ERROR;

   113

   114

  for(unsigned int i = 0; i < strlen(integer->value); i++)

   115

    if (integer->value[i] != '_')  str += integer->value[i];

   116

   117

  errno = 0;

   118

  ret = strtoll(str.c_str(), &endptr, 10);

   119

  if (overflow != NULL)

   120

    *overflow = (errno == ERANGE);

   121

  if ((errno != 0) && (errno != ERANGE))

   122

    ERROR;

   123

   124

  return ret;

   125

}

   126

   127

uint64_t extract_uint64_value(symbol_c *sym, bool *overflow) {

   128

  std::string str = "";

   129

  integer_c *integer;

   130

  neg_integer_c * neg_integer;

   131

  char *endptr;

   132

  uint64_t ret;

   133

   134

  if ((integer = dynamic_cast<integer_c *>(sym)) == NULL) ERROR;

   135

   136

  for(unsigned int i = 0; i < strlen(integer->value); i++)

   137

    if (integer->value[i] != '_')  str += integer->value[i];

   138

   139

  errno = 0;

   140

  ret = strtoull(str.c_str(), &endptr, 10);

   141

  if (overflow != NULL)

   142

    *overflow = (errno == ERANGE);

   143

  if ((errno != 0) && (errno != ERANGE))

   144

    ERROR;

   145

   146

  return ret;

   147

}

   148

   149

   150

/* extract the value of an hex integer from an hex_integer_c object !! */

   151

/* NOTE: it must ignore underscores! */

   152

uint64_t extract_hex_value(symbol_c *sym) {

   153

  std::string str = "";

   154

  char *endptr;

   155

  hex_integer_c * hex_integer;

   156

  uint64_t ret;

   157

   158

  if ((hex_integer = dynamic_cast<hex_integer_c *>(sym)) == NULL) ERROR;

   159

  for(unsigned int i = 3; i < strlen(hex_integer->value); i++)

   160

    if (hex_integer->value[i] != '_') str += hex_integer->value[i];

   161

   162

  errno = 0; // since strtoXX() may legally return 0, we must set errno to 0 to detect errors correctly!

   163

  ret = strtoull(str.c_str(), &endptr, 16);

   164

  if (errno != 0) ERROR;

   165

   166

  return ret;

   167

}

   168

   169

   170

/* extract the value of a real from an real_c object !! */

   171

/* NOTE: it must ignore underscores! */

   172

/* From iec_bison.yy

   173

 *  real:

   174

 *   real_token		{$$ = new real_c($1, locloc(@$));}

   175

 * | fixed_point_token	{$$ = new real_c($1, locloc(@$));}

   176

 *

   177

 * From iec_flex.ll

   178

 * {real}			{yylval.ID=strdup(yytext); return real_token;}

   179

 * {fixed_point}		{yylval.ID=strdup(yytext); return fixed_point_token;}

   180

 *

   181

 * real		{integer}\.{integer}{exponent}

   182

 * fixed_point		{integer}\.{integer}

   183

 * exponent        [Ee]([+-]?){integer}

   184

 * integer         {digit}((_?{digit})*)

   185

 */

   186

real64_t extract_real_value(symbol_c *sym, bool *overflow) {

   187

  std::string str = "";

   188

  real_c * real_sym;

   189

  real64_t ret;

   190

   191

  if ((real_sym = dynamic_cast<real_c *>(sym)) == NULL) ERROR;

   192

  for(unsigned int i = 0; i < strlen(real_sym->value); i++)

   193

    if (real_sym->value[i] != '_') str += real_sym->value[i];

   194

   195

  errno = 0; // since strtoXX() may legally return 0, we must set errno to 0 to detect errors correctly!

   196

  #if    (real64_t  == float)

   197

    ret = strtof(str.c_str(), NULL);

   198

  #elif  (real64_t  == double)

   199

    ret = strtod(str.c_str(), NULL);

   200

  #elif  (real64_t  == long_double)

   201

    ret = strtold(str.c_str(), NULL);

   202

  #else 

   203

    #error Could not determine which data type is being used for real64_t (defined in absyntax.hh). Aborting!

   204

  #endif

   205

  if (overflow != NULL)

   206

    *overflow = (errno == ERANGE);

   207

  if ((errno != 0) && (errno != ERANGE)) 

   208

    ERROR;

   209

   210

  return ret;

   211

}

   212

   213

   214

   215

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

   216

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

   217

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

   218

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

   219

   220

   221

   222

/* A symbol table with all globally declared functions... */

   223

function_declaration_c null_symbol1(NULL,NULL,NULL,NULL);

   224

dsymtable_c<function_declaration_c *, &null_symbol1> function_symtable;

   225

   226

/* A symbol table with all globally declared functions block types... */

   227

function_block_declaration_c null_symbol2(NULL,NULL,NULL);

   228

symtable_c<function_block_declaration_c *, &null_symbol2> function_block_type_symtable;

   229

   230

/* A symbol table with all globally declared program types... */

   231

program_declaration_c null_symbol3(NULL,NULL,NULL);

   232

symtable_c<program_declaration_c *, &null_symbol3> program_type_symtable;

   233

   234

/* A symbol table with all user declared type definitions... */

   235

/* Note that function block types and program types have their

   236

 * own symbol tables, so do not get placed in this symbol table!

   237

 *

   238

 * The symbol_c * associated to the value will point to the data type declaration.

   239

 */

   240

symbol_c null_symbol4;

   241

symtable_c<symbol_c *, &null_symbol4> type_symtable;

   242

   243

/* A symbol table with all values declared for enumerated type... */

   244

/* Notes:

   245

 * - if the value is defined multiple times the value

   246

 * is the null pointer.

   247

 *

   248

 * - The stored symbol_c * associated to the value points to the enumerated_type_name

   249

 * (i.e. the name of the enumerated data type) in which the the value/identifier

   250

 * is used/declared.

   251

 *

   252

 * - We could re-use the null_symbol4 object, but it is safer to use a distinct object

   253

 *   (i.e. it might make it easier to find strange bugs).

   254

 */

   255

symbol_c null_symbol5;

   256

symtable_c<symbol_c *, &null_symbol5> enumerated_value_symtable;

   257

   258

   259

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

   260

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

   261

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

   262

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

   263

   264

   265

class populate_symtables_c: public iterator_visitor_c {

   266

   267

  private:

   268

	symbol_c *current_enumerated_type;

   269

   270

  public:

   271

    populate_symtables_c(void) {

   272

    	current_enumerated_type = NULL;

   273

    };

   274

    virtual ~populate_symtables_c(void) {}

   275

   276

   277

  public:

   278

   279

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

   280

  /* B.1 - Common elements */

   281

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

   282

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

   283

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

   284

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

   285

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

   286

  /* B 1.2 - Constants */

   287

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

   288

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

   289

  /* B 1.2.1 - Numeric Literals */

   290

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

   291

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

   292

  /* B.1.2.2   Character Strings */

   293

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

   294

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

   295

  /* B 1.2.3 - Time Literals */

   296

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

   297

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

   298

  /* B 1.2.3.1 - Duration */

   299

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

   300

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

   301

  /* B 1.2.3.2 - Time of day and Date */

   302

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

   303

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

   304

  /* B.1.3 - Data types */

   305

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

   306

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

   307

  /* B 1.3.1 - Elementary Data Types */

   308

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

   309

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

   310

  /* B.1.3.2 - Generic data types */

   311

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

   312

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

   313

  /* B 1.3.3 - Derived data types */

   314

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

   315

   316

  /*  subrange_type_name ':' subrange_spec_init */

   317

  void *visit(subrange_type_declaration_c *symbol) {

   318

    TRACE("subrange_type_declaration_c");  

   319

    type_symtable.insert(symbol->subrange_type_name, symbol->subrange_spec_init);

   320

    return NULL;

   321

  }

   322

   323

   324

  /*  enumerated_type_name ':' enumerated_spec_init */

   325

  void *visit(enumerated_type_declaration_c *symbol) {

   326

    TRACE("enumerated_type_declaration_c");

   327

    type_symtable.insert(symbol->enumerated_type_name, symbol->enumerated_spec_init);

   328

    current_enumerated_type = symbol->enumerated_type_name;

   329

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

   330

    current_enumerated_type = NULL;

   331

    return NULL;

   332

  }

   333

   334

  /* enumerated_specification ASSIGN enumerated_value */

   335

  void *visit(enumerated_spec_init_c *symbol) {

   336

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

   337

  }

   338

   339

  /* [enumerated_type_name '#'] identifier */

   340

  void *visit(enumerated_value_c *symbol) {

   341

    if (current_enumerated_type != NULL) {

   342

      if (symbol->type != NULL) ERROR;

   343

   344

      symbol_c *value_type = enumerated_value_symtable.find_value(symbol->value);

   345

      /* NOTE: The following condition checks whether the same identifier is used more than once

   346

       *       when defining the enumerated values of the type declaration of the new enumerated type.

   347

       *       If this occurs, then the program beeing compiled contains a semantic error, which

   348

       *       must be caught and reported by the semantic analyser. However, since

   349

       *       this code is run before the semantic analyser, we must not yet raise the ERROR (internal

   350

       *       compiler error message).

   351

       *       For this reason, the follosing check is commented out.

   352

       */

   353

      /* if (value_type == current_enumerated_type) ERROR; */

   354

   355

      if (value_type == enumerated_value_symtable.end_value())

   356

	/* This identifier has not yet been used in any previous declaration of an enumeration data type.

   357

	 * so we add it to the symbol table.

   358

	 */

   359

        enumerated_value_symtable.insert(symbol->value, current_enumerated_type);

   360

      else if (value_type != NULL)

   361

	/* This identifier has already been used in a previous declaration of an enumeration data type.

   362

	 * so we set the symbol in symbol table pointing to NULL.

   363

	 */

   364

        enumerated_value_symtable.set(symbol->value, NULL);

   365

    }

   366

    return NULL;

   367

  }

   368

   369

  /*  identifier ':' array_spec_init */

   370

  void *visit(array_type_declaration_c *symbol) {

   371

    TRACE("array_type_declaration_c");

   372

    type_symtable.insert(symbol->identifier, symbol->array_spec_init);

   373

    return NULL;

   374

  }

   375

   376

   377

  /*  simple_type_name ':' simple_spec_init */

   378

  void *visit(simple_type_declaration_c *symbol) {

   379

    TRACE("simple_type_declaration_c");

   380

    type_symtable.insert(symbol->simple_type_name, symbol->simple_spec_init);

   381

    return NULL;

   382

  }

   383

   384

   385

  /*  structure_type_name ':' structure_specification */

   386

  void *visit(structure_type_declaration_c *symbol) {

   387

    TRACE("structure_type_declaration_c");

   388

    type_symtable.insert(symbol->structure_type_name, symbol->structure_specification);

   389

    return NULL;

   390

  }

   391

   392

   393

  /*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   394

  // SYM_REF4(string_type_declaration_c,	string_type_name,

   395

  //    					elementary_string_type_name,

   396

  //    					string_type_declaration_size,

   397

  //    					string_type_declaration_init) /* may be == NULL! */

   398

  void *visit(string_type_declaration_c *symbol)	{

   399

    TRACE("string_type_declaration_c");

   400

    type_symtable.insert(symbol->string_type_name, symbol);

   401

    return NULL;

   402

}

   403

   404

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

   405

  /* B 1.4 - Variables */

   406

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

   407

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

   408

  /* B.1.4.1   Directly Represented Variables */

   409

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

   410

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

   411

  /* B.1.4.2   Multi-element Variables */

   412

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

   413

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

   414

  /* B 1.4.3 - Declaration & Initialisation */

   415

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

   416

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

   417

  /* B.1.5 - Program organization units */

   418

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

   419

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

   420

  /* B 1.5.1 - Functions */

   421

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

   422

  public:

   423

  /*   FUNCTION derived_function_name ':' elementary_type_name io_OR_function_var_declarations_list function_body END_FUNCTION */

   424

  /* | FUNCTION derived_function_name ':' derived_type_name io_OR_function_var_declarations_list function_body END_FUNCTION */

   425

  void *visit(function_declaration_c *symbol) {

   426

    TRACE("function_declaration_c");

   427

    function_symtable.insert(symbol->derived_function_name, symbol);

   428

   429

    /* symbol->derived_function_name->accept(*this);  */ /* Function name */

   430

    /* symbol->type_name->accept(*this);              */ /* return data type */

   431

    /* symbol->var_declarations_list->accept(*this);  */ /* Function parameters and variables */

   432

    /* symbol->function_body->accept(*this);          */ /* Function body */

   433

    return NULL;

   434

  }

   435

   436

   437

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

   438

  /* B 1.5.2 - Function Blocks */

   439

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

   440

  public:

   441

  /*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   442

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

   443

  void *visit(function_block_declaration_c *symbol) {

   444

    TRACE("function_block_declaration_c");

   445

    function_block_type_symtable.insert(symbol->fblock_name, symbol);

   446

  /*

   447

    symbol->fblock_name->accept(*this);

   448

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

   449

    symbol->fblock_body->accept(*this);

   450

  */

   451

    return NULL;

   452

  }

   453

   454

   455

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

   456

  /* B 1.5.3 - Programs */

   457

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

   458

  public:

   459

  /*  PROGRAM program_type_name program_var_declarations_list function_block_body END_PROGRAM */

   460

  //SYM_REF4(program_declaration_c, program_type_name, var_declarations, function_block_body, unused)

   461

  void *visit(program_declaration_c *symbol) {

   462

    TRACE("program_declaration_c");

   463

    program_type_symtable.insert(symbol->program_type_name, symbol);

   464

  /*

   465

    symbol->program_type_name->accept(*this);

   466

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

   467

    symbol->function_block_body->accept(*this);

   468

  */

   469

    return NULL;

   470

  }

   471

   472

}; /* populate_symtables_c */

   473

   474

   475

   476

   477

   478

void absyntax_utils_init(symbol_c *tree_root) {

   479

  populate_symtables_c populate_symbols;

   480

   481

  tree_root->accept(populate_symbols);

   482

}

   483