1

/*

     2

 * (c) 2003 Mario de Sousa

     3

 *

     4

 * Offered to the public under the terms of the GNU General Public License

     5

 * as published by the Free Software Foundation; either version 2 of the

     6

 * License, or (at your option) any later version.

     7

 *

     8

 * This program is distributed in the hope that it will be useful, but

     9

 * WITHOUT ANY WARRANTY; without even the implied warranty of

    10

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General

    11

 * Public License for more details.

    12

 *

    13

 * This code is made available on the understanding that it will not be

    14

 * used in safety-critical situations without a full and competent review.

    15

 */

    16

    17

/*

    18

 * An IEC 61131-3 IL and ST compiler.

    19

 *

    20

 * Based on the

    21

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    22

 *

    23

 */

    24

    25

    26

/*

    27

 * Conversion of basic abstract syntax constructs.

    28

 *

    29

 * This is part of the 4th stage that generates

    30

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

    31

 * code.

    32

 */

    33

    34

    35

    36

    37

    38

    39

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

    40

//#include <string>

    41

//#include <iostream>

    42

    43

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

    44

    45

//#include "generate_cc.hh"

    46

    47

    48

    49

    50

    51

    52

    53

    54

    55

    56

    57

    58

    59

class generate_cc_base_c: public iterator_visitor_c {

    60

    61

  protected:

    62

    stage4out_c &s4o;

    63

    64

  private:

    65

    /* Unlike programs that are mapped onto C++ classes, Function Blocks are mapped onto a data structure type

    66

     * and a separate function conatining the code. This function is passed a pointer to an instance of the data

    67

     * structure. This means that the code inside the functions must insert a pointer to the data structure whenever

    68

     * it wishes to access a Function Block variable.

    69

     * The variable_prefix_ variable will contain the correct string which needs to be prefixed to all variable accesses.

    70

     * This string is set with the set_variable_prefix() member function.

    71

     */

    72

    const char *variable_prefix_;

    73

    74

    75

    76

  public:

    77

    generate_cc_base_c(stage4out_c *s4o_ptr): s4o(*s4o_ptr) {variable_prefix_ = NULL;}

    78

    ~generate_cc_base_c(void) {}

    79

    80

    void set_variable_prefix(const char *variable_prefix) {variable_prefix_ = variable_prefix;}

    81

    void print_variable_prefix(void) {

    82

      if (variable_prefix_ != NULL)

    83

        s4o.print(variable_prefix_);

    84

    }

    85

    86

    void *print_token(token_c *token, int offset = 0) {

    87

      return s4o.printupper((token->value)+offset);

    88

    }

    89

    90

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

    91

      s4o.print("(");

    92

      type->accept(*this);

    93

      s4o.print(")");

    94

      value->accept(*this);

    95

      return NULL;

    96

    }

    97

    98

    void *print_striped_token(token_c *token, int offset = 0) {

    99

      std::string str = "";

   100

      for (unsigned int i = offset; i < strlen(token->value); i++)

   101

        if (token->value[i] != '_')

   102

          str += token->value[i];

   103

      return s4o.printupper(str);

   104

    }

   105

   106

    void *print_striped_binary_token(token_c *token, unsigned int offset = 0) {

   107

      /* convert the binary value to hexadecimal format... */

   108

      unsigned char value, bit_mult;

   109

      unsigned int i;

   110

      int total_bits;

   111

      char str[2] = {'A', '\0'};  /* since the s4o object is not prepared to print out one character at a time... */

   112

   113

      s4o.print("0x");

   114

   115

      total_bits = 0;

   116

      for (i = offset; i < strlen(token->value); i++)

   117

        if (token->value[i] != '_')

   118

	  total_bits++;

   119

   120

      value = 0;

   121

      bit_mult = (unsigned char)1 << (((total_bits+3)%4)+1);

   122

      for (i = offset; i < strlen(token->value); i++) {

   123

        if (token->value[i] != '_') {

   124

	  bit_mult /= 2;

   125

	  value += bit_mult * ((token->value[i] == '0')? 0:1);

   126

	  if (bit_mult == 1) {

   127

	    str[0] = (value <= 9)? (char)'0' + value : (char)'A' + value;

   128

	    s4o.print(str);

   129

            bit_mult = 0x10;

   130

            value = 0;

   131

	  }

   132

	}

   133

      }

   134

   135

      return NULL;

   136

    }

   137

   138

    void *print_list(list_c *list,

   139

		     std::string pre_elem_str = "",

   140

		     std::string inter_elem_str = "",

   141

		     std::string post_elem_str = "",

   142

		     visitor_c *visitor = NULL) {

   143

      if (visitor == NULL) visitor = this;

   144

   145

      if (list->n > 0) {

   146

//std::cout << "generate_cc_base_c::print_list(n = " << list->n << ")   000\n";

   147

        s4o.print(pre_elem_str);

   148

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

   149

      }

   150

   151

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

   152

//std::cout << "generate_cc_base_c::print_list   " << i << "\n";

   153

        s4o.print(inter_elem_str);

   154

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

   155

      }

   156

   157

      if (list->n > 0)

   158

        s4o.print(post_elem_str);

   159

   160

      return NULL;

   161

    }

   162

   163

   164

    void *print_binary_expression(symbol_c *l_exp,

   165

				  symbol_c *r_exp,

   166

				  const char *operation) {

   167

      s4o.print("(");

   168

      l_exp->accept(*this);

   169

      s4o.print(operation);

   170

      r_exp->accept(*this);

   171

      s4o.print(")");

   172

      return NULL;

   173

    }

   174

   175

    void *print_unary_expression(symbol_c *exp,

   176

				 const char *operation) {

   177

      s4o.print(operation);

   178

      s4o.print("(");

   179

      exp->accept(*this);

   180

      s4o.print(")");

   181

      return NULL;

   182

    }

   183

   184

    void *print_binary_function(const char *function,

   185

          symbol_c *l_exp,

   186

				  symbol_c *r_exp) {

   187

      s4o.print(function);

   188

      s4o.print("(");

   189

      l_exp->accept(*this);

   190

      s4o.print(", ");

   191

      r_exp->accept(*this);

   192

      s4o.print(")");

   193

      return NULL;

   194

   	}

   195

   196

    void *print_compare_function(const char *function,

   198

          symbol_c *l_exp,

   199

          symbol_c *r_exp) {

   200

      s4o.print(function);

   203

      l_exp->accept(*this);

   204

      s4o.print(", ");

   205

      r_exp->accept(*this);

   206

      s4o.print(")");

   207

      return NULL;

   208

    }

   209

   210

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

   211

/* 2.1.6 - Pragmas */

   212

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

   213

    /* Do not use print_token() as it will change everything into uppercase */

   214

    void *visit(pragma_c *symbol) {return s4o.print(symbol->value);}

   215

   216

   217

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

   218

/* B 0 - Programming Model */

   219

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

   220

  /* leave for derived classes... */

   221

   222

   223

   224

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

   225

/* B.1 - Common elements */

   226

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

   227

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

   228

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

   229

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

   230

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

   231

   232

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

   233

/* B 1.2 - Constants */

   234

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

   235

  /* originally empty... */

   236

   237

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

   238

/* B 1.2.1 - Numeric Literals */

   239

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

   240

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

   241

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

   242

    void *visit(binary_integer_c *symbol) {return print_striped_binary_token(symbol, 2);}

   243

    void *visit(octal_integer_c *symbol) {s4o.print("0"); return print_striped_token(symbol, 2);}

   244

    void *visit(hex_integer_c *symbol) {s4o.print("0x"); return print_striped_token(symbol, 3);}

   245

   246

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

   247

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

   248

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

   249

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

   250

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

   251

   252

    /* helper class for boolean_literal_c */

   253

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

   254

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

   255

   256

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

   257

/* B.1.2.2   Character Strings */

   258

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

   259

    void *visit(double_byte_character_string_c *symbol) {

   260

      // TO DO ...

   261

      ERROR;

   262

      return print_token(symbol);

   263

    }

   264

   265

    void *visit(single_byte_character_string_c *symbol) {

   266

      std::string str = "";

   267

      unsigned int count = 0; 

   268

      str += '"';

   269

      /* we ignore the first and last bytes, they will be the character ' */

   270

      for (unsigned int i = 1; i < strlen(symbol->value) - 1; i++) {

   271

        char c = symbol->value[i];

   272

        if ((c == '\\') || (c == '"'))

   273

          {str += '\\'; str += c; count ++; continue;}

   274

        if (c != '$')

   275

          {str += c; count++; continue;}

   276

        /* this should be safe, since the code has passed the syntax parser!! */

   277

        c = symbol->value[++i];

   278

        switch (c) {

   279

          case '$':

   280

          case '\'':

   281

            {str += c; count++; continue;}

   282

          case 'L':

   283

          case 'l':

   284

            {str += "\x0A"; /* LF */; count++; continue;}

   285

          case 'N':

   286

          case 'n':

   287

            {str += "\\x0A"; /* NL */; count++; continue;}

   288

          case 'P':

   289

          case 'p':

   290

            {str += "\\f"; /* FF */; count++; continue;}

   291

          case 'R':

   292

          case 'r':

   293

            {str += "\\r"; /* CR */; count++; continue;}

   294

          case 'T':

   295

          case 't':

   296

            {str += "\\t"; /* tab */; count++; continue;}

   297

          default: {

   298

            if (isxdigit(c)) {

   299

              /* this should be safe, since the code has passed the syntax parser!! */

   300

	      char c2 = symbol->value[++i];

   301

	      if (isxdigit(c2)) {

   302

	        str += '\\'; str += 'x'; str += c; str += c2;

   303

	        count++; continue;

   304

	      }

   305

	    }

   306

          }

   307

          /* otherwise we have an invalid string!! */

   308

          /* This should not have got through the syntax parser! */

   309

          ERROR;

   310

        } /* switch() */

   311

      } /* for() */

   312

   313

      str += '"';

   314

      s4o.print("(STRING){");

   315

      s4o.print_integer(count); 

   316

      s4o.print(",");

   317

      s4o.print(str);

   318

      s4o.print("}");

   319

      return NULL;

   320

    }

   321

   322

   323

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

   324

/* B 1.2.3 - Time Literals */

   325

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

   326

   327

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

   328

/* B 1.2.3.1 - Duration */

   329

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

   330

/* The following output is actually the parameters to the constructor of the TIME class! */

   331

   332

/* SYM_REF0(neg_time_c) */

   333

void *visit(neg_time_c *symbol) {s4o.print("-1"); /* negative time value */; return NULL;}

   334

   335

   336

/* SYM_REF2(duration_c, neg, interval) */

   337

void *visit(duration_c *symbol) {

   338

  TRACE("duration_c");

   339

  s4o.print("__time_to_timespec(");

   340

  if (NULL == symbol->neg)

   341

    s4o.print("1");  /* positive time value */

   342

  else

   343

    symbol->neg->accept(*this);  /* this will print '-1'   :-) */

   344

   345

  s4o.print(", ");

   346

   347

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

   348

  if (typeid(*symbol->interval) == typeid(hours_c)) {s4o.print(", 0");}

   349

  if (typeid(*symbol->interval) == typeid(minutes_c)) {s4o.print(", 0, 0");}

   350

  if (typeid(*symbol->interval) == typeid(seconds_c)) {s4o.print(", 0, 0, 0");}

   351

  if (typeid(*symbol->interval) == typeid(milliseconds_c)) {s4o.print(", 0, 0, 0, 0");}

   352

  s4o.print(")");

   353

  return NULL;

   354

}

   355

   356

   357

/* SYM_TOKEN(fixed_point_c) */

   358

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

   359

   360

   361

/* SYM_REF2(days_c, days, hours) */

   362

void *visit(days_c *symbol) {

   363

  TRACE("days_c");

   364

  if (NULL == symbol->hours)

   365

    s4o.print("0, 0, 0, 0");  /* milliseconds, seconds, minutes, hours */

   366

  else

   367

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

   368

   369

  s4o.print(", ");

   370

   371

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

   372

  return NULL;

   373

}

   374

   375

   376

/* SYM_REF2(hours_c, hours, minutes) */

   377

void *visit(hours_c *symbol) {

   378

  TRACE("hours_c");

   379

  if (NULL == symbol->minutes)

   380

    s4o.print("0, 0, 0");  /* milliseconds, seconds, minutes */

   381

  else

   382

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

   383

   384

  s4o.print(", ");

   385

   386

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

   387

  return NULL;

   388

}

   389

   390

   391

/* SYM_REF2(minutes_c, minutes, seconds) */

   392

void *visit(minutes_c *symbol) {

   393

  TRACE("minutes_c");

   394

  if (NULL == symbol->seconds)

   395

    s4o.print("0, 0");  /* milliseconds, seconds */

   396

  else

   397

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

   398

   399

  s4o.print(", ");

   400

   401

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

   402

  return NULL;

   403

}

   404

   405

   406

/* SYM_REF2(seconds_c, seconds, milliseconds) */

   407

void *visit(seconds_c *symbol) {

   408

  TRACE("seconds_c");

   409

  if (NULL == symbol->milliseconds)

   410

    s4o.print("0");  /* milliseconds */

   411

  else

   412

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

   413

   414

  s4o.print(", ");

   415

   416

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

   417

  return NULL;

   418

}

   419

   420

   421

/* SYM_REF2(milliseconds_c, milliseconds, unused) */

   422

void *visit(milliseconds_c *symbol) {

   423

  TRACE("milliseconds_c");

   424

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

   425

  return NULL;

   426

}

   427

   428

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

   429

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

   430

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

   431

   432

/* SYM_REF2(time_of_day_c, daytime, unused) */

   433

void *visit(time_of_day_c *symbol) {

   434

  TRACE("time_of_day_c");

   435

  s4o.print("__tod_to_timespec(");

   436

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

   437

  s4o.print(")");

   438

  return NULL;

   439

}

   440

   441

   442

/* SYM_REF4(daytime_c, day_hour, day_minute, day_second, unused) */

   443

void *visit(daytime_c *symbol) {

   444

  TRACE("daytime_c");

   445

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

   446

  s4o.print(", ");

   447

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

   448

  s4o.print(", ");

   449

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

   450

  return NULL;

   451

}

   452

   453

   454

/* SYM_REF2(date_c, date_literal, unused) */

   455

void *visit(date_c *symbol) {

   456

  TRACE("date_c");

   457

  s4o.print("__date_to_timespec(");

   458

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

   459

  s4o.print(")");

   460

  return NULL;

   461

}

   462

   463

   464

/* SYM_REF4(date_literal_c, year, month, day, unused) */

   465

void *visit(date_literal_c *symbol) {

   466

  TRACE("date_literal_c");

   467

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

   468

  s4o.print(", ");

   469

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

   470

  s4o.print(", ");

   471

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

   472

  return NULL;

   473

}

   474

   475

   476

/* SYM_REF2(date_and_time_c, date_literal, daytime) */

   477

void *visit(date_and_time_c *symbol) {

   478

  TRACE("date_and_time_c");

   479

  s4o.print("__dt_to_timespec(");

   480

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

   481

  s4o.print(", ");

   482

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

   483

  s4o.print(")");

   484

  return NULL;

   485

}

   486

   487

   488

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

   489

/* B.1.3 - Data types */

   490

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

   491

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

   492

/* B 1.3.1 - Elementary Data Types */

   493

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

   494

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

   495

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

   496

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

   497

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

   498

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

   499

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

   500

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

   501

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

   502

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

   503

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

   504

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

   505

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

   506

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

   507

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

   508

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

   509

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

   510

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

   511

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

   512

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

   513

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

   514

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

   515

   516

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

   517

/* B.1.3.2 - Generic data types */

   518

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

   519

  /* originally empty... */

   520

   521

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

   522

/* B 1.3.3 - Derived data types */

   523

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

   524

  /* leave for derived classes... */