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

#include "../main.hh" // required for ERROR() and ERROR_MSG() macros.

    61

    62

    63

    64

//#define DEBUG

    65

#ifdef DEBUG

    66

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

    67

#else

    68

#define TRACE(classname)

    69

#endif

    70

    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

    99

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

   100

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

   101

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

   102

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

   103

   104

   105

   106

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

   107

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

   108

dsymtable_c<function_declaration_c *, &null_symbol1> function_symtable;

   109

   110

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

   111

function_block_declaration_c null_symbol2(NULL,NULL,NULL);

   112

symtable_c<function_block_declaration_c *, &null_symbol2> function_block_type_symtable;

   113

   114

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

   115

program_declaration_c null_symbol3(NULL,NULL,NULL);

   116

symtable_c<program_declaration_c *, &null_symbol3> program_type_symtable;

   117

   118

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

   119

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

   120

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

   121

 *

   122

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

   123

 */

   124

symbol_c null_symbol4;

   125

symtable_c<symbol_c *, &null_symbol4> type_symtable;

   126

   127

   128

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

   129

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

   130

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

   131

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

   132

   133

   134

class populate_symtables_c: public iterator_visitor_c {

   135

   136

  private:

   137

	symbol_c *current_enumerated_type;

   138

   139

  public:

   140

    populate_symtables_c(void) {

   141

    	current_enumerated_type = NULL;

   142

    };

   143

    virtual ~populate_symtables_c(void) {}

   144

   145

   146

  public:

   147

   148

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

   149

  /* B.1 - Common elements */

   150

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

   151

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

   152

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

   153

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

   154

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

   155

  /* B 1.2 - Constants */

   156

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

   157

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

   158

  /* B 1.2.1 - Numeric Literals */

   159

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

   160

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

   161

  /* B.1.2.2   Character Strings */

   162

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

   163

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

   164

  /* B 1.2.3 - Time Literals */

   165

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

   166

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

   167

  /* B 1.2.3.1 - Duration */

   168

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

   169

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

   170

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

   171

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

   172

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

   173

  /* B.1.3 - Data types */

   174

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

   175

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

   176

  /* B 1.3.1 - Elementary Data Types */

   177

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

   178

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

   179

  /* B.1.3.2 - Generic data types */

   180

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

   181

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

   182

  /* B 1.3.3 - Derived data types */

   183

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

   184

   185

  /*  subrange_type_name ':' subrange_spec_init */

   186

  void *visit(subrange_type_declaration_c *symbol) {

   187

    TRACE("subrange_type_declaration_c");  

   188

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

   189

    return NULL;

   190

  }

   191

   192

   193

  /*  enumerated_type_name ':' enumerated_spec_init */

   194

  void *visit(enumerated_type_declaration_c *symbol) {

   195

    TRACE("enumerated_type_declaration_c");

   196

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

   197

    current_enumerated_type = symbol->enumerated_type_name;

   198

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

   199

    current_enumerated_type = NULL;

   200

    return NULL;

   201

  }

   202

   203

  /* enumerated_specification ASSIGN enumerated_value */

   204

  void *visit(enumerated_spec_init_c *symbol) {

   205

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

   206

  }

   207

   208

   209

  /*  identifier ':' array_spec_init */

   210

  void *visit(array_type_declaration_c *symbol) {

   211

    TRACE("array_type_declaration_c");

   212

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

   213

    return NULL;

   214

  }

   215

   216

   217

  /*  simple_type_name ':' simple_spec_init */

   218

  void *visit(simple_type_declaration_c *symbol) {

   219

    TRACE("simple_type_declaration_c");

   220

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

   221

    return NULL;

   222

  }

   223

   224

   225

  /*  structure_type_name ':' structure_specification */

   226

  void *visit(structure_type_declaration_c *symbol) {

   227

    TRACE("structure_type_declaration_c");

   228

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

   229

    return NULL;

   230

  }

   231

   232

   233

  /*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   234

  // SYM_REF4(string_type_declaration_c,	string_type_name,

   235

  //    					elementary_string_type_name,

   236

  //    					string_type_declaration_size,

   237

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

   238

  void *visit(string_type_declaration_c *symbol)	{

   239

    TRACE("string_type_declaration_c");

   240

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

   241

    return NULL;

   242

}

   243

   244

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

   245

  /* B 1.4 - Variables */

   246

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

   247

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

   248

  /* B.1.4.1   Directly Represented Variables */

   249

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

   250

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

   251

  /* B.1.4.2   Multi-element Variables */

   252

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

   253

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

   254

  /* B 1.4.3 - Declaration & Initialisation */

   255

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

   256

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

   257

  /* B.1.5 - Program organization units */

   258

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

   259

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

   260

  /* B 1.5.1 - Functions */

   261

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

   262

  public:

   263

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

   264

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

   265

  void *visit(function_declaration_c *symbol) {

   266

    TRACE("function_declaration_c");

   267

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

   268

   269

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

   270

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

   271

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

   272

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

   273

    return NULL;

   274

  }

   275

   276

   277

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

   278

  /* B 1.5.2 - Function Blocks */

   279

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

   280

  public:

   281

  /*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   282

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

   283

  void *visit(function_block_declaration_c *symbol) {

   284

    TRACE("function_block_declaration_c");

   285

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

   286

  /*

   287

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

   288

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

   289

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

   290

  */

   291

    return NULL;

   292

  }

   293

   294

   295

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

   296

  /* B 1.5.3 - Programs */

   297

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

   298

  public:

   299

  /*  PROGRAM program_type_name program_var_declarations_list function_block_body END_PROGRAM */

   300

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

   301

  void *visit(program_declaration_c *symbol) {

   302

    TRACE("program_declaration_c");

   303

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

   304

  /*

   305

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

   306

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

   307

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

   308

  */

   309

    return NULL;

   310

  }

   311

   312

}; /* populate_symtables_c */

   313

   314

   315

   316

   317

   318

void absyntax_utils_init(symbol_c *tree_root) {

   319

  populate_symtables_c populate_symbols;

   320

   321

  tree_root->accept(populate_symbols);

   322

}

   323