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_base_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

    search_varfb_instance_type_c *search_varfb_instance_type;

    81

    search_var_instance_decl_c   *search_var_instance_decl;

    82

    83

    symbol_c *scope_;

    84

    85

    symbol_c* current_array_type;

    86

    symbol_c* current_param_type;

    87

    88

    int fcall_number;

    89

    symbol_c *fbname;

    90

    91

    bool first_subrange_case_list;

    92

    93

    variablegeneration_t wanted_variablegeneration;

    94

    casegeneration_t wanted_casegeneration;

    95

    96

  public:

    97

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

    98

    : generate_c_base_c(s4o_ptr) {

    99

      search_fb_instance_decl    = new search_fb_instance_decl_c   (scope);

   100

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

   101

      search_var_instance_decl   = new search_var_instance_decl_c  (scope);

   102

      scope_ = 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 = analyse_variable_c::first_nonfb_vardecltype(symbol, scope_);

   134

  if (wanted_variablegeneration == fparam_output_vg) {

   135

    if (vartype == search_var_instance_decl_c::external_vt) {

   136

      if (!get_datatype_info_c::is_type_valid    (symbol->datatype)) ERROR;

   137

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

   138

        s4o.print(GET_EXTERNAL_FB_BY_REF);

   139

      else

   140

        s4o.print(GET_EXTERNAL_BY_REF);

   141

    }

   142

    else if (vartype == search_var_instance_decl_c::located_vt)

   143

      s4o.print(GET_LOCATED_BY_REF);

   144

    else

   145

      s4o.print(GET_VAR_BY_REF);

   146

  }

   147

  else {

   148

    if (vartype == search_var_instance_decl_c::external_vt) {

   149

      if (!get_datatype_info_c::is_type_valid    (symbol->datatype)) ERROR;

   150

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

   151

        s4o.print(GET_EXTERNAL_FB);

   152

      else

   153

        s4o.print(GET_EXTERNAL);

   154

    }

   155

    else if (vartype == search_var_instance_decl_c::located_vt)

   156

      s4o.print(GET_LOCATED);

   157

    else

   158

      s4o.print(GET_VAR);

   159

  }

   160

  s4o.print("(");

   161

   162

  variablegeneration_t old_wanted_variablegeneration = wanted_variablegeneration;

   163

  wanted_variablegeneration = complextype_base_vg;

   164

  symbol->accept(*this);

   165

  s4o.print(",");

   166

  wanted_variablegeneration = complextype_suffix_vg;

   167

  symbol->accept(*this);

   168

  s4o.print(")");

   169

  wanted_variablegeneration = old_wanted_variablegeneration;

   170

  return NULL;

   171

}

   172

   173

   174

   175

void *print_setter(symbol_c* symbol,

   176

        symbol_c* type,

   177

        symbol_c* value,

   178

        symbol_c* fb_symbol = NULL,

   179

        symbol_c* fb_value = NULL) {

   180

   181

  bool type_is_complex = false;

   182

  if (fb_symbol == NULL) {

   183

    unsigned int vartype = analyse_variable_c::first_nonfb_vardecltype(symbol, scope_);

   184

    type_is_complex = analyse_variable_c::contains_complex_type(symbol);

   185

    if (vartype == search_var_instance_decl_c::external_vt) {

   186

      if (!get_datatype_info_c::is_type_valid    (symbol->datatype)) ERROR;

   187

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

   188

        s4o.print(SET_EXTERNAL_FB);

   189

      else

   190

        s4o.print(SET_EXTERNAL);

   191

    }

   192

    else if (vartype == search_var_instance_decl_c::located_vt)

   193

      s4o.print(SET_LOCATED);

   194

    else

   195

      s4o.print(SET_VAR);

   196

  }

   197

  else {

   198

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

   199

    if (vartype == search_var_instance_decl_c::external_vt)

   200

      s4o.print(SET_EXTERNAL_FB);

   201

    else

   202

      s4o.print(SET_VAR);

   203

  }

   204

  s4o.print("(");

   205

   206

  if (fb_symbol != NULL) {

   207

    print_variable_prefix();

   208

    fb_symbol->accept(*this);

   209

    s4o.print(".,");

   210

  }

   211

  else if (type_is_complex)

   212

    wanted_variablegeneration = complextype_base_assignment_vg;

   213

  else

   214

    wanted_variablegeneration = assignment_vg;

   215

   216

  symbol->accept(*this);

   217

  s4o.print(",");

   218

  wanted_variablegeneration = expression_vg;

   219

  print_check_function(type, value, fb_value);

   220

  if (type_is_complex) {

   221

    s4o.print(",");

   222

    wanted_variablegeneration = complextype_suffix_vg;

   223

    symbol->accept(*this);

   224

  }

   225

  s4o.print(")");

   226

  wanted_variablegeneration = expression_vg;

   227

  return NULL;

   228

}

   229

   230

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

   231

/* B 1.3.3 - Derived data types */

   232

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

   233

   234

/*  signed_integer DOTDOT signed_integer */

   235

void *visit(subrange_c *symbol) {

   236

  switch (wanted_casegeneration) {

   237

    case subrange_cg:

   238

      s4o.print("__case_expression >= ");

   239

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

   240

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

   241

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

   242

      break;

   243

    default:

   244

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

   245

      break;

   246

  }

   247

  return NULL;

   248

}

   249

   250

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

   251

void *visit(array_specification_c *symbol) {

   252

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

   253

  return NULL;

   254

}

   255

   256

/*  enumerated_type_name ':' enumerated_spec_init */

   257

void *visit(enumerated_type_declaration_c *symbol) {

   258

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

   259

  return NULL;

   260

}

   261

   262

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

   263

/* B 1.4 - Variables */

   264

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

   265

void *visit(symbolic_variable_c *symbol) {

   266

  switch (wanted_variablegeneration) {

   267

    case complextype_base_assignment_vg:

   268

    case assignment_vg:

   269

      this->print_variable_prefix();

   270

      s4o.print(",");

   271

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

   272

      break;

   273

    case complextype_base_vg:

   274

      generate_c_base_c::visit(symbol);

   275

      break;

   276

    case complextype_suffix_vg:

   277

      break;

   278

    default:

   279

      if (this->is_variable_prefix_null()) {

   280

        if (wanted_variablegeneration == fparam_output_vg) {

   281

          s4o.print("&(");

   282

          generate_c_base_c::visit(symbol);

   283

          s4o.print(")");

   284

        }

   285

        else {

   286

          generate_c_base_c::visit(symbol);

   287

        }

   288

      }

   289

      else

   290

        print_getter(symbol);

   291

      break;

   292

  }

   293

  return NULL;

   294

}

   295

   296

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

   297

/* B.1.4.1   Directly Represented Variables */

   298

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

   299

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

   300

void *visit(direct_variable_c *symbol) {

   301

  TRACE("direct_variable_c");

   302

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

   303

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

   304

  if (this->is_variable_prefix_null()) {

   305

    if (wanted_variablegeneration != fparam_output_vg)

   306

      s4o.print("*(");

   307

  }

   308

  else {

   309

    switch (wanted_variablegeneration) {

   310

      case expression_vg:

   311

        s4o.print(GET_LOCATED);

   312

        s4o.print("(");

   313

        break;

   314

      case fparam_output_vg:

   315

        s4o.print(GET_LOCATED_BY_REF);

   316

        s4o.print("(");

   317

        break;

   318

      default:

   319

        break;

   320

    }

   321

  }

   322

  this->print_variable_prefix();

   323

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

   324

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

   325

      wanted_variablegeneration != assignment_vg)

   326

    s4o.print(")");

   327

  return NULL;

   328

}

   329

   330

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

   331

/* B.1.4.2   Multi-element Variables */

   332

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

   333

   334

// SYM_REF2(structured_variable_c, record_variable, field_selector)

   335

void *visit(structured_variable_c *symbol) {

   336

  TRACE("structured_variable_c");

   337

  bool type_is_complex = analyse_variable_c::is_complex_type(symbol->record_variable);

   338

  switch (wanted_variablegeneration) {

   339

    case complextype_base_vg:

   340

    case complextype_base_assignment_vg:

   341

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

   342

      if (!type_is_complex) {

   343

        s4o.print(".");

   344

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

   345

      }

   346

      break;

   347

    case complextype_suffix_vg:

   348

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

   349

      if (type_is_complex) {

   350

        s4o.print(".");

   351

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

   352

      }

   353

      break;

   354

    case assignment_vg:

   355

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

   356

      s4o.print(".");

   357

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

   358

      break;

   359

    default:

   360

      if (this->is_variable_prefix_null()) {

   361

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

   362

        s4o.print(".");

   363

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

   364

      }

   365

      else

   366

        print_getter(symbol);

   367

      break;

   368

  }

   369

  return NULL;

   370

}

   371

   372

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

   373

//SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   374

void *visit(array_variable_c *symbol) {

   375

  switch (wanted_variablegeneration) {

   376

    case complextype_base_vg:

   377

    case complextype_base_assignment_vg:

   378

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

   379

      break;

   380

    case complextype_suffix_vg:

   381

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

   382

   383

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

   384

      if (current_array_type == NULL) ERROR;

   385

   386

      s4o.print(".table");

   387

      wanted_variablegeneration = expression_vg;

   388

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

   389

      wanted_variablegeneration = complextype_suffix_vg;

   390

   391

      current_array_type = NULL;

   392

      break;

   393

    default:

   394

      if (this->is_variable_prefix_null()) {

   395

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

   396

   397

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

   398

        if (current_array_type == NULL) ERROR;

   399

   400

        s4o.print(".table");

   401

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

   402

   403

        current_array_type = NULL;

   404

      }

   405

      else

   406

        print_getter(symbol);

   407

      break;

   408

  }

   409

  return NULL;

   410

}

   411

   412

/* subscript_list ',' subscript */

   413

void *visit(subscript_list_c *symbol) {

   414

  array_dimension_iterator_c* array_dimension_iterator = new array_dimension_iterator_c(current_array_type);

   415

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

   416

    symbol_c* dimension = array_dimension_iterator->next();

   417

    if (dimension == NULL) ERROR;

   418

   419

    s4o.print("[(");

   420

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

   421

    s4o.print(") - (");

   422

    dimension->accept(*this);

   423

    s4o.print(")]");

   424

  }

   425

  delete array_dimension_iterator;

   426

  return NULL;

   427

}

   428

   429

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

   430

/* B 1.4.3 - Declaration & Initialisation */

   431

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

   432

   433

/* helper symbol for structure_initialization */

   434

/* structure_element_initialization_list ',' structure_element_initialization */

   435

void *visit(structure_element_initialization_list_c *symbol) {

   436

  generate_c_structure_initialization_c *structure_initialization = new generate_c_structure_initialization_c(&s4o);

   437

  structure_initialization->init_structure_default(this->current_param_type);

   438

  structure_initialization->init_structure_values(symbol);

   439

  delete structure_initialization;

   440

  return NULL;

   441

}

   442

   443

/* helper symbol for array_initialization */

   444

/* array_initial_elements_list ',' array_initial_elements */

   445

void *visit(array_initial_elements_list_c *symbol) {

   446

  generate_c_array_initialization_c *array_initialization = new generate_c_array_initialization_c(&s4o);

   447

  array_initialization->init_array_size(this->current_param_type);

   448

  array_initialization->init_array_values(symbol);

   449

  delete array_initialization;

   450

  return NULL;

   451

}

   452

   453

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

   454

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

   455

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

   456

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

   457

/* B 3.1 - Expressions */

   458

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

   459

void *visit(ref_expression_c *symbol) {

   460

  s4o.print("((IEC_UDINT)");  

   461

  if (this->is_variable_prefix_null()) {  

   462

    /* For code in FUNCTIONs */

   463

    s4o.print("&(");  

   464

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

   465

    s4o.print(")");  

   466

  } else {

   467

    /* For code in FBs, and PROGRAMS... */

   468

    s4o.print("(");  

   469

    unsigned int vartype = analyse_variable_c::first_nonfb_vardecltype(symbol->exp, scope_);

   470

    if (vartype == search_var_instance_decl_c::external_vt) {

   471

      if (!get_datatype_info_c::is_type_valid    (symbol->exp->datatype)) ERROR;

   472

      if ( get_datatype_info_c::is_function_block(symbol->exp->datatype))

   473

        s4o.print(GET_EXTERNAL_FB_REF);

   474

      else

   475

        s4o.print(GET_EXTERNAL_REF);

   476

    }

   477

    else if (vartype == search_var_instance_decl_c::located_vt)

   478

      s4o.print(GET_LOCATED_REF);

   479

    else

   480

      s4o.print(GET_VAR_REF);

   481

   482

    variablegeneration_t old_wanted_variablegeneration = wanted_variablegeneration; 

   483

    s4o.print("(");

   484

    wanted_variablegeneration = complextype_base_vg;

   485

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

   486

    s4o.print(",");

   487

    wanted_variablegeneration = complextype_suffix_vg;

   488

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

   489

    s4o.print(")");

   490

    wanted_variablegeneration = old_wanted_variablegeneration;

   491