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

   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];

   132

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

   133

  if (errno != 0) ERROR;

   134

   135

  return ret;

   136

}

   137

   138

   158

   159

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

   160

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

   161

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

   162

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

   163

   164

   165

   166

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

   167

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

   168

dsymtable_c<function_declaration_c *, &null_symbol1> function_symtable;

   169

   170

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

   171

function_block_declaration_c null_symbol2(NULL,NULL,NULL);

   172

symtable_c<function_block_declaration_c *, &null_symbol2> function_block_type_symtable;

   173

   174

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

   175

program_declaration_c null_symbol3(NULL,NULL,NULL);

   176

symtable_c<program_declaration_c *, &null_symbol3> program_type_symtable;

   177

   178

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

   179

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

   180

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

   181

 *

   182

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

   183

 */

   184

symbol_c null_symbol4;

   185

symtable_c<symbol_c *, &null_symbol4> type_symtable;

   186

   187

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

   188

/* Notes:

   189

 * - if the value is defined multiple times the value

   190

 * is the null pointer.

   191

 *

   192

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

   193

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

   194

 * is used/declared.

   195

 *

   196

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

   197

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

   198

 */

   199

symbol_c null_symbol5;

   200

symtable_c<symbol_c *, &null_symbol5> enumerated_value_symtable;

   201

   202

   203

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

   204

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

   205

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

   206

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

   207

   208

   209

class populate_symtables_c: public iterator_visitor_c {

   210

   211

  private:

   212

	symbol_c *current_enumerated_type;

   213

   214

  public:

   215

    populate_symtables_c(void) {

   216

    	current_enumerated_type = NULL;

   217

    };

   218

    virtual ~populate_symtables_c(void) {}

   219

   220

   221

  public:

   222

   223

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

   224

  /* B.1 - Common elements */

   225

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

   226

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

   227

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

   228

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

   229

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

   230

  /* B 1.2 - Constants */

   231

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

   232

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

   233

  /* B 1.2.1 - Numeric Literals */

   234

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

   235

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

   236

  /* B.1.2.2   Character Strings */

   237

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

   238

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

   239

  /* B 1.2.3 - Time Literals */

   240

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

   241

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

   242

  /* B 1.2.3.1 - Duration */

   243

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

   244

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

   245

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

   246

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

   247

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

   248

  /* B.1.3 - Data types */

   249

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

   250

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

   251

  /* B 1.3.1 - Elementary Data Types */

   252

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

   253

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

   254

  /* B.1.3.2 - Generic data types */

   255

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

   256

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

   257

  /* B 1.3.3 - Derived data types */

   258

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

   259

   260

  /*  subrange_type_name ':' subrange_spec_init */

   261

  void *visit(subrange_type_declaration_c *symbol) {

   262

    TRACE("subrange_type_declaration_c");  

   263

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

   264

    return NULL;

   265

  }

   266

   267

   268

  /*  enumerated_type_name ':' enumerated_spec_init */

   269

  void *visit(enumerated_type_declaration_c *symbol) {

   270

    TRACE("enumerated_type_declaration_c");

   271

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

   272

    current_enumerated_type = symbol->enumerated_type_name;

   273

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

   274

    current_enumerated_type = NULL;

   275

    return NULL;

   276

  }

   277

   278

  /* enumerated_specification ASSIGN enumerated_value */

   279

  void *visit(enumerated_spec_init_c *symbol) {

   280

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

   281

  }

   282

   283

  /* [enumerated_type_name '#'] identifier */

   284

  void *visit(enumerated_value_c *symbol) {

   285

    if (current_enumerated_type != NULL) {

   286

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

   287

   288

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

   289

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

   290

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

   291

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

   292

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

   293

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

   294

       *       compiler error message).

   295

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

   296

       */

   297

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

   298

   299

      if (value_type == enumerated_value_symtable.end_value())

   300

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

   301

	 * so we add it to the symbol table.

   302

	 */

   303

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

   304

      else if (value_type != NULL)

   305

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

   306

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

   307

	 */

   308

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

   309

    }

   310

    return NULL;

   311

  }

   312

   313

  /*  identifier ':' array_spec_init */

   314

  void *visit(array_type_declaration_c *symbol) {

   315

    TRACE("array_type_declaration_c");

   316

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

   317

    return NULL;

   318

  }

   319

   320

   321

  /*  simple_type_name ':' simple_spec_init */

   322

  void *visit(simple_type_declaration_c *symbol) {

   323

    TRACE("simple_type_declaration_c");

   324

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

   325

    return NULL;

   326

  }

   327

   328

   329

  /*  structure_type_name ':' structure_specification */

   330

  void *visit(structure_type_declaration_c *symbol) {

   331

    TRACE("structure_type_declaration_c");

   332

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

   333

    return NULL;

   334

  }

   335

   336

   337

  /*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   338

  // SYM_REF4(string_type_declaration_c,	string_type_name,

   339

  //    					elementary_string_type_name,

   340

  //    					string_type_declaration_size,

   341

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

   342

  void *visit(string_type_declaration_c *symbol)	{

   343

    TRACE("string_type_declaration_c");

   344

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

   345

    return NULL;

   346

}

   347

   348

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

   349

  /* B 1.4 - Variables */

   350

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

   351

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

   352

  /* B.1.4.1   Directly Represented Variables */

   353

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

   354

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

   355

  /* B.1.4.2   Multi-element Variables */

   356

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

   357

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

   358

  /* B 1.4.3 - Declaration & Initialisation */

   359

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

   360

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

   361

  /* B.1.5 - Program organization units */

   362

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

   363

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

   364

  /* B 1.5.1 - Functions */

   365

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

   366

  public:

   367

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

   368

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

   369

  void *visit(function_declaration_c *symbol) {

   370

    TRACE("function_declaration_c");

   371

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

   372

   373

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

   374

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

   375

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

   376

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

   377

    return NULL;

   378

  }

   379

   380

   381

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

   382

  /* B 1.5.2 - Function Blocks */

   383

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

   384

  public:

   385

  /*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   386

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

   387

  void *visit(function_block_declaration_c *symbol) {

   388

    TRACE("function_block_declaration_c");

   389

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

   390

  /*

   391

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

   392

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

   393

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

   394

  */

   395

    return NULL;

   396

  }

   397

   398

   399

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

   400

  /* B 1.5.3 - Programs */

   401

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

   402

  public:

   403

  /*  PROGRAM program_type_name program_var_declarations_list function_block_body END_PROGRAM */

   404

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

   405

  void *visit(program_declaration_c *symbol) {

   406

    TRACE("program_declaration_c");

   407

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

   408

  /*

   409

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

   410

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

   411

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

   412

  */

   413

    return NULL;

   414

  }

   415

   416

}; /* populate_symtables_c */

   417

   418

   419

   420

   421

   422

void absyntax_utils_init(symbol_c *tree_root) {

   423

  populate_symtables_c populate_symbols;

   424

   425

  tree_root->accept(populate_symbols);

   426

}

   427