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

/*  This file cotains two main classes:

    30

 *   - generate_c_base_c

    31

 *   - generate_c_base_and_typeid_c

    32

 * 

    33

 *  generate_c_base_c

    34

 *  -----------------

    35

 *   This class generates C code for all literals and varables. In short, all the basic stuff

    36

 *   that will probably be needed in all other code generating classes.

    37

 *   It does not however handle derived datatypes.

    38

 *

    39

 * generate_c_base_and_typeid_c

    40

 * ----------------------------

    41

 *   This is similar to the generate_c_base_c (from which it inherits), but it also handles

    42

 *   all the derived datatypes. Note that it does not generate C code for the declaration of

    43

 *   those datatypes (that is what generate_c_typedecl_c is for), but rather it merely

    44

 *   generates the name/id of a derived datatype.

    45

 *   Note too that not all derived datatypes in the IEC 61131-3 have a name (for example, 

    46

 *   VAR a: ARRAY [3..5] of INT END_VAR), in which case an alias for this datatype should 

    47

 *   have been previously generated by either generate_c_typedecl_c or generate_implicit_typedecl_c.

    48

 */ 

    49

    50

    51

    52

    53

    54

typedef struct

    55

{

    56

  symbol_c *param_name;

    57

  symbol_c *param_value;

    58

  symbol_c *param_type;

    59

  function_param_iterator_c::param_direction_t param_direction;

    60

} FUNCTION_PARAM;

    61

    62

#define DECLARE_PARAM_LIST()\

    63

  std::list<FUNCTION_PARAM*> param_list;\

    64

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

    65

  FUNCTION_PARAM *param;

    66

    67

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

    68

  param = new FUNCTION_PARAM;\

    69

  param->param_name = name;\

    70

  param->param_value = value;\

    71

  param->param_type = type;\

    72

  param->param_direction = direction;\

    73

  param_list.push_back(param);

    74

    75

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

    76

    77

#define PARAM_NAME (*pt)->param_name

    78

#define PARAM_VALUE (*pt)->param_value

    79

#define PARAM_TYPE (*pt)->param_type

    80

#define PARAM_DIRECTION (*pt)->param_direction

    81

    82

#define CLEAR_PARAM_LIST()\

    83

  PARAM_LIST_ITERATOR()\

    84

    delete *pt;\

    85

  param_list.clear();

    86

    87

    88

/*  generate_c_base_c

    89

 *  -----------------

    90

 *   This class generates C code for all literals and varables. In short, all the basic stuff

    91

 *   that will probably be needed in all other code generating classes.

    92

 *   It does not however handle derived datatypes.

    93

 */

    94

class generate_c_base_c: public iterator_visitor_c {

    95

    96

  protected:

    97

    stage4out_c &s4o;

    98

    99

  private:

   100

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

   101

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

   102

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

   103

     * it wishes to access a Function Block variable.

   104

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

   105

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

   106

     */

   107

    const char *variable_prefix_;

   108

   109

  public:

   110

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

   111

      variable_prefix_ = NULL;

   112

    }

   113

    ~generate_c_base_c(void) {}

   114

   115

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

   116

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

   117

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

   118

    void print_variable_prefix(void) {

   119

      if (variable_prefix_ != NULL)

   120

        s4o.print(variable_prefix_);

   121

    }

   122

   123

    void print_line_directive(symbol_c *symbol) {

   124

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

   125

      s4o.print("#line ");

   126

      s4o.print(symbol->first_line);

   127

      s4o.print(" \"");

   128

      s4o.print(symbol->first_file);

   129

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

   130

    }

   131

   132

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

   133

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

   134

    }

   135

   136

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

   137

      s4o.print("__");

   138

      type->accept(*this);

   139

      s4o.print("_LITERAL(");

   140

      value->accept(*this);

   141

      s4o.print(")");

   142

      return NULL;

   143

    }

   144

   145

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

   146

      std::string str = "";

   147

      bool leading_zero = true;

   148

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

   149

        if (leading_zero

   150

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

   151

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

   152

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

   153

                )

   154

            )

   155

          leading_zero = false;

   156

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

   157

          str += token->value[i];

   158

      }

   159

      return s4o.printupper(str);

   160

    }

   161

   162

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

   163

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

   164

      unsigned char value, bit_mult;

   165

      unsigned int i;

   166

      int total_bits;

   167

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

   168

   169

      s4o.print("0x");

   170

   171

      total_bits = 0;

   172

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

   173

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

   174

          total_bits++;

   175

   176

      value = 0;

   177

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

   178

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

   179

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

   180

          bit_mult /= 2;

   181

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

   182

          if (bit_mult == 1) {

   183

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

   184

            s4o.print(str);

   185

            bit_mult = 0x10;

   186

            value = 0;

   187

          }

   188

        }

   189

      }

   190

   191

      return NULL;

   192

    }

   193

   194

    void *print_list(list_c *list,

   195

                     std::string pre_elem_str = "",

   196

                     std::string inter_elem_str = "",

   197

                     std::string post_elem_str = "",

   198

                     visitor_c *visitor = NULL) {

   199

      if (visitor == NULL) visitor = this;

   200

   201

      if (list->n > 0) {

   202

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

   203

        s4o.print(pre_elem_str);

   204

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

   205

      }

   206

   207

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

   208

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

   209

        s4o.print(inter_elem_str);

   210

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

   211

      }

   212

   213

      if (list->n > 0)

   214

        s4o.print(post_elem_str);

   215

   216

      return NULL;

   217

    }

   218

   219

   220

    void *print_binary_expression(symbol_c *l_exp,

   221

                                  symbol_c *r_exp,

   222

                                  const char *operation) {

   223

      s4o.print("(");

   224

      l_exp->accept(*this);

   225

      s4o.print(operation);

   226

      r_exp->accept(*this);

   227

      s4o.print(")");

   228

      return NULL;

   229

    }

   230

   231

    void *print_unary_expression(symbol_c *exp,

   232

                                 const char *operation) {

   233

      s4o.print(operation);

   234

      s4o.print("(");

   235

      exp->accept(*this);

   236

      s4o.print(")");

   237

      return NULL;

   238

    }

   239

   240

    void *print_binary_function(const char *function,

   241

          symbol_c *l_exp,

   242

          symbol_c *r_exp) {

   243

      s4o.print(function);

   244

      s4o.print("(");

   245

      l_exp->accept(*this);

   246

      s4o.print(", ");

   247

      r_exp->accept(*this);

   248

      s4o.print(")");

   249

      return NULL;

   250

    }

   251

   252

    void *print_compare_function(const char *function,

   253

          symbol_c *compare_type,

   254

          symbol_c *l_exp,

   255

          symbol_c *r_exp) {

   256

      s4o.print(function);

   257

      compare_type->accept(*this);

   258

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

   259

      l_exp->accept(*this);

   260

      s4o.print(", ");

   261

      r_exp->accept(*this);

   262

      s4o.print(")");

   263

      return NULL;

   264

    }

   265

   266

    void *print_check_function(symbol_c *type,

   267

          symbol_c *value,

   268

          symbol_c *fb_name = NULL,

   269

          bool temp = false) {

   270

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

   271

      bool is_subrange = get_datatype_info_c::is_subrange(type);

   272

      if (is_subrange) {

   273

        s4o.print("__CHECK_");

   274

        type->accept(*this);

   275

        s4o.print("(");

   276

      }

   277

      if (fb_name != NULL) {

   278

        s4o.print(GET_VAR);

   279

        s4o.print("(");

   280

        print_variable_prefix();

   281

        fb_name->accept(*this);

   282

        s4o.print(".");

   283

        value->accept(*this);

   284

        s4o.print(")");

   285

      }

   286

      else {

   287

        if (temp)

   288

        s4o.print(TEMP_VAR);

   289

        value->accept(*this);

   290

      }

   291

      if (is_subrange)

   292

        s4o.print(")");

   293

      return NULL;

   294

    }

   295

   296

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

   297

/* 2.1.6 - Pragmas  */

   298

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

   299

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

   300

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

   301

   302

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

   303

    void *visit(pragma_c *symbol) {

   304

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

   305

        s4o.print(s4o.indent_spaces);

   306

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

   307

        s4o.print(symbol->value);

   308

        s4o.print("\n");

   309

        s4o.print(s4o.indent_spaces);

   310

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

   311

        s4o.print(s4o.indent_spaces);

   312

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

   313

        return NULL;

   314

    }

   315

   316

   317

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

   318

/* B 0 - Programming Model */

   319

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

   320

  /* leave for derived classes... */

   321

   322

   323

   324

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

   325

/* B.1 - Common elements */

   326

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

   327

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

   328

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

   329

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

   332

    /* If you need the derived_datatype_identifier_c visitor, then you should probably be 

   333

     * inheriting from generate_c_base_and_typeid_c and not generate_c_base_c !!

   334

     */

   335

    void *visit(derived_datatype_identifier_c *symbol) {ERROR; return NULL;}

   336

   337

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

   338

/* B 1.2 - Constants */

   339

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

   340

  /* originally empty... */

   341

   342

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

   343

/* B 1.2.XX - Reference Literals */

   344

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

   345

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

   346

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

   347

   348

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

   349

/* B 1.2.1 - Numeric Literals */

   350

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

   351

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

   352

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

   353

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

   354

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

   355

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

   356

   357

    void *visit(neg_real_c *symbol) {

   358

      s4o.print("-");

   359

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

   360

      return NULL;

   361

    }

   362

   363

    void *visit(neg_integer_c *symbol) {

   364

      s4o.print("-");

   365

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

   366

      return NULL;

   367

    }

   368

   369

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

   370

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

   371

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

   372

    void *visit(boolean_literal_c *symbol) {

   373

      if (NULL != symbol->type)

   374

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

   375

      else {

   376

        bool_type_name_c bool_type;

   377

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

   378

      }

   379

    }

   380

   381

    /* helper class for boolean_literal_c */

   382

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

   383

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

   384

   385

    void *visit(neg_expression_c *symbol) {

   386

      s4o.print("-");

   387

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

   388

      return NULL;

   389

    }

   390

   391

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

   392

/* B.1.2.2   Character Strings */

   393

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

   394

    void *visit(double_byte_character_string_c *symbol) {

   395

      // TO DO ...

   396

      ERROR;

   397

      return print_token(symbol);

   398

    }

   399

   400

    void *visit(single_byte_character_string_c *symbol) {

   401

      std::string str = "";

   402

      unsigned int count = 0; 

   403

      str += '"';

   404

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

   405

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

   406

        char c = symbol->value[i];

   407

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

   408

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

   409

        if (c != '$')

   410

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

   411

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

   412

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

   413

        switch (c) {

   414

          case '$':

   415

          case '\'':

   416

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

   417

          case 'L':

   418

          case 'l':

   419

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

   420

          case 'N':

   421

          case 'n':

   422

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

   423

          case 'P':

   424

          case 'p':

   425

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

   426

          case 'R':

   427

          case 'r':

   428

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

   429

          case 'T':

   430

          case 't':

   431

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

   432

          default: {

   433

            if (isxdigit(c)) {

   434

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

   435

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

   436

              if (isxdigit(c2)) {

   437

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

   438

                count++; continue;

   439

              }

   440

            }

   441

          }

   442

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

   443

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

   444

          ERROR;

   445

        } /* switch() */

   446

      } /* for() */

   447

   448

      str += '"';

   449

      s4o.print("__STRING_LITERAL(");

   450

      s4o.print(count); 

   451

      s4o.print(",");

   452

      s4o.print(str);

   453

      s4o.print(")");

   454

      return NULL;

   455

    }

   456

   457

   458

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

   459

/* B 1.2.3 - Time Literals */

   460

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

   461

   462

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

   463

/* B 1.2.3.1 - Duration */

   464

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

   465

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

   466

   467

/* SYM_REF0(neg_time_c) */

   468

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

   469

   470

   471

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

   472

void *visit(duration_c *symbol) {

   473

  TRACE("duration_c");

   474

  s4o.print("__time_to_timespec(");

   475

   476

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

   477

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

   478

   479

  s4o.print(", ");

   480

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

   481

  s4o.print(")");

   482

  return NULL;

   483

}

   484

   485

   486

/* SYM_TOKEN(fixed_point_c) */

   487

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

   488

   489

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

   490

void *visit(interval_c *symbol) {

   491

  TRACE("interval_c");

   492

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

   493

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

   494

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

   495

  s4o.print(", ");

   496

   497

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

   498

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

   499

  s4o.print(", ");

   500

   501

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

   502

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

   503

  s4o.print(", ");

   504

   505

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

   506

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