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

#include <string.h>

    26

    27

    28

    29

    30

typedef struct

    31

{

    32

  symbol_c *param_name;

    33

  symbol_c *param_value;

    34

  symbol_c *param_type;

    35

  function_param_iterator_c::param_direction_t param_direction;

    36

} FUNCTION_PARAM;

    37

    38

#define DECLARE_PARAM_LIST()\

    39

  std::list<FUNCTION_PARAM*> param_list;\

    40

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

    41

  FUNCTION_PARAM *param;

    42

    43

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

    44

  param = new FUNCTION_PARAM;\

    45

  param->param_name = name;\

    46

  param->param_value = value;\

    47

  param->param_type = type;\

    48

  param->param_direction = direction;\

    49

  param_list.push_back(param);

    50

    51

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

    52

    53

#define PARAM_NAME (*pt)->param_name

    54

#define PARAM_VALUE (*pt)->param_value

    55

#define PARAM_TYPE (*pt)->param_type

    56

#define PARAM_DIRECTION (*pt)->param_direction

    57

    58

#define CLEAR_PARAM_LIST()\

    59

  PARAM_LIST_ITERATOR()\

    60

    delete *pt;\

    61

  param_list.clear();

    62

    63

    64

class generate_c_base_c: public iterator_visitor_c {

    65

    66

  protected:

    67

    stage4out_c &s4o;

    68

    69

  private:

    70

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

    71

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

    72

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

    73

     * it wishes to access a Function Block variable.

    74

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

    75

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

    76

     */

    77

    const char *variable_prefix_;

    78

    79

  public:

    80

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

    81

      variable_prefix_ = NULL;

    82

    }

    83

    ~generate_c_base_c(void) {}

    84

    85

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

    86

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

    87

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

    88

    void print_variable_prefix(void) {

    89

      if (variable_prefix_ != NULL)

    90

        s4o.print(variable_prefix_);

    91

    }

    92

   101

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

   102

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

   103

    }

   104

   105

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

   106

      s4o.print("__");

   107

      type->accept(*this);

   108

      s4o.print("_LITERAL(");

   109

      value->accept(*this);

   110

      s4o.print(")");

   111

      return NULL;

   112

    }

   113

   114

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

   115

      std::string str = "";

   116

      bool leading_zero = true;

   117

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

   118

        if (leading_zero &&

   119

        	(token->value[i] != '0' ||

   120

        	 i == strlen(token->value) - 1 ||

   121

        	 token->value[i + 1] == '.'

   122

        	))

   123

          leading_zero = false;

   124

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

   125

          str += token->value[i];

   126

      }

   127

      return s4o.printupper(str);

   128

    }

   129

   130

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

   131

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

   132

      unsigned char value, bit_mult;

   133

      unsigned int i;

   134

      int total_bits;

   135

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

   136

   137

      s4o.print("0x");

   138

   139

      total_bits = 0;

   140

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

   141

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

   142

	  total_bits++;

   143

   144

      value = 0;

   145

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

   146

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

   147

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

   148

	  bit_mult /= 2;

   149

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

   150

	  if (bit_mult == 1) {

   151

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

   152

	    s4o.print(str);

   153

            bit_mult = 0x10;

   154

            value = 0;

   155

	  }

   156

	}

   157

      }

   158

   159

      return NULL;

   160

    }

   161

   162

    void *print_list(list_c *list,

   163

		     std::string pre_elem_str = "",

   164

		     std::string inter_elem_str = "",

   165

		     std::string post_elem_str = "",

   166

		     visitor_c *visitor = NULL) {

   167

      if (visitor == NULL) visitor = this;

   168

   169

      if (list->n > 0) {

   170

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

   171

        s4o.print(pre_elem_str);

   172

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

   173

      }

   174

   175

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

   176

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

   177

        s4o.print(inter_elem_str);

   178

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

   179

      }

   180

   181

      if (list->n > 0)

   182

        s4o.print(post_elem_str);

   183

   184

      return NULL;

   185

    }

   186

   187

   188

    void *print_binary_expression(symbol_c *l_exp,

   189

				  symbol_c *r_exp,

   190

				  const char *operation) {

   191

      s4o.print("(");

   192

      l_exp->accept(*this);

   193

      s4o.print(operation);

   194

      r_exp->accept(*this);

   195

      s4o.print(")");

   196

      return NULL;

   197

    }

   198

   199

    void *print_unary_expression(symbol_c *exp,

   200

				 const char *operation) {

   201

      s4o.print(operation);

   202

      s4o.print("(");

   203

      exp->accept(*this);

   204

      s4o.print(")");

   205

      return NULL;

   206

    }

   207

   208

    void *print_binary_function(const char *function,

   209

          symbol_c *l_exp,

   210

				  symbol_c *r_exp) {

   211

      s4o.print(function);

   212

      s4o.print("(");

   213

      l_exp->accept(*this);

   214

      s4o.print(", ");

   215

      r_exp->accept(*this);

   216

      s4o.print(")");

   217

      return NULL;

   218

   	}

   219

   220

    void *print_compare_function(const char *function,

   221

          symbol_c *compare_type,

   222

          symbol_c *l_exp,

   223

          symbol_c *r_exp) {

   224

      s4o.print(function);

   225

      compare_type->accept(*this);

   226

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

   227

      l_exp->accept(*this);

   228

      s4o.print(", ");

   229

      r_exp->accept(*this);

   230

      s4o.print(")");

   231

      return NULL;

   232

    }

   233

   234

    void *print_check_function(symbol_c *type,

   235

          symbol_c *value,

   236

          symbol_c *fb_name = NULL,

   237

          bool temp = false) {

   238

      if (!get_datatype_info_c::is_type_valid(type)) ERROR;

   239

      bool is_subrange = get_datatype_info_c::is_subrange(type);

   240

      if (is_subrange) {

   241

		s4o.print("__CHECK_");

   242

		type->accept(*this);

   243

		s4o.print("(");

   244

      }

   245

      if (fb_name != NULL) {

   246

        s4o.print(GET_VAR);

   247

        s4o.print("(");

   248

        print_variable_prefix();

   249

        fb_name->accept(*this);

   250

        s4o.print(".");

   251

        value->accept(*this);

   252

        s4o.print(")");

   253

      }

   254

      else {

   255

        if (temp)

   256

    	  s4o.print(TEMP_VAR);

   257

        value->accept(*this);

   258

      }

   259

      if (is_subrange)

   260

        s4o.print(")");

   261

      return NULL;

   262

    }

   263

   264

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

   265

/* 2.1.6 - Pragmas  */

   266

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

   267

    void *visit(enable_code_generation_pragma_c * symbol)   {s4o.enable_output();  return NULL;}

   268

    void *visit(disable_code_generation_pragma_c * symbol)  {s4o.disable_output(); return NULL;} 

   269

   270

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

   271

    void *visit(pragma_c *symbol) {

   272

        s4o.print(s4o.indent_spaces);

   273

        s4o.print("#define GetFbVar(var,...) __GET_VAR(data__->var,__VA_ARGS__)\n");

   274

        s4o.print(s4o.indent_spaces);

   275

        s4o.print("#define SetFbVar(var,val,...) __SET_VAR(data__->,var,val,__VA_ARGS__)\n");

   276

        s4o.print(symbol->value);

   277

        s4o.print("\n");

   278

        s4o.print(s4o.indent_spaces);

   279

        s4o.print("#undef GetFbVar\n");

   280

        s4o.print(s4o.indent_spaces);

   281

        s4o.print("#undef SetFbVar\n");

   282

        return NULL;

   283

    }

   284

   285

   286

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

   287

/* B 0 - Programming Model */

   288

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

   289

  /* leave for derived classes... */

   290

   291

   292

   293

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

   294

/* B.1 - Common elements */

   295

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

   296

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

   297

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

   298

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

   299

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

   300

   301

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

   302

/* B 1.2 - Constants */

   303

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

   304

  /* originally empty... */

   305

   306

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

   307

/* B 1.2.1 - Numeric Literals */

   308

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

   309

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

   310

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

   311

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

   312

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

   313

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

   314

   315

    void *visit(neg_real_c *symbol) {

   316

      s4o.print("-");

   317

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

   318

      return NULL;

   319

    }

   320

   321

    void *visit(neg_integer_c *symbol) {

   322

      s4o.print("-");

   323

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

   324

      return NULL;

   325

    }

   326

   327

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

   328

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

   329

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

   330

    void *visit(boolean_literal_c *symbol) {

   331

      if (NULL != symbol->type)

   332

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

   333

      else {

   334

	bool_type_name_c bool_type;

   335

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

   336

      }

   337

    }

   338

   339

    /* helper class for boolean_literal_c */

   340

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

   341

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

   342

   343

    void *visit(neg_expression_c *symbol) {

   344

      s4o.print("-");

   345

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

   346

      return NULL;

   347

    }

   348

   349

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

   350

/* B.1.2.2   Character Strings */

   351

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

   352

    void *visit(double_byte_character_string_c *symbol) {

   353

      // TO DO ...

   354

      ERROR;

   355

      return print_token(symbol);

   356

    }

   357

   358

    void *visit(single_byte_character_string_c *symbol) {

   359

      std::string str = "";

   360

      unsigned int count = 0; 

   361

      str += '"';

   362

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

   363

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

   364

        char c = symbol->value[i];

   365

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

   366

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

   367

        if (c != '$')

   368

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

   369

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

   370

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

   371

        switch (c) {

   372

          case '$':

   373

          case '\'':

   374

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

   375

          case 'L':

   376

          case 'l':

   377

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

   378

          case 'N':

   379

          case 'n':

   380

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

   381

          case 'P':

   382

          case 'p':

   383

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

   384

          case 'R':

   385

          case 'r':

   386

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

   387

          case 'T':

   388

          case 't':

   389

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

   390

          default: {

   391

            if (isxdigit(c)) {

   392

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

   393

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

   394

	      if (isxdigit(c2)) {

   395

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

   396

	        count++; continue;

   397

	      }

   398

	    }

   399

          }

   400

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

   401

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

   402

          ERROR;

   403

        } /* switch() */

   404

      } /* for() */

   405

   406

      str += '"';

   407

      s4o.print("__STRING_LITERAL(");

   408

      s4o.print(count); 

   409

      s4o.print(",");

   410

      s4o.print(str);

   411

      s4o.print(")");

   412

      return NULL;

   413

    }

   414

   415

   416

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

   417

/* B 1.2.3 - Time Literals */

   418

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

   419

   420

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

   421

/* B 1.2.3.1 - Duration */

   422

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

   423

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

   424

   425

/* SYM_REF0(neg_time_c) */

   426

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

   427

   428

   429

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

   430

void *visit(duration_c *symbol) {

   431

  TRACE("duration_c");

   432

  s4o.print("__time_to_timespec(");

   433

   434

  if (NULL == symbol->neg)    s4o.print("1");  /* positive time value */

   435

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

   436

   437

  s4o.print(", ");

   438

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

   439

  s4o.print(")");

   440

  return NULL;

   441

}

   442

   443

   444

/* SYM_TOKEN(fixed_point_c) */

   445

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

   446

   447

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

   448

void *visit(interval_c *symbol) {

   449

  TRACE("interval_c");

   450

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

   451

  if (NULL == symbol->milliseconds) s4o.print("0");  /* milliseconds */

   452

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

   453

  s4o.print(", ");

   454

   455

  if (NULL == symbol->seconds)      s4o.print("0");  /* seconds */

   456

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

   457

  s4o.print(", ");

   458

   459

  if (NULL == symbol->minutes)      s4o.print("0");  /* minutes */

   460

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

   461

  s4o.print(", ");

   462

   463

  if (NULL == symbol->hours)        s4o.print("0");  /* hours */

   464

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

   465

  s4o.print(", ");

   466

   467

  if (NULL == symbol->days)         s4o.print("0");  /* days */

   468

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

   469

   470

  return NULL;

   471

}

   472

   473

   474

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

   475

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

   476

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

   477

   478

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

   479

void *visit(time_of_day_c *symbol) {

   480

  TRACE("time_of_day_c");

   481

  s4o.print("__tod_to_timespec(");

   482

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

   483

  s4o.print(")");

   484

  return NULL;

   485

}

   486

   487

   488

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

   489

void *visit(daytime_c *symbol) {

   490

  TRACE("daytime_c");

   491

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

   492

  s4o.print(", ");

   493

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

   494

  s4o.print(", ");

   495

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

   496

  return NULL;

   497

}

   498

   499

   500

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

   501

void *visit(date_c *symbol) {

   502

  TRACE("date_c");

   503

  s4o.print("__date_to_timespec(");

   504

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

   505

  s4o.print(")");

   506

  return NULL;

   507

}

   508

   509

   510

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

   511

void *visit(date_literal_c *symbol) {

   512

  TRACE("date_literal_c");

   513

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