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

      complextype_base_vg,

    53

      complextype_suffix_vg,

    54

      fparam_output_vg

    55

    } variablegeneration_t;

    56

    57

    typedef enum {

    58

      single_cg,

    59

      subrange_cg,

    60

      none_cg

    61

    } casegeneration_t;

    62

    63

  private:

    64

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

    65

     * by searching through the declarations of the variables currently

    66

     * in scope.

    67

     * This class does just that...

    68

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

    69

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

    70

     * This object instance will then later be called while the

    71

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

    72

     *

    73

     * Note that functions cannot contain calls to function blocks,

    74

     * so we do not create an object instance when handling

    75

     * a function declaration.

    76

     */

    77

    search_fb_instance_decl_c    *search_fb_instance_decl;

    78

    search_varfb_instance_type_c *search_varfb_instance_type;

    79

    search_var_instance_decl_c   *search_var_instance_decl;

    80

    81

    symbol_c *scope_;

    82

    83

    symbol_c* current_array_type;

    84

    symbol_c* current_param_type;

    85

    86

    int fcall_number;

    87

    symbol_c *fbname;

    88

    89

    bool first_subrange_case_list;

    90

    91

    variablegeneration_t wanted_variablegeneration;

    92

    casegeneration_t wanted_casegeneration;

    93

    94

  public:

    95

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

    96

    : generate_c_base_c(s4o_ptr) {

    97

      search_fb_instance_decl    = new search_fb_instance_decl_c   (scope);

    98

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

    99

      search_var_instance_decl   = new search_var_instance_decl_c  (scope);

   100

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

   132

  if (wanted_variablegeneration == fparam_output_vg) {

   133

    if (vartype == search_var_instance_decl_c::external_vt) {

   134

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

   135

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

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

   147

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

   148

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

   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

   159

  variablegeneration_t old_wanted_variablegeneration = wanted_variablegeneration;

   160

  s4o.print("(");

   161

  print_variable_prefix();  

   162

  wanted_variablegeneration = complextype_base_vg;

   163

  symbol->accept(*this);

   164

  s4o.print(",");

   165

  wanted_variablegeneration = complextype_suffix_vg;

   166

  symbol->accept(*this);

   167

  s4o.print(")");

   168

  wanted_variablegeneration = old_wanted_variablegeneration;

   169

  return NULL;

   170

}

   171

   172

   173

   174

void *print_setter(symbol_c* symbol,

   175

        symbol_c* type,

   176

        symbol_c* value,

   177

        symbol_c* fb_symbol = NULL,

   178

        symbol_c* fb_value = NULL) {

   179

   180

  if (fb_symbol == NULL) {

   181

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

   184

    if (vartype == search_var_instance_decl_c::external_vt) {

   187

        s4o.print(SET_EXTERNAL_FB);

   188

      else

   189

        s4o.print(SET_EXTERNAL);

   190

    }

   191

    else if (vartype == search_var_instance_decl_c::located_vt)

   192

      s4o.print(SET_LOCATED);

   193

    else

   194

      s4o.print(SET_VAR);

   195

  }

   196

  else {

   197

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

   198

    if (vartype == search_var_instance_decl_c::external_vt)

   199

      s4o.print(SET_EXTERNAL_FB);

   200

    else

   201

      s4o.print(SET_VAR);

   202

  }

   203

  s4o.print("(");

   204

   205

  if (fb_symbol != NULL) {

   206

    print_variable_prefix();

   207

    // It is my (MJS) conviction that by this time the following will always be true...

   208

    //   wanted_variablegeneration == expression_vg;

   209

    fb_symbol->accept(*this);

   210

    s4o.print(".,");

   211

    symbol->accept(*this);

   212

    s4o.print(",");

   213

    s4o.print(",");    

   214

  }

   215

  else {

   216

    print_variable_prefix();

   217

    s4o.print(",");    

   218

    wanted_variablegeneration = complextype_base_vg;

   219

    symbol->accept(*this);

   220

    s4o.print(",");

   221

    wanted_variablegeneration = complextype_suffix_vg;

   222

    symbol->accept(*this);

   223

    s4o.print(",");

   224

  }

   225

  wanted_variablegeneration = expression_vg;

   226

  print_check_function(type, value, fb_value);

   227

  s4o.print(")");

   228

  wanted_variablegeneration = expression_vg;

   229

  return NULL;

   230

}

   231

   232

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

   233

/* B 1.3.3 - Derived data types */

   234

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

   235

   236

/*  signed_integer DOTDOT signed_integer */

   237

void *visit(subrange_c *symbol) {

   238

  switch (wanted_casegeneration) {

   239

    case subrange_cg:

   240

      s4o.print("__case_expression >= ");

   241

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

   242

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

   243

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

   244

      break;

   245

    default:

   246

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

   247

      break;

   248

  }

   249

  return NULL;

   250

}

   251

   252

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

   253

void *visit(array_specification_c *symbol) {

   254

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

   255

  return NULL;

   256

}

   257

   258

/*  enumerated_type_name ':' enumerated_spec_init */

   259

void *visit(enumerated_type_declaration_c *symbol) {

   260

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

   261

  return NULL;

   262

}

   263

   264

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

   265

/* B 1.4 - Variables */

   266

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

   267

void *visit(symbolic_variable_c *symbol) {

   268

  switch (wanted_variablegeneration) {

   269

    case complextype_base_vg:

   270

      symbol->var_name->accept(*this); //generate_c_base_c::visit(symbol);

   271

      break;

   272

    case complextype_suffix_vg:

   273

      break;

   274

    default:

   275

      if (this->is_variable_prefix_null()) {

   276

        if (wanted_variablegeneration == fparam_output_vg) {

   277

          s4o.print("&(");

   278

          generate_c_base_c::visit(symbol);

   279

          s4o.print(")");

   280

        }

   281

        else {

   282

          generate_c_base_c::visit(symbol);

   283

        }

   284

      }

   285

      else

   286

        print_getter(symbol);

   287

      break;

   288

  }

   289

  return NULL;

   290

}

   291

   292

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

   293

/* B.1.4.1   Directly Represented Variables */

   294

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

   295

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

   296

void *visit(direct_variable_c *symbol) {

   297

  TRACE("direct_variable_c");

   298

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

   299

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

   300

  if (this->is_variable_prefix_null()) {

   301

    if (wanted_variablegeneration != fparam_output_vg)

   302

      s4o.print("*(");

   303

  }

   304

  else {

   305

    switch (wanted_variablegeneration) {

   306

      case expression_vg:

   307

        s4o.print(GET_LOCATED);

   308

        s4o.print("(");

   309

        break;

   310

      case fparam_output_vg:

   311

        s4o.print(GET_LOCATED_BY_REF);

   312

        s4o.print("(");

   313

        break;

   314

      default:

   315

        break;

   316

    }

   317

  }

   318

  this->print_variable_prefix();

   319

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

   320

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

   321

      (!this->is_variable_prefix_null() && (wanted_variablegeneration == expression_vg   )) ||

   322

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

   323

    s4o.print(")");

   324

  return NULL;

   325

}

   326

   327

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

   328

/* B.1.4.2   Multi-element Variables */

   329

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

   330

   331

// SYM_REF2(structured_variable_c, record_variable, field_selector)

   332

void *visit(structured_variable_c *symbol) {

   333

  TRACE("structured_variable_c");

   334

  switch (wanted_variablegeneration) {

   335

    case complextype_base_vg:

   336

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

   344

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

   345

      }

   346

      break;

   347

    case complextype_suffix_vg:

   348

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

   350

        s4o.print(".");

   351

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

   352

      }

   353

      break;

   354

    default:

   355

      if (this->is_variable_prefix_null()) {

   356

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

   357

        s4o.print(".");

   358

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

   359

      }

   360

      else

   361

        print_getter(symbol);

   362

      break;

   363

  }

   364

  return NULL;

   365

}

   366

   367

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

   368

//SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   369

void *visit(array_variable_c *symbol) {

   370

  switch (wanted_variablegeneration) {

   371

    case complextype_base_vg:

   372

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

   373

      break;

   374

    case complextype_suffix_vg:

   375

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

   376

   377

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

   378

      if (current_array_type == NULL) ERROR;

   379

   380

      s4o.print(".table");

   381

      wanted_variablegeneration = expression_vg;

   382

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

   383

      wanted_variablegeneration = complextype_suffix_vg;

   384

   385

      current_array_type = NULL;

   386

      break;

   387

    default:

   388

      if (this->is_variable_prefix_null()) {

   389

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

   390

   391

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

   392

        if (current_array_type == NULL) ERROR;

   393

   394

        s4o.print(".table");

   395

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

   396

   397

        current_array_type = NULL;

   398

      }

   399

      else

   400

        print_getter(symbol);

   401

      break;

   402

  }

   403

  return NULL;

   404

}

   405

   406

/* subscript_list ',' subscript */

   407

void *visit(subscript_list_c *symbol) {

   408

  array_dimension_iterator_c* array_dimension_iterator = new array_dimension_iterator_c(current_array_type);

   409

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

   410

    symbol_c* dimension = array_dimension_iterator->next();

   411

    if (dimension == NULL) ERROR;

   412

   413

    s4o.print("[(");

   414

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

   415

    s4o.print(") - (");

   416

    dimension->accept(*this);

   417

    s4o.print(")]");

   418

  }

   419

  delete array_dimension_iterator;

   420

  return NULL;

   421

}

   422

   423

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

   424

/* B 1.4.3 - Declaration & Initialisation */

   425

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

   426

   427

/* helper symbol for structure_initialization */

   428

/* structure_element_initialization_list ',' structure_element_initialization */

   429

void *visit(structure_element_initialization_list_c *symbol) {

   430

  generate_c_structure_initialization_c *structure_initialization = new generate_c_structure_initialization_c(&s4o);

   431

  structure_initialization->init_structure_default(this->current_param_type);

   432

  structure_initialization->init_structure_values(symbol);

   433

  delete structure_initialization;

   434

  return NULL;

   435

}

   436

   437

/* helper symbol for array_initialization */

   438

/* array_initial_elements_list ',' array_initial_elements */

   439

void *visit(array_initial_elements_list_c *symbol) {

   440

  generate_c_array_initialization_c *array_initialization = new generate_c_array_initialization_c(&s4o);

   441

  array_initialization->init_array_size(this->current_param_type);

   442

  array_initialization->init_array_values(symbol);

   443

  delete array_initialization;

   444

  return NULL;

   445

}

   446

   447

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

   448

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

   449

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

   450

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

   451

/* B 3.1 - Expressions */

   452

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

   453

void *visit(ref_expression_c *symbol) {

   454

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

   455

  if (this->is_variable_prefix_null()) {  

   456

    /* For code in FUNCTIONs */

   457

    s4o.print("&(");  

   458

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

   459

    s4o.print(")");  

   460

  } else {

   461

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

   462

    s4o.print("(");  

   463

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

   464

    if (vartype == search_var_instance_decl_c::external_vt) {

   465

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

   466

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

   467

        s4o.print(GET_EXTERNAL_FB_REF);

   468

      else

   469

        s4o.print(GET_EXTERNAL_REF);

   470

    }

   471

    else if (vartype == search_var_instance_decl_c::located_vt)

   472

      s4o.print(GET_LOCATED_REF);

   473

    else

   474

      s4o.print(GET_VAR_REF);

   475

   476

    variablegeneration_t old_wanted_variablegeneration = wanted_variablegeneration; 

   477

    s4o.print("(");

   478

    wanted_variablegeneration = complextype_base_vg;

   479

    print_variable_prefix();

   480

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

   481

    s4o.print(",");

   482

    wanted_variablegeneration = complextype_suffix_vg;

   483

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

   484

    s4o.print(")");

   485

    wanted_variablegeneration = old_wanted_variablegeneration;

   486

   487

    s4o.print(")");  

   488

  }

   489

  s4o.print(")");  

   490

   491

  return NULL;