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

long long extract_integer_value(symbol_c *sym) {

   103

  std::string str = "";

   104

  integer_c *integer;

   105

  neg_integer_c * neg_integer;

   106

   107

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

   108

    return - extract_integer_value(neg_integer->exp);

   109

   110

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

   111

   112

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

   113

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

   114

   115

  /* return atoi(str.c_str()); */

   116

  return atoll(str.c_str());

   117

}

   118

   119

   120

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

   121

/* NOTE: it must ignore underscores! */

   122

uint64_t extract_hex_value(symbol_c *sym) {

   123

  std::string str = "";

   124

  char *endptr;

   125

  hex_integer_c * hex_integer;

   126

  uint64_t ret;

   127

   128

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

   129

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

   130

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

   131

   132

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

   133

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

   134

  if (errno != 0) ERROR;

   135

   136

  return ret;

   137

}

   138

   139

   140

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

   141

/* NOTE: it must ignore underscores! */

   142

/* From iec_bison.yy

   143

 *  real:

   144

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

   145

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

   146

 *

   147

 * From iec_flex.ll

   148

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

   149

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

   150

 *

   151

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

   152

 * fixed_point		{integer}\.{integer}

   153

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

   154

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

   155

 */

   156

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

   157

  std::string str = "";

   158

  char *endptr;

   159

  real_c * real_sym;

   160

  real64_t ret;

   161

   162

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

   163

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

   164

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

   165

   166

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

   167

  #if    (real64_t  == float)

   168

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

   169

  #elif  (real64_t  == double)

   170

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

   171

  #elif  (real64_t  == long_double)

   172

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

   173

  #else 

   174

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

   175

  #endif

   176

  if (overflow != NULL)

   177

    *overflow = (errno == ERANGE);

   178

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

   179

    ERROR;

   180

   181

  return ret;

   182

}

   183

   184

   185

   186

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

   187

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

   188

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

   189

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

   190

   191

   192

   193

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

   194

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

   195

dsymtable_c<function_declaration_c *, &null_symbol1> function_symtable;

   196

   197

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

   198

function_block_declaration_c null_symbol2(NULL,NULL,NULL);

   199

symtable_c<function_block_declaration_c *, &null_symbol2> function_block_type_symtable;

   200

   201

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

   202

program_declaration_c null_symbol3(NULL,NULL,NULL);

   203

symtable_c<program_declaration_c *, &null_symbol3> program_type_symtable;

   204

   205

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

   206

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

   207

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

   208

 *

   209

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

   210

 */

   211

symbol_c null_symbol4;

   212

symtable_c<symbol_c *, &null_symbol4> type_symtable;

   213

   214

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

   215

/* Notes:

   216

 * - if the value is defined multiple times the value

   217

 * is the null pointer.

   218

 *

   219

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

   220

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

   221

 * is used/declared.

   222

 *

   223

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

   224

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

   225

 */

   226

symbol_c null_symbol5;

   227

symtable_c<symbol_c *, &null_symbol5> enumerated_value_symtable;

   228

   229

   230

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

   231

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

   232

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

   233

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

   234

   235

   236

class populate_symtables_c: public iterator_visitor_c {

   237

   238

  private:

   239

	symbol_c *current_enumerated_type;

   240

   241

  public:

   242

    populate_symtables_c(void) {

   243

    	current_enumerated_type = NULL;

   244

    };

   245

    virtual ~populate_symtables_c(void) {}

   246

   247

   248

  public:

   249

   250

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

   251

  /* B.1 - Common elements */

   252

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

   253

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

   254

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

   255

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

   256

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

   257

  /* B 1.2 - Constants */

   258

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

   259

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

   260

  /* B 1.2.1 - Numeric Literals */

   261

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

   262

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

   263

  /* B.1.2.2   Character Strings */

   264

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

   265

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

   266

  /* B 1.2.3 - Time Literals */

   267

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

   268

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

   269

  /* B 1.2.3.1 - Duration */

   270

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

   271

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

   272

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

   273

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

   274

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

   275

  /* B.1.3 - Data types */

   276

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

   277

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

   278

  /* B 1.3.1 - Elementary Data Types */

   279

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

   280

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

   281

  /* B.1.3.2 - Generic data types */

   282

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

   283

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

   284

  /* B 1.3.3 - Derived data types */

   285

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

   286

   287

  /*  subrange_type_name ':' subrange_spec_init */

   288

  void *visit(subrange_type_declaration_c *symbol) {

   289

    TRACE("subrange_type_declaration_c");  

   290

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

   291

    return NULL;

   292

  }

   293

   294

   295

  /*  enumerated_type_name ':' enumerated_spec_init */

   296

  void *visit(enumerated_type_declaration_c *symbol) {

   297

    TRACE("enumerated_type_declaration_c");

   298

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

   299

    current_enumerated_type = symbol->enumerated_type_name;

   300

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

   301

    current_enumerated_type = NULL;

   302

    return NULL;

   303

  }

   304

   305

  /* enumerated_specification ASSIGN enumerated_value */

   306

  void *visit(enumerated_spec_init_c *symbol) {

   307

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

   308

  }

   309

   310

  /* [enumerated_type_name '#'] identifier */

   311

  void *visit(enumerated_value_c *symbol) {

   312

    if (current_enumerated_type != NULL) {

   313

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

   314

   315

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

   316

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

   317

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

   318

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

   319

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

   320

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

   321

       *       compiler error message).

   322

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

   323

       */

   324

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

   325

   326

      if (value_type == enumerated_value_symtable.end_value())

   327

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

   328

	 * so we add it to the symbol table.

   329

	 */

   330

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

   331

      else if (value_type != NULL)

   332

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

   333

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

   334

	 */

   335

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

   336

    }

   337

    return NULL;

   338

  }

   339

   340

  /*  identifier ':' array_spec_init */

   341

  void *visit(array_type_declaration_c *symbol) {

   342

    TRACE("array_type_declaration_c");

   343

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

   344

    return NULL;

   345

  }

   346

   347

   348

  /*  simple_type_name ':' simple_spec_init */

   349

  void *visit(simple_type_declaration_c *symbol) {

   350

    TRACE("simple_type_declaration_c");

   351

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

   352

    return NULL;

   353

  }

   354

   355

   356

  /*  structure_type_name ':' structure_specification */

   357

  void *visit(structure_type_declaration_c *symbol) {

   358

    TRACE("structure_type_declaration_c");

   359

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

   360

    return NULL;

   361

  }

   362

   363

   364

  /*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   365

  // SYM_REF4(string_type_declaration_c,	string_type_name,

   366

  //    					elementary_string_type_name,

   367

  //    					string_type_declaration_size,

   368

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

   369

  void *visit(string_type_declaration_c *symbol)	{

   370

    TRACE("string_type_declaration_c");

   371

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

   372

    return NULL;

   373

}

   374

   375

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

   376

  /* B 1.4 - Variables */

   377

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

   378

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

   379

  /* B.1.4.1   Directly Represented Variables */

   380

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

   381

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

   382

  /* B.1.4.2   Multi-element Variables */

   383

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

   384

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

   385

  /* B 1.4.3 - Declaration & Initialisation */

   386

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

   387

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

   388

  /* B.1.5 - Program organization units */

   389

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

   390

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

   391

  /* B 1.5.1 - Functions */

   392

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

   393

  public:

   394

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

   395

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

   396

  void *visit(function_declaration_c *symbol) {

   397

    TRACE("function_declaration_c");

   398

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

   399

   400

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

   401

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

   402

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

   403

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

   404

    return NULL;

   405

  }

   406

   407

   408

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

   409

  /* B 1.5.2 - Function Blocks */

   410

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

   411

  public:

   412

  /*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   413

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

   414

  void *visit(function_block_declaration_c *symbol) {

   415

    TRACE("function_block_declaration_c");

   416

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

   417

  /*

   418

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

   419

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

   420

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

   421

  */

   422

    return NULL;

   423

  }

   424

   425

   426

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

   427

  /* B 1.5.3 - Programs */

   428

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

   429

  public:

   430

  /*  PROGRAM program_type_name program_var_declarations_list function_block_body END_PROGRAM */

   431

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

   432

  void *visit(program_declaration_c *symbol) {

   433

    TRACE("program_declaration_c");

   434

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

   435

  /*

   436

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

   437

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

   438

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

   439

  */

   440

    return NULL;

   441

  }

   442

   443

}; /* populate_symtables_c */

   444

   445

   446

   447

   448

   449

void absyntax_utils_init(symbol_c *tree_root) {

   450

  populate_symtables_c populate_symbols;

   451

   452

  tree_root->accept(populate_symbols);

   453

}

   454