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

            )

   125

          leading_zero = false;

   126

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

   127

          str += token->value[i];

   128

      }

   129

      return s4o.printupper(str);

   130

    }

   131

   132

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

   133

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

   134

      unsigned char value, bit_mult;

   135

      unsigned int i;

   136

      int total_bits;

   137

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

   138

   139

      s4o.print("0x");

   140

   141

      total_bits = 0;

   142

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

   143

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

   144

          total_bits++;

   145

   146

      value = 0;

   147

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

   148

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

   149

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

   150

          bit_mult /= 2;

   151

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

   152

          if (bit_mult == 1) {

   153

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

   154

            s4o.print(str);

   155

            bit_mult = 0x10;

   156

            value = 0;

   157

          }

   158

        }

   159

      }

   160

   161

      return NULL;

   162

    }

   163

   164

    void *print_list(list_c *list,

   165

                     std::string pre_elem_str = "",

   166

                     std::string inter_elem_str = "",

   167

                     std::string post_elem_str = "",

   168

                     visitor_c *visitor = NULL) {

   169

      if (visitor == NULL) visitor = this;

   170

   171

      if (list->n > 0) {

   172

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

   173

        s4o.print(pre_elem_str);

   174

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

   175

      }

   176

   177

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

   178

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

   179

        s4o.print(inter_elem_str);

   180

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

   181

      }

   182

   183

      if (list->n > 0)

   184

        s4o.print(post_elem_str);

   185

   186

      return NULL;

   187

    }

   188

   189

   190

    void *print_binary_expression(symbol_c *l_exp,

   191

                                  symbol_c *r_exp,

   192

                                  const char *operation) {

   193

      s4o.print("(");

   194

      l_exp->accept(*this);

   195

      s4o.print(operation);

   196

      r_exp->accept(*this);

   197

      s4o.print(")");

   198

      return NULL;

   199

    }

   200

   201

    void *print_unary_expression(symbol_c *exp,

   202

                                 const char *operation) {

   203

      s4o.print(operation);

   204

      s4o.print("(");

   205

      exp->accept(*this);

   206

      s4o.print(")");

   207

      return NULL;

   208

    }

   209

   210

    void *print_binary_function(const char *function,

   211

          symbol_c *l_exp,

   212

          symbol_c *r_exp) {

   213

      s4o.print(function);

   214

      s4o.print("(");

   215

      l_exp->accept(*this);

   216

      s4o.print(", ");

   217

      r_exp->accept(*this);

   218

      s4o.print(")");

   219

      return NULL;

   220

    }

   221

   222

    void *print_compare_function(const char *function,

   223

          symbol_c *compare_type,

   224

          symbol_c *l_exp,

   225

          symbol_c *r_exp) {

   226

      s4o.print(function);

   227

      compare_type->accept(*this);

   228

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

   229

      l_exp->accept(*this);

   230

      s4o.print(", ");

   231

      r_exp->accept(*this);

   232

      s4o.print(")");

   233

      return NULL;

   234

    }

   235

   236

    void *print_check_function(symbol_c *type,

   237

          symbol_c *value,

   238

          symbol_c *fb_name = NULL,

   239

          bool temp = false) {

   240

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

   241

      bool is_subrange = get_datatype_info_c::is_subrange(type);

   242

      if (is_subrange) {

   243

        s4o.print("__CHECK_");

   244

        type->accept(*this);

   245

        s4o.print("(");

   246

      }

   247

      if (fb_name != NULL) {

   248

        s4o.print(GET_VAR);

   249

        s4o.print("(");

   250

        print_variable_prefix();

   251

        fb_name->accept(*this);

   252

        s4o.print(".");

   253

        value->accept(*this);

   254

        s4o.print(")");

   255

      }

   256

      else {

   257

        if (temp)

   258

        s4o.print(TEMP_VAR);

   259

        value->accept(*this);

   260

      }

   261

      if (is_subrange)

   262

        s4o.print(")");

   263

      return NULL;

   264

    }

   265

   266

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

   267

/* 2.1.6 - Pragmas  */

   268

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

   269

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

   270

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

   271

   272

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

   273

    void *visit(pragma_c *symbol) {

   274

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

   275

        s4o.print(s4o.indent_spaces);

   276

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

   277

        s4o.print(symbol->value);

   278

        s4o.print("\n");

   279

        s4o.print(s4o.indent_spaces);

   280

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

   281

        s4o.print(s4o.indent_spaces);

   282

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

   283

        return NULL;

   284

    }

   285

   286

   287

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

   288

/* B 0 - Programming Model */

   289

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

   290

  /* leave for derived classes... */

   291

   292

   293

   294

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

   295

/* B.1 - Common elements */

   296

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

   297

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

   298

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

   299

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

   300

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

   301

   302

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

   303

/* B 1.2 - Constants */

   304

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

   305

  /* originally empty... */

   306

   307

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

   308

/* B 1.2.XX - Reference Literals */

   309

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

   310

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

   311

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

   312

   313

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

   314

/* B 1.2.1 - Numeric Literals */

   315

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

   316

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

   317

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

   318

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

   319

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

   320

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

   321

   322

    void *visit(neg_real_c *symbol) {

   323

      s4o.print("-");

   324

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

   325

      return NULL;

   326

    }

   327

   328

    void *visit(neg_integer_c *symbol) {

   329

      s4o.print("-");

   330

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

   331

      return NULL;

   332

    }

   333

   334

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

   335

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

   336

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

   337

    void *visit(boolean_literal_c *symbol) {

   338

      if (NULL != symbol->type)

   339

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

   340

      else {

   341

        bool_type_name_c bool_type;

   342

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

   343

      }

   344

    }

   345

   346

    /* helper class for boolean_literal_c */

   347

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

   348

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

   349

   350

    void *visit(neg_expression_c *symbol) {

   351

      s4o.print("-");

   352

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

   353

      return NULL;

   354

    }

   355

   356

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

   357

/* B.1.2.2   Character Strings */

   358

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

   359

    void *visit(double_byte_character_string_c *symbol) {

   360

      // TO DO ...

   361

      ERROR;

   362

      return print_token(symbol);

   363

    }

   364

   365

    void *visit(single_byte_character_string_c *symbol) {

   366

      std::string str = "";

   367

      unsigned int count = 0; 

   368

      str += '"';

   369

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

   370

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

   371

        char c = symbol->value[i];

   372

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

   373

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

   374

        if (c != '$')

   375

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

   376

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

   377

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

   378

        switch (c) {

   379

          case '$':

   380

          case '\'':

   381

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

   382

          case 'L':

   383

          case 'l':

   384

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

   385

          case 'N':

   386

          case 'n':

   387

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

   388

          case 'P':

   389

          case 'p':

   390

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

   391

          case 'R':

   392

          case 'r':

   393

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

   394

          case 'T':

   395

          case 't':

   396

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

   397

          default: {

   398

            if (isxdigit(c)) {

   399

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

   400

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

   401

              if (isxdigit(c2)) {

   402

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

   403

                count++; continue;

   404

              }

   405

            }

   406

          }

   407

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

   408

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

   409

          ERROR;

   410

        } /* switch() */

   411

      } /* for() */

   412

   413

      str += '"';

   414

      s4o.print("__STRING_LITERAL(");

   415

      s4o.print(count); 

   416

      s4o.print(",");

   417

      s4o.print(str);

   418

      s4o.print(")");

   419

      return NULL;

   420

    }

   421

   422

   423

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

   424

/* B 1.2.3 - Time Literals */

   425

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

   426

   427

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

   428

/* B 1.2.3.1 - Duration */

   429

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

   430

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

   431

   432

/* SYM_REF0(neg_time_c) */

   433

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

   434

   435

   436

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

   437

void *visit(duration_c *symbol) {

   438

  TRACE("duration_c");

   439

  s4o.print("__time_to_timespec(");

   440

   441

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

   442

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

   443

   444

  s4o.print(", ");

   445

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

   446

  s4o.print(")");

   447

  return NULL;

   448

}

   449

   450

   451

/* SYM_TOKEN(fixed_point_c) */

   452

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

   453

   454

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

   455

void *visit(interval_c *symbol) {

   456

  TRACE("interval_c");

   457

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

   458

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

   459

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

   460

  s4o.print(", ");

   461

   462

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

   463

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

   464

  s4o.print(", ");

   465

   466

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

   467

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

   468

  s4o.print(", ");

   469

   470

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

   471

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

   472

  s4o.print(", ");

   473

   474

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

   475

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

   476

   477

  return NULL;

   478

}

   479

   480

   481

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

   482

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

   483

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

   484

   485

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

   486

void *visit(time_of_day_c *symbol) {

   487

  TRACE("time_of_day_c");

   488

  s4o.print("__tod_to_timespec(");

   489

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

   490

  s4o.print(")");

   491

  return NULL;

   492

}

   493

   494

   495

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

   496

void *visit(daytime_c *symbol) {

   497

  TRACE("daytime_c");

   498

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

   499

  s4o.print(", ");

   500

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

   501

  s4o.print(", ");

   502

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

   503

  return NULL;

   504

}

   505

   506

   507

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

   508

void *visit(date_c *symbol) {

   509

  TRACE("date_c");