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

    93

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

    94

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

    95

    }

    96

    97

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

    98

      s4o.print("__");

    99

      type->accept(*this);

   100

      s4o.print("_LITERAL(");

   101

      value->accept(*this);

   102

      s4o.print(")");

   103

      return NULL;

   104

    }

   105

   106

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

   107

      std::string str = "";

   108

      bool leading_zero = true;

   109

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

   110

        if (leading_zero &&

   111

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

   112

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

   113

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

   114

        	))

   115

          leading_zero = false;

   116

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

   117

          str += token->value[i];

   118

      }

   119

      return s4o.printupper(str);

   120

    }

   121

   122

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

   123

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

   124

      unsigned char value, bit_mult;

   125

      unsigned int i;

   126

      int total_bits;

   127

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

   128

   129

      s4o.print("0x");

   130

   131

      total_bits = 0;

   132

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

   133

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

   134

	  total_bits++;

   135

   136

      value = 0;

   137

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

   138

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

   139

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

   140

	  bit_mult /= 2;

   141

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

   142

	  if (bit_mult == 1) {

   143

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

   144

	    s4o.print(str);

   145

            bit_mult = 0x10;

   146

            value = 0;

   147

	  }

   148

	}

   149

      }

   150

   151

      return NULL;

   152

    }

   153

   154

    void *print_list(list_c *list,

   155

		     std::string pre_elem_str = "",

   156

		     std::string inter_elem_str = "",

   157

		     std::string post_elem_str = "",

   158

		     visitor_c *visitor = NULL) {

   159

      if (visitor == NULL) visitor = this;

   160

   161

      if (list->n > 0) {

   162

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

   163

        s4o.print(pre_elem_str);

   164

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

   165

      }

   166

   167

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

   168

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

   169

        s4o.print(inter_elem_str);

   170

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

   171

      }

   172

   173

      if (list->n > 0)

   174

        s4o.print(post_elem_str);

   175

   176

      return NULL;

   177

    }

   178

   179

   180

    void *print_binary_expression(symbol_c *l_exp,

   181

				  symbol_c *r_exp,

   182

				  const char *operation) {

   183

      s4o.print("(");

   184

      l_exp->accept(*this);

   185

      s4o.print(operation);

   186

      r_exp->accept(*this);

   187

      s4o.print(")");

   188

      return NULL;

   189

    }

   190

   191

    void *print_unary_expression(symbol_c *exp,

   192

				 const char *operation) {

   193

      s4o.print(operation);

   194

      s4o.print("(");

   195

      exp->accept(*this);

   196

      s4o.print(")");

   197

      return NULL;

   198

    }

   199

   200

    void *print_binary_function(const char *function,

   201

          symbol_c *l_exp,

   202

				  symbol_c *r_exp) {

   203

      s4o.print(function);

   204

      s4o.print("(");

   205

      l_exp->accept(*this);

   206

      s4o.print(", ");

   207

      r_exp->accept(*this);

   208

      s4o.print(")");

   209

      return NULL;

   210

   	}

   211

   212

    void *print_compare_function(const char *function,

   213

          symbol_c *compare_type,

   214

          symbol_c *l_exp,

   215

          symbol_c *r_exp) {

   216

      s4o.print(function);

   217

      compare_type->accept(*this);

   218

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

   219

      l_exp->accept(*this);

   220

      s4o.print(", ");

   221

      r_exp->accept(*this);

   222

      s4o.print(")");

   223

      return NULL;

   224

    }

   225

   226

    void *print_check_function(symbol_c *type,

   227

          symbol_c *value,

   228

          symbol_c *fb_name = NULL,

   229

          bool temp = false) {

   230

      bool is_subrange = search_base_type_c::type_is_subrange(type);

   231

      if (is_subrange) {

   232

		s4o.print("__CHECK_");

   233

		type->accept(*this);

   234

		s4o.print("(");

   235

      }

   236

      if (fb_name != NULL) {

   237

        s4o.print(GET_VAR);

   238

        s4o.print("(");

   239

        print_variable_prefix();

   240

        fb_name->accept(*this);

   241

        s4o.print(".");

   242

        value->accept(*this);

   243

        s4o.print(")");

   244

      }

   245

      else {

   246

        if (temp)

   247

    	  s4o.print(TEMP_VAR);

   248

        value->accept(*this);

   249

      }

   250

      if (is_subrange)

   251

        s4o.print(")");

   252

      return NULL;

   253

    }

   254

   255

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

   256

/* 2.1.6 - Pragmas  */

   257

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

   258

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

   259

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

   260

   261

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

   262

    void *visit(pragma_c *symbol) {

   263

        s4o.print(s4o.indent_spaces);

   264

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

   265

        s4o.print(s4o.indent_spaces);

   266

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

   267

        s4o.print(symbol->value);

   268

        s4o.print("\n");

   269

        s4o.print(s4o.indent_spaces);

   270

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

   271

        s4o.print(s4o.indent_spaces);

   272

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

   273

        return NULL;

   274

    }

   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(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

   425

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

   426

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

   427

   428

  s4o.print(", ");

   429

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

   430

  s4o.print(")");

   431

  return NULL;

   432

}

   433

   434

   435

/* SYM_TOKEN(fixed_point_c) */

   436

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

   437

   438

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

   439

void *visit(interval_c *symbol) {

   440

  TRACE("interval_c");

   441

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

   442

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

   443

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

   444

  s4o.print(", ");

   445

   446

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

   447

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

   448

  s4o.print(", ");

   449

   450

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

   451

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

   452

  s4o.print(", ");

   453

   454

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

   455

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

   456

  s4o.print(", ");

   457

   458

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

   459

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

   460

   461

  return NULL;

   462

}

   463

   464

   465

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

   466

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

   467

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

   468

   469

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

   470

void *visit(time_of_day_c *symbol) {

   471

  TRACE("time_of_day_c");

   472

  s4o.print("__tod_to_timespec(");

   473

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

   474

  s4o.print(")");

   475

  return NULL;

   476

}

   477

   478

   479

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

   480

void *visit(daytime_c *symbol) {

   481

  TRACE("daytime_c");

   482

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

   483

  s4o.print(", ");

   484

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

   485

  s4o.print(", ");

   486

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

   487

  return NULL;

   488

}

   489

   490

   491

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

   492

void *visit(date_c *symbol) {

   493

  TRACE("date_c");

   494

  s4o.print("__date_to_timespec(");

   495

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

   496

  s4o.print(")");

   497

  return NULL;

   498

}

   499

   500

   501

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

   502

void *visit(date_literal_c *symbol) {

   503

  TRACE("date_literal_c");

   504

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

   505

  s4o.print(", ");

   506

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

   507

  s4o.print(", ");

   508

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

   509

  return NULL;

   510

}

   511

   512

   513

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