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

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

    61

    62

    63

    64

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

    65

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

    66

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

    67

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

    68

    69

/* Parse command line options passed from main.c !! */

    70

    71

int  stage4_parse_options(char *options) {return 0;}

    72

    73

void stage4_print_options(void) {

    74

  printf("          (no options available when generating IEC 61131-3 code)\n"); 

    75

}

    76

    77

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

    78

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

    79

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

    80

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

    81

    82

    83

//class generate_iec_c: public iterator_visitor_c {

    84

class generate_iec_c: public visitor_c {

    85

  private:

    86

    stage4out_c &s4o;

    87

    88

    89

  public:

    90

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

    91

    ~generate_iec_c(void) {}

    92

    93

    94

  private:

    95

    96

    97

void print_const_value(symbol_c *symbol) {

    98

#ifdef DEBUG_CONST_VALUE

    99

  if (NULL == symbol) return;

   100

  bool first = true;

   101

   102

  if (NULL != symbol->const_value_uint64) {

   103

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

   104

    first = false;

   105

    s4o.print("uint64:");

   106

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

   107

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

   108

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

   109

    s4o.print("OVERFLOW");

   110

  }

   111

  if (NULL != symbol->const_value_int64) {

   112

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

   113

    first = false;

   114

    s4o.print("int64:");

   115

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

   116

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

   117

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

   118

    s4o.print("OVERFLOW");

   119

  }

   120

  if (NULL != symbol->const_value_real64) {

   121

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

   122

    first = false;

   123

    s4o.print("real64:");

   124

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

   125

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

   126

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

   127

    s4o.print("OVERFLOW");

   128

  }

   129

  if (NULL != symbol->const_value_bool) {

   130

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

   131

    first = false;

   132

    s4o.print("bool:");

   133

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

   134

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

   135

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

   136

    s4o.print("OVERFLOW");

   137

  }

   138

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

   139

#endif

   140

  return;

   141

}

   142

   143

   144

   145

void *print_token(token_c *token) {

   146

  print_const_value(token);

   147

  return s4o.print(token->value);

   148

}

   149

   150

   151

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

   152

  print_const_value(value);

   153

  if (NULL != type) {

   154

    type->accept(*this);

   155

    s4o.print("#");

   156

  }

   157

  value->accept(*this);

   158

  return NULL;

   159

}

   160

   161

void *print_list(list_c *list,

   162

			       std::string pre_elem_str = "",

   163

			       std::string inter_elem_str = "",

   164

			       std::string post_elem_str = "") {

   165

  if (list->n > 0) {

   166

    s4o.print(pre_elem_str);

   167

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

   168

  }

   169

   170

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

   171

    s4o.print(inter_elem_str);

   172

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

   173

  }

   174

   175

  if (list->n > 0)

   176

    s4o.print(post_elem_str);

   177

   178

  return NULL;

   179

}

   180

   181

   182

void *print_binary_expression(symbol_c *symbol,

   183

			      symbol_c *l_exp,

   184

			      symbol_c *r_exp,

   185

			      const char *operation) {

   186

  print_const_value(symbol);

   187

  s4o.print("(");

   188

  l_exp->accept(*this);

   189

  s4o.print(operation);

   190

  r_exp->accept(*this);

   191

  s4o.print(")");

   192

  return NULL;

   193

}

   194

   195

void *print_unary_expression(symbol_c *symbol,

   196

			     symbol_c *exp,

   197

			     const char *operation) {

   198

  print_const_value(symbol);

   199

  s4o.print(operation);

   200

  exp->accept(*this);

   201

  return NULL;

   202

}

   203

   204

   205

   206

   207

   208

  public:

   209

   210

/*  EN/ENO */

   211

#if 0

   212

void *visit(en_param_c *symbol) {

   213

  s4o.print("EN");

   214

  return NULL;

   215

}

   216

   217

void *visit(eno_param_c *symbol) {

   218

  s4o.print("ENO");

   219

  return NULL;

   220

}

   221

void *visit(en_param_c *symbol) {

   222

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

   223

}

   224

   225

void *visit(eno_param_c *symbol) {

   226

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

   227

}

   228

#endif

   229

   230

   231

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

   232

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

   233

// SYM_REF0(invalid_type_name_c)

   234

void *visit(invalid_type_name_c *symbol) {

   235

  ERROR;

   236

  return NULL;

   237

}

   238

   239

   240

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

   241

/* 2.1.6 Pragmas  */

   242

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

   243

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

   244

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

   245

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

   246

   247

   248

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

   249

/* B 0 - Programming Model */

   250

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

   251

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

   252

   253

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

   254

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

   255

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

   256

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

   257

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

   258

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

   259

   260

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

   261

/* B 1.2 - Constants */

   262

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

   263

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

   264

/* B 1.2.XX - Reference Literals */

   265

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

   266

/* defined in IEC 61131-3 v3 - Basically the 'NULL' keyword! */

   267

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

   268

   269

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

   270

/* B 1.2.1 - Numeric Literals */

   271

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

   272

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

   273

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

   274

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

   275

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

   276

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

   277

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

   278

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

   279

   280

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

   281

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

   282

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

   283

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

   284

   285

/* helper class for boolean_literal_c */

   286

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

   287

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

   288

   289

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

   290

/* B.1.2.2   Character Strings */

   291

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

   292

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

   293

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

   294

   295

   296

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

   297

/* B 1.2.3 - Time Literals */

   298

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

   299

   300

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

   301

/* B 1.2.3.1 - Duration */

   302

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

   303

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

   304

   305

void *visit(duration_c *symbol) {

   306

  s4o.print("TIME#");

   307

  if (symbol->neg != NULL)

   308

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

   309

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

   310

  return NULL;

   311

}

   312

   313

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

   314

   315

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

   316

void *visit(interval_c *symbol) {

   317

  if (NULL != symbol->days) {

   318

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

   319

    s4o.print("d");

   320

  }

   321

   322

  if (NULL != symbol->hours) {

   323

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

   324

    s4o.print("h");

   325

  }

   326

   327

  if (NULL != symbol->minutes) {

   328

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

   329

    s4o.print("m");

   330

  }

   331

   332

  if (NULL != symbol->seconds) {

   333

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

   334

    s4o.print("s");

   335

  }

   336

   337

  if (NULL != symbol->milliseconds) {

   338

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

   339

    s4o.print("ms");

   340

  }

   341

   342

  return NULL;

   343

}

   344

   345

   346

   347

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

   348

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

   349

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

   350

   351

void *visit(time_of_day_c *symbol) {

   352

  s4o.print("TIME_OF_DAY#");

   353

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

   354

  return NULL;

   355

}

   356

   357

void *visit(daytime_c *symbol) {

   358

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

   359

  s4o.print(":");

   360

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

   361

  s4o.print(":");

   362

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

   363

  return NULL;

   364

}

   365

   366

   367

void *visit(date_c *symbol) {

   368

  s4o.print("DATE#");

   369

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

   370

  return NULL;

   371

}

   372

   373

void *visit(date_literal_c *symbol) {

   374

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

   375

  s4o.print("-");

   376

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

   377

  s4o.print("-");

   378

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

   379

  return NULL;

   380

}

   381

   382

void *visit(date_and_time_c *symbol) {

   383

  s4o.print("DATE_AND_TIME#");

   384

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

   385

  s4o.print("-");

   386

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

   387

  return NULL;

   388

}

   389

   390

   391

   392

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

   393

/* B 1.3.1 - Elementary Data Types */

   394

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

   395

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

   396

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

   397

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

   398

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

   399

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

   400

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

   401

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

   402

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

   403

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

   404

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

   405

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

   406

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

   407

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

   408

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

   409

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

   410

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

   411

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

   412

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

   413

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

   414

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

   415

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

   416

   417

void *visit(       void_type_name_c *symbol) {s4o.print("VOID");        return NULL;} /* a non-standard extension! */

   418

   419

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

   420

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

   421

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

   422

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

   423

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

   424

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

   425

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

   426

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

   427

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

   428

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

   429

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

   430

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

   431

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

   432

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

   433

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

   434

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

   435

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

   436

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

   437

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

   438

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

   439

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

   440

   441

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

   442

/* B.1.3.2 - Generic data types */

   443

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

   444

void *visit(generic_type_any_c      *symbol) {s4o.print("ANY");         return NULL;}

   445

   446

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

   447

/* B 1.3.3 - Derived data types */

   448

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

   449

/*  TYPE type_declaration_list END_TYPE */

   450

void *visit(data_type_declaration_c *symbol) {

   451

  s4o.print("TYPE\n");

   452

  s4o.indent_right();

   453

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

   454

  s4o.indent_left();

   455

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

   456

  return NULL;

   457

}

   458

   459

   460

/* helper symbol for data_type_declaration */

   461

/*| type_declaration_list type_declaration ';' */

   462

void *visit(type_declaration_list_c *symbol) {

   463

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

   464

}

   465

   466

   467

/*  simple_type_name ':' simple_spec_init */

   468

void *visit(simple_type_declaration_c *symbol) {

   469

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

   470

  s4o.print(" : ");

   471

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

   472

  return NULL;

   473

}

   474

   475

/* simple_specification ASSIGN constant */

   476

void *visit(simple_spec_init_c *symbol) {

   477

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

   478

  if (symbol->constant != NULL) {

   479

    s4o.print(" := ");

   480

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

   481

  }

   482

  return NULL;

   483

}

   484

   485

/*  subrange_type_name ':' subrange_spec_init */

   486

void *visit(subrange_type_declaration_c *symbol) {

   487

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

   488

  s4o.print(" : ");

   489

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

   490

  return NULL;

   491

}

   492

   493

/* subrange_specification ASSIGN signed_integer */

   494

void *visit(subrange_spec_init_c *symbol) {

   495

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

   496

  if (symbol->signed_integer != NULL) {

   497

    s4o.print(" := ");

   498

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

   499

  }

   500

  return NULL;

   501

}

   502

   503

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

   504

void *visit(subrange_specification_c *symbol) {

   505

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

   506

  if (symbol->subrange != NULL) {

   507

    s4o.print("(");

   508

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