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

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

    21

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

    22

 *

    23

 * Based on the

    24

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

    25

 *

    26

 */

    27

    28

    29

/*

    30

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

    31

 *

    32

 * This is part of the 4th stage that generates

    33

 * a C source program equivalent to the IL and ST, or SFC

    34

 * code.

    35

 */

    36

    37

    38

    39

#include "../../util/strdup.hh"

    40

    41

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

    42

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

    43

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

    44

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

    45

    46

    47

class generate_c_st_c: public generate_c_typedecl_c {

    48

    49

  public:

    50

    typedef enum {

    51

      expression_vg,

    52

      assignment_vg,

    53

      complextype_base_vg,

    54

      complextype_base_assignment_vg,

    55

      complextype_suffix_vg,

    56

      fparam_output_vg

    57

    } variablegeneration_t;

    58

    59

    typedef enum {

    60

      single_cg,

    61

      subrange_cg,

    62

      none_cg

    63

    } casegeneration_t;

    64

    65

  private:

    66

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

    67

     * by searching through the declarations of the variables currently

    68

     * in scope.

    69

     * This class does just that...

    70

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

    71

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

    72

     * This object instance will then later be called while the

    73

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

    74

     *

    75

     * Note that functions cannot contain calls to function blocks,

    76

     * so we do not create an object instance when handling

    77

     * a function declaration.

    78

     */

    79

    search_fb_instance_decl_c *search_fb_instance_decl;

    80

    81

    search_varfb_instance_type_c *search_varfb_instance_type;

    82

    search_var_instance_decl_c   *search_var_instance_decl;

    83

    84

    symbol_c* current_array_type;

    85

    symbol_c* current_param_type;

    86

    87

    int fcall_number;

    88

    symbol_c *fbname;

    89

    90

    bool first_subrange_case_list;

    91

    92

    variablegeneration_t wanted_variablegeneration;

    93

    casegeneration_t wanted_casegeneration;

    94

    95

  public:

    96

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

    97

    : generate_c_typedecl_c(s4o_ptr) {

    98

      search_fb_instance_decl    = new search_fb_instance_decl_c   (scope);

    99

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

   100

      search_var_instance_decl   = new search_var_instance_decl_c  (scope);

   101

   102

      this->set_variable_prefix(variable_prefix);

   103

      current_array_type = NULL;

   104

      current_param_type = NULL;

   105

      fcall_number = 0;

   106

      fbname = name;

   107

      wanted_variablegeneration = expression_vg;

   108

      wanted_casegeneration = none_cg;

   109

    }

   110

   111

    virtual ~generate_c_st_c(void) {

   112

      delete search_fb_instance_decl;

   113

      delete search_varfb_instance_type;

   114

      delete search_var_instance_decl;

   115

    }

   116

   117

   118

  public:

   119

    void generate(statement_list_c *stl) {

   120

      stl->accept(*this);

   121

    }

   122

   123

  private:

   124

   125

   126

   127

   128

   129

   130

void *print_getter(symbol_c *symbol) {

   131

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

   132

  if (wanted_variablegeneration == fparam_output_vg) {

   133

    if (vartype == search_var_instance_decl_c::external_vt) {

   134

      if (search_var_instance_decl->type_is_fb(symbol))

   135

        s4o.print(GET_EXTERNAL_FB_BY_REF);

   136

      else

   137

        s4o.print(GET_EXTERNAL_BY_REF);

   138

    }

   139

    else if (vartype == search_var_instance_decl_c::located_vt)

   140

      s4o.print(GET_LOCATED_BY_REF);

   141

    else

   142

      s4o.print(GET_VAR_BY_REF);

   143

  }

   144

  else {

   145

    if (vartype == search_var_instance_decl_c::external_vt) {

   146

      if (search_var_instance_decl->type_is_fb(symbol))

   147

        s4o.print(GET_EXTERNAL_FB);

   148

      else

   149

        s4o.print(GET_EXTERNAL);

   150

    }

   151

    else if (vartype == search_var_instance_decl_c::located_vt)

   152

      s4o.print(GET_LOCATED);

   153

    else

   154

      s4o.print(GET_VAR);

   155

  }

   156

  s4o.print("(");

   157

   158

  variablegeneration_t old_wanted_variablegeneration = wanted_variablegeneration;

   159

  wanted_variablegeneration = complextype_base_vg;

   160

  symbol->accept(*this);

   161

  if (search_var_instance_decl->type_is_complex(symbol))

   162

    s4o.print(",");

   163

  wanted_variablegeneration = complextype_suffix_vg;

   164

  symbol->accept(*this);

   165

  s4o.print(")");

   166

  wanted_variablegeneration = old_wanted_variablegeneration;

   167

  return NULL;

   168

}

   169

   170

void *print_setter(symbol_c* symbol,

   171

        symbol_c* type,

   172

        symbol_c* value,

   173

        symbol_c* fb_symbol = NULL,

   174

        symbol_c* fb_value = NULL) {

   175

   176

  bool type_is_complex = false;

   177

  if (fb_symbol == NULL) {

   178

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

   179

    type_is_complex = search_var_instance_decl->type_is_complex(symbol);

   180

    if (vartype == search_var_instance_decl_c::external_vt) {

   181

      if (search_var_instance_decl->type_is_fb(symbol))

   182

        s4o.print(SET_EXTERNAL_FB);

   183

      else

   184

        s4o.print(SET_EXTERNAL);

   185

    }

   186

    else if (vartype == search_var_instance_decl_c::located_vt)

   187

      s4o.print(SET_LOCATED);

   188

    else

   189

      s4o.print(SET_VAR);

   190

  }

   191

  else {

   192

    unsigned int vartype = search_var_instance_decl->get_vartype(fb_symbol);

   193

    if (vartype == search_var_instance_decl_c::external_vt)

   194

      s4o.print(SET_EXTERNAL_FB);

   195

    else

   196

      s4o.print(SET_VAR);

   197

  }

   198

  s4o.print("(");

   199

   200

  if (fb_symbol != NULL) {

   201

    print_variable_prefix();

   202

    fb_symbol->accept(*this);

   203

    s4o.print(".,");

   204

  }

   205

  else if (type_is_complex)

   206

    wanted_variablegeneration = complextype_base_assignment_vg;

   207

  else

   208

    wanted_variablegeneration = assignment_vg;

   209

   210

  symbol->accept(*this);

   211

  s4o.print(",");

   212

  wanted_variablegeneration = expression_vg;

   213

  print_check_function(type, value, fb_value);

   214

  if (type_is_complex) {

   215

    s4o.print(",");

   216

    wanted_variablegeneration = complextype_suffix_vg;

   217

    symbol->accept(*this);

   218

  }

   219

  s4o.print(")");

   220

  wanted_variablegeneration = expression_vg;

   221

  return NULL;

   222

}

   223

   224

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

   225

/* B 1.3.3 - Derived data types */

   226

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

   227

   228

/*  signed_integer DOTDOT signed_integer */

   229

void *visit(subrange_c *symbol) {

   230

  switch (wanted_casegeneration) {

   231

    case subrange_cg:

   232

      s4o.print("__case_expression >= ");

   233

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

   234

      s4o.print(" && __case_expression <= ");

   235

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

   236

      break;

   237

    default:

   238

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

   239

      break;

   240

  }

   241

  return NULL;

   242

}

   243

   244

/* ARRAY '[' array_subrange_list ']' OF non_generic_type_name */

   245

void *visit(array_specification_c *symbol) {

   246

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

   247

  return NULL;

   248

}

   249

   250

/*  enumerated_type_name ':' enumerated_spec_init */

   251

void *visit(enumerated_type_declaration_c *symbol) {

   252

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

   253

  return NULL;

   254

}

   255

   256

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

   257

/* B 1.4 - Variables */

   258

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

   259

void *visit(symbolic_variable_c *symbol) {

   260

  switch (wanted_variablegeneration) {

   261

    case complextype_base_assignment_vg:

   262

    case assignment_vg:

   263

      this->print_variable_prefix();

   264

      s4o.print(",");

   265

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

   266

      break;

   267

    case complextype_base_vg:

   268

      generate_c_base_c::visit(symbol);

   269

      break;

   270

    case complextype_suffix_vg:

   271

      break;

   272

    default:

   273

      if (this->is_variable_prefix_null()) {

   274

        if (wanted_variablegeneration == fparam_output_vg) {

   275

          s4o.print("&(");

   276

          generate_c_base_c::visit(symbol);

   277

          s4o.print(")");

   278

        }

   279

        else {

   280

          generate_c_base_c::visit(symbol);

   281

        }

   282

      }

   283

      else

   284

        print_getter(symbol);

   285

      break;

   286

  }

   287

  return NULL;

   288

}

   289

   290

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

   291

/* B.1.4.1   Directly Represented Variables */

   292

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

   293

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

   294

void *visit(direct_variable_c *symbol) {

   295

  TRACE("direct_variable_c");

   296

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

   297

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

   298

  if (this->is_variable_prefix_null()) {

   299

    if (wanted_variablegeneration != fparam_output_vg)

   300

      s4o.print("*(");

   301

  }

   302

  else {

   303

    switch (wanted_variablegeneration) {

   304

      case expression_vg:

   305

        s4o.print(GET_LOCATED);

   306

        s4o.print("(");

   307

        break;

   308

      case fparam_output_vg:

   309

        s4o.print(GET_LOCATED_BY_REF);

   310

        s4o.print("(");

   311

        break;

   312

      default:

   313

        break;

   314

    }

   315

  }

   316

  this->print_variable_prefix();

   317

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

   318

  if ((this->is_variable_prefix_null() && wanted_variablegeneration != fparam_output_vg) ||

   319

      wanted_variablegeneration != assignment_vg)

   320

    s4o.print(")");

   321

  return NULL;

   322

}

   323

   324

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

   325

/* B.1.4.2   Multi-element Variables */

   326

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

   327

   328

// SYM_REF2(structured_variable_c, record_variable, field_selector)

   329

void *visit(structured_variable_c *symbol) {

   330

  TRACE("structured_variable_c");

   331

  bool type_is_complex = search_var_instance_decl->type_is_complex(symbol->record_variable);

   332

  switch (wanted_variablegeneration) {

   333

    case complextype_base_vg:

   334

    case complextype_base_assignment_vg:

   335

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

   336

      if (!type_is_complex) {

   337

        s4o.print(".");

   338

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

   339

      }

   340

      break;

   341

    case complextype_suffix_vg:

   342

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

   343

      if (type_is_complex) {

   344

        s4o.print(".");

   345

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

   346

      }

   347

      break;

   348

    case assignment_vg:

   349

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

   350

      s4o.print(".");

   351

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

   352

      break;

   353

    default:

   354

      if (this->is_variable_prefix_null()) {

   355

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

   356

        s4o.print(".");

   357

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

   358

      }

   359

      else

   360

        print_getter(symbol);

   361

      break;

   362

  }

   363

  return NULL;

   364

}

   365

   366

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

   367

//SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   368

void *visit(array_variable_c *symbol) {

   369

  switch (wanted_variablegeneration) {

   370

    case complextype_base_vg:

   371

    case complextype_base_assignment_vg:

   372

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

   373

      break;

   374

    case complextype_suffix_vg:

   375

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

   376

   377

      current_array_type = search_varfb_instance_type->get_basetype_decl(symbol->subscripted_variable);

   378

      if (current_array_type == NULL) ERROR;

   379

   380

      s4o.print(".table");

   381

      wanted_variablegeneration = expression_vg;

   382

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

   383

      wanted_variablegeneration = complextype_suffix_vg;

   384

   385

      current_array_type = NULL;

   386

      break;

   387

    default:

   388

      if (this->is_variable_prefix_null()) {

   389

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

   390

   391

        current_array_type = search_varfb_instance_type->get_basetype_decl(symbol->subscripted_variable);

   392

        if (current_array_type == NULL) ERROR;

   393

   394

        s4o.print(".table");

   395

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

   396

   397

        current_array_type = NULL;

   398

      }

   399

      else

   400

        print_getter(symbol);

   401

      break;

   402

  }

   403

  return NULL;

   404

}

   405

   406

/* subscript_list ',' subscript */

   407

void *visit(subscript_list_c *symbol) {

   408

  array_dimension_iterator_c* array_dimension_iterator = new array_dimension_iterator_c(current_array_type);

   409

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

   410

    symbol_c* dimension = array_dimension_iterator->next();

   411

    if (dimension == NULL) ERROR;

   412

   413

    s4o.print("[(");

   414

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

   415

    s4o.print(") - (");

   416

    dimension->accept(*this);

   417

    s4o.print(")]");

   418

  }

   419

  delete array_dimension_iterator;

   420

  return NULL;

   421

}

   422

   423

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

   424

/* B 1.4.3 - Declaration & Initialisation */

   425

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

   426

   427

/* helper symbol for structure_initialization */

   428

/* structure_element_initialization_list ',' structure_element_initialization */

   429

void *visit(structure_element_initialization_list_c *symbol) {

   430

  generate_c_structure_initialization_c *structure_initialization = new generate_c_structure_initialization_c(&s4o);

   431

  structure_initialization->init_structure_default(this->current_param_type);

   432

  structure_initialization->init_structure_values(symbol);

   433

  delete structure_initialization;

   434

  return NULL;

   435

}

   436

   437

/* helper symbol for array_initialization */

   438

/* array_initial_elements_list ',' array_initial_elements */

   439

void *visit(array_initial_elements_list_c *symbol) {

   440

  generate_c_array_initialization_c *array_initialization = new generate_c_array_initialization_c(&s4o);

   441

  array_initialization->init_array_size(this->current_param_type);

   442

  array_initialization->init_array_values(symbol);

   443

  delete array_initialization;

   444

  return NULL;

   445

}

   446

   447

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

   448

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

   449

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

   450

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

   451

/* B 3.1 - Expressions */

   452

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

   453

void *visit(or_expression_c *symbol) {

   454

  if (get_datatype_info_c::is_BOOL_compatible(symbol->datatype))

   455

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

   456

  if (get_datatype_info_c::is_ANY_nBIT_compatible(symbol->datatype))

   457

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

   458

  ERROR;

   459

  return NULL;

   460

}

   461

   462

void *visit(xor_expression_c *symbol) {

   463

  if (get_datatype_info_c::is_BOOL_compatible(symbol->datatype)) {

   464

    s4o.print("(");

   465

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

   466

    s4o.print(" && !");

   467

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

   468

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

   469

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

   470

    s4o.print(" && ");

   471

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

   472

    s4o.print(")");

   473

    return NULL;

   474

  }

   475

  if (get_datatype_info_c::is_ANY_nBIT_compatible(symbol->datatype))

   476

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

   477

  ERROR;

   478

  return NULL;

   479

}

   480

   481

void *visit(and_expression_c *symbol) {

   482

  if (get_datatype_info_c::is_BOOL_compatible(symbol->datatype))

   483

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

   484

  if (get_datatype_info_c::is_ANY_nBIT_compatible(symbol->datatype))

   485

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

   486

  ERROR;

   487

return NULL;

   488

}

   489

   490

void *visit(equ_expression_c *symbol) {

   491

  if (get_datatype_info_c::is_TIME_compatible      (symbol->l_exp->datatype) ||

   492

      get_datatype_info_c::is_ANY_DATE_compatible  (symbol->l_exp->datatype) ||

   493

      get_datatype_info_c::is_ANY_STRING_compatible(symbol->l_exp->datatype))