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_line_directive(symbol_c *symbol) {

    94

      if (!generate_line_directives__) return; /* global variable generate_line_directives__ is defined in generate_c.cc */

    95

      s4o.print("#line ");

    96

      s4o.print(symbol->first_line);

    97

      s4o.print(" \"");

    98

      s4o.print(symbol->first_file);

    99

      s4o.print("\"\n");    

   100

    }

   101

   102

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

   103

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

   104

    }

   105

   106

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

   107

      s4o.print("__");

   108

      type->accept(*this);

   109

      s4o.print("_LITERAL(");

   110

      value->accept(*this);

   111

      s4o.print(")");

   112

      return NULL;

   113

    }

   114

   115

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

   116

      std::string str = "";

   117

      bool leading_zero = true;

   118

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

   119

        if (leading_zero &&

   120

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

   121

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

   122

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

   123

        	))

   124

          leading_zero = false;

   125

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

   126

          str += token->value[i];

   127

      }

   128

      return s4o.printupper(str);

   129

    }

   130

   131

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

   132

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

   133

      unsigned char value, bit_mult;

   134

      unsigned int i;

   135

      int total_bits;

   136

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

   137

   138

      s4o.print("0x");

   139

   140

      total_bits = 0;

   141

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

   142

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

   143

	  total_bits++;

   144

   145

      value = 0;

   146

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

   147

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

   148

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

   149

	  bit_mult /= 2;

   150

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

   151

	  if (bit_mult == 1) {

   152

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

   153

	    s4o.print(str);

   154

            bit_mult = 0x10;

   155

            value = 0;

   156

	  }

   157

	}

   158

      }

   159

   160

      return NULL;

   161

    }

   162

   163

    void *print_list(list_c *list,

   164

		     std::string pre_elem_str = "",

   165

		     std::string inter_elem_str = "",

   166

		     std::string post_elem_str = "",

   167

		     visitor_c *visitor = NULL) {

   168

      if (visitor == NULL) visitor = this;

   169

   170

      if (list->n > 0) {

   171

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

   172

        s4o.print(pre_elem_str);

   173

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

   174

      }

   175

   176

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

   177

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

   178

        s4o.print(inter_elem_str);

   179

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

   180

      }

   181

   182

      if (list->n > 0)

   183

        s4o.print(post_elem_str);

   184

   185

      return NULL;

   186

    }

   187

   188

   189

    void *print_binary_expression(symbol_c *l_exp,

   190

				  symbol_c *r_exp,

   191

				  const char *operation) {

   192

      s4o.print("(");

   193

      l_exp->accept(*this);

   194

      s4o.print(operation);

   195

      r_exp->accept(*this);

   196

      s4o.print(")");

   197

      return NULL;

   198

    }

   199

   200

    void *print_unary_expression(symbol_c *exp,

   201

				 const char *operation) {

   202

      s4o.print(operation);

   203

      s4o.print("(");

   204

      exp->accept(*this);

   205

      s4o.print(")");

   206

      return NULL;

   207

    }

   208

   209

    void *print_binary_function(const char *function,

   210

          symbol_c *l_exp,

   211

				  symbol_c *r_exp) {

   212

      s4o.print(function);

   213

      s4o.print("(");

   214

      l_exp->accept(*this);

   215

      s4o.print(", ");

   216

      r_exp->accept(*this);

   217

      s4o.print(")");

   218

      return NULL;

   219

   	}

   220

   221

    void *print_compare_function(const char *function,

   222

          symbol_c *compare_type,

   223

          symbol_c *l_exp,

   224

          symbol_c *r_exp) {

   225

      s4o.print(function);

   226

      compare_type->accept(*this);

   227

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

   228

      l_exp->accept(*this);

   229

      s4o.print(", ");

   230

      r_exp->accept(*this);

   231

      s4o.print(")");

   232

      return NULL;

   233

    }

   234

   235

    void *print_check_function(symbol_c *type,

   236

          symbol_c *value,

   237

          symbol_c *fb_name = NULL,

   238

          bool temp = false) {

   239

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

   240

      bool is_subrange = get_datatype_info_c::is_subrange(type);

   241

      if (is_subrange) {

   242

		s4o.print("__CHECK_");

   243

		type->accept(*this);

   244

		s4o.print("(");

   245

      }

   246

      if (fb_name != NULL) {

   247

        s4o.print(GET_VAR);

   248

        s4o.print("(");

   249

        print_variable_prefix();

   250

        fb_name->accept(*this);

   251

        s4o.print(".");

   252

        value->accept(*this);

   253

        s4o.print(")");

   254

      }

   255

      else {

   256

        if (temp)

   257

    	  s4o.print(TEMP_VAR);

   258

        value->accept(*this);

   259

      }

   260

      if (is_subrange)

   261

        s4o.print(")");

   262

      return NULL;

   263

    }

   264

   265

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

   266

/* 2.1.6 - Pragmas  */

   267

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

   268

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

   269

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

   270

   271

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

   272

    void *visit(pragma_c *symbol) {

   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,__VA_ARGS__,val)\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.XX - Reference Literals */

   308

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

   309

/* defined in IEC 61131-3 v3 - Basically the 'NULL' keyword! */

   310

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

   311

   312

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

   313

/* B 1.2.1 - Numeric Literals */

   314

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

   315

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

   316

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

   317

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

   318

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

   319

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

   320

   321

    void *visit(neg_real_c *symbol) {

   322

      s4o.print("-");

   323

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

   324

      return NULL;

   325

    }

   326

   327

    void *visit(neg_integer_c *symbol) {

   328

      s4o.print("-");

   329

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

   330

      return NULL;

   331

    }

   332

   333

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

   334

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

   335

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

   336

    void *visit(boolean_literal_c *symbol) {

   337

      if (NULL != symbol->type)

   338

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

   339

      else {

   340

	bool_type_name_c bool_type;

   341

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

   342

      }

   343

    }

   344

   345

    /* helper class for boolean_literal_c */

   346

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

   347

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

   348

   349

    void *visit(neg_expression_c *symbol) {

   350

      s4o.print("-");

   351

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

   352

      return NULL;

   353

    }

   354

   355

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

   356

/* B.1.2.2   Character Strings */

   357

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

   358

    void *visit(double_byte_character_string_c *symbol) {

   359

      // TO DO ...

   360

      ERROR;

   361

      return print_token(symbol);

   362

    }

   363

   364

    void *visit(single_byte_character_string_c *symbol) {

   365

      std::string str = "";

   366

      unsigned int count = 0; 

   367

      str += '"';

   368

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

   369

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

   370

        char c = symbol->value[i];

   371

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

   372

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

   373

        if (c != '$')

   374

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

   375

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

   376

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

   377

        switch (c) {

   378

          case '$':

   379

          case '\'':

   380

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

   381

          case 'L':

   382

          case 'l':

   383

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

   384

          case 'N':

   385

          case 'n':

   386

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

   387

          case 'P':

   388

          case 'p':

   389

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

   390

          case 'R':

   391

          case 'r':

   392

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

   393

          case 'T':

   394

          case 't':

   395

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

   396

          default: {

   397

            if (isxdigit(c)) {

   398

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

   399

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

   400

	      if (isxdigit(c2)) {

   401

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

   402

	        count++; continue;

   403

	      }

   404

	    }

   405

          }

   406

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

   407

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

   408

          ERROR;

   409

        } /* switch() */

   410

      } /* for() */

   411

   412

      str += '"';

   413

      s4o.print("__STRING_LITERAL(");

   414

      s4o.print(count); 

   415

      s4o.print(",");

   416

      s4o.print(str);

   417

      s4o.print(")");

   418

      return NULL;

   419

    }

   420

   421

   422

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

   423

/* B 1.2.3 - Time Literals */

   424

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

   425

   426

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

   427

/* B 1.2.3.1 - Duration */

   428

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

   429

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

   430

   431

/* SYM_REF0(neg_time_c) */

   432

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

   433

   434

   435

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

   436

void *visit(duration_c *symbol) {

   437

  TRACE("duration_c");

   438

  s4o.print("__time_to_timespec(");

   439

   440

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

   441

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

   442

   443

  s4o.print(", ");

   444

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

   445

  s4o.print(")");

   446

  return NULL;

   447

}

   448

   449

   450

/* SYM_TOKEN(fixed_point_c) */

   451

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

   452

   453

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

   454

void *visit(interval_c *symbol) {

   455

  TRACE("interval_c");

   456

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

   457

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

   458

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

   459

  s4o.print(", ");

   460

   461

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

   462

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

   463

  s4o.print(", ");

   464

   465

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

   466

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

   467

  s4o.print(", ");

   468

   469

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

   470

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

   471

  s4o.print(", ");

   472

   473

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

   474

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

   475

   476

  return NULL;

   477

}

   478

   479

   480

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

   481

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

   482

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

   483

   484

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

   485

void *visit(time_of_day_c *symbol) {

   486

  TRACE("time_of_day_c");

   487

  s4o.print("__tod_to_timespec(");

   488

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

   489

  s4o.print(")");

   490

  return NULL;

   491

}

   492

   493

   494

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

   495

void *visit(daytime_c *symbol) {

   496

  TRACE("daytime_c");

   497

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

   498

  s4o.print(", ");

   499

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

   500

  s4o.print(", ");

   501

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

   502

  return NULL;

   503

}

   504

   505

   506

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

   507

void *visit(date_c *symbol) {

   508

  TRACE("date_c");

   509

  s4o.print("__date_to_timespec(");

   510

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

   511

  s4o.print(")");

   512

  return NULL;