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

 *

    21

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

    22

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

    23

 */

    24

    25

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

    26

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

    27

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

    28

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

    29

    30

/* Returns the data type of an il_operand.

    31

 *

    32

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

    33

 * we return the type of the variable instance.

    34

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

    35

 * we return the data type of that constant.

    36

 *

    37

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

    38

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

    39

 *

    40

 * The class constructor must be given the search scope

    41

 * (function, function block or program within which

    42

 * the possible il_operand variable instance was declared).

    43

 */

    44

    45

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

    46

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

    47

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

    48

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

    49

    50

    51

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

    52

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

    53

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

    54

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

    55

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

    56

 *

    57

 * Nevertheless, the basic visitor class visitor_c does not know

    58

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

    59

 * to extend that too.

    60

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

    61

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

    62

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

    63

 * than the alternative...

    64

 */

    65

class il_default_variable_c;

    66

    67

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

    68

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

    69

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

    70

 */

    71

class il_default_variable_visitor_c {

    72

  public:

    73

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

    74

    75

    virtual ~il_default_variable_visitor_c(void) {return;}

    76

};

    77

    78

    79

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

    80

 * the IL default variable name.

    81

 *

    82

 * It includes a reference to its name,

    83

 * and the data type of the data currently stored

    84

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

    85

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

    86

 * of the union top reference!!

    87

 *

    88

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

    89

 * the value currently being stored in the default variable.

    90

 * This is required so we can process parenthesis,

    91

 *

    92

 * e.g. :

    93

 *         LD var1

    94

 *         AND (

    95

 *         LD var2

    96

 *         OR var3

    97

 *         )

    98

 *

    99

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

   100

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

   101

 * instructions inside the parenthesis.

   102

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

   103

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

   104

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

   105

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

   106

 *

   107

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

   108

 * to track this!

   109

 */

   110

class il_default_variable_c: public symbol_c {

   111

  public:

   112

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

   113

    symbol_c *current_type;

   114

   115

  public:

   116

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

   117

    virtual void *accept(visitor_c &visitor);

   118

};

   119

   120

   121

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

   122

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

   123

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

   124

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

   125

   126

   127

   128

class generate_c_il_c: public generate_c_typedecl_c, il_default_variable_visitor_c {

   129

   130

  public:

   131

    typedef enum {

   132

      expression_vg,

   133

      assignment_vg,

   134

      complextype_base_vg,

   135

      complextype_suffix_vg,

   136

      fparam_output_vg

   137

    } variablegeneration_t;

   138

   139

  private:

   140

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

   141

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

   142

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

   143

     * or function currently being processed.

   144

     * The following object does just that...

   145

     * This object instance will then later be called while the

   146

     * remaining il code is being handled.

   147

     */

   148

    search_expression_type_c *search_expression_type;

   149

   150

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

   151

     * imediately after a parenthesis is opened.

   152

     * This variable is only used to pass data from the

   153

     * il_expression_c visitor to the simple_instr_list_c visitor.

   154

     *

   155

     * e.g.:

   156

     *         LD var1

   157

     *         AND ( var2

   158

     *         OR var3

   159

     *         )

   160

     *

   161

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

   162

     * an il_expression_c, where var2 should be loaded into the

   163

     * il default variable before continuing with the expression

   164

     * inside the parenthesis.

   165

     * Unfortunately, only the simple_instr_list_c may do the

   166

     * initial laoding of the var2 bariable following the parenthesis,

   167

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

   168

     * parameter to the simple_instr_list_c visitor.

   169

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

   170

     */

   171

    symbol_c *il_default_variable_init_value;

   172

   173

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

   174

    /* These variables are used to pass data from the

   175

     * il_simple_operation_c and il_expression_c visitors

   176

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

   177

     * LDN_operator_c, ST_operator_c, STN_operator_c, ...)

   178

     */

   179

    symbol_c *current_operand;

   180

    symbol_c *current_operand_type;

   181

   182

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

   183

    /* This variable is used to pass data from the

   184

     * il_jump_operation_c visitor

   185

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

   186

     * JMPC_operator_c, JMPCN_operator_c, ...)

   187

     */

   188

    symbol_c *jump_label;

   189

   190

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

   191

     * is a boolean variable.

   192

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

   193

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

   194

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

   195

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

   196

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

   197

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

   198

     * data type.

   199

     * The following object is it...

   200

     */

   201

    bool_type_name_c bool_type;

   202

    lint_type_name_c lint_type;

   203

    lword_type_name_c lword_type;

   204

    lreal_type_name_c lreal_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

    symbol_c* current_array_type;

   238

    symbol_c* current_param_type;

   239

   240

    int fcall_number;

   241

    symbol_c *fbname;

   242

   243

    variablegeneration_t wanted_variablegeneration;

   244

   245

  public:

   246

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

   247

    : generate_c_typedecl_c(s4o_ptr),

   248

      default_variable_name(IL_DEFVAR, NULL),

   249

      default_variable_back_name(IL_DEFVAR_BACK, NULL)

   250

    {

   251

      search_expression_type = new search_expression_type_c(scope);

   252

      search_fb_instance_decl = new search_fb_instance_decl_c(scope);

   253

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

   254

      current_operand = NULL;

   255

      current_operand_type = NULL;

   256

      il_default_variable_init_value = NULL;

   257

      current_array_type = NULL;

   258

      current_param_type = NULL;

   259

      fcall_number = 0;

   260

      fbname = name;

   261

      wanted_variablegeneration = expression_vg;

   262

      this->set_variable_prefix(variable_prefix);

   263

    }

   264

   265

    virtual ~generate_c_il_c(void) {

   266

      delete search_fb_instance_decl;

   267

      delete search_expression_type;

   268

      delete search_varfb_instance_type;

   269

    }

   270

   271

    void generate(instruction_list_c *il) {

   272

      il->accept(*this);

   273

    }

   274

   275

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

   276

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

   277

     */

   278

    void declare_backup_variable(void) {

   279

      s4o.print(s4o.indent_spaces);

   280

      s4o.print(IL_DEFVAR_T);

   281

      s4o.print(" ");

   282

      print_backup_variable();

   283

      s4o.print(";\n");

   284

    }

   285

   286

    void print_backup_variable(void) {

   287

      this->default_variable_back_name.accept(*this);

   288

    }

   289

   290

  private:

   291

    /* A helper function... */

   292

    /*

   293

    bool is_bool_type(symbol_c *type_symbol) {

   294

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

   295

    }

   296

    */

   297

   298

    /* A helper function... */

   299

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

   300

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

   301

      if (NULL == op) ERROR;

   302

   303

      lo->accept(*this);

   304

      s4o.print(op);

   305

      ro->accept(*this);

   306

      return NULL;

   307

    }

   308

   309

    /* A helper function... */

   310

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

   311

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

   312

      if (NULL == func) ERROR;

   313

   314

      lo->accept(*this);

   315

      s4o.print(" = ");

   316

      s4o.print(func);

   317

      s4o.print("(");

   318

      lo->accept(*this);

   319

      s4o.print(", ");

   320

      ro->accept(*this);

   321

      s4o.print(")");

   322

      return NULL;

   323

    }

   324

   325

    /* A helper function... */

   326

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

   327

      if (NULL == fb_name) ERROR;

   328

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

   329

      if (NULL == sv) ERROR;

   330

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

   331

      if (NULL == id) ERROR;

   332

   333

      identifier_c param(param_name);

   334

   335

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

   336

      il_assign_operator_c il_assign_operator(&param);

   337

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

   338

      // SYM_LIST(il_param_list_c)

   339

      il_param_list_c il_param_list;   

   340

      il_param_list.add_element(&il_param_assignment);

   341

      CAL_operator_c CAL_operator;

   342

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

   343

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

   344

   345

      il_fb_call.accept(*this);

   346

      return NULL;

   347

    }

   348

   349

    /* A helper function... */

   350

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

   351

      if (NULL == o) ERROR;

   352

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

   353

   354

      symbol_c *backup = this->default_variable_name.current_type;

   355

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

   356

      this->default_variable_name.accept(*this);

   357

      this->default_variable_name.current_type = backup;

   358

   359

      s4o.print(" = ");

   360

      s4o.print(operation);

   361

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

   362

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

   363

      this->default_variable_name.accept(*this);

   364

      s4o.print(", ");

   365

      o->accept(*this);

   366

      s4o.print(")");

   367

   368

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

   369

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

   370

      return NULL;

   371

    }

   372

   373

   374

    /* A helper function... */

   375

    void C_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

    /* A helper function... */

   385

    void CN_modifier(void) {

   386

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

   387

        s4o.print("if (!");

   388

        this->default_variable_name.accept(*this);

   389

        s4o.print(") ");

   390

      }

   391

      else {ERROR;}

   392

    }

   393

   394

    void BYTE_operator_result_type(void) {

   395

      if (search_expression_type->is_literal_integer_type(this->default_variable_name.current_type)) {

   396

        if (search_expression_type->is_literal_integer_type(this->current_operand_type))

   397

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

   398

        else

   399

          this->default_variable_name.current_type = this->current_operand_type;

   400

      }

   401

      else if (search_expression_type->is_literal_integer_type(this->current_operand_type))

   402

    	  this->current_operand_type = this->default_variable_name.current_type;

   403

    }

   404

   405

    void NUM_operator_result_type(void) {

   406

      if (search_expression_type->is_literal_real_type(this->default_variable_name.current_type)) {

   407

        if (search_expression_type->is_literal_integer_type(this->current_operand_type) ||

   408

            search_expression_type->is_literal_real_type(this->current_operand_type))

   409

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

   410

        else

   411

          this->default_variable_name.current_type = this->current_operand_type;

   412

      }

   413

      else if (search_expression_type->is_literal_integer_type(this->default_variable_name.current_type)) {

   414

        if (search_expression_type->is_literal_integer_type(this->current_operand_type))

   415

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

   416

        else if (search_expression_type->is_literal_real_type(this->current_operand_type))

   417

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

   418

        else

   419

          this->default_variable_name.current_type = this->current_operand_type;

   420

      }

   421

      else if (search_expression_type->is_literal_integer_type(this->current_operand_type) ||

   422

               search_expression_type->is_literal_real_type(this->current_operand_type))

   423

        this->current_operand_type = this->default_variable_name.current_type;

   424

    }

   425

   426

    void *print_getter(symbol_c *symbol) {

   427

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

   428

      if (wanted_variablegeneration == fparam_output_vg) {

   429

      	if (vartype == search_var_instance_decl_c::external_vt)

   430

          s4o.print(GET_EXTERNAL_BY_REF);

   431

        else if (vartype == search_var_instance_decl_c::located_vt)

   432

          s4o.print(GET_LOCATED_BY_REF);

   433

        else

   434

          s4o.print(GET_VAR_BY_REF);

   435

      }

   436

      else {

   437

    	if (vartype == search_var_instance_decl_c::external_vt)

   438

    	  s4o.print(GET_EXTERNAL);

   439

    	else if (vartype == search_var_instance_decl_c::located_vt)

   440

    	  s4o.print(GET_LOCATED);

   441

    	else

   442

    	  s4o.print(GET_VAR);

   443

      }

   444

      s4o.print("(");

   445

   446

      variablegeneration_t old_wanted_variablegeneration = wanted_variablegeneration;

   447

      wanted_variablegeneration = complextype_base_vg;

   448

      symbol->accept(*this);

   449

      if (search_varfb_instance_type->type_is_complex())

   450

        s4o.print(",");

   451

      wanted_variablegeneration = complextype_suffix_vg;

   452

      symbol->accept(*this);

   453

      s4o.print(")");

   454

      wanted_variablegeneration = old_wanted_variablegeneration;

   455

      return NULL;

   456

    }

   457

   458

    void *print_setter(symbol_c* symbol,

   459

    		symbol_c* type,

   460

    		symbol_c* value,

   461

    		symbol_c* fb_symbol = NULL,

   462

    		symbol_c* fb_value = NULL,

   463

    		bool negative = false) {

   464

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

   465

      if (vartype == search_var_instance_decl_c::external_vt) {

   466

        symbolic_variable_c *variable = dynamic_cast<symbolic_variable_c *>(symbol);

   467

        /* TODO Find a solution for forcing global complex variables */

   468

        if (variable != NULL) {

   469

          s4o.print(SET_EXTERNAL);

   470

          s4o.print("(");

   471

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

   472

          s4o.print(",");

   473

        }

   474

        else {

   475

          s4o.print(SET_COMPLEX_EXTERNAL);

   476

          s4o.print("(");

   477

        }

   478

      }

   479

      else {

   480

        if (vartype == search_var_instance_decl_c::located_vt)

   481

          s4o.print(SET_LOCATED);

   482

        else

   483

          s4o.print(SET_VAR);

   484

        s4o.print("(");

   485

      }

   486

   487

      if (fb_symbol != NULL) {

   488

        print_variable_prefix();

   489

        fb_symbol->accept(*this);

   490

        s4o.print(".");

   491

      }

   492

      else

   493

        wanted_variablegeneration = complextype_base_vg;

   494

      symbol->accept(*this);

   495

      s4o.print(",");

   496

      if (negative) {

   497

	    if (search_expression_type->is_bool_type(this->current_operand_type))

   498

		  s4o.print("!");

   499

	    else

   500

		  s4o.print("~");

   501

      }

   502

      wanted_variablegeneration = expression_vg;

   503

      print_check_function(type, value, fb_value);

   504

      if (search_varfb_instance_type->type_is_complex()) {

   505

        s4o.print(",");

   506

        wanted_variablegeneration = complextype_suffix_vg;

   507

        symbol->accept(*this);

   508

      }

   509

      s4o.print(")");

   510

      wanted_variablegeneration = expression_vg;

   511

      return NULL;

   512

    }

   513

   514

public:

   515

void *visit(il_default_variable_c *symbol) {