1

/*

     2

 * (c) 2003 Mario de Sousa

     3

 *

     4

 * Offered to the public under the terms of the GNU General Public License

     5

 * as published by the Free Software Foundation; either version 2 of the

     6

 * License, or (at your option) any later version.

     7

 *

     8

 * This program is distributed in the hope that it will be useful, but

     9

 * WITHOUT ANY WARRANTY; without even the implied warranty of

    10

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General

    11

 * Public License for more details.

    12

 *

    13

 * This code is made available on the understanding that it will not be

    14

 * used in safety-critical situations without a full and competent review.

    15

 */

    16

    17

/*

    18

 * An IEC 61131-3 IL and ST compiler.

    19

 *

    20

 * Based on the

    21

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    22

 *

    23

 */

    24

    25

    26

/*

    27

 * Conversion of il statements (i.e. IL code).

    28

 *

    29

 * This is part of the 4th stage that generates

    30

 * a c++ source program equivalent to the IL and ST

    31

 * code.

    32

 */

    33

    34

    35

    36

    37

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

    38

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

    39

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

    40

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

    41

    42

/* Returns the data type of an il_operand.

    43

 *

    44

 * Note that the il_operand may be a variable, in which case

    45

 * we return the type of the variable instance.

    46

 * The il_operand may also be a constant, in which case

    47

 * we return the data type of that constant.

    48

 *

    49

 * The variable instance may be a member of a structured variable,

    50

 * or an element in an array, or any combination of the two.

    51

 *

    52

 * The class constructor must be given the search scope

    53

 * (function, function block or program within which

    54

 * the possible il_operand variable instance was declared).

    55

 */

    56

    58

    59

    60

    61

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

    62

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

    63

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

    64

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

    65

    66

    67

/* A new class to ouput the il default variable to c++ code

    68

 * We use this class, inheriting from symbol_c, so it may be used

    69

 * as any other symbol_c object in the intermediate parse tree,

    70

 * more specifically, so it can be used as any other il operand.

    71

 * This makes the rest of the code much easier...

    72

 *

    73

 * Nevertheless, the basic visitor class visitor_c does not know

    74

 * how to visit this new il_default_variable_c class, so we have

    75

 * to extend that too.

    76

 * In reality extending the basic symbols doesn't quite work out

    77

 * as cleanly as desired (we need to use dynamic_cast in the

    78

 * accept method of the il_default_variable_c), but it is cleaner

    79

 * than the alternative...

    80

 */

    81

class il_default_variable_c;

    82

    83

/* This visitor class is not really required, we could place the

    84

 * visit() method directly in genertae_cc_il_c, but doing it in

    85

 * a seperate class makes the architecture more evident...

    86

 */

    87

class il_default_variable_visitor_c {

    88

  public:

    89

    virtual void *visit(il_default_variable_c *symbol) = 0;

    90

    91

    virtual ~il_default_variable_visitor_c(void) {return;}

    92

};

    93

    94

    95

/* A class to print out to the resulting C++ code

    96

 * the IL default variable name.

    97

 *

    98

 * It includes a reference to its name,

    99

 * and the data type of the data currently stored

   100

 * in this C++ variable... This is required because the

   101

 * C++ variable is a union, and we must know which member

   102

 * of the union top reference!!

   103

 *

   104

 * Note that we also need to keep track of the data type of

   105

 * the value currently being stored in the default variable.

   106

 * This is required so we can process parenthesis,

   107

 *

   108

 * e.g. :

   109

 *         LD var1

   110

 *         AND (

   111

 *         LD var2

   112

 *         OR var3

   113

 *         )

   114

 *

   115

 * Note that we only execute the 'AND (' operation when we come across

   116

 * the ')', i.e. once we have evaluated the result of the

   117

 * instructions inside the parenthesis.

   118

 * When we do execute the 'AND (' operation, we need to know the data type

   119

 * of the operand, which in this case is the result of the evaluation of the

   120

 * instruction list inside the parenthesis. We can only know this if we

   121

 * keep track of the data type currently stored in the default variable!

   122

 *

   123

 * We use the current_type inside the generate_c_il::default_variable_name variable

   124

 * to track this!

   125

 */

   126

class il_default_variable_c: public symbol_c {

   127

  public:

   128

    symbol_c *var_name;  /* in principle, this should point to an indentifier_c */

   129

    symbol_c *current_type;

   130

   131

  public:

   132

    il_default_variable_c(const char *var_name_str, symbol_c *current_type);

   133

    virtual void *accept(visitor_c &visitor);

   134

};

   135

   136

   137

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

   138

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

   139

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

   140

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

   141

   142

   143

   144

class generate_c_il_c: public generate_c_typedecl_c, il_default_variable_visitor_c {

   145

   146

  private:

   147

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

   148

     * data type of il operands. To do this, we must first find the

   149

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

   150

     * or function currently being processed.

   151

     * The following object does just that...

   152

     * This object instance will then later be called while the

   153

     * remaining il code is being handled.

   154

     */

   155

    //search_il_operand_type_c *search_il_operand_type;

   156

    search_expression_type_c *search_expression_type;

   157

   158

    /* The initial value that should be given to the IL default variable

   159

     * imediately after a parenthesis is opened.

   160

     * This variable is only used to pass data from the

   161

     * il_expression_c visitor to the simple_instr_list_c visitor.

   162

     *

   163

     * e.g.:

   164

     *         LD var1

   165

     *         AND ( var2

   166

     *         OR var3

   167

     *         )

   168

     *

   169

     * In the above code sample, the line 'AND ( var2' constitutes

   170

     * an il_expression_c, where var2 should be loaded into the

   171

     * il default variable before continuing with the expression

   172

     * inside the parenthesis.

   173

     * Unfortunately, only the simple_instr_list_c may do the

   174

     * initial laoding of the var2 bariable following the parenthesis,

   175

     * so the il_expression_c visitor will have to pass 'var2' as a

   176

     * parameter to the simple_instr_list_c visitor.

   177

     * Ergo, the existance of the following parameter...!

   178

     */

   179

    symbol_c *il_default_variable_init_value;

   180

   181

    /* Operand to the IL operation currently being processed... */

   182

    /* These variables are used to pass data from the

   183

     * il_simple_operation_c and il_expression_c visitors

   184

     * to the il operator visitors (i.e. LD_operator_c,

   185

     * LDN_operator_c, ST_operator_c, STN_operator_c, ...)

   186

     */

   187

    symbol_c *current_operand;

   188

    symbol_c *current_operand_type;

   189

   190

    /* Label to which the current IL jump operation should jump to... */

   191

    /* This variable is used to pass data from the

   192

     * il_jump_operation_c visitor

   193

     * to the il jump operator visitors (i.e. JMP_operator_c,

   194

     * JMPC_operator_c, JMPCN_operator_c, ...)

   195

     */

   196

    symbol_c *jump_label;

   197

   198

    /* The result of the comparison IL operations (GT, EQ, LT, ...)

   199

     * is a boolean variable.

   200

     * This class keeps track of the current data type stored in the

   201

     * il default variable. This is usually done by keeping a reference

   202

     * to the data type of the last operand. Nevertheless, in the case of

   203

     * the comparison IL operators, the data type of the result (a boolean)

   204

     * is not the data type of the operand. We therefore need an object

   205

     * of the boolean data type to keep as a reference of the current

   206

     * data type.

   207

     * The following object is it...

   208

     */

   209

    bool_type_name_c bool_type;

   210

   211

    /* the data type of the IL default variable... */

   212

    #define IL_DEFVAR_T VAR_LEADER "IL_DEFVAR_T"

   213

    /* The name of the IL default variable... */

   214

    #define IL_DEFVAR   VAR_LEADER "IL_DEFVAR"

   215

    /* The name of the variable used to pass the result of a

   216

     * parenthesised instruction list to the immediately preceding

   217

     * scope ...

   218

     */

   219

    #define IL_DEFVAR_BACK   VAR_LEADER "IL_DEFVAR_BACK"

   220

    il_default_variable_c default_variable_name;

   221

    il_default_variable_c default_variable_back_name;

   222

   223

    /* Some function calls in the body of functions or function blocks

   224

     * may leave some parameters to their default values, and

   225

     * ignore some output parameters of the function being called.

   226

     * Our conversion of ST functions to C++ does not contemplate that,

   227

     * i.e. each called function must get all it's input and output

   228

     * parameters set correctly.

   229

     * For input parameters we merely need to call the function with

   230

     * the apropriate default value, but for output parameters

   231

     * we must create temporary variables to hold the output value.

   232

     *

   233

     * We declare all the temporary output variables at the begining of

   234

     * the body of each function or function block, and use them as

   235

     * in function calls later on as they become necessary...

   236

     * Note that we cannot create these variables just before a function

   237

     * call, as the function call itself may be integrated within an

   238

     * expression, or another function call!

   239

     *

   240

     * The variables are declared in the exact same order in which they

   241

     * will be used later on during the function calls, which allows us

   242

     * to simply re-create the name that was used for the temporary variable

   243

     * instead of keeping it in some list.

   244

     * The names are recreated by the temp_var_name_factory, after reset()

   245

     * has been called!

   246

     *

   247

     * This function will genertae code similar to...

   248

     *

   249

     *     INT __TMP_0 = 23;

   250

     *     REAL __TMP_1 = 45.5;

   251

     *     ...

   252

     */

   253

    temp_var_name_c temp_var_name_factory;

   254

   255

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

   256

     * by searching through the declarations of the variables currently

   257

     * in scope.

   258

     * This class does just that...

   259

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

   260

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

   261

     * This object instance will then later be called while the

   262

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

   263

     *

   264

     * Note that functions cannot contain calls to function blocks,

   265

     * so we do not create an object instance when handling

   266

     * a function declaration.

   267

     */

   268

    search_fb_instance_decl_c *search_fb_instance_decl;

   269

   270

    search_varfb_instance_type_c *search_varfb_instance_type;

   271

   272

    search_base_type_c search_base_type;

   273

   274

    bool current_param_is_pointer;

   275

   276

  public:

   277

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

   278

    : generate_c_typedecl_c(s4o_ptr),

   279

      default_variable_name(IL_DEFVAR, NULL),

   280

      default_variable_back_name(IL_DEFVAR_BACK, NULL)

   281

    {

   282

      //search_il_operand_type  = new search_il_operand_type_c(scope);

   283

      search_expression_type = new search_expression_type_c(scope);

   284

      search_fb_instance_decl = new search_fb_instance_decl_c(scope);

   285

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

   286

      current_operand = NULL;

   287

      current_operand_type = NULL;

   288

      il_default_variable_init_value = NULL;

   289

      current_param_is_pointer = false;

   290

      this->set_variable_prefix(variable_prefix);

   291

    }

   292

   293

    virtual ~generate_c_il_c(void) {

   294

      delete search_fb_instance_decl;

   295

      //delete search_il_operand_type;

   296

      delete search_expression_type;

   297

      delete search_varfb_instance_type;

   298

    }

   299

   300

    void generate(instruction_list_c *il) {

   301

      generate_c_tempvardecl_c generate_c_tempvardecl(&s4o);

   302

      generate_c_tempvardecl.generate(il, &temp_var_name_factory);

   303

      il->accept(*this);

   304

    }

   305

   306

    /* Declare the backup to the default variable, that will store the result

   307

     * of the IL operations executed inside a parenthesis...

   308

     */

   309

    void declare_backup_variable(void) {

   310

      s4o.print(s4o.indent_spaces);

   311

      s4o.print(IL_DEFVAR_T);

   312

      s4o.print(" ");

   313

      print_backup_variable();

   314

      s4o.print(";\n");

   315

    }

   316

   317

    void print_backup_variable(void) {

   318

      this->default_variable_back_name.accept(*this);

   319

    }

   320

   321

  private:

   322

    /* A helper function... */

   323

    /*

   324

    bool is_bool_type(symbol_c *type_symbol) {

   325

      return (NULL != dynamic_cast<bool_type_name_c *>(type_symbol));

   326

    }

   327

    */

   328

   329

    /* A helper function... */

   330

    void *XXX_operator(symbol_c *lo, const char *op, symbol_c *ro) {

   331

      if ((NULL == lo) || (NULL == ro)) ERROR;

   332

      if (NULL == op) ERROR;

   333

   334

      lo->accept(*this);

   335

      s4o.print(op);

   336

      ro->accept(*this);

   337

      return NULL;

   338

    }

   339

   340

    /* A helper function... */

   341

    void *XXX_function(const char *func, symbol_c *lo, symbol_c *ro) {

   342

      if ((NULL == lo) || (NULL == ro)) ERROR;

   343

      if (NULL == func) ERROR;

   344

   345

      lo->accept(*this);

   346

      s4o.print(" = ");

   347

      s4o.print(func);

   348

      s4o.print("(");

   349

      lo->accept(*this);

   350

      s4o.print(", ");

   351

      ro->accept(*this);

   352

      s4o.print(")");

   353

      return NULL;

   354

    }

   355

   356

    /* A helper function... */

   357

    void *XXX_CAL_operator(const char *param_name, symbol_c *fb_name) {

   358

      if (NULL == fb_name) ERROR;

   359

      symbolic_variable_c *sv = dynamic_cast<symbolic_variable_c *>(fb_name);

   360

      if (NULL == sv) ERROR;

   361

      identifier_c *id = dynamic_cast<identifier_c *>(sv->var_name);

   362

      if (NULL == id) ERROR;

   363

   364

      identifier_c param(param_name);

   365

   366

      //SYM_REF3(il_param_assignment_c, il_assign_operator, il_operand, simple_instr_list)

   367

      il_param_assignment_c il_param_assignment(&param, &this->default_variable_name, NULL);

   368

      // SYM_LIST(il_param_list_c)

   369

      il_param_list_c il_param_list;

   370

      il_param_list.add_element(&il_param_assignment);

   371

      CAL_operator_c CAL_operator;

   372

      // SYM_REF4(il_fb_call_c, il_call_operator, fb_name, il_operand_list, il_param_list)

   373

      il_fb_call_c il_fb_call(&CAL_operator, id, NULL, &il_param_list);

   374

   375

      il_fb_call.accept(*this);

   376

      return NULL;

   377

    }

   378

   379

    /* A helper function... */

   380

    void *CMP_operator(symbol_c *o, const char *operation) {

   381

      if (NULL == o) ERROR;

   382

      if (NULL == this->default_variable_name.current_type) ERROR;

   383

   384

      symbol_c *backup = this->default_variable_name.current_type;

   385

      this->default_variable_name.current_type = &(this->bool_type);

   386

      this->default_variable_name.accept(*this);

   387

      this->default_variable_name.current_type = backup;

   388

   389

      s4o.print(" = ");

   390

      s4o.print(operation);

   391

      this->default_variable_name.current_type->accept(*this);

   392

      s4o.print("(__BOOL_LITERAL(TRUE), NULL, 2, ");

   393

      this->default_variable_name.accept(*this);

   394

      s4o.print(", ");

   395

      o->accept(*this);

   396

      s4o.print(")");

   397

   398

      /* the data type resulting from this operation... */

   399

      this->default_variable_name.current_type = &(this->bool_type);

   400

      return NULL;

   401

    }

   402

   403

   404

    /* A helper function... */

   405

    void C_modifier(void) {

   406

      if (search_expression_type->is_bool_type(default_variable_name.current_type)) {

   407

        s4o.print("if (");

   408

        this->default_variable_name.accept(*this);

   409

        s4o.print(") ");

   410

      }

   411

      else {ERROR;}

   412

    }

   413

   414

    /* A helper function... */

   415

    void CN_modifier(void) {

   416

      if (search_expression_type->is_bool_type(default_variable_name.current_type)) {

   417

        s4o.print("if (!");

   418

        this->default_variable_name.accept(*this);

   419

        s4o.print(") ");

   420

      }

   421

      else {ERROR;}

   422

    }

   423

   424

   425

public:

   426

void *visit(il_default_variable_c *symbol) {

   427

  //s4o.print("il_default_variable_c VISITOR!!\n");

   428

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

   429

  if (NULL != symbol->current_type) {

   430

    s4o.print(".");

   431

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

   432

    s4o.print("var");

   433

  }

   434

  return NULL;

   435

}

   436

   437

   438

private:

   439

   440

void *visit(eno_param_c *symbol) {

   441

  if (this->is_variable_prefix_null()) {

   442

    s4o.print("*");

   443

  }

   444

  else {

   445

    this->print_variable_prefix();

   446

  }

   447

  s4o.print("ENO");

   448

  return NULL;

   449

}

   450

   451

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

   452

/* B 1.4 - Variables */

   453

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

   454

void *visit(symbolic_variable_c *symbol) {

   455

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

   456

  if (!current_param_is_pointer && (vartype == search_var_instance_decl_c::external_vt || vartype == search_var_instance_decl_c::located_vt)) {

   457

    s4o.print("*(");

   458

    generate_c_base_c::visit(symbol);

   459

    s4o.print(")");

   460

  }

   461

  else if (current_param_is_pointer && vartype != search_var_instance_decl_c::external_vt && vartype != search_var_instance_decl_c::located_vt) {

   462

    s4o.print("&(");

   463

    generate_c_base_c::visit(symbol);

   464

    s4o.print(")");

   465

  }

   466

  else {

   467

    generate_c_base_c::visit(symbol);

   468

  }

   469

  return NULL;

   470

}

   471

   472

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

   473

/* B.1.4.1   Directly Represented Variables */

   474

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

   475

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

   476

void *visit(direct_variable_c *symbol) {

   477

  TRACE("direct_variable_c");

   478

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

   479

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

   480

  if (!current_param_is_pointer) {

   481

    s4o.print("*(");

   482

  }

   483

  this->print_variable_prefix();

   484

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

   485

  if (!current_param_is_pointer) {

   486

    s4o.print(")");

   487

  }

   488

  return NULL;

   489

}

   490

   491

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

   492

/* B.2 - Language IL (Instruction List) */

   493

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

   494

   495

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

   496

/* B 2.1 Instructions and Operands */

   497

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

   498

   499

/* please see the comment before the RET_operator_c visitor for details... */

   500

#define END_LABEL VAR_LEADER "end"

   501

   502

/*| instruction_list il_instruction */

   503

void *visit(instruction_list_c *symbol) {

   504

   505

  /* Declare the backup to the default variable, that will store the result

   506

   * of the IL operations executed inside a parenthesis...

   507

   */

   508

  declare_backup_variable();

   509

   510

  /* Declare the default variable, that will store the result of the IL operations... */

   511

  s4o.print(s4o.indent_spaces);

   512

  s4o.print(IL_DEFVAR_T);

   513

  s4o.print(" ");

   514

  this->default_variable_name.accept(*this);

   515

  s4o.print(";\n\n");

   516

   517

  print_list(symbol, s4o.indent_spaces, ";\n" + s4o.indent_spaces, ";\n");

   518

   519

  /* write the label marking the end of the code block */

   520

  /* please see the comment before the RET_operator_c visitor for details... */

   521

  s4o.print("\n");

   522

  s4o.print(s4o.indent_spaces);

   523

  s4o.print(END_LABEL);

   524

  s4o.print(":\n");

   525

  s4o.indent_right();