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

   120

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

   121

/* NOTE: it must ignore underscores! */

   122

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

   123

  std::string str = "";

   124

  integer_c *integer;

   125

  neg_integer_c * neg_integer;

   126

  char *endptr;

   127

  int64_t ret;

   128

   129

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

   130

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

   131

   132

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

   133

   134

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

   135

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

   136

   139

  if (overflow != NULL)

   140

    *overflow = (errno == ERANGE);

   141

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

   142

    ERROR;

   143

   144

  return ret;

   145

}

   146

   147

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

   148

  std::string str = "";

   149

  integer_c *integer;

   150

  neg_integer_c * neg_integer;

   151

  char *endptr;

   152

  uint64_t ret;

   153

   154

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

   155

   156

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

   157

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

   158

   161

  if (overflow != NULL)

   162

    *overflow = (errno == ERANGE);

   163

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

   164

    ERROR;

   165

   166

  return ret;

   167

}

   168

   169

   170

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

   171

/* NOTE: it must ignore underscores! */

   172

uint64_t extract_hex_value(symbol_c *sym) {

   173

  std::string str = "";

   174

  char *endptr;

   175

  hex_integer_c * hex_integer;

   176

  uint64_t ret;

   177

   178

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

   179

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

   180

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

   181

   182

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

   183

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

   184

  if (errno != 0) ERROR;

   185

   186

  return ret;

   187

}

   188

   189

   190

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

   191

/* NOTE: it must ignore underscores! */

   192

/* From iec_bison.yy

   193

 *  real:

   194

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

   195

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

   196

 *

   197

 * From iec_flex.ll

   198

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

   199

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

   200

 *

   201

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

   202

 * fixed_point		{integer}\.{integer}

   203

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

   204

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

   205

 */

   206

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

   207

  std::string str = "";

   208

  real_c * real_sym;

   209

  real64_t ret;

   210

   211

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

   212

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

   213

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

   214

   215

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

   216

  #if    (real64_t  == float)

   217

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

   218

  #elif  (real64_t  == double)

   219

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

   220

  #elif  (real64_t  == long_double)

   221

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

   222

  #else 

   223

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

   224

  #endif

   225

  if (overflow != NULL)

   226

    *overflow = (errno == ERANGE);

   227

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

   228

    ERROR;

   229

   230

  return ret;

   231

}

   232

   233

   234

   235

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

   236

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

   237

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

   238

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

   239

   240

   241

   242

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

   243

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

   244

dsymtable_c<function_declaration_c *, &null_symbol1> function_symtable;

   245

   246

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

   247

function_block_declaration_c null_symbol2(NULL,NULL,NULL);

   248

symtable_c<function_block_declaration_c *, &null_symbol2> function_block_type_symtable;

   249

   250

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

   251

program_declaration_c null_symbol3(NULL,NULL,NULL);

   252

symtable_c<program_declaration_c *, &null_symbol3> program_type_symtable;

   253

   254

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

   255

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

   256

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

   257

 *

   258

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

   259

 */

   260

symbol_c null_symbol4;

   261

symtable_c<symbol_c *, &null_symbol4> type_symtable;

   262

   263

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

   264

/* Notes:

   265

 * - if the value is defined multiple times the value

   266

 * is the null pointer.

   267

 *

   268

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

   269

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

   270

 * is used/declared.

   271

 *

   272

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

   273

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

   274

 */

   275

symbol_c null_symbol5;

   276

symtable_c<symbol_c *, &null_symbol5> enumerated_value_symtable;

   277

   278

   279

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

   280

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

   281

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

   282

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

   283

   284

   285

class populate_symtables_c: public iterator_visitor_c {

   286

   287

  private:

   288

	symbol_c *current_enumerated_type;

   289

   290

  public:

   291

    populate_symtables_c(void) {

   292

    	current_enumerated_type = NULL;

   293

    };

   294

    virtual ~populate_symtables_c(void) {}

   295

   296

   297

  public:

   298

   299

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

   300

  /* B.1 - Common elements */

   301

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

   302

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

   303

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

   304

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

   305

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

   306

  /* B 1.2 - Constants */

   307

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

   308

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

   309

  /* B 1.2.1 - Numeric Literals */

   310

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

   311

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

   312

  /* B.1.2.2   Character Strings */

   313

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

   314

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

   315

  /* B 1.2.3 - Time Literals */

   316

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

   317

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

   318

  /* B 1.2.3.1 - Duration */

   319

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

   320

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

   321

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

   322

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

   323

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

   324

  /* B.1.3 - Data types */

   325

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

   326

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

   327

  /* B 1.3.1 - Elementary Data Types */

   328

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

   329

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

   330

  /* B.1.3.2 - Generic data types */

   331

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

   332

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

   333

  /* B 1.3.3 - Derived data types */

   334

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

   335

   336

  /*  subrange_type_name ':' subrange_spec_init */

   337

  void *visit(subrange_type_declaration_c *symbol) {

   338

    TRACE("subrange_type_declaration_c");  

   339

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

   340

    return NULL;

   341

  }

   342

   343

   344

  /*  enumerated_type_name ':' enumerated_spec_init */

   345

  void *visit(enumerated_type_declaration_c *symbol) {

   346

    TRACE("enumerated_type_declaration_c");

   347

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

   348

    current_enumerated_type = symbol->enumerated_type_name;

   349

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

   350

    current_enumerated_type = NULL;

   351

    return NULL;

   352

  }

   353

   354

  /* enumerated_specification ASSIGN enumerated_value */

   355

  void *visit(enumerated_spec_init_c *symbol) {

   356

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

   357

  }

   358

   359

  /* [enumerated_type_name '#'] identifier */

   360

  void *visit(enumerated_value_c *symbol) {

   361

    if (current_enumerated_type != NULL) {

   362

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

   363

   364

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

   365

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

   366

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

   367

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

   368

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

   369

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

   370

       *       compiler error message).

   371

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

   372

       */

   373

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

   374

   375

      if (value_type == enumerated_value_symtable.end_value())

   376

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

   377

	 * so we add it to the symbol table.

   378

	 */

   379

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

   380

      else if (value_type != NULL)

   381

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

   382

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

   383

	 */

   384

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

   385

    }

   386

    return NULL;

   387

  }

   388

   389

  /*  identifier ':' array_spec_init */

   390

  void *visit(array_type_declaration_c *symbol) {

   391

    TRACE("array_type_declaration_c");

   392

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

   393

    return NULL;

   394

  }

   395

   396

   397

  /*  simple_type_name ':' simple_spec_init */

   398

  void *visit(simple_type_declaration_c *symbol) {

   399

    TRACE("simple_type_declaration_c");

   400

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

   401

    return NULL;

   402

  }

   403

   404

   405

  /*  structure_type_name ':' structure_specification */

   406

  void *visit(structure_type_declaration_c *symbol) {

   407

    TRACE("structure_type_declaration_c");

   408

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

   409

    return NULL;

   410

  }

   411

   412

   413

  /*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   414

  // SYM_REF4(string_type_declaration_c,	string_type_name,

   415

  //    					elementary_string_type_name,

   416

  //    					string_type_declaration_size,

   417

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

   418

  void *visit(string_type_declaration_c *symbol)	{

   419

    TRACE("string_type_declaration_c");

   420

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

   421

    return NULL;

   422

}

   423

   424

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

   425

  /* B 1.4 - Variables */

   426

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

   427

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

   428

  /* B.1.4.1   Directly Represented Variables */

   429

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

   430

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

   431

  /* B.1.4.2   Multi-element Variables */

   432

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

   433

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

   434

  /* B 1.4.3 - Declaration & Initialisation */

   435

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

   436

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

   437

  /* B.1.5 - Program organization units */

   438

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

   439

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

   440

  /* B 1.5.1 - Functions */

   441

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

   442

  public:

   443

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

   444

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

   445

  void *visit(function_declaration_c *symbol) {

   446

    TRACE("function_declaration_c");

   447

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

   448

   449

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

   450

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

   451

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

   452

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

   453

    return NULL;

   454

  }

   455

   456

   457

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

   458

  /* B 1.5.2 - Function Blocks */

   459

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

   460

  public:

   461

  /*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   462

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

   463

  void *visit(function_block_declaration_c *symbol) {

   464

    TRACE("function_block_declaration_c");

   465

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

   466

  /*

   467

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

   468

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

   469

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

   470

  */

   471

    return NULL;

   472

  }

   473

   474

   475

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

   476

  /* B 1.5.3 - Programs */

   477

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

   478

  public:

   479

  /*  PROGRAM program_type_name program_var_declarations_list function_block_body END_PROGRAM */

   480

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

   481

  void *visit(program_declaration_c *symbol) {

   482

    TRACE("program_declaration_c");

   483

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

   484

  /*

   485

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

   486

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

   487

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

   488

  */

   489

    return NULL;

   490

  }

   491

   492

}; /* populate_symtables_c */

   493

   494

   495

   496

   497

   498

void absyntax_utils_init(symbol_c *tree_root) {

   499

  populate_symtables_c populate_symbols;

   500

   501

  tree_root->accept(populate_symbols);

   502

}

   503