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) {

   136

        s4o.print(GET_EXTERNAL_FB_BY_REF);

   137

      else

   138

        s4o.print(GET_EXTERNAL_BY_REF);

   139

    }

   140

    else if (vartype == search_var_instance_decl_c::located_vt)

   141

      s4o.print(GET_LOCATED_BY_REF);

   142

    else

   143

      s4o.print(GET_VAR_BY_REF);

   144

  }

   145

  else {

   146

    if (vartype == search_var_instance_decl_c::external_vt) {

   149

        s4o.print(GET_EXTERNAL_FB);

   150

      else

   151

        s4o.print(GET_EXTERNAL);

   152

    }

   153

    else if (vartype == search_var_instance_decl_c::located_vt)

   154

      s4o.print(GET_LOCATED);

   155

    else

   156

      s4o.print(GET_VAR);

   157

  }

   158

  s4o.print("(");

   159

   160

  variablegeneration_t old_wanted_variablegeneration = wanted_variablegeneration;

   161

  wanted_variablegeneration = complextype_base_vg;

   162

  symbol->accept(*this);

   163

  s4o.print(",");

   164

  wanted_variablegeneration = complextype_suffix_vg;

   165

  symbol->accept(*this);

   166

  s4o.print(")");

   167

  wanted_variablegeneration = old_wanted_variablegeneration;

   168

  return NULL;

   169

}

   170

   171

   172

   173

void *print_setter(symbol_c* symbol,

   174

        symbol_c* type,

   175

        symbol_c* value,

   176

        symbol_c* fb_symbol = NULL,

   177

        symbol_c* fb_value = NULL) {

   178

   179

  bool type_is_complex = false;

   180

  if (fb_symbol == NULL) {

   181

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

   182

    type_is_complex = analyse_variable_c::contains_complex_type(symbol);

   183

    if (vartype == search_var_instance_decl_c::external_vt) {

   186

        s4o.print(SET_EXTERNAL_FB);

   187

      else

   188

        s4o.print(SET_EXTERNAL);

   189

    }

   190

    else if (vartype == search_var_instance_decl_c::located_vt)

   191

      s4o.print(SET_LOCATED);

   192

    else

   193

      s4o.print(SET_VAR);

   194

  }

   195

  else {

   196

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

   197

    if (vartype == search_var_instance_decl_c::external_vt)

   198

      s4o.print(SET_EXTERNAL_FB);

   199

    else

   200

      s4o.print(SET_VAR);

   201

  }

   202

  s4o.print("(");

   203

   204

  if (fb_symbol != NULL) {

   205

    print_variable_prefix();

   206

    fb_symbol->accept(*this);

   207

    s4o.print(".,");

   208

  }

   209

  else if (type_is_complex)

   210

    wanted_variablegeneration = complextype_base_assignment_vg;

   211

  else

   212

    wanted_variablegeneration = assignment_vg;

   213

   214

  symbol->accept(*this);

   215

  s4o.print(",");

   216

  wanted_variablegeneration = expression_vg;

   217

  print_check_function(type, value, fb_value);

   218

  if (type_is_complex) {

   219

    s4o.print(",");

   220

    wanted_variablegeneration = complextype_suffix_vg;

   221

    symbol->accept(*this);

   222

  }

   223

  s4o.print(")");

   224

  wanted_variablegeneration = expression_vg;

   225

  return NULL;

   226

}

   227

   228

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

   229

/* B 1.3.3 - Derived data types */

   230

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

   231

   232

/*  signed_integer DOTDOT signed_integer */

   233

void *visit(subrange_c *symbol) {

   234

  switch (wanted_casegeneration) {

   235

    case subrange_cg:

   236

      s4o.print("__case_expression >= ");

   237

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

   238

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

   239

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

   240

      break;

   241

    default:

   242

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

   243

      break;

   244

  }

   245

  return NULL;

   246

}

   247

   248

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

   249

void *visit(array_specification_c *symbol) {

   250

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

   251

  return NULL;

   252

}

   253

   254

/*  enumerated_type_name ':' enumerated_spec_init */

   255

void *visit(enumerated_type_declaration_c *symbol) {

   256

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

   257

  return NULL;

   258

}

   259

   260

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

   261

/* B 1.4 - Variables */

   262

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

   263

void *visit(symbolic_variable_c *symbol) {

   264

  switch (wanted_variablegeneration) {

   265

    case complextype_base_assignment_vg:

   266

    case assignment_vg:

   267

      this->print_variable_prefix();

   268

      s4o.print(",");

   269

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

   270

      break;

   271

    case complextype_base_vg:

   272

      generate_c_base_c::visit(symbol);

   273

      break;

   274

    case complextype_suffix_vg:

   275

      break;

   276

    default:

   277

      if (this->is_variable_prefix_null()) {

   278

        if (wanted_variablegeneration == fparam_output_vg) {

   279

          s4o.print("&(");

   280

          generate_c_base_c::visit(symbol);

   281

          s4o.print(")");

   282

        }

   283

        else {

   284

          generate_c_base_c::visit(symbol);

   285

        }

   286

      }

   287

      else

   288

        print_getter(symbol);

   289

      break;

   290

  }

   291

  return NULL;

   292

}

   293

   294

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

   295

/* B.1.4.1   Directly Represented Variables */

   296

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

   297

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

   298

void *visit(direct_variable_c *symbol) {

   299

  TRACE("direct_variable_c");

   300

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

   301

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

   302

  if (this->is_variable_prefix_null()) {

   303

    if (wanted_variablegeneration != fparam_output_vg)

   304

      s4o.print("*(");

   305

  }

   306

  else {

   307

    switch (wanted_variablegeneration) {

   308

      case expression_vg:

   309

        s4o.print(GET_LOCATED);

   310

        s4o.print("(");

   311

        break;

   312

      case fparam_output_vg:

   313

        s4o.print(GET_LOCATED_BY_REF);

   314

        s4o.print("(");

   315

        break;

   316

      default:

   317

        break;

   318

    }

   319

  }

   320

  this->print_variable_prefix();

   321

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

   322

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

   323

      wanted_variablegeneration != assignment_vg)

   324

    s4o.print(")");

   325

  return NULL;

   326

}

   327

   328

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

   329

/* B.1.4.2   Multi-element Variables */

   330

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

   331

   332

// SYM_REF2(structured_variable_c, record_variable, field_selector)

   333

void *visit(structured_variable_c *symbol) {

   334

  TRACE("structured_variable_c");

   336

  switch (wanted_variablegeneration) {

   337

    case complextype_base_vg:

   338

    case complextype_base_assignment_vg:

   339

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

   340

      if (!type_is_complex) {

   341

        s4o.print(".");

   342

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

   343

      }

   344

      break;

   345

    case complextype_suffix_vg:

   346

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

   347

      if (type_is_complex) {

   348

        s4o.print(".");

   349

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

   350

      }

   351

      break;

   352

    case assignment_vg:

   353

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

   354

      s4o.print(".");

   355

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

   356

      break;

   357

    default:

   358

      if (this->is_variable_prefix_null()) {

   359

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

   360

        s4o.print(".");

   361

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

   362

      }

   363

      else

   364

        print_getter(symbol);

   365

      break;

   366

  }

   367

  return NULL;

   368

}

   369

   370

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

   371

//SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   372

void *visit(array_variable_c *symbol) {

   373

  switch (wanted_variablegeneration) {

   374

    case complextype_base_vg:

   375

    case complextype_base_assignment_vg:

   376

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

   377

      break;

   378

    case complextype_suffix_vg:

   379

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

   380

   381

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

   382

      if (current_array_type == NULL) ERROR;

   383

   384

      s4o.print(".table");

   385

      wanted_variablegeneration = expression_vg;

   386

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

   387

      wanted_variablegeneration = complextype_suffix_vg;

   388

   389

      current_array_type = NULL;

   390

      break;

   391

    default:

   392

      if (this->is_variable_prefix_null()) {

   393

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

   394

   395

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

   396

        if (current_array_type == NULL) ERROR;

   397

   398

        s4o.print(".table");

   399

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

   400

   401

        current_array_type = NULL;

   402

      }

   403

      else

   404

        print_getter(symbol);

   405

      break;

   406

  }

   407

  return NULL;

   408

}

   409

   410

/* subscript_list ',' subscript */

   411

void *visit(subscript_list_c *symbol) {

   412

  array_dimension_iterator_c* array_dimension_iterator = new array_dimension_iterator_c(current_array_type);

   413

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

   414

    symbol_c* dimension = array_dimension_iterator->next();

   415

    if (dimension == NULL) ERROR;

   416

   417

    s4o.print("[(");

   418

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

   419

    s4o.print(") - (");

   420

    dimension->accept(*this);

   421

    s4o.print(")]");

   422

  }

   423

  delete array_dimension_iterator;

   424

  return NULL;

   425

}

   426

   427

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

   428

/* B 1.4.3 - Declaration & Initialisation */

   429

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

   430

   431

/* helper symbol for structure_initialization */

   432

/* structure_element_initialization_list ',' structure_element_initialization */

   433

void *visit(structure_element_initialization_list_c *symbol) {

   434

  generate_c_structure_initialization_c *structure_initialization = new generate_c_structure_initialization_c(&s4o);

   435

  structure_initialization->init_structure_default(this->current_param_type);

   436

  structure_initialization->init_structure_values(symbol);

   437

  delete structure_initialization;

   438

  return NULL;

   439

}

   440

   441

/* helper symbol for array_initialization */

   442

/* array_initial_elements_list ',' array_initial_elements */

   443

void *visit(array_initial_elements_list_c *symbol) {

   444

  generate_c_array_initialization_c *array_initialization = new generate_c_array_initialization_c(&s4o);

   445

  array_initialization->init_array_size(this->current_param_type);

   446

  array_initialization->init_array_values(symbol);

   447

  delete array_initialization;

   448

  return NULL;

   449

}

   450

   451

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

   452

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

   453

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

   454

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

   455

/* B 3.1 - Expressions */

   456

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

   457

void *visit(or_expression_c *symbol) {

   458

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

   459

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

   460

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

   461

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

   462

  ERROR;

   463

  return NULL;

   464

}

   465

   466

void *visit(xor_expression_c *symbol) {

   467

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

   468

    s4o.print("(");

   469

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

   470

    s4o.print(" && !");

   471

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

   472

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

   473

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

   474

    s4o.print(" && ");

   475

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

   476

    s4o.print(")");

   477

    return NULL;

   478

  }

   479

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

   480

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

   481

  ERROR;

   482

  return NULL;

   483

}

   484

   485

void *visit(and_expression_c *symbol) {

   486

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

   487

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

   488

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

   489

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

   490

  ERROR;

   491

return NULL;

   492

}