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

    57

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

    58

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

    59

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

    60

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

    61

    62

    63

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

    64

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

    65

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

    66

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

    67

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

    68

 *

    69

 * Nevertheless, the basic visitor class visitor_c does not know

    70

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

    71

 * to extend that too.

    72

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

    73

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

    74

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

    75

 * than the alternative...

    76

 */

    77

class il_default_variable_c;

    78

    79

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

    80

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

    81

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

    82

 */

    83

class il_default_variable_visitor_c {

    84

  public:

    85

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

    86

    87

    virtual ~il_default_variable_visitor_c(void) {return;}

    88

};

    89

    90

    91

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

    92

 * the IL default variable name.

    93

 *

    94

 * It includes a reference to its name,

    95

 * and the data type of the data currently stored

    96

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

    97

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

    98

 * of the union top reference!!

    99

 *

   100

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

   101

 * the value currently being stored in the default variable.

   102

 * This is required so we can process parenthesis,

   103

 *

   104

 * e.g. :

   105

 *         LD var1

   106

 *         AND (

   107

 *         LD var2

   108

 *         OR var3

   109

 *         )

   110

 *

   111

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

   112

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

   113

 * instructions inside the parenthesis.

   114

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

   115

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

   116

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

   117

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

   118

 *

   119

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

   120

 * to track this!

   121

 */

   122

class il_default_variable_c: public symbol_c {

   123

  public:

   124

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

   125

    symbol_c *current_type;

   126

   127

  public:

   128

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

   129

    virtual void *accept(visitor_c &visitor);

   130

};

   131

   132

   133

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

   134

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

   135

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

   136

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

   137

   138

   139

   140

class generate_c_il_c: public generate_c_typedecl_c, il_default_variable_visitor_c {

   141

   142

  private:

   143

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

   144

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

   145

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

   146

     * or function currently being processed.

   147

     * The following object does just that...

   148

     * This object instance will then later be called while the

   149

     * remaining il code is being handled.

   150

     */

   151

    search_expression_type_c *search_expression_type;

   152

   153

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

   154

     * imediately after a parenthesis is opened.

   155

     * This variable is only used to pass data from the

   156

     * il_expression_c visitor to the simple_instr_list_c visitor.

   157

     *

   158

     * e.g.:

   159

     *         LD var1

   160

     *         AND ( var2

   161

     *         OR var3

   162

     *         )

   163

     *

   164

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

   165

     * an il_expression_c, where var2 should be loaded into the

   166

     * il default variable before continuing with the expression

   167

     * inside the parenthesis.

   168

     * Unfortunately, only the simple_instr_list_c may do the

   169

     * initial laoding of the var2 bariable following the parenthesis,

   170

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

   171

     * parameter to the simple_instr_list_c visitor.

   172

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

   173

     */

   174

    symbol_c *il_default_variable_init_value;

   175

   176

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

   177

    /* These variables are used to pass data from the

   178

     * il_simple_operation_c and il_expression_c visitors

   179

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

   180

     * LDN_operator_c, ST_operator_c, STN_operator_c, ...)

   181

     */

   182

    symbol_c *current_operand;

   183

    symbol_c *current_operand_type;

   184

   185

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

   186

    /* This variable is used to pass data from the

   187

     * il_jump_operation_c visitor

   188

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

   189

     * JMPC_operator_c, JMPCN_operator_c, ...)

   190

     */

   191

    symbol_c *jump_label;

   192

   193

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

   194

     * is a boolean variable.

   195

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

   196

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

   197

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

   198

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

   199

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

   200

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

   201

     * data type.

   202

     * The following object is it...

   203

     */

   204

    bool_type_name_c bool_type;

   205

   206

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

   207

    #define IL_DEFVAR_T VAR_LEADER "IL_DEFVAR_T"

   208

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

   209

    #define IL_DEFVAR   VAR_LEADER "IL_DEFVAR"

   210

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

   211

     * parenthesised instruction list to the immediately preceding

   212

     * scope ...

   213

     */

   214

    #define IL_DEFVAR_BACK   VAR_LEADER "IL_DEFVAR_BACK"

   215

    il_default_variable_c default_variable_name;

   216

    il_default_variable_c default_variable_back_name;

   217

   218

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

   219

     * by searching through the declarations of the variables currently

   220

     * in scope.

   221

     * This class does just that...

   222

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

   223

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

   224

     * This object instance will then later be called while the

   225

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

   226

     *

   227

     * Note that functions cannot contain calls to function blocks,

   228

     * so we do not create an object instance when handling

   229

     * a function declaration.

   230

     */

   231

    search_fb_instance_decl_c *search_fb_instance_decl;

   232

   233

    search_varfb_instance_type_c *search_varfb_instance_type;

   234

   235

    search_base_type_c search_base_type;

   236

   237

    bool current_param_is_pointer;

   238

   239

  public:

   240

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

   241

    : generate_c_typedecl_c(s4o_ptr),

   242

      default_variable_name(IL_DEFVAR, NULL),

   243

      default_variable_back_name(IL_DEFVAR_BACK, NULL)

   244

    {

   245

      search_expression_type = new search_expression_type_c(scope);

   246

      search_fb_instance_decl = new search_fb_instance_decl_c(scope);

   247

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

   248

      current_operand = NULL;

   249

      current_operand_type = NULL;

   250

      il_default_variable_init_value = NULL;

   251

      current_param_is_pointer = false;

   252

      this->set_variable_prefix(variable_prefix);

   253

    }

   254

   255

    virtual ~generate_c_il_c(void) {

   256

      delete search_fb_instance_decl;

   257

      delete search_expression_type;

   258

      delete search_varfb_instance_type;

   259

    }

   260

   261

    void generate(instruction_list_c *il) {

   262

      il->accept(*this);

   263

    }

   264

   265

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

   266

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

   267

     */

   268

    void declare_backup_variable(void) {

   269

      s4o.print(s4o.indent_spaces);

   270

      s4o.print(IL_DEFVAR_T);

   271

      s4o.print(" ");

   272

      print_backup_variable();

   273

      s4o.print(";\n");

   274

    }

   275

   276

    void print_backup_variable(void) {

   277

      this->default_variable_back_name.accept(*this);

   278

    }

   279

   280

  private:

   281

    /* A helper function... */

   282

    /*

   283

    bool is_bool_type(symbol_c *type_symbol) {

   284

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

   285

    }

   286

    */

   287

   288

    /* A helper function... */

   289

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

   290

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

   291

      if (NULL == op) ERROR;

   292

   293

      lo->accept(*this);

   294

      s4o.print(op);

   295

      ro->accept(*this);

   296

      return NULL;

   297

    }

   298

   299

    /* A helper function... */

   300

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

   301

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

   302

      if (NULL == func) ERROR;

   303

   304

      lo->accept(*this);

   305

      s4o.print(" = ");

   306

      s4o.print(func);

   307

      s4o.print("(");

   308

      lo->accept(*this);

   309

      s4o.print(", ");

   310

      ro->accept(*this);

   311

      s4o.print(")");

   312

      return NULL;

   313

    }

   314

   315

    /* A helper function... */

   316

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

   317

      if (NULL == fb_name) ERROR;

   318

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

   319

      if (NULL == sv) ERROR;

   320

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

   321

      if (NULL == id) ERROR;

   323

      identifier_c param(param_name);

   324

   325

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

   328

      // SYM_LIST(il_param_list_c)

   330

      il_param_list.add_element(&il_param_assignment);

   331

      CAL_operator_c CAL_operator;

   332

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

   333

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

   334

   335

      il_fb_call.accept(*this);

   336

      return NULL;

   337

    }

   338

   339

    /* A helper function... */

   340

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

   341

      if (NULL == o) ERROR;

   342

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

   343

   344

      symbol_c *backup = this->default_variable_name.current_type;

   345

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

   346

      this->default_variable_name.accept(*this);

   347

      this->default_variable_name.current_type = backup;

   348

   349

      s4o.print(" = ");

   350

      s4o.print(operation);

   351

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

   352

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

   353

      this->default_variable_name.accept(*this);

   354

      s4o.print(", ");

   355

      o->accept(*this);

   356

      s4o.print(")");

   357

   358

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

   359

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

   360

      return NULL;

   361

    }

   362

   363

   364

    /* A helper function... */

   365

    void C_modifier(void) {

   366

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

   367

        s4o.print("if (");

   368

        this->default_variable_name.accept(*this);

   369

        s4o.print(") ");

   370

      }

   371

      else {ERROR;}

   372

    }

   373

   374

    /* A helper function... */

   375

    void CN_modifier(void) {

   376

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

   377

        s4o.print("if (!");

   378

        this->default_variable_name.accept(*this);

   379

        s4o.print(") ");

   380

      }

   381

      else {ERROR;}

   382

    }

   383

   384

   385

public:

   386

void *visit(il_default_variable_c *symbol) {

   387

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

   388

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

   389

  if (NULL != symbol->current_type) {

   390

    s4o.print(".");

   391

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

   392

    s4o.print("var");

   393

  }

   394

  return NULL;

   395

}

   396

   397

   398

private:

   399

   403

void *visit(eno_param_c *symbol) {

   404

  if (this->is_variable_prefix_null()) {

   405

    s4o.print("*");

   406

  }

   407

  else {

   408

    this->print_variable_prefix();

   409

  }

   410

  s4o.print("ENO");

   411

  return NULL;

   412

}

   416

   417

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

   418

/* B 1.4 - Variables */

   419

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

   420

void *visit(symbolic_variable_c *symbol) {

   421

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

   422

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

   423

    s4o.print("*(");

   424

    generate_c_base_c::visit(symbol);

   425

    s4o.print(")");

   426

  }

   427

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

   428

    s4o.print("&(");

   429

    generate_c_base_c::visit(symbol);

   430

    s4o.print(")");

   431

  }

   432

  else {

   433

    generate_c_base_c::visit(symbol);

   434

  }

   435

  return NULL;

   436

}

   437

   438

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

   439

/* B.1.4.1   Directly Represented Variables */

   440

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

   441

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

   442

void *visit(direct_variable_c *symbol) {

   443

  TRACE("direct_variable_c");

   444

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

   445

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

   446

  if (!current_param_is_pointer) {

   447

    s4o.print("*(");

   448

  }

   449

  this->print_variable_prefix();

   450

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

   451

  if (!current_param_is_pointer) {

   452

    s4o.print(")");

   453

  }

   454

  return NULL;

   455

}

   456

   457

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

   458

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

   459

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

   460

   461

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

   462

/* B 2.1 Instructions and Operands */

   463

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

   464

   465

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

   466

#define END_LABEL VAR_LEADER "end"

   467

   468

/*| instruction_list il_instruction */

   469

void *visit(instruction_list_c *symbol) {

   470

   471

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

   472

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

   473

   */

   474

  declare_backup_variable();

   475

   476

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

   477

  s4o.print(s4o.indent_spaces);

   478

  s4o.print(IL_DEFVAR_T);

   479

  s4o.print(" ");

   480

  this->default_variable_name.accept(*this);

   481

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

   482

   483

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

   484

   485

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

   486

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

   487

  s4o.print("\n");

   488

  s4o.print(s4o.indent_spaces);

   489

  s4o.print(END_LABEL);

   490

  s4o.print(":\n");

   491

  s4o.indent_right();

   492

  /* since every label must be followed by at least one statement, and

   493

   * only the functions will introduce the return statement after this label,

   494

   * function blocks written in IL would result in invalid C++ code.

   495

   * To work around this we introduce the equivalent of a 'nop' operation

   496

   * to humour the compiler...

   497

   */

   498

  s4o.print(s4o.indent_spaces);

   499

  s4o.print("/* to humour the compiler, we insert a nop */\n");

   500

  s4o.print(s4o.indent_spaces);

   501

  this->default_variable_name.accept(*this);

   502

  s4o.print(" = ");

   503

  this->default_variable_name.accept(*this);

   504

  s4o.print(";\n");

   505

  s4o.indent_left();

   506

   507

  return NULL;

   508

}

   509

   510

   511

/* | label ':' [il_incomplete_instruction] eol_list */

   512

// SYM_REF2(il_instruction_c, label, il_instruction)

   513

void *visit(il_instruction_c *symbol) {

   514

  if (NULL != symbol->label) {

   515

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

   516

    s4o.print(":\n");

   517

    s4o.print(s4o.indent_spaces);

   518

  }

   519

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

   520

  return NULL;

   521

}

   522

   523

/* | il_simple_operator [il_operand] */

   524

//SYM_REF2(il_simple_operation_c, il_simple_operator, il_operand)