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

//class generate_iec_c: public iterator_visitor_c {

    69

class generate_iec_c: public visitor_c {

    70

  private:

    71

    stage4out_c &s4o;

    72

    73

    74

  public:

    75

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

    76

    ~generate_iec_c(void) {}

    77

    78

    79

  private:

    80

    81

    82

void print_const_value(symbol_c *symbol) {

    83

#ifdef DEBUG_CONST_VALUE

    84

  if (NULL == symbol) return;

    85

  bool first = true;

    86

    87

  if (NULL != symbol->const_value_uint64) {

    88

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

    89

    first = false;

    90

    s4o.print("uint64:");

    91

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

    92

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

    93

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

    94

    s4o.print("OVERFLOW");

    95

  }

    96

  if (NULL != symbol->const_value_int64) {

    97

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

    98

    first = false;

    99

    s4o.print("int64:");

   100

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

   101

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

   102

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

   103

    s4o.print("OVERFLOW");

   104

  }

   105

  if (NULL != symbol->const_value_real64) {

   106

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

   107

    first = false;

   108

    s4o.print("real64:");

   109

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

   110

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

   111

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

   112

    s4o.print("OVERFLOW");

   113

  }

   114

  if (NULL != symbol->const_value_bool) {

   115

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

   116

    first = false;

   117

    s4o.print("bool:");

   118

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

   119

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

   120

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

   121

    s4o.print("OVERFLOW");

   122

  }

   123

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

   124

#endif

   125

  return;

   126

}

   127

   128

   129

   130

void *print_token(token_c *token) {

   131

  print_const_value(token);

   132

  return s4o.print(token->value);

   133

}

   134

   135

   136

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

   137

  print_const_value(value);

   138

  if (NULL != type) {

   139

    type->accept(*this);

   140

    s4o.print("#");

   141

  }

   142

  value->accept(*this);

   143

  return NULL;

   144

}

   145

   146

void *print_list(list_c *list,

   147

			       std::string pre_elem_str = "",

   148

			       std::string inter_elem_str = "",

   149

			       std::string post_elem_str = "") {

   150

  if (list->n > 0) {

   151

    s4o.print(pre_elem_str);

   152

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

   153

  }

   154

   155

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

   156

    s4o.print(inter_elem_str);

   157

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

   158

  }

   159

   160

  if (list->n > 0)

   161

    s4o.print(post_elem_str);

   162

   163

  return NULL;

   164

}

   165

   166

   167

void *print_binary_expression(symbol_c *symbol,

   168

			      symbol_c *l_exp,

   169

			      symbol_c *r_exp,

   170

			      const char *operation) {

   171

  print_const_value(symbol);

   172

  s4o.print("(");

   173

  l_exp->accept(*this);

   174

  s4o.print(operation);

   175

  r_exp->accept(*this);

   176

  s4o.print(")");

   177

  return NULL;

   178

}

   179

   180

void *print_unary_expression(symbol_c *symbol,

   181

			     symbol_c *exp,

   182

			     const char *operation) {

   183

  print_const_value(symbol);

   184

  s4o.print(operation);

   185

  exp->accept(*this);

   186

  return NULL;

   187

}

   188

   189

   190

   191

   192

   193

  public:

   194

   195

/*  EN/ENO */

   196

#if 0

   197

void *visit(en_param_c *symbol) {

   198

  s4o.print("EN");

   199

  return NULL;

   200

}

   201

   202

void *visit(eno_param_c *symbol) {

   203

  s4o.print("ENO");

   204

  return NULL;

   205

}

   206

void *visit(en_param_c *symbol) {

   207

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

   208

}

   209

   210

void *visit(eno_param_c *symbol) {

   211

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

   212

}

   213

#endif

   214

   215

   216

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

   217

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

   218

// SYM_REF0(invalid_type_name_c)

   219

void *visit(invalid_type_name_c *symbol) {

   220

  ERROR;

   221

  return NULL;

   222

}

   223

   224

   225

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

   226

/* 2.1.6 Pragmas  */

   227

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

   228

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

   229

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

   230

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

   231

   232

   233

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

   234

/* B 0 - Programming Model */

   235

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

   236

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

   237

   238

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

   239

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

   240

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

   241

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

   242

   243

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

   244

/* B 1.2 - Constants */

   245

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

   246

   247

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

   248

/* B 1.2.1 - Numeric Literals */

   249

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

   250

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

   251

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

   252

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

   253

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

   254

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

   255

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

   256

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

   257

   258

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

   259

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

   260

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

   261

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

   262

   263

/* helper class for boolean_literal_c */

   264

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

   265

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

   266

   267

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

   268

/* B.1.2.2   Character Strings */

   269

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

   270

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

   271

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

   272

   273

   274

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

   275

/* B 1.2.3 - Time Literals */

   276

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

   277

   278

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

   279

/* B 1.2.3.1 - Duration */

   280

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

   281

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

   282

   283

void *visit(duration_c *symbol) {

   284

  s4o.print("TIME#");

   285

  if (symbol->neg != NULL)

   286

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

   287

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

   288

  return NULL;

   289

}

   290

   291

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

   292

   293

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

   294

void *visit(interval_c *symbol) {

   295

  if (NULL != symbol->days) {

   296

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

   297

    s4o.print("d");

   298

  }

   299

   300

  if (NULL != symbol->hours) {

   301

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

   302

    s4o.print("h");

   303

  }

   304

   305

  if (NULL != symbol->minutes) {

   306

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

   307

    s4o.print("m");

   308

  }

   309

   310

  if (NULL != symbol->seconds) {

   311

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

   312

    s4o.print("s");

   313

  }

   314

   315

  if (NULL != symbol->milliseconds) {

   316

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

   317

    s4o.print("ms");

   318

  }

   319

   320

  return NULL;

   321

}

   322

   323

   324

   325

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

   326

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

   327

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

   328

   329

void *visit(time_of_day_c *symbol) {

   330

  s4o.print("TIME_OF_DAY#");

   331

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

   332

  return NULL;

   333

}

   334

   335

void *visit(daytime_c *symbol) {

   336

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

   337

  s4o.print(":");

   338

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

   339

  s4o.print(":");

   340

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

   341

  return NULL;

   342

}

   343

   344

   345

void *visit(date_c *symbol) {

   346

  s4o.print("DATE#");

   347

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

   348

  return NULL;

   349

}

   350

   351

void *visit(date_literal_c *symbol) {

   352

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

   353

  s4o.print("-");

   354

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

   355

  s4o.print("-");

   356

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

   357

  return NULL;

   358

}

   359

   360

void *visit(date_and_time_c *symbol) {

   361

  s4o.print("DATE_AND_TIME#");

   362

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

   363

  s4o.print("-");

   364

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

   365

  return NULL;

   366

}

   367

   368

   369

   370

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

   371

/* B 1.3.1 - Elementary Data Types */

   372

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

   373

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

   374

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

   375

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

   376

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

   377

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

   378

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

   379

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

   380

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

   381

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

   382

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

   383

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

   384

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

   385

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

   386

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

   387

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

   388

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

   389

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

   390

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

   391

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

   392

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

   393

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

   394

   395

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

   396

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

   397

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

   398

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

   399

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

   400

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

   401

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

   402

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

   403

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

   404

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

   405

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

   406

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

   407

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

   408

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

   409

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

   410

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

   411

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

   412

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

   413

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

   414

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

   415

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

   416

   417

   418

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

   419

/* B 1.3.3 - Derived data types */

   420

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

   421

/*  TYPE type_declaration_list END_TYPE */

   422

void *visit(data_type_declaration_c *symbol) {

   423

  s4o.print("TYPE\n");

   424

  s4o.indent_right();

   425

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

   426

  s4o.indent_left();

   427

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

   428

  return NULL;

   429

}

   430

   431

   432

/* helper symbol for data_type_declaration */

   433

/*| type_declaration_list type_declaration ';' */

   434

void *visit(type_declaration_list_c *symbol) {

   435

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

   436

}

   437

   438

   439

/*  simple_type_name ':' simple_spec_init */

   440

void *visit(simple_type_declaration_c *symbol) {

   441

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

   442

  s4o.print(" : ");

   443

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

   444

  return NULL;

   445

}

   446

   447

/* simple_specification ASSIGN constant */

   448

void *visit(simple_spec_init_c *symbol) {

   449

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

   450

  if (symbol->constant != NULL) {

   451

    s4o.print(" := ");

   452

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

   453

  }

   454

  return NULL;

   455

}

   456

   457

/*  subrange_type_name ':' subrange_spec_init */

   458

void *visit(subrange_type_declaration_c *symbol) {

   459

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

   460

  s4o.print(" : ");

   461

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

   462

  return NULL;

   463

}

   464

   465

/* subrange_specification ASSIGN signed_integer */

   466

void *visit(subrange_spec_init_c *symbol) {

   467

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

   468

  if (symbol->signed_integer != NULL) {

   469

    s4o.print(" := ");

   470

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

   471

  }

   472

  return NULL;

   473

}

   474

   475

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

   476

void *visit(subrange_specification_c *symbol) {

   477

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

   478

  if (symbol->subrange != NULL) {

   479

    s4o.print("(");

   480

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

   481

    s4o.print(")");

   482

  }

   483

  return NULL;

   484

}

   485

   486

/*  signed_integer DOTDOT signed_integer */

   487

void *visit(subrange_c *symbol) {

   488

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

   489

  s4o.print(" .. ");

   490

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

   491

  return NULL;

   492

}

   493

   494

/*  enumerated_type_name ':' enumerated_spec_init */

   495

void *visit(enumerated_type_declaration_c *symbol) {

   496

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

   497

  s4o.print(" : ");

   498

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

   499

  return NULL;

   500

}

   501

   502

/* enumerated_specification ASSIGN enumerated_value */

   503

void *visit(enumerated_spec_init_c *symbol) {

   504

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

   505

  if (symbol->enumerated_value != NULL) {

   506

    s4o.print(" := ");

   507

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

   508

  }

   509

  return NULL;

   510

}

   511