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_name;

    55

  symbol_c *param_value;

    56

  symbol_c *param_type;

    57

  function_param_iterator_c::param_direction_t param_direction;

    58

} FUNCTION_PARAM;

    59

    60

#define DECLARE_PARAM_LIST()\

    61

  std::list<FUNCTION_PARAM*> param_list;\

    62

  std::list<FUNCTION_PARAM*>::iterator pt;\

    63

  FUNCTION_PARAM *param;

    64

    65

#define ADD_PARAM_LIST(name, value, type, direction)\

    66

  param = new FUNCTION_PARAM;\

    67

  param->param_name = name;\

    68

  param->param_value = value;\

    69

  param->param_type = type;\

    70

  param->param_direction = direction;\

    71

  param_list.push_back(param);

    72

    73

#define PARAM_LIST_ITERATOR() for(pt = param_list.begin(); pt != param_list.end(); pt++)

    74

    75

#define PARAM_NAME (*pt)->param_name

    76

#define PARAM_VALUE (*pt)->param_value

    77

#define PARAM_TYPE (*pt)->param_type

    78

#define PARAM_DIRECTION (*pt)->param_direction

    79

    80

#define CLEAR_PARAM_LIST()\

    81

  PARAM_LIST_ITERATOR()\

    82

    delete *pt;\

    83

  param_list.clear();

    84

    85

    86

class generate_c_base_c: public iterator_visitor_c {

    87

    88

  protected:

    89

    stage4out_c &s4o;

    90

    91

  private:

    92

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

    93

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

    94

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

    95

     * it wishes to access a Function Block variable.

    96

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

    97

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

    98

     */

    99

    const char *variable_prefix_;

   100

   101

  public:

   102

    generate_c_base_c(stage4out_c *s4o_ptr): s4o(*s4o_ptr) {

   103

      variable_prefix_ = NULL;

   104

    }

   105

    ~generate_c_base_c(void) {}

   106

   107

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

   108

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

   109

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

   110

    void print_variable_prefix(void) {

   111

      if (variable_prefix_ != NULL)

   112

        s4o.print(variable_prefix_);

   113

    }

   114

   115

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

   116

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

   117

    }

   118

   119

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

   120

      s4o.print("__");

   121

      type->accept(*this);

   122

      s4o.print("_LITERAL(");

   123

      value->accept(*this);

   124

      s4o.print(")");

   125

      return NULL;

   126

    }

   127

   128

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

   129

      std::string str = "";

   130

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

   131

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

   132

          str += token->value[i];

   133

      return s4o.printupper(str);

   134

    }

   135

   136

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

   137

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

   138

      unsigned char value, bit_mult;

   139

      unsigned int i;

   140

      int total_bits;

   141

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

   142

   143

      s4o.print("0x");

   144

   145

      total_bits = 0;

   146

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

   147

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

   148

	  total_bits++;

   149

   150

      value = 0;

   151

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

   152

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

   153

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

   154

	  bit_mult /= 2;

   155

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

   156

	  if (bit_mult == 1) {

   157

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

   158

	    s4o.print(str);

   159

            bit_mult = 0x10;

   160

            value = 0;

   161

	  }

   162

	}

   163

      }

   164

   165

      return NULL;

   166

    }

   167

   168

    void *print_list(list_c *list,

   169

		     std::string pre_elem_str = "",

   170

		     std::string inter_elem_str = "",

   171

		     std::string post_elem_str = "",

   172

		     visitor_c *visitor = NULL) {

   173

      if (visitor == NULL) visitor = this;

   174

   175

      if (list->n > 0) {

   176

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

   177

        s4o.print(pre_elem_str);

   178

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

   179

      }

   180

   181

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

   182

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

   183

        s4o.print(inter_elem_str);

   184

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

   185

      }

   186

   187

      if (list->n > 0)

   188

        s4o.print(post_elem_str);

   189

   190

      return NULL;

   191

    }

   192

   193

   194

    void *print_binary_expression(symbol_c *l_exp,

   195

				  symbol_c *r_exp,

   196

				  const char *operation) {

   197

      s4o.print("(");

   198

      l_exp->accept(*this);

   199

      s4o.print(operation);

   200

      r_exp->accept(*this);

   201

      s4o.print(")");

   202

      return NULL;

   203

    }

   204

   205

    void *print_unary_expression(symbol_c *exp,

   206

				 const char *operation) {

   207

      s4o.print(operation);

   208

      s4o.print("(");

   209

      exp->accept(*this);

   210

      s4o.print(")");

   211

      return NULL;

   212

    }

   213

   214

    void *print_binary_function(const char *function,

   215

          symbol_c *l_exp,

   216

				  symbol_c *r_exp) {

   217

      s4o.print(function);

   218

      s4o.print("(");

   219

      l_exp->accept(*this);

   220

      s4o.print(", ");

   221

      r_exp->accept(*this);

   222

      s4o.print(")");

   223

      return NULL;

   224

   	}

   225

   226

    void *print_compare_function(const char *function,

   227

          symbol_c *compare_type,

   228

          symbol_c *l_exp,

   229

          symbol_c *r_exp) {

   230

      s4o.print(function);

   231

      compare_type->accept(*this);

   232

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

   233

      l_exp->accept(*this);

   234

      s4o.print(", ");

   235

      r_exp->accept(*this);

   236

      s4o.print(")");

   237

      return NULL;

   238

    }

   239

   240

    void *print_check_function(symbol_c *type,

   241

          symbol_c *value,

   242

          symbol_c *fb_name = NULL,

   243

          bool temp = false) {

   244

      search_base_type_c search_base_type;

   245

      bool is_subrange = search_base_type.type_is_subrange(type);

   246

      if (is_subrange) {

   247

		s4o.print("__CHECK_");

   248

		type->accept(*this);

   249

		s4o.print("(");

   250

      }

   251

      if (fb_name != NULL) {

   252

        s4o.print(GET_VAR);

   253

        s4o.print("(");

   254

        print_variable_prefix();

   255

        fb_name->accept(*this);

   256

        s4o.print(".");

   257

        value->accept(*this);

   258

        s4o.print(")");

   259

      }

   260

      else {

   261

        if (temp)

   262

    	  s4o.print(TEMP_VAR);

   263

        value->accept(*this);

   264

      }

   265

      if (is_subrange)

   266

        s4o.print(")");

   267

      return NULL;

   268

    }

   269

   270

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

   271

/* 2.1.6 - Pragmas */

   272

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

   273

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

   274

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

   275

   276

   277

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

   278

/* B 0 - Programming Model */

   279

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

   280

  /* leave for derived classes... */

   281

   282

   283

   284

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

   285

/* B.1 - Common elements */

   286

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

   287

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

   288

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

   289

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

   290

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

   291

   292

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

   293

/* B 1.2 - Constants */

   294

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

   295

  /* originally empty... */

   296

   297

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

   298

/* B 1.2.1 - Numeric Literals */

   299

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

   300

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

   301

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

   302

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

   303

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

   304

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

   305

   306

    void *visit(neg_real_c *symbol) {

   307

      s4o.print("-");

   308

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

   309

      return NULL;

   310

    }

   311

   312

    void *visit(neg_integer_c *symbol) {

   313

      s4o.print("-");

   314

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

   315

      return NULL;

   316

    }

   317

   318

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

   319

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

   320

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

   321

    void *visit(boolean_literal_c *symbol) {

   322

      if (NULL != symbol->type)

   323

        return print_literal(symbol->type, symbol->value);

   324

      else {

   325

	bool_type_name_c bool_type;

   326

	return print_literal(&bool_type, symbol->value);

   327

      }

   328

    }

   329

   330

    /* helper class for boolean_literal_c */

   331

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

   332

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

   333

   334

    void *visit(neg_expression_c *symbol) {

   335

      s4o.print("-");

   336

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

   337

      return NULL;

   338

    }

   339

   340

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

   341

/* B.1.2.2   Character Strings */

   342

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

   343

    void *visit(double_byte_character_string_c *symbol) {

   344

      // TO DO ...

   345

      ERROR;

   346

      return print_token(symbol);

   347

    }

   348

   349

    void *visit(single_byte_character_string_c *symbol) {

   350

      std::string str = "";

   351

      unsigned int count = 0; 

   352

      str += '"';

   353

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

   354

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

   355

        char c = symbol->value[i];

   356

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

   357

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

   358

        if (c != '$')

   359

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

   360

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

   361

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

   362

        switch (c) {

   363

          case '$':

   364

          case '\'':

   365

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

   366

          case 'L':

   367

          case 'l':

   368

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

   369

          case 'N':

   370

          case 'n':

   371

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

   372

          case 'P':

   373

          case 'p':

   374

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

   375

          case 'R':

   376

          case 'r':

   377

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

   378

          case 'T':

   379

          case 't':

   380

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

   381

          default: {

   382

            if (isxdigit(c)) {

   383

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

   384

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

   385

	      if (isxdigit(c2)) {

   386

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

   387

	        count++; continue;

   388

	      }

   389

	    }

   390

          }

   391

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

   392

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

   393

          ERROR;

   394

        } /* switch() */

   395

      } /* for() */

   396

   397

      str += '"';

   398

      s4o.print("__STRING_LITERAL(");

   399

      s4o.print_integer(count); 

   400

      s4o.print(",");

   401

      s4o.print(str);

   402

      s4o.print(")");

   403

      return NULL;

   404

    }

   405

   406

   407

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

   408

/* B 1.2.3 - Time Literals */

   409

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

   410

   411

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

   412

/* B 1.2.3.1 - Duration */

   413

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

   414

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

   415

   416

/* SYM_REF0(neg_time_c) */

   417

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

   418

   419

   420

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

   421

void *visit(duration_c *symbol) {

   422

  TRACE("duration_c");

   423

  s4o.print("__time_to_timespec(");

   424

  if (NULL == symbol->neg)

   425

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

   426

  else

   427

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

   428

   429

  s4o.print(", ");

   430

   431

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

   432

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

   433

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

   434

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

   435

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

   436

  s4o.print(")");

   437

  return NULL;

   438

}

   439

   440

   441

/* SYM_TOKEN(fixed_point_c) */

   442

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

   443

   444

   445

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

   446

void *visit(days_c *symbol) {

   447

  TRACE("days_c");

   448

  if (NULL == symbol->hours)

   449

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

   450

  else

   451

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

   452

   453

  s4o.print(", ");

   454

   455

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

   456

  return NULL;

   457

}

   458

   459

   460

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

   461

void *visit(hours_c *symbol) {

   462

  TRACE("hours_c");

   463

  if (NULL == symbol->minutes)

   464

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

   465

  else

   466

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

   467

   468

  s4o.print(", ");

   469

   470

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

   471

  return NULL;

   472

}

   473

   474

   475

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

   476

void *visit(minutes_c *symbol) {

   477

  TRACE("minutes_c");

   478

  if (NULL == symbol->seconds)

   479

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

   480

  else

   481

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

   482

   483

  s4o.print(", ");

   484

   485

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

   486

  return NULL;

   487

}

   488

   489

   490

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

   491

void *visit(seconds_c *symbol) {

   492

  TRACE("seconds_c");

   493

  if (NULL == symbol->milliseconds)

   494

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

   495

  else

   496

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

   497

   498

  s4o.print(", ");

   499

   500

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

   501

  return NULL;

   502

}

   503

   504

   505

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

   506

void *visit(milliseconds_c *symbol) {

   507

  TRACE("milliseconds_c");

   508

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

   509

  return NULL;

   510

}

   511

   512

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

   513

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

   514

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

   515

   516

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

   517

void *visit(time_of_day_c *symbol) {

   518

  TRACE("time_of_day_c");

   519

  s4o.print("__tod_to_timespec(");

   520

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