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_suffix_vg,

    55

      fparam_output_vg

    56

    } variablegeneration_t;

    57

    58

    typedef enum {

    59

      single_cg,

    60

      subrange_cg,

    61

      none_cg

    62

    } casegeneration_t;

    63

    64

  private:

    65

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

    66

     * by searching through the declarations of the variables currently

    67

     * in scope.

    68

     * This class does just that...

    69

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

    70

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

    71

     * This object instance will then later be called while the

    72

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

    73

     *

    74

     * Note that functions cannot contain calls to function blocks,

    75

     * so we do not create an object instance when handling

    76

     * a function declaration.

    77

     */

    78

    search_fb_instance_decl_c *search_fb_instance_decl;

    79

    80

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

    81

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

    82

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

    83

     * or function currently being processed.

    84

     * The following object does just that...

    85

     * This object instance will then later be called while the

    86

     * remaining st code is being handled.

    87

     */

    88

    search_expression_type_c *search_expression_type;

    89

    90

    search_varfb_instance_type_c *search_varfb_instance_type;

    91

    92

    search_base_type_c search_base_type;

    93

    94

    symbol_c* current_array_type;

    95

    symbol_c* current_param_type;

    96

    97

    int fcall_number;

    98

    symbol_c *fbname;

    99

   100

    bool first_subrange_case_list;

   101

   102

    variablegeneration_t wanted_variablegeneration;

   103

    casegeneration_t wanted_casegeneration;

   104

   105

  public:

   106

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

   107

    : generate_c_typedecl_c(s4o_ptr) {

   108

      search_fb_instance_decl = new search_fb_instance_decl_c(scope);

   109

      search_expression_type = new search_expression_type_c(scope);

   110

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

   111

      this->set_variable_prefix(variable_prefix);

   112

      current_array_type = NULL;

   113

      current_param_type = NULL;

   114

      fcall_number = 0;

   115

      fbname = name;

   116

      wanted_variablegeneration = expression_vg;

   117

      wanted_casegeneration = none_cg;

   118

    }

   119

   120

    virtual ~generate_c_st_c(void) {

   121

      delete search_fb_instance_decl;

   122

      delete search_expression_type;

   123

      delete search_varfb_instance_type;

   124

    }

   125

   126

   127

  public:

   128

    void generate(statement_list_c *stl) {

   129

      stl->accept(*this);

   130

    }

   131

   132

  private:

   133

   134

void *print_getter(symbol_c *symbol) {

   135

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

   136

  if (wanted_variablegeneration == fparam_output_vg) {

   137

  	if (vartype == search_var_instance_decl_c::external_vt)

   138

      s4o.print(GET_EXTERNAL_BY_REF);

   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

	  s4o.print(GET_EXTERNAL);

   147

	else if (vartype == search_var_instance_decl_c::located_vt)

   148

	  s4o.print(GET_LOCATED);

   149

	else

   150

	  s4o.print(GET_VAR);

   151

  }

   152

  s4o.print("(");

   153

   154

  variablegeneration_t old_wanted_variablegeneration = wanted_variablegeneration;

   155

  wanted_variablegeneration = complextype_base_vg;

   156

  symbol->accept(*this);

   157

  if (search_varfb_instance_type->type_is_complex())

   158

    s4o.print(",");

   159

  wanted_variablegeneration = complextype_suffix_vg;

   160

  symbol->accept(*this);

   161

  s4o.print(")");

   162

  wanted_variablegeneration = old_wanted_variablegeneration;

   163

  return NULL;

   164

}

   165

   166

void *print_setter(symbol_c* symbol,

   167

		symbol_c* type,

   168

		symbol_c* value,

   169

		symbol_c* fb_symbol = NULL,

   170

		symbol_c* fb_value = NULL) {

   171

   172

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

   174

  if (vartype == search_var_instance_decl_c::external_vt) {

   175

    symbolic_variable_c *variable = dynamic_cast<symbolic_variable_c *>(symbol);

   176

    /* TODO Find a solution for forcing global complex variables */

   177

    if (variable != NULL) {

   178

      s4o.print(SET_EXTERNAL);

   179

      s4o.print("(");

   180

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

   181

      s4o.print(",");

   182

    }

   183

    else {

   184

      s4o.print(SET_COMPLEX_EXTERNAL);

   185

      s4o.print("(");

   186

    }

   187

  }

   188

  else {

   189

    if (vartype == search_var_instance_decl_c::located_vt)

   190

      s4o.print(SET_LOCATED);

   191

    else

   192

      s4o.print(SET_VAR);

   193

    s4o.print("(");

   194

  }

   195

   196

  if (fb_symbol != NULL) {

   197

    print_variable_prefix();

   198

    fb_symbol->accept(*this);

   199

    s4o.print(".");

   200

  }

   203

  else

   205

   206

  symbol->accept(*this);

   207

  s4o.print(",");

   208

  wanted_variablegeneration = expression_vg;

   209

  print_check_function(type, value, fb_value);

   211

    s4o.print(",");

   212

    wanted_variablegeneration = complextype_suffix_vg;

   213

    symbol->accept(*this);

   214

  }

   215

  s4o.print(")");

   216

  wanted_variablegeneration = expression_vg;

   217

  return NULL;

   218

}

   219

   220

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

   221

/* B 1.3.3 - Derived data types */

   222

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

   223

   224

/*  signed_integer DOTDOT signed_integer */

   225

void *visit(subrange_c *symbol) {

   226

  switch (wanted_casegeneration) {

   227

    case subrange_cg:

   228

      s4o.print("__case_expression >= ");

   229

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

   230

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

   231

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

   232

      break;

   233

    default:

   234

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

   235

      break;

   236

  }

   237

  return NULL;

   238

}

   239

   240

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

   241

void *visit(array_specification_c *symbol) {

   242

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

   243

  return NULL;

   244

}

   245

   246

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

   247

/* B 1.4 - Variables */

   248

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

   249

void *visit(symbolic_variable_c *symbol) {

   250

  unsigned int vartype;

   274

  return NULL;

   275

}

   276

   277

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

   278

/* B.1.4.1   Directly Represented Variables */

   279

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

   280

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

   281

void *visit(direct_variable_c *symbol) {

   282

  TRACE("direct_variable_c");

   283

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

   284

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

   285

  if (this->is_variable_prefix_null()) {

   286

    if (wanted_variablegeneration != fparam_output_vg)

   287

	  s4o.print("*(");

   288

  }

   289

  else {

   290

    switch (wanted_variablegeneration) {

   291

      case expression_vg:

   292

  	    s4o.print(GET_LOCATED);

   293

  	    s4o.print("(");

   294

  	    break;

   295

      case fparam_output_vg:

   296

        s4o.print(GET_LOCATED_BY_REF);

   297

        s4o.print("(");

   298

        break;

   299

      default:

   300

        break;

   301

    }

   302

  }

   303

  this->print_variable_prefix();

   304

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

   305

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

   306

	  wanted_variablegeneration != assignment_vg)

   307

    s4o.print(")");

   308

  return NULL;

   309

}

   310

   311

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

   312

/* B.1.4.2   Multi-element Variables */

   313

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

   314

   315

// SYM_REF2(structured_variable_c, record_variable, field_selector)

   316

void *visit(structured_variable_c *symbol) {

   317

  TRACE("structured_variable_c");

   318

  switch (wanted_variablegeneration) {

   319

    case complextype_base_vg:

   320

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

   321

      break;

   322

    case complextype_suffix_vg:

   324

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

   325

      s4o.print(".");

   326

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

   327

      break;

   328

    default:

   329

      if (this->is_variable_prefix_null()) {

   330

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

   331

    	s4o.print(".");

   332

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

   333

      }

   334

      else

   335

    	print_getter(symbol);

   336

      break;

   337

  }

   338

  return NULL;

   339

}

   340

   341

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

   342

//SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   343

void *visit(array_variable_c *symbol) {

   344

  switch (wanted_variablegeneration) {

   345

    case complextype_base_vg:

   346

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

   347

      break;

   348

    case complextype_suffix_vg:

   349

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

   350

   351

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

   352

      if (current_array_type == NULL) ERROR;

   353

   354

      s4o.print(".table");

   355

      wanted_variablegeneration = expression_vg;

   356

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

   357

      wanted_variablegeneration = complextype_suffix_vg;

   358

   359

      current_array_type = NULL;

   360

      break;

   361

    default:

   362

      if (this->is_variable_prefix_null()) {

   363

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

   364

   365

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

   366

    	if (current_array_type == NULL) ERROR;

   367

   368

    	s4o.print(".table");

   369

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

   370

   371

        current_array_type = NULL;

   372

      }

   373

      else

   374

    	print_getter(symbol);

   375

      break;

   376

  }

   377

  return NULL;

   378

}

   379

   380

/* subscript_list ',' subscript */

   381

void *visit(subscript_list_c *symbol) {

   382

  array_dimension_iterator_c* array_dimension_iterator = new array_dimension_iterator_c(current_array_type);

   383

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

   384

    symbol_c* dimension = array_dimension_iterator->next();

   385

	if (dimension == NULL) ERROR;

   386

   387

	s4o.print("[(");

   388

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

   389

    s4o.print(") - (");

   390

    dimension->accept(*this);

   391

    s4o.print(")]");

   392

  }

   393

  delete array_dimension_iterator;

   394

  return NULL;

   395

}

   396

   397

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

   398

/* B 1.4.3 - Declaration & Initialisation */

   399

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

   400

   401

/* helper symbol for structure_initialization */

   402

/* structure_element_initialization_list ',' structure_element_initialization */

   403

void *visit(structure_element_initialization_list_c *symbol) {

   404

  generate_c_structure_initialization_c *structure_initialization = new generate_c_structure_initialization_c(&s4o);

   405

  structure_initialization->init_structure_default(this->current_param_type);

   406

  structure_initialization->init_structure_values(symbol);

   407

  delete structure_initialization;

   408

  return NULL;

   409

}

   410

   411

/* helper symbol for array_initialization */

   412

/* array_initial_elements_list ',' array_initial_elements */

   413

void *visit(array_initial_elements_list_c *symbol) {

   414

  generate_c_array_initialization_c *array_initialization = new generate_c_array_initialization_c(&s4o);

   415

  array_initialization->init_array_size(this->current_param_type);

   416

  array_initialization->init_array_values(symbol);

   417

  delete array_initialization;

   418

  return NULL;

   419

}

   420

   421

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

   422

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

   423

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

   424

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

   425

/* B 3.1 - Expressions */

   426

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

   427

void *visit(or_expression_c *symbol) {

   428

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

   429

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

   430

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

   431

      ERROR;

   432

  if (search_expression_type->is_bool_type(left_type))

   433

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

   434

  if (search_expression_type->is_binary_type(left_type))

   435

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

   436

  ERROR;

   437

  return NULL;

   438

}

   439

   440

void *visit(xor_expression_c *symbol) {

   441

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

   442

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

   443

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

   444

      ERROR;

   445

  if (search_expression_type->is_bool_type(left_type)) {

   446

    s4o.print("(");

   447

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

   448

    s4o.print(" && !");

   449

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

   450

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

   451

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

   452

    s4o.print(" && ");

   453

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

   454

    s4o.print(")");

   455

    return NULL;

   456

  }

   457

  if (search_expression_type->is_binary_type(left_type))

   458

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

   459

  ERROR;

   460

  return NULL;

   461

}

   462

   463

void *visit(and_expression_c *symbol) {

   464

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

   465

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

   466

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

   467

      ERROR;

   468

  if (search_expression_type->is_bool_type(left_type))

   469

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

   470

  if (search_expression_type->is_binary_type(left_type))

   471

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

   472

  ERROR;

   473

  return NULL;

   474

}

   475

   476

void *visit(equ_expression_c *symbol) {

   477

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

   478

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

   479

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

   480

      ERROR;

   481

  if (search_expression_type->is_time_type(left_type) ||

   482

      search_expression_type->is_string_type(left_type))

   483

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

   484

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

   485

}

   486

   487

void *visit(notequ_expression_c *symbol) {

   488

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

   489

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

   490

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

   491

      ERROR;

   492

  if (search_expression_type->is_time_type(left_type) ||

   493

      search_expression_type->is_string_type(left_type))

   494

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

   495

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

   496

}

   497

   498

void *visit(lt_expression_c *symbol) {

   499

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

   500