1

/*

     2

 *  matiec - a compiler for the programming languages defined in IEC 61131-3

     3

 *

     4

 *  Copyright (C) 2003-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

 * Code to be included into the code generated by the 4th stage.

    36

 *

    37

 * This is part of the 4th stage that generates

    38

 * a ST and IL source program equivalent to the IL and ST

    39

 * code.

    40

 * This is expected to be used mainly in debuging the syntax

    41

 * and lexical parser, and as a starting point for other

    42

 * 4th stages.

    43

 */

    44

    45

    46

    47

/* Compile with the following option, to print out the const_value of each symbol, which was filled in by constant_folding_c during stage3 */

    48

// #define DEBUG_CONST_VALUE

    49

    50

    51

    52

// #include <stdio.h>  /* required for NULL */

    53

#include <string>

    54

#include <iostream>

    55

#include <sstream>

    56

#include <typeinfo>

    57

#include "generate_iec.hh"

    58

    59

#include "../stage4.hh"

    60

    61

    62

    63

#define ERROR error_exit(__FILE__,__LINE__)

    64

/* function defined in main.cc */

    65

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

    66

    67

    68

    69

    70

//class generate_iec_c: public iterator_visitor_c {

    71

class generate_iec_c: public visitor_c {

    72

  private:

    73

    stage4out_c &s4o;

    74

    75

    76

  public:

    77

    generate_iec_c(stage4out_c *s4o_ptr): s4o(*s4o_ptr) {}

    78

    ~generate_iec_c(void) {}

    79

    80

    81

  private:

    82

    83

    84

void print_const_value(symbol_c *symbol) {

    85

#ifdef DEBUG_CONST_VALUE

    86

  if (NULL == symbol) return;

    87

  bool first = true;

    88

    89

  if (NULL != symbol->const_value_uint64) {

    90

    first?s4o.print("{"):s4o.print("; ");

    91

    first = false;

    92

    s4o.print("uint64:");

    93

    if (symbol->const_value_uint64->status == symbol_c::cs_const_value)

    94

      s4o.print_uint64(symbol->const_value_uint64->value);

    95

    if (symbol->const_value_uint64->status == symbol_c::cs_overflow)

    96

    s4o.print("OVERFLOW");

    97

  }

    98

  if (NULL != symbol->const_value_int64) {

    99

    first?s4o.print("{"):s4o.print("; ");

   100

    first = false;

   101

    s4o.print("int64:");

   102

    if (symbol->const_value_int64->status == symbol_c::cs_const_value)

   103

      s4o.print_int64(symbol->const_value_int64->value);

   104

    if (symbol->const_value_int64->status == symbol_c::cs_overflow)

   105

    s4o.print("OVERFLOW");

   106

  }

   107

  if (NULL != symbol->const_value_real64) {

   108

    first?s4o.print("{"):s4o.print("; ");

   109

    first = false;

   110

    s4o.print("real64:");

   111

    if (symbol->const_value_real64->status == symbol_c::cs_const_value)

   112

      s4o.print_real64(symbol->const_value_real64->value);

   113

    if (symbol->const_value_real64->status == symbol_c::cs_overflow)

   114

    s4o.print("OVERFLOW");

   115

  }

   116

  if (NULL != symbol->const_value_bool) {

   117

    first?s4o.print("{"):s4o.print("; ");

   118

    first = false;

   119

    s4o.print("bool:");

   120

    if (symbol->const_value_bool->status == symbol_c::cs_const_value)

   121

      s4o.print((symbol->const_value_bool->value)?"true":"false");

   122

    if (symbol->const_value_bool->status == symbol_c::cs_overflow)

   123

    s4o.print("OVERFLOW");

   124

  }

   125

  if (!first) s4o.print("}");  

   126

#endif

   127

  return;

   128

}

   129

   130

   131

   132

void *print_token(token_c *token) {

   133

  print_const_value(token);

   134

  return s4o.print(token->value);

   135

}

   136

   137

   138

void *print_literal(symbol_c *type, symbol_c *value) {

   139

  print_const_value(value);

   140

  if (NULL != type) {

   141

    type->accept(*this);

   142

    s4o.print("#");

   143

  }

   144

  value->accept(*this);

   145

  return NULL;

   146

}

   147

   148

void *print_list(list_c *list,

   149

			       std::string pre_elem_str = "",

   150

			       std::string inter_elem_str = "",

   151

			       std::string post_elem_str = "") {

   152

  if (list->n > 0) {

   153

    s4o.print(pre_elem_str);

   154

    list->elements[0]->accept(*this);

   155

  }

   156

   157

  for(int i = 1; i < list->n; i++) {

   158

    s4o.print(inter_elem_str);

   159

    list->elements[i]->accept(*this);

   160

  }

   161

   162

  if (list->n > 0)

   163

    s4o.print(post_elem_str);

   164

   165

  return NULL;

   166

}

   167

   168

   169

void *print_binary_expression(symbol_c *symbol,

   170

			      symbol_c *l_exp,

   171

			      symbol_c *r_exp,

   172

			      const char *operation) {

   173

  print_const_value(symbol);

   174

  s4o.print("(");

   175

  l_exp->accept(*this);

   176

  s4o.print(operation);

   177

  r_exp->accept(*this);

   178

  s4o.print(")");

   179

  return NULL;

   180

}

   181

   182

void *print_unary_expression(symbol_c *symbol,

   183

			     symbol_c *exp,

   184

			     const char *operation) {

   185

  print_const_value(symbol);

   186

  s4o.print(operation);

   187

  exp->accept(*this);

   188

  return NULL;

   189

}

   190

   191

   192

   193

   194

   195

  public:

   196

   197

/*  EN/ENO */

   198

#if 0

   199

void *visit(en_param_c *symbol) {

   200

  s4o.print("EN");

   201

  return NULL;

   202

}

   203

   204

void *visit(eno_param_c *symbol) {

   205

  s4o.print("ENO");

   206

  return NULL;

   207

}

   208

void *visit(en_param_c *symbol) {

   209

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

   210

}

   211

   212

void *visit(eno_param_c *symbol) {

   213

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

   214

}

   215

#endif

   216

   217

   218

/* A class used to identify an entry (literal, variable, etc...) in the abstract syntax tree with an invalid data type */

   219

/* This is only used from stage3 onwards. Stages 1 and 2 will never create any instances of invalid_type_name_c */

   220

// SYM_REF0(invalid_type_name_c)

   221

void *visit(invalid_type_name_c *symbol) {

   222

  ERROR;

   223

  return NULL;

   224

}

   225

   226

   227

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

   228

/* 2.1.6 Pragmas  */

   229

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

   230

void *visit(enable_code_generation_pragma_c*)  {s4o.print("{enable code generation}");  return NULL;}

   231

void *visit(disable_code_generation_pragma_c*) {s4o.print("{disable code generation}"); return NULL;}

   232

void *visit(pragma_c *symbol)                  {return print_token(symbol);}

   233

   234

   235

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

   236

/* B 0 - Programming Model */

   237

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

   238

void *visit(library_c *symbol) {return print_list(symbol);}

   239

   240

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

   241

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

   242

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

   243

void *visit(identifier_c *symbol) {return print_token(symbol);}

   244

   245

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

   246

/* B 1.2 - Constants */

   247

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

   248

   249

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

   250

/* B 1.2.1 - Numeric Literals */

   251

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

   252

void *visit(real_c *symbol)               {return print_token(symbol);}

   253

void *visit(neg_real_c *symbol)           {return print_unary_expression(symbol, symbol->exp, "-");}

   254

void *visit(integer_c *symbol)            {return print_token(symbol);}

   255

void *visit(neg_integer_c *symbol)        {return print_unary_expression(symbol, symbol->exp, "-");}

   256

void *visit(binary_integer_c *symbol)     {return print_token(symbol);}

   257

void *visit(octal_integer_c *symbol)      {return print_token(symbol);}

   258

void *visit(hex_integer_c *symbol)        {return print_token(symbol);}

   259

   260

void *visit(integer_literal_c *symbol)    {return print_literal(symbol->type, symbol->value);}

   261

void *visit(real_literal_c *symbol)       {return print_literal(symbol->type, symbol->value);}

   262

void *visit(bit_string_literal_c *symbol) {return print_literal(symbol->type, symbol->value);}

   263

void *visit(boolean_literal_c *symbol)    {return print_literal(symbol->type, symbol->value);}

   264

   265

/* helper class for boolean_literal_c */

   266

void *visit(boolean_true_c *symbol)       {s4o.print(/*"TRUE"*/"1"); return NULL;}

   267

void *visit(boolean_false_c *symbol)      {s4o.print(/*"FALSE"*/"0"); return NULL;}

   268

   269

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

   270

/* B.1.2.2   Character Strings */

   271

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

   272

void *visit(double_byte_character_string_c *symbol) {return print_token(symbol);}

   273

void *visit(single_byte_character_string_c *symbol) {return print_token(symbol);}

   274

   275

   276

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

   277

/* B 1.2.3 - Time Literals */

   278

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

   279

   280

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

   281

/* B 1.2.3.1 - Duration */

   282

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

   283

void *visit(neg_time_c *symbol) {s4o.print("-"); return NULL;}

   284

   285

void *visit(duration_c *symbol) {

   286

  s4o.print("TIME#");

   287

  if (symbol->neg != NULL)

   288

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

   289

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

   290

  return NULL;

   291

}

   292

   293

void *visit(fixed_point_c *symbol) {return print_token(symbol);}

   294

   295

/* SYM_REF5(interval_c, days, hours, minutes, seconds, milliseconds) */

   296

void *visit(interval_c *symbol) {

   297

  if (NULL != symbol->days) {

   298

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

   299

    s4o.print("d");

   300

  }

   301

   302

  if (NULL != symbol->hours) {

   303

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

   304

    s4o.print("h");

   305

  }

   306

   307

  if (NULL != symbol->minutes) {

   308

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

   309

    s4o.print("m");

   310

  }

   311

   312

  if (NULL != symbol->seconds) {

   313

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

   314

    s4o.print("s");

   315

  }

   316

   317

  if (NULL != symbol->milliseconds) {

   318

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

   319

    s4o.print("ms");

   320

  }

   321

   322

  return NULL;

   323

}

   324

   325

   326

   327

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

   328

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

   329

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

   330

   331

void *visit(time_of_day_c *symbol) {

   332

  s4o.print("TIME_OF_DAY#");

   333

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

   334

  return NULL;

   335

}

   336

   337

void *visit(daytime_c *symbol) {

   338

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

   339

  s4o.print(":");

   340

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

   341

  s4o.print(":");

   342

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

   343

  return NULL;

   344

}

   345

   346

   347

void *visit(date_c *symbol) {

   348

  s4o.print("DATE#");

   349

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

   350

  return NULL;

   351

}

   352

   353

void *visit(date_literal_c *symbol) {

   354

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

   355

  s4o.print("-");

   356

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

   357

  s4o.print("-");

   358

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

   359

  return NULL;

   360

}

   361

   362

void *visit(date_and_time_c *symbol) {

   363

  s4o.print("DATE_AND_TIME#");

   364

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

   365

  s4o.print("-");

   366

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

   367

  return NULL;

   368

}

   369

   370

   371

   372

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

   373

/* B 1.3.1 - Elementary Data Types */

   374

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

   375

void *visit(time_type_name_c *symbol)        {s4o.print("TIME");        return NULL;}

   376

void *visit(bool_type_name_c *symbol)        {s4o.print("BOOL");        return NULL;}

   377

void *visit(sint_type_name_c *symbol)        {s4o.print("SINT");        return NULL;}

   378

void *visit(int_type_name_c *symbol)         {s4o.print("INT");         return NULL;}

   379

void *visit(dint_type_name_c *symbol)        {s4o.print("DINT");        return NULL;}

   380

void *visit(lint_type_name_c *symbol)        {s4o.print("LINT");        return NULL;}

   381

void *visit(usint_type_name_c *symbol)       {s4o.print("USINT");       return NULL;}

   382

void *visit(uint_type_name_c *symbol)        {s4o.print("UINT");        return NULL;}

   383

void *visit(udint_type_name_c *symbol)       {s4o.print("UDINT");       return NULL;}

   384

void *visit(ulint_type_name_c *symbol)       {s4o.print("ULINT");       return NULL;}

   385

void *visit(real_type_name_c *symbol)        {s4o.print("REAL");        return NULL;}

   386

void *visit(lreal_type_name_c *symbol)       {s4o.print("LREAL");       return NULL;}

   387

void *visit(date_type_name_c *symbol)        {s4o.print("DATE");        return NULL;}

   388

void *visit(tod_type_name_c *symbol)         {s4o.print("TOD");         return NULL;}

   389

void *visit(dt_type_name_c *symbol)          {s4o.print("DT");          return NULL;}

   390

void *visit(byte_type_name_c *symbol)        {s4o.print("BYTE");        return NULL;}

   391

void *visit(word_type_name_c *symbol)        {s4o.print("WORD");        return NULL;}

   392

void *visit(lword_type_name_c *symbol)       {s4o.print("LWORD");       return NULL;}

   393

void *visit(dword_type_name_c *symbol)       {s4o.print("DWORD");       return NULL;}

   394

void *visit(string_type_name_c *symbol)      {s4o.print("STRING");      return NULL;}

   395

void *visit(wstring_type_name_c *symbol)     {s4o.print("WSTRING");     return NULL;}

   396

   397

void *visit(safetime_type_name_c *symbol)    {s4o.print("SAFETIME");    return NULL;}

   398

void *visit(safebool_type_name_c *symbol)    {s4o.print("SAFEBOOL");    return NULL;}

   399

void *visit(safesint_type_name_c *symbol)    {s4o.print("SAFESINT");    return NULL;}

   400

void *visit(safeint_type_name_c *symbol)     {s4o.print("SAFEINT");     return NULL;}

   401

void *visit(safedint_type_name_c *symbol)    {s4o.print("SAFEDINT");    return NULL;}

   402

void *visit(safelint_type_name_c *symbol)    {s4o.print("SAFELINT");    return NULL;}

   403

void *visit(safeusint_type_name_c *symbol)   {s4o.print("SAFEUSINT");   return NULL;}

   404

void *visit(safeuint_type_name_c *symbol)    {s4o.print("SAFEUINT");    return NULL;}

   405

void *visit(safeudint_type_name_c *symbol)   {s4o.print("SAFEUDINT");   return NULL;}

   406

void *visit(safeulint_type_name_c *symbol)   {s4o.print("SAFEULINT");   return NULL;}

   407

void *visit(safereal_type_name_c *symbol)    {s4o.print("SAFEREAL");    return NULL;}

   408

void *visit(safelreal_type_name_c *symbol)   {s4o.print("SAFELREAL");   return NULL;}

   409

void *visit(safedate_type_name_c *symbol)    {s4o.print("SAFEDATE");    return NULL;}

   410

void *visit(safetod_type_name_c *symbol)     {s4o.print("SAFETOD");     return NULL;}

   411

void *visit(safedt_type_name_c *symbol)      {s4o.print("SAFEDT");      return NULL;}

   412

void *visit(safebyte_type_name_c *symbol)    {s4o.print("SAFEBYTE");    return NULL;}

   413

void *visit(safeword_type_name_c *symbol)    {s4o.print("SAFEWORD");    return NULL;}

   414

void *visit(safelword_type_name_c *symbol)   {s4o.print("SAFELWORD");   return NULL;}

   415

void *visit(safedword_type_name_c *symbol)   {s4o.print("SAFEDWORD");   return NULL;}

   416

void *visit(safestring_type_name_c *symbol)  {s4o.print("SAFESTRING");  return NULL;}

   417

void *visit(safewstring_type_name_c *symbol) {s4o.print("SAFEWSTRING"); return NULL;}

   418

   419

   420

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

   421

/* B 1.3.3 - Derived data types */

   422

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

   423

/*  TYPE type_declaration_list END_TYPE */

   424

void *visit(data_type_declaration_c *symbol) {

   425

  s4o.print("TYPE\n");

   426

  s4o.indent_right();

   427

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

   428

  s4o.indent_left();

   429

  s4o.print("END_TYPE\n\n\n");

   430

  return NULL;

   431

}

   432

   433

   434

/* helper symbol for data_type_declaration */

   435

/*| type_declaration_list type_declaration ';' */

   436

void *visit(type_declaration_list_c *symbol) {

   437

  return print_list(symbol, s4o.indent_spaces, ";\n" + s4o.indent_spaces, ";\n");

   438

}

   439

   440

   441

/*  simple_type_name ':' simple_spec_init */

   442

void *visit(simple_type_declaration_c *symbol) {

   443

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

   444

  s4o.print(" : ");

   445

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

   446

  return NULL;

   447

}

   448

   449

/* simple_specification ASSIGN constant */

   450

void *visit(simple_spec_init_c *symbol) {

   451

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

   452

  if (symbol->constant != NULL) {

   453

    s4o.print(" := ");

   454

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

   455

  }

   456

  return NULL;

   457

}

   458

   459

/*  subrange_type_name ':' subrange_spec_init */

   460

void *visit(subrange_type_declaration_c *symbol) {

   461

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

   462

  s4o.print(" : ");

   463

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

   464

  return NULL;

   465

}

   466

   467

/* subrange_specification ASSIGN signed_integer */

   468

void *visit(subrange_spec_init_c *symbol) {

   469

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

   470

  if (symbol->signed_integer != NULL) {

   471

    s4o.print(" := ");

   472

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

   473

  }

   474

  return NULL;

   475

}

   476

   477

/*  integer_type_name '(' subrange')' */

   478

void *visit(subrange_specification_c *symbol) {

   479

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

   480

  if (symbol->subrange != NULL) {

   481

    s4o.print("(");

   482

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

   483

    s4o.print(")");

   484

  }

   485

  return NULL;

   486

}

   487

   488

/*  signed_integer DOTDOT signed_integer */

   489

void *visit(subrange_c *symbol) {

   490

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

   491

  s4o.print(" .. ");

   492

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

   493

  return NULL;

   494

}

   495

   496

/*  enumerated_type_name ':' enumerated_spec_init */

   497

void *visit(enumerated_type_declaration_c *symbol) {

   498

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

   499

  s4o.print(" : ");

   500

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

   501

  return NULL;

   502

}

   503

   504

/* enumerated_specification ASSIGN enumerated_value */

   505

void *visit(enumerated_spec_init_c *symbol) {

   506

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

   507

  if (symbol->enumerated_value != NULL) {

   508

    s4o.print(" := ");

   509

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

   510

  }

   511

  return NULL;