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_c.hh"

    46

    47

#include <string.h>

    48

    49

    50

    51

    52

    53

    54

    55

    56

    57

    58

    59

class generate_c_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_c_base_c(stage4out_c *s4o_ptr): s4o(*s4o_ptr) {variable_prefix_ = NULL;}

    78

    ~generate_c_base_c(void) {}

    79

    80

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

    82

    void print_variable_prefix(void) {

    83

      if (variable_prefix_ != NULL)

    84

        s4o.print(variable_prefix_);

    85

    }

    86

    87

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

    88

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

    89

    }

    90

    91

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

    92

      s4o.print("__");

    93

      type->accept(*this);

    94

      s4o.print("_LITERAL(");

    95

      value->accept(*this);

    96

      s4o.print(")");

    97

      return NULL;

    98

    }

    99

   100

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

   101

      std::string str = "";

   102

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

   103

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

   104

          str += token->value[i];

   105

      return s4o.printupper(str);

   106

    }

   107

   108

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

   109

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

   110

      unsigned char value, bit_mult;

   111

      unsigned int i;

   112

      int total_bits;

   113

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

   114

   115

      s4o.print("0x");

   116

   117

      total_bits = 0;

   118

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

   119

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

   120

	  total_bits++;

   121

   122

      value = 0;

   123

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

   124

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

   125

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

   126

	  bit_mult /= 2;

   127

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

   128

	  if (bit_mult == 1) {

   129

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

   130

	    s4o.print(str);

   131

            bit_mult = 0x10;

   132

            value = 0;

   133

	  }

   134

	}

   135

      }

   136

   137

      return NULL;

   138

    }

   139

   140

    void *print_list(list_c *list,

   141

		     std::string pre_elem_str = "",

   142

		     std::string inter_elem_str = "",

   143

		     std::string post_elem_str = "",

   144

		     visitor_c *visitor = NULL) {

   145

      if (visitor == NULL) visitor = this;

   146

   147

      if (list->n > 0) {

   148

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

   149

        s4o.print(pre_elem_str);

   150

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

   151

      }

   152

   153

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

   154

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

   155

        s4o.print(inter_elem_str);

   156

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

   157

      }

   158

   159

      if (list->n > 0)

   160

        s4o.print(post_elem_str);

   161

   162

      return NULL;

   163

    }

   164

   165

   166

    void *print_binary_expression(symbol_c *l_exp,

   167

				  symbol_c *r_exp,

   168

				  const char *operation) {

   169

      s4o.print("(");

   170

      l_exp->accept(*this);

   171

      s4o.print(operation);

   172

      r_exp->accept(*this);

   173

      s4o.print(")");

   174

      return NULL;

   175

    }

   176

   177

    void *print_unary_expression(symbol_c *exp,

   178

				 const char *operation) {

   179

      s4o.print(operation);

   180

      s4o.print("(");

   181

      exp->accept(*this);

   182

      s4o.print(")");

   183

      return NULL;

   184

    }

   185

   186

    void *print_binary_function(const char *function,

   187

          symbol_c *l_exp,

   188

				  symbol_c *r_exp) {

   189

      s4o.print(function);

   190

      s4o.print("(");

   191

      l_exp->accept(*this);

   192

      s4o.print(", ");

   193

      r_exp->accept(*this);

   194

      s4o.print(")");

   195

      return NULL;

   196

   	}

   197

   198

    void *print_compare_function(const char *function,

   199

          symbol_c *compare_type,

   200

          symbol_c *l_exp,

   201

          symbol_c *r_exp) {

   202

      s4o.print(function);

   203

      compare_type->accept(*this);

   204

      s4o.print("(2, ");

   205

      l_exp->accept(*this);

   206

      s4o.print(", ");

   207

      r_exp->accept(*this);

   208

      s4o.print(")");

   209

      return NULL;

   210

    }

   211

   212

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

   213

/* 2.1.6 - Pragmas */

   214

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

   215

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

   216

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

   217

   218

   219

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

   220

/* B 0 - Programming Model */

   221

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

   222

  /* leave for derived classes... */

   223

   224

   225

   226

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

   227

/* B.1 - Common elements */

   228

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

   229

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

   230

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

   231

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

   232

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

   233

   234

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

   235

/* B 1.2 - Constants */

   236

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

   237

  /* originally empty... */

   238

   239

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

   240

/* B 1.2.1 - Numeric Literals */

   241

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

   242

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

   243

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

   244

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

   245

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

   246

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

   247

   248

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

   249

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

   250

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

   251

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

   252

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

   253

   254

    /* helper class for boolean_literal_c */

   255

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

   256

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

   257

   258

    void *visit(neg_literal_c *symbol) {

   259

      s4o.print("-");

   260

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

   261

      return NULL;

   262

    }

   263

   264

    void *visit(neg_expression_c *symbol) {

   265

      s4o.print("-");

   266

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

   267

      return NULL;

   268

    }

   269

   270

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

   271

/* B.1.2.2   Character Strings */

   272

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

   273

    void *visit(double_byte_character_string_c *symbol) {

   274

      // TO DO ...

   275

      ERROR;

   276

      return print_token(symbol);

   277

    }

   278

   279

    void *visit(single_byte_character_string_c *symbol) {

   280

      std::string str = "";

   281

      unsigned int count = 0; 

   282

      str += '"';

   283

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

   284

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

   285

        char c = symbol->value[i];

   286

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

   287

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

   288

        if (c != '$')

   289

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

   290

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

   291

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

   292

        switch (c) {

   293

          case '$':

   294

          case '\'':

   295

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

   296

          case 'L':

   297

          case 'l':

   298

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

   299

          case 'N':

   300

          case 'n':

   301

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

   302

          case 'P':

   303

          case 'p':

   304

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

   305

          case 'R':

   306

          case 'r':

   307

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

   308

          case 'T':

   309

          case 't':

   310

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

   311

          default: {

   312

            if (isxdigit(c)) {

   313

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

   314

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

   315

	      if (isxdigit(c2)) {

   316

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

   317

	        count++; continue;

   318

	      }

   319

	    }

   320

          }

   321

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

   322

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

   323

          ERROR;

   324

        } /* switch() */

   325

      } /* for() */

   326

   327

      str += '"';

   328

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

   329

      s4o.print_integer(count); 

   330

      s4o.print(",");

   331

      s4o.print(str);

   332

      s4o.print("}");

   333

      return NULL;

   334

    }

   335

   336

   337

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

   338

/* B 1.2.3 - Time Literals */

   339

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

   340

   341

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

   342

/* B 1.2.3.1 - Duration */

   343

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

   344

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

   345

   346

/* SYM_REF0(neg_time_c) */

   347

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

   348

   349

   350

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

   351

void *visit(duration_c *symbol) {

   352

  TRACE("duration_c");

   353

  s4o.print("__time_to_timespec(");

   354

  if (NULL == symbol->neg)

   355

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

   356

  else

   357

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

   358

   359

  s4o.print(", ");

   360

   361

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

   362

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

   363

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

   364

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

   365

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

   366

  s4o.print(")");

   367

  return NULL;

   368

}

   369

   370

   371

/* SYM_TOKEN(fixed_point_c) */

   372

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

   373

   374

   375

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

   376

void *visit(days_c *symbol) {

   377

  TRACE("days_c");

   378

  if (NULL == symbol->hours)

   379

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

   380

  else

   381

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

   382

   383

  s4o.print(", ");

   384

   385

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

   386

  return NULL;

   387

}

   388

   389

   390

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

   391

void *visit(hours_c *symbol) {

   392

  TRACE("hours_c");

   393

  if (NULL == symbol->minutes)

   394

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

   395

  else

   396

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

   397

   398

  s4o.print(", ");

   399

   400

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

   401

  return NULL;

   402

}

   403

   404

   405

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

   406

void *visit(minutes_c *symbol) {

   407

  TRACE("minutes_c");

   408

  if (NULL == symbol->seconds)

   409

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

   410

  else

   411

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

   412

   413

  s4o.print(", ");

   414

   415

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

   416

  return NULL;

   417

}

   418

   419

   420

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

   421

void *visit(seconds_c *symbol) {

   422

  TRACE("seconds_c");

   423

  if (NULL == symbol->milliseconds)

   424

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

   425

  else

   426

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

   427

   428

  s4o.print(", ");

   429

   430

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

   431

  return NULL;

   432

}

   433

   434

   435

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

   436

void *visit(milliseconds_c *symbol) {

   437

  TRACE("milliseconds_c");

   438

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

   439

  return NULL;

   440

}

   441

   442

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

   443

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

   444

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

   445

   446

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

   447

void *visit(time_of_day_c *symbol) {

   448

  TRACE("time_of_day_c");

   449

  s4o.print("__tod_to_timespec(");

   450

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

   451

  s4o.print(")");

   452

  return NULL;

   453

}

   454

   455

   456

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

   457

void *visit(daytime_c *symbol) {

   458

  TRACE("daytime_c");

   459

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

   460

  s4o.print(", ");

   461

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

   462

  s4o.print(", ");

   463

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

   464

  return NULL;

   465

}

   466

   467

   468

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

   469

void *visit(date_c *symbol) {

   470

  TRACE("date_c");

   471

  s4o.print("__date_to_timespec(");

   472

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

   473

  s4o.print(")");

   474

  return NULL;

   475

}

   476

   477

   478

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

   479

void *visit(date_literal_c *symbol) {

   480

  TRACE("date_literal_c");

   481

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

   482

  s4o.print(", ");

   483

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

   484

  s4o.print(", ");

   485

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

   486

  return NULL;

   487

}

   488

   489

   490

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

   491

void *visit(date_and_time_c *symbol) {

   492

  TRACE("date_and_time_c");

   493

  s4o.print("__dt_to_timespec(");

   494

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

   495

  s4o.print(", ");

   496

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

   497

  s4o.print(")");

   498

  return NULL;

   499

}

   500

   501

   502

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

   503

/* B.1.3 - Data types */

   504

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

   505

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

   506

/* B 1.3.1 - Elementary Data Types */

   507

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

   508

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

   509

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

   510

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

   511

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

   512

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

   513

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

   514

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

   515

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

   516

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

   517

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

   518

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

   519

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

   520

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

   521

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

   522

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

   523

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

   524

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

   525

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

   526

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

   527

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

   528

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