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

    search_base_type_c search_base_type;

    85

    86

    symbol_c* current_array_type;

    87

    symbol_c* current_param_type;

    88

    89

    int fcall_number;

    90

    symbol_c *fbname;

    91

    92

    bool first_subrange_case_list;

    93

    94

    variablegeneration_t wanted_variablegeneration;

    95

    casegeneration_t wanted_casegeneration;

    96

    97

  public:

    98

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

    99

    : generate_c_typedecl_c(s4o_ptr) {

   101

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

   103

   104

      this->set_variable_prefix(variable_prefix);

   105

      current_array_type = NULL;

   106

      current_param_type = NULL;

   107

      fcall_number = 0;

   108

      fbname = name;

   109

      wanted_variablegeneration = expression_vg;

   110

      wanted_casegeneration = none_cg;

   111

    }

   112

   113

    virtual ~generate_c_st_c(void) {

   114

      delete search_fb_instance_decl;

   115

      delete search_varfb_instance_type;

   116

      delete search_var_instance_decl;

   117

    }

   118

   119

   120

  public:

   121

    void generate(statement_list_c *stl) {

   122

      stl->accept(*this);

   123

    }

   124

   125

  private:

   126

   127

   128

   129

   130

   131

   132

void *print_getter(symbol_c *symbol) {

   133

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

   134

  if (wanted_variablegeneration == fparam_output_vg) {

   135

    if (vartype == search_var_instance_decl_c::external_vt)

   136

      s4o.print(GET_EXTERNAL_BY_REF);

   137

    else if (vartype == search_var_instance_decl_c::located_vt)

   138

      s4o.print(GET_LOCATED_BY_REF);

   139

    else

   140

      s4o.print(GET_VAR_BY_REF);

   141

  }

   142

  else {

   143

    if (vartype == search_var_instance_decl_c::external_vt)

   144

      s4o.print(GET_EXTERNAL);

   145

    else if (vartype == search_var_instance_decl_c::located_vt)

   146

      s4o.print(GET_LOCATED);

   147

    else

   148

      s4o.print(GET_VAR);

   149

  }

   150

  s4o.print("(");

   151

   152

  variablegeneration_t old_wanted_variablegeneration = wanted_variablegeneration;

   153

  wanted_variablegeneration = complextype_base_vg;

   154

  symbol->accept(*this);

   155

  if (search_var_instance_decl->type_is_complex(symbol))

   156

    s4o.print(",");

   157

  wanted_variablegeneration = complextype_suffix_vg;

   158

  symbol->accept(*this);

   159

  s4o.print(")");

   160

  wanted_variablegeneration = old_wanted_variablegeneration;

   161

  return NULL;

   162

}

   163

   164

void *print_setter(symbol_c* symbol,

   165

		symbol_c* type,

   166

		symbol_c* value,

   167

		symbol_c* fb_symbol = NULL,

   168

		symbol_c* fb_value = NULL) {

   169

   170

  bool type_is_complex = false;

   171

  if (fb_symbol == NULL) {

   172

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

   173

    type_is_complex = search_var_instance_decl->type_is_complex(symbol);

   174

    if (vartype == search_var_instance_decl_c::external_vt)

   175

      s4o.print(SET_EXTERNAL);

   176

    else if (vartype == search_var_instance_decl_c::located_vt)

   177

      s4o.print(SET_LOCATED);

   178

    else

   179

      s4o.print(SET_VAR);

   180

  }

   181

  else

   182

	s4o.print(SET_VAR);

   183

  s4o.print("(");

   184

   185

  if (fb_symbol != NULL) {

   186

    print_variable_prefix();

   187

    fb_symbol->accept(*this);

   188

    s4o.print(".,");

   189

  }

   190

  else if (type_is_complex)

   191

    wanted_variablegeneration = complextype_base_assignment_vg;

   192

  else

   193

    wanted_variablegeneration = assignment_vg;

   194

   195

  symbol->accept(*this);

   196

  s4o.print(",");

   197

  wanted_variablegeneration = expression_vg;

   198

  print_check_function(type, value, fb_value);

   199

  if (type_is_complex) {

   200

    s4o.print(",");

   201

    wanted_variablegeneration = complextype_suffix_vg;

   202

    symbol->accept(*this);

   203

  }

   204

  s4o.print(")");

   205

  wanted_variablegeneration = expression_vg;

   206

  return NULL;

   207

}

   208

   209

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

   210

/* B 1.3.3 - Derived data types */

   211

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

   212

   213

/*  signed_integer DOTDOT signed_integer */

   214

void *visit(subrange_c *symbol) {

   215

  switch (wanted_casegeneration) {

   216

    case subrange_cg:

   217

      s4o.print("__case_expression >= ");

   218

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

   219

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

   220

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

   221

      break;

   222

    default:

   223

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

   224

      break;

   225

  }

   226

  return NULL;

   227

}

   228

   229

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

   230

void *visit(array_specification_c *symbol) {

   231

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

   232

  return NULL;

   233

}

   234

   235

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

   236

/* B 1.4 - Variables */

   237

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

   238

void *visit(symbolic_variable_c *symbol) {

   239

  switch (wanted_variablegeneration) {

   240

    case complextype_base_assignment_vg:

   241

    case assignment_vg:

   242

      this->print_variable_prefix();

   243

      s4o.print(",");

   244

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

   245

      break;

   246

    case complextype_base_vg:

   247

      generate_c_base_c::visit(symbol);

   248

      break;

   249

    case complextype_suffix_vg:

   250

      break;

   251

    default:

   252

      if (this->is_variable_prefix_null()) {

   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

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

   311

  switch (wanted_variablegeneration) {

   312

    case complextype_base_vg:

   313

    case complextype_base_assignment_vg:

   314

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

   315

      if (!type_is_complex) {

   316

    	s4o.print(".");

   317

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

   318

      }

   319

      break;

   320

    case complextype_suffix_vg:

   321

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

   322

      if (type_is_complex) {

   323

        s4o.print(".");

   324

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

   325

      }

   326

      break;

   327

    case assignment_vg:

   328

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

   329

      s4o.print(".");

   330

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

   331

      break;

   332

    default:

   333

      if (this->is_variable_prefix_null()) {

   334

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

   335

    	s4o.print(".");

   336

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

   337

      }

   338

      else

   339

    	print_getter(symbol);

   340

      break;

   341

  }

   342

  return NULL;

   343

}

   344

   345

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

   346

//SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   347

void *visit(array_variable_c *symbol) {

   348

  switch (wanted_variablegeneration) {

   349

    case complextype_base_vg:

   350

    case complextype_base_assignment_vg:

   351

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

   352

      break;

   353

    case complextype_suffix_vg:

   354

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

   355

   356

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

   357

      if (current_array_type == NULL) ERROR;

   358

   359

      s4o.print(".table");

   360

      wanted_variablegeneration = expression_vg;

   361

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

   362

      wanted_variablegeneration = complextype_suffix_vg;

   363

   364

      current_array_type = NULL;

   365

      break;

   366

    default:

   367

      if (this->is_variable_prefix_null()) {

   368

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

   369

   370

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

   371

    	if (current_array_type == NULL) ERROR;

   372

   373

    	s4o.print(".table");

   374

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

   375

   376

        current_array_type = NULL;

   377

      }

   378

      else

   379

    	print_getter(symbol);

   380

      break;

   381

  }

   382

  return NULL;

   383

}

   384

   385

/* subscript_list ',' subscript */

   386

void *visit(subscript_list_c *symbol) {

   387

  array_dimension_iterator_c* array_dimension_iterator = new array_dimension_iterator_c(current_array_type);

   388

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

   389

    symbol_c* dimension = array_dimension_iterator->next();

   390

	if (dimension == NULL) ERROR;

   391

   392

	s4o.print("[(");

   393

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

   394

    s4o.print(") - (");

   395

    dimension->accept(*this);

   396

    s4o.print(")]");

   397

  }

   398

  delete array_dimension_iterator;

   399

  return NULL;

   400

}

   401

   402

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

   403

/* B 1.4.3 - Declaration & Initialisation */

   404

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

   405

   406

/* helper symbol for structure_initialization */

   407

/* structure_element_initialization_list ',' structure_element_initialization */

   408

void *visit(structure_element_initialization_list_c *symbol) {

   409

  generate_c_structure_initialization_c *structure_initialization = new generate_c_structure_initialization_c(&s4o);

   410

  structure_initialization->init_structure_default(this->current_param_type);

   411

  structure_initialization->init_structure_values(symbol);

   412

  delete structure_initialization;

   413

  return NULL;

   414

}

   415

   416

/* helper symbol for array_initialization */

   417

/* array_initial_elements_list ',' array_initial_elements */

   418

void *visit(array_initial_elements_list_c *symbol) {

   419

  generate_c_array_initialization_c *array_initialization = new generate_c_array_initialization_c(&s4o);

   420

  array_initialization->init_array_size(this->current_param_type);

   421

  array_initialization->init_array_values(symbol);

   422

  delete array_initialization;

   423

  return NULL;

   424

}

   425

   426

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

   427

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

   428

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

   429

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

   430

/* B 3.1 - Expressions */

   431

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

   432

void *visit(or_expression_c *symbol) {

   434

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

   436

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

   437

  ERROR;

   438

  return NULL;

   439

}

   440

   441

void *visit(xor_expression_c *symbol) {

   443

    s4o.print("(");

   444

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

   445

    s4o.print(" && !");

   446

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

   447

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

   448

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

   449

    s4o.print(" && ");

   450

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

   451

    s4o.print(")");

   452

    return NULL;

   453

  }

   455

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

   456

  ERROR;

   457

  return NULL;

   458

}

   459

   460

void *visit(and_expression_c *symbol) {

   462

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

   464

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

   465

  ERROR;

   467

}

   468

   469

void *visit(equ_expression_c *symbol) {

   474

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

   475

}

   476

   477

void *visit(notequ_expression_c *symbol) {

   482

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

   483

}

   484

   485

void *visit(lt_expression_c *symbol) {

   490

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

   491

}

   492

   493

void *visit(gt_expression_c *symbol) {