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;

   208

   209

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

   210

    #define IL_DEFVAR_T VAR_LEADER "IL_DEFVAR_T"

   211

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

   212

    #define IL_DEFVAR   VAR_LEADER "IL_DEFVAR"

   213

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

   214

     * parenthesised instruction list to the immediately preceding

   215

     * scope ...

   216

     */

   217

    #define IL_DEFVAR_BACK   VAR_LEADER "IL_DEFVAR_BACK"

   218

    il_default_variable_c default_variable_name;

   219

    il_default_variable_c default_variable_back_name;

   220

   221

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

   222

     * by searching through the declarations of the variables currently

   223

     * in scope.

   224

     * This class does just that...

   225

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

   226

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

   227

     * This object instance will then later be called while the

   228

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

   229

     *

   230

     * Note that functions cannot contain calls to function blocks,

   231

     * so we do not create an object instance when handling

   232

     * a function declaration.

   233

     */

   234

    search_fb_instance_decl_c *search_fb_instance_decl;

   235

   236

    search_varfb_instance_type_c *search_varfb_instance_type;

   237

   238

    search_base_type_c search_base_type;

   239

   240

    bool current_param_is_pointer;

   241

   242

  public:

   243

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

   244

    : generate_c_typedecl_c(s4o_ptr),

   245

      default_variable_name(IL_DEFVAR, NULL),

   246

      default_variable_back_name(IL_DEFVAR_BACK, NULL)

   247

    {

   248

      search_expression_type = new search_expression_type_c(scope);

   249

      search_fb_instance_decl = new search_fb_instance_decl_c(scope);

   250

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

   251

      current_operand = NULL;

   252

      current_operand_type = NULL;

   253

      il_default_variable_init_value = NULL;

   254

      current_param_is_pointer = false;

   255

      this->set_variable_prefix(variable_prefix);

   256

    }

   257

   258

    virtual ~generate_c_il_c(void) {

   259

      delete search_fb_instance_decl;

   260

      delete search_expression_type;

   261

      delete search_varfb_instance_type;

   262

    }

   263

   264

    void generate(instruction_list_c *il) {

   265

      il->accept(*this);

   266

    }

   267

   268

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

   269

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

   270

     */

   271

    void declare_backup_variable(void) {

   272

      s4o.print(s4o.indent_spaces);

   273

      s4o.print(IL_DEFVAR_T);

   274

      s4o.print(" ");

   275

      print_backup_variable();

   276

      s4o.print(";\n");

   277

    }

   278

   279

    void print_backup_variable(void) {

   280

      this->default_variable_back_name.accept(*this);

   281

    }

   282

   283

  private:

   284

    /* A helper function... */

   285

    /*

   286

    bool is_bool_type(symbol_c *type_symbol) {

   287

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

   288

    }

   289

    */

   290

   291

    /* A helper function... */

   292

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

   293

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

   294

      if (NULL == op) ERROR;

   295

   296

      lo->accept(*this);

   297

      s4o.print(op);

   298

      ro->accept(*this);

   299

      return NULL;

   300

    }

   301

   302

    /* A helper function... */

   303

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

   304

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

   305

      if (NULL == func) ERROR;

   306

   307

      lo->accept(*this);

   308

      s4o.print(" = ");

   309

      s4o.print(func);

   310

      s4o.print("(");

   311

      lo->accept(*this);

   312

      s4o.print(", ");

   313

      ro->accept(*this);

   314

      s4o.print(")");

   315

      return NULL;

   316

    }

   317

   318

    /* A helper function... */

   319

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

   320

      if (NULL == fb_name) ERROR;

   321

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

   322

      if (NULL == sv) ERROR;

   323

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

   324

      if (NULL == id) ERROR;

   325

   326

      identifier_c param(param_name);

   327

   328

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

   329

      il_assign_operator_c il_assign_operator(&param);

   330

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

   331

      // SYM_LIST(il_param_list_c)

   332

      il_param_list_c il_param_list;   

   333

      il_param_list.add_element(&il_param_assignment);

   334

      CAL_operator_c CAL_operator;

   335

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

   336

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

   337

   338

      il_fb_call.accept(*this);

   339

      return NULL;

   340

    }

   341

   342

    /* A helper function... */

   343

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

   344

      if (NULL == o) ERROR;

   345

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

   346

   347

      symbol_c *backup = this->default_variable_name.current_type;

   348

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

   349

      this->default_variable_name.accept(*this);

   350

      this->default_variable_name.current_type = backup;

   351

   352

      s4o.print(" = ");

   353

      s4o.print(operation);

   354

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

   355

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

   356

      this->default_variable_name.accept(*this);

   357

      s4o.print(", ");

   358

      o->accept(*this);

   359

      s4o.print(")");

   360

   361

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

   362

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

   363

      return NULL;

   364

    }

   365

   366

   367

    /* A helper function... */

   368

    void C_modifier(void) {

   369

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

   370

        s4o.print("if (");

   371

        this->default_variable_name.accept(*this);

   372

        s4o.print(") ");

   373

      }

   374

      else {ERROR;}

   375

    }

   376

   377

    /* A helper function... */

   378

    void CN_modifier(void) {

   379

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

   380

        s4o.print("if (!");

   381

        this->default_variable_name.accept(*this);

   382

        s4o.print(") ");

   383

      }

   384

      else {ERROR;}

   385

    }

   386

   419

   420

public:

   421

void *visit(il_default_variable_c *symbol) {

   422

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

   423

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

   424

  if (NULL != symbol->current_type) {

   425

    s4o.print(".");

   426

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

   427

    s4o.print("var");

   428

  }

   429

  return NULL;

   430

}

   431

   432

   433

private:

   434

   435

#if 0

   436

I NEED TO FIX THIS!!!

   437

TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO

   438

void *visit(eno_param_c *symbol) {

   439

  if (this->is_variable_prefix_null()) {

   440

    s4o.print("*");

   441

  }

   442

  else {

   443

    this->print_variable_prefix();

   444

  }

   445

  s4o.print("ENO");

   446

  return NULL;

   447

}

   448

TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO TODO

   449

#endif

   450

   451

   452

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

   453

/* B 1.4 - Variables */

   454

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

   455

void *visit(symbolic_variable_c *symbol) {

   456

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

   457

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

   458

    s4o.print("*(");

   459

    generate_c_base_c::visit(symbol);

   460

    s4o.print(")");

   461

  }

   462

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

   463

    s4o.print("&(");

   464

    generate_c_base_c::visit(symbol);

   465

    s4o.print(")");

   466

  }

   467

  else {

   468

    generate_c_base_c::visit(symbol);

   469

  }

   470

  return NULL;

   471

}

   472

   473

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

   474

/* B.1.4.1   Directly Represented Variables */

   475

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

   476

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

   477

void *visit(direct_variable_c *symbol) {

   478

  TRACE("direct_variable_c");

   479

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

   480

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

   481

  if (!current_param_is_pointer) {

   482

    s4o.print("*(");

   483

  }

   484

  this->print_variable_prefix();

   485

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

   486

  if (!current_param_is_pointer) {

   487

    s4o.print(")");

   488

  }

   489

  return NULL;

   490

}

   491

   492

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

   493

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

   494

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

   495

   496

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

   497

/* B 2.1 Instructions and Operands */

   498

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

   499

   500

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

   501

#define END_LABEL VAR_LEADER "end"

   502

   503

/*| instruction_list il_instruction */

   504

void *visit(instruction_list_c *symbol) {

   505

   506

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

   507

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

   508

   */

   509

  declare_backup_variable();

   510

   511

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

   512

  s4o.print(s4o.indent_spaces);

   513

  s4o.print(IL_DEFVAR_T);

   514

  s4o.print(" ");

   515

  this->default_variable_name.accept(*this);

   516

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

   517

   518

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

   519

   520

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

   521

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