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

typedef struct

    53

{

    54

  symbol_c *param_value;

    55

  symbol_c *param_type;

    56

  function_param_iterator_c::param_direction_t param_direction;

    57

} FUNCTION_PARAM;

    58

    59

#define ADD_PARAM_LIST(value, type, direction)\

    60

  param = new FUNCTION_PARAM;\

    61

  param->param_value = value;\

    62

  param->param_type = type;\

    63

  param->param_direction = direction;\

    64

  param_list.push_back(*param);

    65

    66

    67

    68

class generate_c_base_c: public iterator_visitor_c {

    69

    70

  protected:

    71

    stage4out_c &s4o;

    72

    73

  private:

    74

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

    75

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

    76

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

    77

     * it wishes to access a Function Block variable.

    78

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

    79

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

    80

     */

    81

    const char *variable_prefix_;

    82

    83

    84

    85

  public:

    86

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

    87

    ~generate_c_base_c(void) {}

    88

    89

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

    90

    const char *get_variable_prefix(void) {return variable_prefix_;}

    91

    bool is_variable_prefix_null(void) {return variable_prefix_ == NULL;}

    92

    void print_variable_prefix(void) {

    93

      if (variable_prefix_ != NULL)

    94

        s4o.print(variable_prefix_);

    95

    }

    96

    97

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

    98

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

    99

    }

   100

   101

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

   102

      s4o.print("__");

   103

      type->accept(*this);

   104

      s4o.print("_LITERAL(");

   105

      value->accept(*this);

   106

      s4o.print(")");

   107

      return NULL;

   108

    }

   109

   110

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

   111

      std::string str = "";

   112

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

   113

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

   114

          str += token->value[i];

   115

      return s4o.printupper(str);

   116

    }

   117

   118

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

   119

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

   120

      unsigned char value, bit_mult;

   121

      unsigned int i;

   122

      int total_bits;

   123

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

   124

   125

      s4o.print("0x");

   126

   127

      total_bits = 0;

   128

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

   129

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

   130

	  total_bits++;

   131

   132

      value = 0;

   133

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

   134

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

   135

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

   136

	  bit_mult /= 2;

   137

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

   138

	  if (bit_mult == 1) {

   139

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

   140

	    s4o.print(str);

   141

            bit_mult = 0x10;

   142

            value = 0;

   143

	  }

   144

	}

   145

      }

   146

   147

      return NULL;

   148

    }

   149

   150

    void *print_list(list_c *list,

   151

		     std::string pre_elem_str = "",

   152

		     std::string inter_elem_str = "",

   153

		     std::string post_elem_str = "",

   154

		     visitor_c *visitor = NULL) {

   155

      if (visitor == NULL) visitor = this;

   156

   157

      if (list->n > 0) {

   158

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

   159

        s4o.print(pre_elem_str);

   160

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

   161

      }

   162

   163

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

   164

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

   165

        s4o.print(inter_elem_str);

   166

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

   167

      }

   168

   169

      if (list->n > 0)

   170

        s4o.print(post_elem_str);

   171

   172

      return NULL;

   173

    }

   174

   175

   176

    void *print_binary_expression(symbol_c *l_exp,

   177

				  symbol_c *r_exp,

   178

				  const char *operation) {

   179

      s4o.print("(");

   180

      l_exp->accept(*this);

   181

      s4o.print(operation);

   182

      r_exp->accept(*this);

   183

      s4o.print(")");

   184

      return NULL;

   185

    }

   186

   187

    void *print_unary_expression(symbol_c *exp,

   188

				 const char *operation) {

   189

      s4o.print(operation);

   190

      s4o.print("(");

   191

      exp->accept(*this);

   192

      s4o.print(")");

   193

      return NULL;

   194

    }

   195

   196

    void *print_binary_function(const char *function,

   197

          symbol_c *l_exp,

   198

				  symbol_c *r_exp) {

   199

      s4o.print(function);

   200

      s4o.print("(");

   201

      l_exp->accept(*this);

   202

      s4o.print(", ");

   203

      r_exp->accept(*this);

   204

      s4o.print(")");

   205

      return NULL;

   206

   	}

   207

   208

    void *print_compare_function(const char *function,

   209

          symbol_c *compare_type,

   210

          symbol_c *l_exp,

   211

          symbol_c *r_exp) {

   212

      s4o.print(function);

   213

      compare_type->accept(*this);

   214

      s4o.print("(__BOOL_LITERAL(TRUE), NULL, 2, ");

   215

      l_exp->accept(*this);

   216

      s4o.print(", ");

   217

      r_exp->accept(*this);

   218

      s4o.print(")");

   219

      return NULL;

   220

    }

   221

   222

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

   223

/* 2.1.6 - Pragmas */

   224

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

   225

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

   226

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

   227

   228

   229

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

   230

/* B 0 - Programming Model */

   231

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

   232

  /* leave for derived classes... */

   233

   234

   235

   236

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

   237

/* B.1 - Common elements */

   238

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

   239

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

   240

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

   241

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

   242

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

   243

   244

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

   245

/* B 1.2 - Constants */

   246

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

   247

  /* originally empty... */

   248

   249

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

   250

/* B 1.2.1 - Numeric Literals */

   251

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

   252

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

   253

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

   254

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

   255

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

   256

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

   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"); return NULL;}

   265

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

   266

   267

    void *visit(neg_literal_c *symbol) {

   268

      s4o.print("-");

   269

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

   270

      return NULL;

   271

    }

   272

   273

    void *visit(neg_expression_c *symbol) {

   274

      s4o.print("-");

   275

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

   276

      return NULL;

   277

    }

   278

   279

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

   280

/* B.1.2.2   Character Strings */

   281

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

   282

    void *visit(double_byte_character_string_c *symbol) {

   283

      // TO DO ...

   284

      ERROR;

   285

      return print_token(symbol);

   286

    }

   287

   288

    void *visit(single_byte_character_string_c *symbol) {

   289

      std::string str = "";

   290

      unsigned int count = 0; 

   291

      str += '"';

   292

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

   293

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

   294

        char c = symbol->value[i];

   295

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

   296

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

   297

        if (c != '$')

   298

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

   299

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

   300

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

   301

        switch (c) {

   302

          case '$':

   303

          case '\'':

   304

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

   305

          case 'L':

   306

          case 'l':

   307

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

   308

          case 'N':

   309

          case 'n':

   310

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

   311

          case 'P':

   312

          case 'p':

   313

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

   314

          case 'R':

   315

          case 'r':

   316

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

   317

          case 'T':

   318

          case 't':

   319

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

   320

          default: {

   321

            if (isxdigit(c)) {

   322

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

   323

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

   324

	      if (isxdigit(c2)) {

   325

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

   326

	        count++; continue;

   327

	      }

   328

	    }

   329

          }

   330

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

   331

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

   332

          ERROR;

   333

        } /* switch() */

   334

      } /* for() */

   335

   336

      str += '"';

   337

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

   338

      s4o.print_integer(count); 

   339

      s4o.print(",");

   340

      s4o.print(str);

   341

      s4o.print("}");

   342

      return NULL;

   343

    }

   344

   345

   346

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

   347

/* B 1.2.3 - Time Literals */

   348

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

   349

   350

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

   351

/* B 1.2.3.1 - Duration */

   352

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

   353

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

   354

   355

/* SYM_REF0(neg_time_c) */

   356

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

   357

   358

   359

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

   360

void *visit(duration_c *symbol) {

   361

  TRACE("duration_c");

   362

  s4o.print("__time_to_timespec(");

   363

  if (NULL == symbol->neg)

   364

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

   365

  else

   366

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

   367

   368

  s4o.print(", ");

   369

   370

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

   371

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

   372

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

   373

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

   374

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

   375

  s4o.print(")");

   376

  return NULL;

   377

}

   378

   379

   380

/* SYM_TOKEN(fixed_point_c) */

   381

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

   382

   383

   384

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

   385

void *visit(days_c *symbol) {

   386

  TRACE("days_c");

   387

  if (NULL == symbol->hours)

   388

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

   389

  else

   390

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

   391

   392

  s4o.print(", ");

   393

   394

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

   395

  return NULL;

   396

}

   397

   398

   399

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

   400

void *visit(hours_c *symbol) {

   401

  TRACE("hours_c");

   402

  if (NULL == symbol->minutes)

   403

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

   404

  else

   405

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

   406

   407

  s4o.print(", ");

   408

   409

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

   410

  return NULL;

   411

}

   412

   413

   414

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

   415

void *visit(minutes_c *symbol) {

   416

  TRACE("minutes_c");

   417

  if (NULL == symbol->seconds)

   418

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

   419

  else

   420

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

   421

   422

  s4o.print(", ");

   423

   424

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

   425

  return NULL;

   426

}

   427

   428

   429

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

   430

void *visit(seconds_c *symbol) {

   431

  TRACE("seconds_c");

   432

  if (NULL == symbol->milliseconds)

   433

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

   434

  else

   435

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

   436

   437

  s4o.print(", ");

   438

   439

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

   440

  return NULL;

   441

}

   442

   443

   444

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

   445

void *visit(milliseconds_c *symbol) {

   446

  TRACE("milliseconds_c");

   447

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

   448

  return NULL;

   449

}

   450

   451

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

   452

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

   453

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

   454

   455

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

   456

void *visit(time_of_day_c *symbol) {

   457

  TRACE("time_of_day_c");

   458

  s4o.print("__tod_to_timespec(");

   459

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

   460

  s4o.print(")");

   461

  return NULL;

   462

}

   463

   464

   465

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

   466

void *visit(daytime_c *symbol) {

   467

  TRACE("daytime_c");

   468

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

   469

  s4o.print(", ");

   470

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

   471

  s4o.print(", ");

   472

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

   473

  return NULL;

   474

}

   475

   476

   477

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

   478

void *visit(date_c *symbol) {

   479

  TRACE("date_c");

   480

  s4o.print("__date_to_timespec(");

   481

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

   482

  s4o.print(")");

   483

  return NULL;

   484

}

   485

   486

   487

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

   488

void *visit(date_literal_c *symbol) {

   489

  TRACE("date_literal_c");

   490

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

   491

  s4o.print(", ");

   492

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

   493

  s4o.print(", ");

   494

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

   495

  return NULL;

   496

}

   497

   498

   499

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

   500

void *visit(date_and_time_c *symbol) {

   501

  TRACE("date_and_time_c");

   502

  s4o.print("__dt_to_timespec(");

   503

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

   504

  s4o.print(", ");

   505

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

   506

  s4o.print(")");

   507

  return NULL;

   508

}

   509

   510

   511

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

   512

/* B.1.3 - Data types */

   513

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

   514

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

   515

/* B 1.3.1 - Elementary Data Types */

   516

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

   517

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

   518

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

   519

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

   520

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

   521

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

   522

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

   523

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

   524

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

   525

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

   526

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

   527