1

/*

     2

 * (c) 2003 Mario de Sousa

     3

 *

     4

 * Offered to the public under the terms of the GNU General Public License

     5

 * as published by the Free Software Foundation; either version 2 of the

     6

 * License, or (at your option) any later version.

     7

 *

     8

 * This program is distributed in the hope that it will be useful, but

     9

 * WITHOUT ANY WARRANTY; without even the implied warranty of

    10

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General

    11

 * Public License for more details.

    12

 *

    13

 * This code is made available on the understanding that it will not be

    14

 * used in safety-critical situations without a full and competent review.

    15

 */

    16

    17

/*

    18

 * An IEC 61131-3 IL and ST compiler.

    19

 *

    20

 * Based on the

    21

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    22

 *

    23

 */

    24

    25

    26

/*

    27

 * Conversion of st statements (i.e. ST code).

    28

 *

    29

 * This is part of the 4th stage that generates

    30

 * a c++ source program equivalent to the IL and ST

    31

 * code.

    32

 */

    33

    34

    35

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

    36

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

    37

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

    38

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

    39

    40

    41

class generate_c_st_c: public generate_c_typedecl_c {

    42

    43

  private:

    44

    /* When calling a function block, we must first find it's type,

    45

     * by searching through the declarations of the variables currently

    46

     * in scope.

    47

     * This class does just that...

    48

     * A new class is instantiated whenever we begin generating the code

    49

     * for a function block type declaration, or a program declaration.

    50

     * This object instance will then later be called while the

    51

     * function block's or the program's body is being handled.

    52

     *

    53

     * Note that functions cannot contain calls to function blocks,

    54

     * so we do not create an object instance when handling

    55

     * a function declaration.

    56

     */

    57

    search_fb_instance_decl_c *search_fb_instance_decl;

    58

    59

    /* When compiling st code, it becomes necessary to determine the

    60

     * data type of st expressions. To do this, we must first find the

    61

     * st operand's declaration, within the scope of the function block

    62

     * or function currently being processed.

    63

     * The following object does just that...

    64

     * This object instance will then later be called while the

    65

     * remaining st code is being handled.

    66

     */

    67

    search_expression_type_c *search_expression_type;

    68

    69

    search_varfb_instance_type_c *search_varfb_instance_type;

    70

    71

    search_base_type_c search_base_type;

    72

    73

    symbol_c* current_array_type;

    74

    75

    bool current_param_is_pointer;

    76

    77

  public:

    78

    generate_c_st_c(stage4out_c *s4o_ptr, symbol_c *scope, const char *variable_prefix = NULL)

    79

    : generate_c_typedecl_c(s4o_ptr) {

    80

      search_fb_instance_decl = new search_fb_instance_decl_c(scope);

    81

      search_expression_type = new search_expression_type_c(scope);

    82

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

    83

      this->set_variable_prefix(variable_prefix);

    84

      current_array_type = NULL;

    85

      current_param_is_pointer = false;

    86

    }

    87

    88

    virtual ~generate_c_st_c(void) {

    89

      delete search_fb_instance_decl;

    90

      delete search_expression_type;

    91

      delete search_varfb_instance_type;

    92

    }

    93

    94

    95

  public:

    96

    void generate(statement_list_c *stl) {

    97

      stl->accept(*this);

    98

    }

    99

   100

  private:

   101

   102

   103

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

   104

/* B 1.4 - Variables */

   105

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

   106

void *visit(symbolic_variable_c *symbol) {

   107

  unsigned int vartype = search_varfb_instance_type->get_vartype(symbol);

   108

  if (!current_param_is_pointer && (vartype == search_var_instance_decl_c::external_vt || vartype == search_var_instance_decl_c::located_vt)) {

   109

    s4o.print("*(");

   110

    generate_c_base_c::visit(symbol);

   111

    s4o.print(")");

   112

  }

   113

  else if (current_param_is_pointer && vartype != search_var_instance_decl_c::external_vt && vartype != search_var_instance_decl_c::located_vt) {

   114

    s4o.print("&(");

   115

    generate_c_base_c::visit(symbol);

   116

    s4o.print(")");

   117

  }

   118

  else {

   119

    generate_c_base_c::visit(symbol);

   120

  }

   121

  return NULL;

   122

}

   123

   124

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

   125

/* B.1.4.1   Directly Represented Variables */

   126

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

   127

// direct_variable: direct_variable_token   {$$ = new direct_variable_c($1);};

   128

void *visit(direct_variable_c *symbol) {

   129

  TRACE("direct_variable_c");

   130

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

   131

  if (strlen(symbol->value) == 0) ERROR;

   132

  if (!current_param_is_pointer) {

   133

    s4o.print("*(");

   134

  }

   135

  this->print_variable_prefix();

   136

  s4o.printlocation(symbol->value + 1);

   137

  if (!current_param_is_pointer) {

   138

    s4o.print(")");

   139

  }

   140

  return NULL;

   141

}

   142

   143

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

   144

/* B.1.4.2   Multi-element Variables */

   145

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

   146

   147

/*  subscripted_variable '[' subscript_list ']' */

   148

//SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   149

void *visit(array_variable_c *symbol) {

   150

  current_array_type = search_varfb_instance_type->get_type(symbol->subscripted_variable, false);

   151

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

   152

  if (current_array_type != NULL) {

   153

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

   154

    current_array_type = NULL;

   155

  }

   156

  return NULL;

   157

}

   158

   159

/* subscript_list ',' subscript */

   160

void *visit(subscript_list_c *symbol) {

   161

  for (int i =  0; i < symbol->n; i++) {

   162

    s4o.print("[__");

   163

    current_array_type->accept(*this);

   164

    s4o.print("_TRANSIDX");

   165

    print_integer(i);

   166

    s4o.print("(");

   167

    symbol->elements[i]->accept(*this);

   168

    s4o.print(")]");

   169

  }

   170

  return NULL;

   171

}

   172

   173

   174

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

   175

/* B.3 - Language ST (Structured Text) */

   176

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

   177

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

   178

/* B 3.1 - Expressions */

   179

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

   180

void *visit(or_expression_c *symbol) {

   181

  symbol_c *left_type = search_expression_type->get_type(symbol->l_exp);

   182

  symbol_c *right_type = search_expression_type->get_type(symbol->r_exp);

   183

  if (!search_expression_type->is_same_type(left_type, right_type))

   184

      ERROR;

   185

  if (search_expression_type->is_bool_type(left_type))

   186

    return print_binary_expression(symbol->l_exp, symbol->r_exp, " || ");

   187

  if (search_expression_type->is_binary_type(left_type))

   188

    return print_binary_expression(symbol->l_exp, symbol->r_exp, " | ");

   189

  ERROR;

   190

  return NULL;

   191

}

   192

   193

void *visit(xor_expression_c *symbol) {

   194

  symbol_c *left_type = search_expression_type->get_type(symbol->l_exp);

   195

  symbol_c *right_type = search_expression_type->get_type(symbol->r_exp);

   196

  if (!search_expression_type->is_same_type(left_type, right_type))

   197

      ERROR;

   198

  if (search_expression_type->is_bool_type(left_type)) {

   199

    s4o.print("(");

   200

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

   201

    s4o.print(" && !");

   202

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

   203

    s4o.print(") || (!");

   204

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

   205

    s4o.print(" && ");

   206

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

   207

    s4o.print(")");

   208

    return NULL;

   209

  }

   210

  if (search_expression_type->is_binary_type(left_type))

   211

    return print_binary_expression(symbol->l_exp, symbol->r_exp, " ^ ");

   212

  ERROR;

   213

  return NULL;

   214

}

   215

   216

void *visit(and_expression_c *symbol) {

   217

  symbol_c *left_type = search_expression_type->get_type(symbol->l_exp);

   218

  symbol_c *right_type = search_expression_type->get_type(symbol->r_exp);

   219

  if (!search_expression_type->is_same_type(left_type, right_type))

   220

      ERROR;

   221

  if (search_expression_type->is_bool_type(left_type))

   222

    return print_binary_expression(symbol->l_exp, symbol->r_exp, " && ");

   223

  if (search_expression_type->is_binary_type(left_type))

   224

    return print_binary_expression(symbol->l_exp, symbol->r_exp, " & ");

   225

  ERROR;

   226

  return NULL;

   227

}

   228

   229

void *visit(equ_expression_c *symbol) {

   230

  symbol_c *left_type = search_expression_type->get_type(symbol->l_exp);

   231

  symbol_c *right_type = search_expression_type->get_type(symbol->r_exp);

   232

  if (!search_expression_type->is_same_type(left_type, right_type))

   233

      ERROR;

   234

  if (search_expression_type->is_time_type(left_type) ||

   235

      search_expression_type->is_string_type(left_type))

   236

    return print_compare_function("__eq_", left_type, symbol->l_exp, symbol->r_exp);

   237

  return print_binary_expression(symbol->l_exp, symbol->r_exp, " == ");

   238

}

   239

   240

void *visit(notequ_expression_c *symbol) {

   241

  symbol_c *left_type = search_expression_type->get_type(symbol->l_exp);

   242

  symbol_c *right_type = search_expression_type->get_type(symbol->r_exp);

   243

  if (!search_expression_type->is_same_type(left_type, right_type))

   244

      ERROR;

   245

  if (search_expression_type->is_time_type(left_type) ||

   246

      search_expression_type->is_string_type(left_type))

   247

    return print_compare_function("__ne_", left_type, symbol->l_exp, symbol->r_exp);

   248

  return print_binary_expression(symbol->l_exp, symbol->r_exp, " != ");

   249

}

   250

   251

void *visit(lt_expression_c *symbol) {

   252

  symbol_c *left_type = search_expression_type->get_type(symbol->l_exp);

   253

  symbol_c *right_type = search_expression_type->get_type(symbol->r_exp);

   254

  if (!search_expression_type->is_same_type(left_type, right_type))

   255

      ERROR;

   256

  if (search_expression_type->is_time_type(left_type) ||

   257

      search_expression_type->is_string_type(left_type))

   258

    return print_compare_function("__lt_", left_type, symbol->l_exp, symbol->r_exp);

   259

  if (!search_base_type.type_is_enumerated(left_type))

   260

    return print_binary_expression(symbol->l_exp, symbol->r_exp, " < ");

   261

  ERROR;

   262

  return NULL;

   263

}

   264

   265

void *visit(gt_expression_c *symbol) {

   266

  symbol_c *left_type = search_expression_type->get_type(symbol->l_exp);

   267

  symbol_c *right_type = search_expression_type->get_type(symbol->r_exp);

   268

  if (!search_expression_type->is_same_type(left_type, right_type))

   269

      ERROR;

   270

  if (search_expression_type->is_time_type(left_type) ||

   271

      search_expression_type->is_string_type(left_type))

   272

    return print_compare_function("__gt_", left_type, symbol->l_exp, symbol->r_exp);

   273

  if (!search_base_type.type_is_enumerated(left_type))

   274

    return print_binary_expression(symbol->l_exp, symbol->r_exp, " > ");

   275

  ERROR;

   276

  return NULL;

   277

}

   278

   279

void *visit(le_expression_c *symbol) {

   280

  symbol_c *left_type = search_expression_type->get_type(symbol->l_exp);

   281

  symbol_c *right_type = search_expression_type->get_type(symbol->r_exp);

   282

  if (!search_expression_type->is_same_type(left_type, right_type))

   283

      ERROR;

   284

  if (search_expression_type->is_time_type(left_type) ||

   285

      search_expression_type->is_string_type(left_type))

   286

    return print_compare_function("__le_", left_type, symbol->l_exp, symbol->r_exp);

   287

  if (!search_base_type.type_is_enumerated(left_type))

   288

    return print_binary_expression(symbol->l_exp, symbol->r_exp, " <= ");

   289

  ERROR;

   290

  return NULL;

   291

}

   292

   293

void *visit(ge_expression_c *symbol) {

   294

  symbol_c *left_type = search_expression_type->get_type(symbol->l_exp);

   295

  symbol_c *right_type = search_expression_type->get_type(symbol->r_exp);

   296

  if (!search_expression_type->is_same_type(left_type, right_type))

   297

      ERROR;

   298

  if (search_expression_type->is_time_type(left_type) ||

   299

      search_expression_type->is_string_type(left_type))

   300

    return print_compare_function("__ge_", left_type, symbol->l_exp, symbol->r_exp);

   301

  if (!search_base_type.type_is_enumerated(left_type))

   302

    return print_binary_expression(symbol->l_exp, symbol->r_exp, " >= ");

   303

  ERROR;

   304

  return NULL;

   305

}

   306

   307

void *visit(add_expression_c *symbol) {

   308

  symbol_c *left_type = search_expression_type->get_type(symbol->l_exp);

   309

	symbol_c *right_type = search_expression_type->get_type(symbol->r_exp);

   310

	if ((typeid(*left_type) == typeid(time_type_name_c) && typeid(*right_type) == typeid(time_type_name_c)) ||

   311

      (typeid(*left_type) == typeid(tod_type_name_c) && typeid(*right_type) == typeid(time_type_name_c)) ||

   312

      (typeid(*left_type) == typeid(dt_type_name_c) && typeid(*right_type) == typeid(time_type_name_c)))

   313

    return print_binary_function("__TIME_ADD", symbol->l_exp, symbol->r_exp);

   314

  if (!search_expression_type->is_same_type(left_type, right_type))

   315

      ERROR;

   316

  if (search_expression_type->is_integer_type(left_type) || search_expression_type->is_real_type(left_type))

   317

    return print_binary_expression(symbol->l_exp, symbol->r_exp, " + ");

   318

  ERROR;

   319

  return NULL;

   320

}

   321

   322

void *visit(sub_expression_c *symbol) {

   323

  symbol_c *left_type = search_expression_type->get_type(symbol->l_exp);

   324

  symbol_c *right_type = search_expression_type->get_type(symbol->r_exp);

   325

  if ((typeid(*left_type) == typeid(time_type_name_c) && typeid(*right_type) == typeid(time_type_name_c)) ||

   326

      (typeid(*left_type) == typeid(date_type_name_c) && typeid(*right_type) == typeid(date_type_name_c)) ||

   327

      (typeid(*left_type) == typeid(tod_type_name_c) && typeid(*right_type) == typeid(time_type_name_c)) ||

   328

      (typeid(*left_type) == typeid(tod_type_name_c) && typeid(*right_type) == typeid(tod_type_name_c)) ||

   329

      (typeid(*left_type) == typeid(dt_type_name_c) && typeid(*right_type) == typeid(time_type_name_c)) ||

   330

      (typeid(*left_type) == typeid(dt_type_name_c) && typeid(*right_type) == typeid(dt_type_name_c)))

   331

    return print_binary_function("__TIME_SUB", symbol->l_exp, symbol->r_exp);

   332

  if (!search_expression_type->is_same_type(left_type, right_type))

   333

      ERROR;

   334

  if (search_expression_type->is_integer_type(left_type) || search_expression_type->is_real_type(left_type))

   335

    return print_binary_expression(symbol->l_exp, symbol->r_exp, " - ");

   336

  ERROR;

   337

  return NULL;

   338

}

   339

   340

void *visit(mul_expression_c *symbol) {

   341

  symbol_c *left_type = search_expression_type->get_type(symbol->l_exp);

   342

  symbol_c *right_type = search_expression_type->get_type(symbol->r_exp);

   343

  if ((typeid(*left_type) == typeid(time_type_name_c) && search_expression_type->is_integer_type(right_type)) ||

   344

      (typeid(*left_type) == typeid(time_type_name_c) && search_expression_type->is_real_type(right_type)))

   345

    return print_binary_function("__TIME_MUL", symbol->l_exp, symbol->r_exp);

   346

  if (!search_expression_type->is_same_type(left_type, right_type))

   347

      ERROR;

   348

  if (search_expression_type->is_integer_type(left_type) || search_expression_type->is_real_type(left_type))

   349

    return print_binary_expression(symbol->l_exp, symbol->r_exp, " * ");

   350

  ERROR;

   351

  return NULL;

   352

}

   353

   354

void *visit(div_expression_c *symbol) {

   355

  symbol_c *left_type = search_expression_type->get_type(symbol->l_exp);

   356

  symbol_c *right_type = search_expression_type->get_type(symbol->r_exp);

   357

  if ((typeid(*left_type) == typeid(time_type_name_c) && search_expression_type->is_integer_type(right_type)) ||

   358

      (typeid(*left_type) == typeid(time_type_name_c) && search_expression_type->is_real_type(right_type)))

   359

    return print_binary_function("__TIME_DIV", symbol->l_exp, symbol->r_exp);

   360

  if (!search_expression_type->is_same_type(left_type, right_type))

   361

      ERROR;

   362

  if (search_expression_type->is_integer_type(left_type) || search_expression_type->is_real_type(left_type))

   363

    return print_binary_expression(symbol->l_exp, symbol->r_exp, " / ");

   364

  ERROR;

   365

  return NULL;

   366

}

   367

   368

void *visit(mod_expression_c *symbol) {

   369

  symbol_c *left_type = search_expression_type->get_type(symbol->l_exp);

   370

  symbol_c *right_type = search_expression_type->get_type(symbol->r_exp);

   371

  if (!search_expression_type->is_same_type(left_type, right_type))

   372

      ERROR;

   373

  if (search_expression_type->is_integer_type(left_type) || search_expression_type->is_real_type(left_type)) {

   374

    s4o.print("((");

   375

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

   376

    s4o.print(" == 0)?0:");

   377

    print_binary_expression(symbol->l_exp, symbol->r_exp, " % ");

   378

    s4o.print(")");

   379

    return NULL;

   380

  }

   381

  ERROR;

   382

  return NULL;

   383

}

   384

   385

/* TODO: power expression... */

   386

void *visit(power_expression_c *symbol) {ERROR; return print_binary_expression(symbol->l_exp, symbol->r_exp, " ** ");}

   387

void *visit(neg_expression_c *symbol) {

   388

  symbol_c *exp_type = search_expression_type->get_type(symbol->exp);

   389

  if (search_expression_type->is_integer_type(exp_type) || search_expression_type->is_real_type(exp_type))

   390

    return print_unary_expression(symbol->exp, " -");

   391

  ERROR;

   392

  return NULL;

   393

}

   394

   395

void *visit(not_expression_c *symbol) {

   396

  symbol_c *exp_type = search_expression_type->get_type(symbol->exp);

   397

  if (search_expression_type->is_binary_type(exp_type))

   398

    return print_unary_expression(symbol->exp, search_expression_type->is_bool_type(exp_type)?"!":"~");

   399

  ERROR;

   400

  return NULL;

   401

}

   402

   403

void *visit(function_invocation_c *symbol) {

   404

  symbol_c* function_type_prefix = NULL;

   405

  symbol_c* function_name = NULL;

   406

  symbol_c* function_type_suffix = NULL;

   407

  std::list<FUNCTION_PARAM> param_list;

   408

  FUNCTION_PARAM *param;

   409

   410

  symbol_c *parameter_assignment_list = NULL;

   411

  if (NULL != symbol->   formal_param_list) parameter_assignment_list = symbol->   formal_param_list;

   412

  if (NULL != symbol->nonformal_param_list) parameter_assignment_list = symbol->nonformal_param_list;

   413

  if (NULL == parameter_assignment_list) ERROR;

   414

   415

  function_declaration_c *f_decl = function_symtable.find_value(symbol->function_name);

   416

  if (f_decl == function_symtable.end_value()) {

   417

    /* The function called is not in the symtable, so we test if it is a

   418

     * standard function defined in standard */

   419

   420

    function_type_t current_function_type = get_function_type((identifier_c *)symbol->function_name);

   421

    if (current_function_type == function_none) ERROR;

   422

   423

    symbol_c *function_return_type = search_expression_type->get_type(symbol);

   424

   425

    function_call_param_iterator_c function_call_param_iterator(symbol);

   426

   427

    int nb_param = ((list_c *)parameter_assignment_list)->n;

   428

   429

    identifier_c en_param_name("EN");

   430

    /* Get the value from EN param */

   431

    symbol_c *EN_param_value = function_call_param_iterator.search_f(&en_param_name);

   432

    if (EN_param_value == NULL)

   433

      EN_param_value = (symbol_c*)(new boolean_literal_c((symbol_c*)(new bool_type_name_c()), new boolean_true_c()));

   434

    else

   435

      nb_param --;

   436

    ADD_PARAM_LIST(EN_param_value, (symbol_c*)(new bool_type_name_c()), function_param_iterator_c::direction_in)

   437

   438

    identifier_c eno_param_name("ENO");

   439

    /* Get the value from ENO param */

   440

    symbol_c *ENO_param_value = function_call_param_iterator.search_f(&eno_param_name);

   441

    if (ENO_param_value != NULL)

   442

      nb_param --;

   443

    ADD_PARAM_LIST(ENO_param_value, (symbol_c*)(new bool_type_name_c()), function_param_iterator_c::direction_out)

   444

   445

    #include "st_code_gen.c"

   446

   447

  }

   448

  else {

   449

    /* loop through each function parameter, find the value we should pass

   450

     * to it, and then output the c equivalent...

   451

     */

   452

    function_param_iterator_c fp_iterator(f_decl);

   453

   454

    function_name = symbol->function_name;

   455

   456

    identifier_c *param_name;

   457

    function_call_param_iterator_c function_call_param_iterator(symbol);

   458

    for(int i = 1; (param_name = fp_iterator.next()) != NULL; i++) {

   459

   460

      function_param_iterator_c::param_direction_t param_direction = fp_iterator.param_direction();

   461

   462

      /* Get the value from a foo(<param_name> = <param_value>) style call */

   463

      symbol_c *param_value = function_call_param_iterator.search_f(param_name);

   464

   465

      /* Get the value from a foo(<param_value>) style call */

   466

      if (param_value == NULL)

   467

        param_value = function_call_param_iterator.next_nf();

   468

   469

      if (param_value == NULL && param_direction == function_param_iterator_c::direction_in) {

   470

        /* No value given for parameter, so we must use the default... */

   471

        /* First check whether default value specified in function declaration...*/

   472

        param_value = fp_iterator.default_value();

   473

      }

   474

   475

      symbol_c *param_type = fp_iterator.param_type();

   476

      if (param_type == NULL) ERROR;

   477

   478

      ADD_PARAM_LIST(param_value, param_type, param_direction)

   479

    } /* for(...) */

   480

    // symbol->parameter_assignment->accept(*this);

   481

  }

   482

   483

  if (function_type_prefix != NULL) {

   484

    s4o.print("(");

   485

    function_type_prefix->accept(*this);

   486

    s4o.print(")");

   487

  }

   488

  if (function_name != NULL)

   489

    function_name->accept(*this);

   490

  if (function_type_suffix != NULL)

   491

    function_type_suffix->accept(*this);

   492

  s4o.print("(");

   493

  s4o.indent_right();

   494

   495

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

   496

  for(pt = param_list.begin(); pt != param_list.end(); pt++) {

   497

    if (pt != param_list.begin())

   498

      s4o.print(",\n"+s4o.indent_spaces);

   499

    symbol_c *param_value = pt->param_value;

   500

    symbol_c *param_type = pt->param_type;

   501

   502

    switch (pt->param_direction) {

   503

      case function_param_iterator_c::direction_in:

   504

        if (param_value == NULL) {

   505

          /* If not, get the default value of this variable's type */

   506

          param_value = (symbol_c *)param_type->accept(*type_initial_value_c::instance());

   507

        }

   508

        if (param_value == NULL) ERROR;

   509

        if (search_base_type.type_is_subrange(param_type)) {

   510

          s4o.print("__CHECK_");

   511

          param_type->accept(*this);