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,

    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

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

    82

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

    83

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

    84

     * or function currently being processed.

    85

     * The following object does just that...

    86

     * This object instance will then later be called while the

    87

     * remaining st code is being handled.

    88

     */

    89

    search_expression_type_c *search_expression_type;

    90

    91

    search_varfb_instance_type_c *search_varfb_instance_type;

    92

    93

    search_base_type_c search_base_type;

    94

    95

    symbol_c* current_array_type;

    96

    symbol_c* current_param_type;

    97

    98

    int fcall_number;

    99

    symbol_c *fbname;

   100

   101

    bool first_subrange_case_list;

   102

   103

    variablegeneration_t wanted_variablegeneration;

   104

    casegeneration_t wanted_casegeneration;

   105

   106

  public:

   107

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

   108

    : generate_c_typedecl_c(s4o_ptr) {

   109

      search_fb_instance_decl = new search_fb_instance_decl_c(scope);

   110

      search_expression_type = new search_expression_type_c(scope);

   111

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

   112

      this->set_variable_prefix(variable_prefix);

   113

      current_array_type = NULL;

   114

      current_param_type = NULL;

   115

      fcall_number = 0;

   116

      fbname = name;

   117

      wanted_variablegeneration = expression_vg;

   118

      wanted_casegeneration = none_cg;

   119

    }

   120

   121

    virtual ~generate_c_st_c(void) {

   122

      delete search_fb_instance_decl;

   123

      delete search_expression_type;

   124

      delete search_varfb_instance_type;

   125

    }

   126

   127

   128

  public:

   129

    void generate(statement_list_c *stl) {

   130

      stl->accept(*this);

   131

    }

   132

   133

  private:

   134

   135

void *print_getter(symbol_c *symbol) {

   136

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

   137

  if (wanted_variablegeneration == fparam_output_vg) {

   138

  	if (vartype == search_var_instance_decl_c::external_vt)

   139

      s4o.print(GET_EXTERNAL_BY_REF);

   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)

   147

	  s4o.print(GET_EXTERNAL);

   148

	else if (vartype == search_var_instance_decl_c::located_vt)

   149

	  s4o.print(GET_LOCATED);

   150

	else

   151

	  s4o.print(GET_VAR);

   152

  }

   153

  s4o.print("(");

   154

   155

  variablegeneration_t old_wanted_variablegeneration = wanted_variablegeneration;

   156

  wanted_variablegeneration = complextype_base_vg;

   157

  symbol->accept(*this);

   158

  if (search_varfb_instance_type->type_is_complex())

   159

    s4o.print(",");

   160

  wanted_variablegeneration = complextype_suffix_vg;

   161

  symbol->accept(*this);

   162

  s4o.print(")");

   163

  wanted_variablegeneration = old_wanted_variablegeneration;

   164

  return NULL;

   165

}

   166

   167

void *print_setter(symbol_c* symbol,

   168

		symbol_c* type,

   169

		symbol_c* value,

   170

		symbol_c* fb_symbol = NULL,

   171

		symbol_c* fb_value = NULL) {

   172

   173

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

   174

  bool type_is_complex = search_varfb_instance_type->type_is_complex();

   182

   183

  if (fb_symbol != NULL) {

   184

    print_variable_prefix();

   185

    fb_symbol->accept(*this);

   187

  }

   188

  else if (type_is_complex)

   190

  else

   191

    wanted_variablegeneration = assignment_vg;

   192

   193

  symbol->accept(*this);

   194

  s4o.print(",");

   195

  wanted_variablegeneration = expression_vg;

   196

  print_check_function(type, value, fb_value);

   197

  if (type_is_complex) {

   198

    s4o.print(",");

   199

    wanted_variablegeneration = complextype_suffix_vg;

   200

    symbol->accept(*this);

   201

  }

   202

  s4o.print(")");

   203

  wanted_variablegeneration = expression_vg;

   204

  return NULL;

   205

}

   206

   207

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

   208

/* B 1.3.3 - Derived data types */

   209

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

   210

   211

/*  signed_integer DOTDOT signed_integer */

   212

void *visit(subrange_c *symbol) {

   213

  switch (wanted_casegeneration) {

   214

    case subrange_cg:

   215

      s4o.print("__case_expression >= ");

   216

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

   217

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

   218

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

   219

      break;

   220

    default:

   221

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

   222

      break;

   223

  }

   224

  return NULL;

   225

}

   226

   227

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

   228

void *visit(array_specification_c *symbol) {

   229

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

   230

  return NULL;

   231

}

   232

   233

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

   234

/* B 1.4 - Variables */

   235

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

   236

void *visit(symbolic_variable_c *symbol) {

   237

  unsigned int vartype;

   238

  switch (wanted_variablegeneration) {

   245

    case complextype_base_vg:

   246

      generate_c_base_c::visit(symbol);

   247

      break;

   248

    case complextype_suffix_vg:

   249

      break;

   250

    default:

   251

      if (this->is_variable_prefix_null()) {

   252

        vartype = search_varfb_instance_type->get_vartype(symbol);

   253

        if (wanted_variablegeneration == fparam_output_vg) {

   254

          s4o.print("&(");

   255

          generate_c_base_c::visit(symbol);

   256

          s4o.print(")");

   257

        }

   258

        else {

   259

          generate_c_base_c::visit(symbol);

   260

        }

   261

      }

   262

      else

   263

        print_getter(symbol);

   264

      break;

   265

  }

   266

  return NULL;

   267

}

   268

   269

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

   270

/* B.1.4.1   Directly Represented Variables */

   271

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

   272

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

   273

void *visit(direct_variable_c *symbol) {

   274

  TRACE("direct_variable_c");

   275

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

   276

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

   277

  if (this->is_variable_prefix_null()) {

   278

    if (wanted_variablegeneration != fparam_output_vg)

   279

	  s4o.print("*(");

   280

  }

   281

  else {

   282

    switch (wanted_variablegeneration) {

   283

      case expression_vg:

   284

  	    s4o.print(GET_LOCATED);

   285

  	    s4o.print("(");

   286

  	    break;

   287

      case fparam_output_vg:

   288

        s4o.print(GET_LOCATED_BY_REF);

   289

        s4o.print("(");

   290

        break;

   291

      default:

   292

        break;

   293

    }

   294

  }

   295

  this->print_variable_prefix();

   296

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

   297

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

   298

	  wanted_variablegeneration != assignment_vg)

   299

    s4o.print(")");

   300

  return NULL;

   301

}

   302

   303

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

   304

/* B.1.4.2   Multi-element Variables */

   305

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

   306

   307

// SYM_REF2(structured_variable_c, record_variable, field_selector)

   308

void *visit(structured_variable_c *symbol) {

   309

  TRACE("structured_variable_c");

   310

  switch (wanted_variablegeneration) {

   311

    case complextype_base_vg:

   313

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

   314

      break;

   315

    case complextype_suffix_vg:

   316

    case assignment_vg:

   317

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

   318

      s4o.print(".");

   319

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

   320

      break;

   321

    default:

   322

      if (this->is_variable_prefix_null()) {

   323

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

   324

    	s4o.print(".");

   325

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

   326

      }

   327

      else

   328

    	print_getter(symbol);

   329

      break;

   330

  }

   331

  return NULL;

   332

}

   333

   334

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

   335

//SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   336

void *visit(array_variable_c *symbol) {

   337

  switch (wanted_variablegeneration) {

   338

    case complextype_base_vg:

   340

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

   341

      break;

   342

    case complextype_suffix_vg:

   343

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

   344

   345

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

   346

      if (current_array_type == NULL) ERROR;

   347

   348

      s4o.print(".table");

   349

      wanted_variablegeneration = expression_vg;

   350

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

   351

      wanted_variablegeneration = complextype_suffix_vg;

   352

   353

      current_array_type = NULL;

   354

      break;

   355

    default:

   356

      if (this->is_variable_prefix_null()) {

   357

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

   358

   359

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

   360

    	if (current_array_type == NULL) ERROR;

   361

   362

    	s4o.print(".table");

   363

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

   364

   365

        current_array_type = NULL;

   366

      }

   367

      else

   368

    	print_getter(symbol);

   369

      break;

   370

  }

   371

  return NULL;

   372

}

   373

   374

/* subscript_list ',' subscript */

   375

void *visit(subscript_list_c *symbol) {

   376

  array_dimension_iterator_c* array_dimension_iterator = new array_dimension_iterator_c(current_array_type);

   377

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

   378

    symbol_c* dimension = array_dimension_iterator->next();

   379

	if (dimension == NULL) ERROR;

   380

   381

	s4o.print("[(");

   382

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

   383

    s4o.print(") - (");

   384

    dimension->accept(*this);

   385

    s4o.print(")]");

   386

  }

   387

  delete array_dimension_iterator;

   388

  return NULL;

   389

}

   390

   391

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

   392

/* B 1.4.3 - Declaration & Initialisation */

   393

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

   394

   395

/* helper symbol for structure_initialization */

   396

/* structure_element_initialization_list ',' structure_element_initialization */

   397

void *visit(structure_element_initialization_list_c *symbol) {

   398

  generate_c_structure_initialization_c *structure_initialization = new generate_c_structure_initialization_c(&s4o);

   399

  structure_initialization->init_structure_default(this->current_param_type);

   400

  structure_initialization->init_structure_values(symbol);

   401

  delete structure_initialization;

   402

  return NULL;

   403

}

   404

   405

/* helper symbol for array_initialization */

   406

/* array_initial_elements_list ',' array_initial_elements */

   407

void *visit(array_initial_elements_list_c *symbol) {

   408

  generate_c_array_initialization_c *array_initialization = new generate_c_array_initialization_c(&s4o);

   409

  array_initialization->init_array_size(this->current_param_type);

   410

  array_initialization->init_array_values(symbol);

   411

  delete array_initialization;

   412

  return NULL;

   413

}

   414

   415

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

   416

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

   417

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

   418

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

   419

/* B 3.1 - Expressions */

   420

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

   421

void *visit(or_expression_c *symbol) {

   422

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

   423

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

   424

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

   425

      ERROR;

   426

  if (search_expression_type->is_bool_type(left_type))

   427

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

   428

  if (search_expression_type->is_binary_type(left_type))

   429

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

   430

  ERROR;

   431

  return NULL;

   432

}

   433

   434

void *visit(xor_expression_c *symbol) {

   435

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

   436

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

   437

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

   438

      ERROR;

   439

  if (search_expression_type->is_bool_type(left_type)) {

   440

    s4o.print("(");

   441

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

   442

    s4o.print(" && !");

   443

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

   444

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

   445

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

   446

    s4o.print(" && ");

   447

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

   448

    s4o.print(")");

   449

    return NULL;

   450

  }

   451

  if (search_expression_type->is_binary_type(left_type))

   452

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

   453

  ERROR;

   454

  return NULL;

   455

}

   456

   457

void *visit(and_expression_c *symbol) {

   458

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

   459

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

   460

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

   461

      ERROR;

   462

  if (search_expression_type->is_bool_type(left_type))

   463

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

   464

  if (search_expression_type->is_binary_type(left_type))

   465

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

   466

  ERROR;

   467

  return NULL;

   468

}

   469

   470

void *visit(equ_expression_c *symbol) {

   471

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

   472

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

   473

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

   474

      ERROR;

   475

  if (search_expression_type->is_time_type(left_type) ||

   476

      search_expression_type->is_string_type(left_type))

   477

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

   478

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

   479

}

   480

   481

void *visit(notequ_expression_c *symbol) {

   482

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

   483

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

   484

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

   485

      ERROR;

   486

  if (search_expression_type->is_time_type(left_type) ||

   487

      search_expression_type->is_string_type(left_type))

   488

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

   489

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

   490

}

   491

   492

void *visit(lt_expression_c *symbol) {

   493

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

   494

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

   495

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

   496

      ERROR;

   497

  if (search_expression_type->is_time_type(left_type) ||

   498

      search_expression_type->is_string_type(left_type))

   499