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 <stdlib.h>  /* required for atoi() */

    54

    55

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

    56

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

    57

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

    58

    59

    60

    61

//#define DEBUG

    62

#ifdef DEBUG

    63

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

    64

#else

    65

#define TRACE(classname)

    66

#endif

    67

    68

#define ERROR error_exit(__FILE__,__LINE__)

    69

/* function defined in main.cc */

    70

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

    71

    72

    73

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

    74

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

    75

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

    76

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

    77

    78

    79

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

    80

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

    81

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

    82

    83

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

    84

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

    85

    86

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

    87

    /* invalid identifiers... */

    88

    return -1;

    89

    90

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

    91

    return 0;

    92

    93

  /* identifiers do not match! */

    94

  return 1;

    95

}

    96

    97

    98

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

    99

/* NOTE: it must ignore underscores! */

   100

int extract_integer(symbol_c *sym) {

   101

  integer_c *integer = dynamic_cast<integer_c *>(sym);  

   102

  if (integer == NULL) ERROR;

   103

   104

  return atoi(integer->value);

   105

}

   106

   107

   108

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

   109

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

   110

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

   111

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

   112

   113

   114

   115

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

   116

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

   117

dsymtable_c<function_declaration_c *, &null_symbol1> function_symtable;

   118

   119

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

   120

function_block_declaration_c null_symbol2(NULL,NULL,NULL);

   121

symtable_c<function_block_declaration_c *, &null_symbol2> function_block_type_symtable;

   122

   123

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

   124

program_declaration_c null_symbol3(NULL,NULL,NULL);

   125

symtable_c<program_declaration_c *, &null_symbol3> program_type_symtable;

   126

   127

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

   128

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

   129

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

   130

 *

   131

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

   132

 */

   133

symbol_c null_symbol4;

   134

symtable_c<symbol_c *, &null_symbol4> type_symtable;

   135

   136

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

   137

/* Notes:

   138

 * - if the value is defined multiple times the value

   139

 * is the null pointer.

   140

 *

   141

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

   142

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

   143

 * is used/declared.

   144

 *

   145

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

   146

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

   147

 */

   148

symbol_c null_symbol5;

   149

symtable_c<symbol_c *, &null_symbol5> enumerated_value_symtable;

   150

   151

   152

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

   153

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

   154

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

   155

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

   156

   157

   158

class populate_symtables_c: public iterator_visitor_c {

   159

   160

  private:

   161

	symbol_c *current_enumerated_type;

   162

   163

  public:

   164

    populate_symtables_c(void) {

   165

    	current_enumerated_type = NULL;

   166

    };

   167

    virtual ~populate_symtables_c(void) {}

   168

   169

   170

  public:

   171

   172

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

   173

  /* B.1 - Common elements */

   174

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

   175

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

   176

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

   177

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

   178

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

   179

  /* B 1.2 - Constants */

   180

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

   181

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

   182

  /* B 1.2.1 - Numeric Literals */

   183

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

   184

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

   185

  /* B.1.2.2   Character Strings */

   186

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

   187

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

   188

  /* B 1.2.3 - Time Literals */

   189

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

   190

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

   191

  /* B 1.2.3.1 - Duration */

   192

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

   193

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

   194

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

   195

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

   196

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

   197

  /* B.1.3 - Data types */

   198

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

   199

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

   200

  /* B 1.3.1 - Elementary Data Types */

   201

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

   202

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

   203

  /* B.1.3.2 - Generic data types */

   204

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

   205

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

   206

  /* B 1.3.3 - Derived data types */

   207

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

   208

   209

  /*  subrange_type_name ':' subrange_spec_init */

   210

  void *visit(subrange_type_declaration_c *symbol) {

   211

    TRACE("subrange_type_declaration_c");  

   212

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

   213

    return NULL;

   214

  }

   215

   216

   217

  /*  enumerated_type_name ':' enumerated_spec_init */

   218

  void *visit(enumerated_type_declaration_c *symbol) {

   219

    TRACE("enumerated_type_declaration_c");

   220

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

   221

    current_enumerated_type = symbol->enumerated_type_name;

   222

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

   223

    current_enumerated_type = NULL;

   224

    return NULL;

   225

  }

   226

   227

  /* enumerated_specification ASSIGN enumerated_value */

   228

  void *visit(enumerated_spec_init_c *symbol) {

   229

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

   230

  }

   231

   232

  /* [enumerated_type_name '#'] identifier */

   233

  void *visit(enumerated_value_c *symbol) {

   234

    if (current_enumerated_type != NULL) {

   235

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

   236

   237

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

   238

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

   239

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

   240

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

   241

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

   242

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

   243

       *       compiler error message).

   244

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

   245

       */

   246

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

   247

   248

      if (value_type == enumerated_value_symtable.end_value())

   249

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

   250

	 * so we add it to the symbol table.

   251

	 */

   252

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

   253

      else if (value_type != NULL)

   254

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

   255

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

   256

	 */

   257

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

   258

    }

   259

    return NULL;

   260

  }

   261

   262

  /*  identifier ':' array_spec_init */

   263

  void *visit(array_type_declaration_c *symbol) {

   264

    TRACE("array_type_declaration_c");

   265

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

   266

    return NULL;

   267

  }

   268

   269

   270

  /*  simple_type_name ':' simple_spec_init */

   271

  void *visit(simple_type_declaration_c *symbol) {

   272

    TRACE("simple_type_declaration_c");

   273

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

   274

    return NULL;

   275

  }

   276

   277

   278

  /*  structure_type_name ':' structure_specification */

   279

  void *visit(structure_type_declaration_c *symbol) {

   280

    TRACE("structure_type_declaration_c");

   281

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

   282

    return NULL;

   283

  }

   284

   285

   286

   287

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

   288

  /* B 1.4 - Variables */

   289

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

   290

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

   291

  /* B.1.4.1   Directly Represented Variables */

   292

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

   293

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

   294

  /* B.1.4.2   Multi-element Variables */

   295

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

   296

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

   297

  /* B 1.4.3 - Declaration & Initialisation */

   298

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

   299

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

   300

  /* B.1.5 - Program organization units */

   301

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

   302

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

   303

  /* B 1.5.1 - Functions */

   304

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

   305

  public:

   306

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

   307

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

   308

  void *visit(function_declaration_c *symbol) {

   309

    TRACE("function_declaration_c");

   310

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

   311

   312

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

   313

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

   314

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

   315

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

   316

    return NULL;

   317

  }

   318

   319

   320

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

   321

  /* B 1.5.2 - Function Blocks */

   322

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

   323

  public:

   324

  /*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   325

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

   326

  void *visit(function_block_declaration_c *symbol) {

   327

    TRACE("function_block_declaration_c");

   328

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

   329

  /*

   330

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

   331

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

   332

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

   333

  */

   334

    return NULL;

   335

  }

   336

   337

   338

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

   339

  /* B 1.5.3 - Programs */

   340

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

   341

  public:

   342

  /*  PROGRAM program_type_name program_var_declarations_list function_block_body END_PROGRAM */

   343

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

   344

  void *visit(program_declaration_c *symbol) {

   345

    TRACE("program_declaration_c");

   346

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

   347

  /*

   348

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

   349

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

   350

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

   351

  */

   352

    return NULL;

   353

  }

   354

   355

}; /* populate_symtables_c */

   356

   357

   358

   359

   360

   361

void absyntax_utils_init(symbol_c *tree_root) {

   362

  populate_symtables_c populate_symbols;

   363

   364

  tree_root->accept(populate_symbols);

   365

}

   366