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

    56

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

    57

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

    58

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

    59

    60

    61

    62

//#define DEBUG

    63

#ifdef DEBUG

    64

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

    65

#else

    66

#define TRACE(classname)

    67

#endif

    68

    69

#define ERROR error_exit(__FILE__,__LINE__)

    70

/* function defined in main.cc */

    71

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

    72

    73

    74

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

    75

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

    76

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

    77

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

    78

    79

    80

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

    81

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

    82

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

    83

    84

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

    85

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

    86

    87

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

    88

    /* invalid identifiers... */

    89

    return -1;

    90

    91

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

    92

    return 0;

    93

    94

  /* identifiers do not match! */

    95

  return 1;

    96

}

    97

    98

    99

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

   100

/* NOTE: it must ignore underscores! */

   101

long long extract_integer_value(symbol_c *sym) {

   102

  std::string str = "";

   103

  integer_c *integer;

   104

  neg_integer_c * neg_integer;

   105

   106

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

   107

    return - extract_integer_value(neg_integer->exp);

   108

   109

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

   110

   111

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

   112

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

   113

   114

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

   115

  return atoll(str.c_str());

   116

}

   117

   118

   119

   120

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

   121

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

   122

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

   123

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

   124

   125

   126

   127

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

   128

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

   129

dsymtable_c<function_declaration_c *, &null_symbol1> function_symtable;

   130

   131

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

   132

function_block_declaration_c null_symbol2(NULL,NULL,NULL);

   133

symtable_c<function_block_declaration_c *, &null_symbol2> function_block_type_symtable;

   134

   135

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

   136

program_declaration_c null_symbol3(NULL,NULL,NULL);

   137

symtable_c<program_declaration_c *, &null_symbol3> program_type_symtable;

   138

   139

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

   140

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

   141

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

   142

 *

   143

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

   144

 */

   145

symbol_c null_symbol4;

   146

symtable_c<symbol_c *, &null_symbol4> type_symtable;

   147

   148

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

   149

/* Notes:

   150

 * - if the value is defined multiple times the value

   151

 * is the null pointer.

   152

 *

   153

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

   154

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

   155

 * is used/declared.

   156

 *

   157

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

   158

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

   159

 */

   160

symbol_c null_symbol5;

   161

symtable_c<symbol_c *, &null_symbol5> enumerated_value_symtable;

   162

   163

   164

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

   165

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

   166

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

   167

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

   168

   169

   170

class populate_symtables_c: public iterator_visitor_c {

   171

   172

  private:

   173

	symbol_c *current_enumerated_type;

   174

   175

  public:

   176

    populate_symtables_c(void) {

   177

    	current_enumerated_type = NULL;

   178

    };

   179

    virtual ~populate_symtables_c(void) {}

   180

   181

   182

  public:

   183

   184

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

   185

  /* B.1 - Common elements */

   186

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

   187

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

   188

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

   189

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

   190

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

   191

  /* B 1.2 - Constants */

   192

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

   193

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

   194

  /* B 1.2.1 - Numeric Literals */

   195

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

   196

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

   197

  /* B.1.2.2   Character Strings */

   198

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

   199

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

   200

  /* B 1.2.3 - Time Literals */

   201

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

   202

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

   203

  /* B 1.2.3.1 - Duration */

   204

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

   205

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

   206

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

   207

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

   208

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

   209

  /* B.1.3 - Data types */

   210

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

   211

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

   212

  /* B 1.3.1 - Elementary Data Types */

   213

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

   214

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

   215

  /* B.1.3.2 - Generic data types */

   216

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

   217

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

   218

  /* B 1.3.3 - Derived data types */

   219

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

   220

   221

  /*  subrange_type_name ':' subrange_spec_init */

   222

  void *visit(subrange_type_declaration_c *symbol) {

   223

    TRACE("subrange_type_declaration_c");  

   224

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

   225

    return NULL;

   226

  }

   227

   228

   229

  /*  enumerated_type_name ':' enumerated_spec_init */

   230

  void *visit(enumerated_type_declaration_c *symbol) {

   231

    TRACE("enumerated_type_declaration_c");

   232

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

   233

    current_enumerated_type = symbol->enumerated_type_name;

   234

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

   235

    current_enumerated_type = NULL;

   236

    return NULL;

   237

  }

   238

   239

  /* enumerated_specification ASSIGN enumerated_value */

   240

  void *visit(enumerated_spec_init_c *symbol) {

   241

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

   242

  }

   243

   244

  /* [enumerated_type_name '#'] identifier */

   245

  void *visit(enumerated_value_c *symbol) {

   246

    if (current_enumerated_type != NULL) {

   247

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

   248

   249

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

   250

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

   251

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

   252

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

   253

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

   254

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

   255

       *       compiler error message).

   256

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

   257

       */

   258

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

   259

   260

      if (value_type == enumerated_value_symtable.end_value())

   261

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

   262

	 * so we add it to the symbol table.

   263

	 */

   264

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

   265

      else if (value_type != NULL)

   266

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

   267

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

   268

	 */

   269

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

   270

    }

   271

    return NULL;

   272

  }

   273

   274

  /*  identifier ':' array_spec_init */

   275

  void *visit(array_type_declaration_c *symbol) {

   276

    TRACE("array_type_declaration_c");

   277

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

   278

    return NULL;

   279

  }

   280

   281

   282

  /*  simple_type_name ':' simple_spec_init */

   283

  void *visit(simple_type_declaration_c *symbol) {

   284

    TRACE("simple_type_declaration_c");

   285

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

   286

    return NULL;

   287

  }

   288

   289

   290

  /*  structure_type_name ':' structure_specification */

   291

  void *visit(structure_type_declaration_c *symbol) {

   292

    TRACE("structure_type_declaration_c");

   293

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

   294

    return NULL;

   295

  }

   296

   297

   298

  /*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   299

  // SYM_REF4(string_type_declaration_c,	string_type_name,

   300

  //    					elementary_string_type_name,

   301

  //    					string_type_declaration_size,

   302

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

   303

  void *visit(string_type_declaration_c *symbol)	{

   304

    TRACE("string_type_declaration_c");

   305

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

   306

    return NULL;

   307

}

   308

   309

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

   310

  /* B 1.4 - Variables */

   311

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

   312

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

   313

  /* B.1.4.1   Directly Represented Variables */

   314

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

   315

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

   316

  /* B.1.4.2   Multi-element Variables */

   317

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

   318

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

   319

  /* B 1.4.3 - Declaration & Initialisation */

   320

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

   321

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

   322

  /* B.1.5 - Program organization units */

   323

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

   324

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

   325

  /* B 1.5.1 - Functions */

   326

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

   327

  public:

   328

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

   329

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

   330

  void *visit(function_declaration_c *symbol) {

   331

    TRACE("function_declaration_c");

   332

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

   333

   334

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

   335

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

   336

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

   337

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

   338

    return NULL;

   339

  }

   340

   341

   342

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

   343

  /* B 1.5.2 - Function Blocks */

   344

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

   345

  public:

   346

  /*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   347

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

   348

  void *visit(function_block_declaration_c *symbol) {

   349

    TRACE("function_block_declaration_c");

   350

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

   351

  /*

   352

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

   353

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

   354

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

   355

  */

   356

    return NULL;

   357

  }

   358

   359

   360

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

   361

  /* B 1.5.3 - Programs */

   362

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

   363

  public:

   364

  /*  PROGRAM program_type_name program_var_declarations_list function_block_body END_PROGRAM */

   365

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

   366

  void *visit(program_declaration_c *symbol) {

   367

    TRACE("program_declaration_c");

   368

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

   369

  /*

   370

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

   371

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

   372

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

   373

  */

   374

    return NULL;

   375

  }

   376

   377

}; /* populate_symtables_c */

   378

   379

   380

   381

   382

   383

void absyntax_utils_init(symbol_c *tree_root) {

   384

  populate_symtables_c populate_symbols;

   385

   386

  tree_root->accept(populate_symbols);

   387

}

   388