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

   130

class generate_c_il_c: public generate_c_typedecl_c, il_default_variable_visitor_c {

   131

   132

  public:

   133

    typedef enum {

   134

      expression_vg,

   135

      assignment_vg,

   136

      complextype_base_vg,

   137

      complextype_base_assignment_vg,

   138

      complextype_suffix_vg,

   139

      fparam_output_vg

   140

    } variablegeneration_t;

   141

   142

  private:

   143

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

   144

     * imediately after a parenthesis is opened.

   145

     * This variable is only used to pass data from the

   146

     * il_expression_c visitor to the simple_instr_list_c visitor.

   147

     *

   148

     * e.g.:

   149

     *         LD var1

   150

     *         AND ( var2

   151

     *         OR var3

   152

     *         )

   153

     *

   154

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

   155

     * an il_expression_c, where var2 should be loaded into the

   156

     * il default variable before continuing with the expression

   157

     * inside the parenthesis.

   158

     * Unfortunately, only the simple_instr_list_c may do the

   159

     * initial laoding of the var2 bariable following the parenthesis,

   160

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

   161

     * parameter to the simple_instr_list_c visitor.

   162

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

   163

     */

   164

    symbol_c *il_default_variable_init_value;

   165

   166

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

   167

    /* These variables are used to pass data from the

   168

     * il_simple_operation_c and il_expression_c visitors

   169

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

   170

     * LDN_operator_c, ST_operator_c, STN_operator_c, ...)

   171

     */

   172

    symbol_c *current_operand;

   173

    symbol_c *current_operand_type;

   174

   175

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

   176

    /* This variable is used to pass data from the

   177

     * il_jump_operation_c visitor

   178

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

   179

     * JMPC_operator_c, JMPCN_operator_c, ...)

   180

     */

   181

    symbol_c *jump_label;

   182

   183

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

   184

     * is a boolean variable.

   185

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

   186

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

   187

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

   188

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

   189

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

   190

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

   191

     * data type.

   192

     * The following object is it...

   193

     */

   194

    bool_type_name_c bool_type;

   195

    lint_type_name_c lint_type;

   196

    lword_type_name_c lword_type;

   197

    lreal_type_name_c lreal_type;

   198

   199

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

   200

    #define IL_DEFVAR_T VAR_LEADER "IL_DEFVAR_T"

   201

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

   202

    #define IL_DEFVAR   VAR_LEADER "IL_DEFVAR"

   203

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

   204

     * parenthesised instruction list to the immediately preceding

   205

     * scope ...

   206

     */

   207

    #define IL_DEFVAR_BACK   VAR_LEADER "IL_DEFVAR_BACK"

   208

    il_default_variable_c default_variable_name;

   209

    il_default_variable_c default_variable_back_name;

   210

   211

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

   212

     * by searching through the declarations of the variables currently

   213

     * in scope.

   214

     * This class does just that...

   215

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

   216

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

   217

     * This object instance will then later be called while the

   218

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

   219

     *

   220

     * Note that functions cannot contain calls to function blocks,

   221

     * so we do not create an object instance when handling

   222

     * a function declaration.

   223

     */

   224

    search_fb_instance_decl_c *search_fb_instance_decl;

   225

   226

    search_varfb_instance_type_c *search_varfb_instance_type;

   227

    search_var_instance_decl_c   *search_var_instance_decl;

   228

   229

    symbol_c* current_array_type;

   230

    symbol_c* current_param_type;

   231

   232

    int fcall_number;

   233

    symbol_c *fbname;

   234

   235

    variablegeneration_t wanted_variablegeneration;

   236

   237

  public:

   238

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

   239

    : generate_c_typedecl_c(s4o_ptr),

   240

      default_variable_name(IL_DEFVAR, NULL),

   241

      default_variable_back_name(IL_DEFVAR_BACK, NULL)

   242

    {

   244

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

   246

   247

      current_operand = NULL;

   248

      current_operand_type = NULL;

   249

      il_default_variable_init_value = NULL;

   250

      current_array_type = NULL;

   251

      current_param_type = NULL;

   252

      fcall_number = 0;

   253

      fbname = name;

   254

      wanted_variablegeneration = expression_vg;

   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_varfb_instance_type;

   261

      delete search_var_instance_decl;

   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

    void reset_default_variable_name(void) {

   284

      this->default_variable_name.current_type = NULL;

   285

      this->default_variable_back_name.current_type = NULL;

   286

    }

   287

   288

  private:

   299

   300

    /* A helper function... */

   301

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

   303

   304

      lo->accept(*this);

   305

      s4o.print(op);

   306

      ro->accept(*this);

   307

      return NULL;

   308

    }

   309

   310

    /* A helper function... */

   311

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

   312

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

   313

      if (NULL == func) ERROR;

   314

   315

      lo->accept(*this);

   316

      s4o.print(" = ");

   317

      s4o.print(func);

   318

      s4o.print("(");

   319

      lo->accept(*this);

   320

      s4o.print(", ");

   321

      ro->accept(*this);

   322

      s4o.print(")");

   323

      return NULL;

   324

    }

   325

   326

    /* A helper function... */

   327

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

   328

      if (wanted_variablegeneration != expression_vg) {

   329

        s4o.print(param_name);

   330

        return NULL;

   331

      }

   332

   333

      if (NULL == fb_name) ERROR;

   334

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

   335

      if (NULL == sv) ERROR;

   336

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

   337

      if (NULL == id) ERROR;

   338

   339

      identifier_c param(param_name);

   340

   341

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

   342

      il_assign_operator_c il_assign_operator(&param);

   343

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

   344

      // SYM_LIST(il_param_list_c)

   345

      il_param_list_c il_param_list;   

   346

      il_param_list.add_element(&il_param_assignment);

   347

      CAL_operator_c CAL_operator;

   348

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

   349

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

   350

   351

      il_fb_call.accept(*this);

   352

      return NULL;

   353

    }

   354

   355

    /* A helper function... */

   356

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

   357

      if (NULL == o) ERROR;

   358

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

   359

   360

      symbol_c *backup = this->default_variable_name.current_type;

   361

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

   362

      this->default_variable_name.accept(*this);

   363

      this->default_variable_name.current_type = backup;

   364

   365

      s4o.print(" = ");

   366

      s4o.print(operation);

   367

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

   368

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

   369

      this->default_variable_name.accept(*this);

   370

      s4o.print(", ");

   371

      o->accept(*this);

   372

      s4o.print(")");

   373

   374

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

   375

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

   376

      return NULL;

   377

    }

   378

   379

   380

    /* A helper function... */

   381

    void C_modifier(void) {

   383

        s4o.print("if (");

   384

        this->default_variable_name.accept(*this);

   385

        s4o.print(") ");

   386

      }

   387

      else {ERROR;}

   388

    }

   389

   390

    /* A helper function... */

   391

    void CN_modifier(void) {

   393

        s4o.print("if (!");

   394

        this->default_variable_name.accept(*this);

   395

        s4o.print(") ");

   396

      }

   397

      else {ERROR;}

   398

    }

   399

   400

    void BYTE_operator_result_type(void) {

   403

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

   404

        else

   405

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

   406

      }

   408

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

   409

    }

   410

   411

    void NUM_operator_result_type(void) {

   415

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

   416

        else

   417

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

   418

      }

   421

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

   423

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

   424

        else

   425

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

   426

      }

   429

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

   430

    }

   431

   432

    void *print_getter(symbol_c *symbol) {

   433

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

   434

      if (wanted_variablegeneration == fparam_output_vg) {

   435

      	if (vartype == search_var_instance_decl_c::external_vt)

   436

          s4o.print(GET_EXTERNAL_BY_REF);

   437

        else if (vartype == search_var_instance_decl_c::located_vt)

   438

          s4o.print(GET_LOCATED_BY_REF);

   439

        else

   440

          s4o.print(GET_VAR_BY_REF);

   441

      }

   442

      else {

   443

    	if (vartype == search_var_instance_decl_c::external_vt)

   444

    	  s4o.print(GET_EXTERNAL);

   445

    	else if (vartype == search_var_instance_decl_c::located_vt)

   446

    	  s4o.print(GET_LOCATED);

   447

    	else

   448

    	  s4o.print(GET_VAR);

   449

      }

   450

      s4o.print("(");

   451

   452

      variablegeneration_t old_wanted_variablegeneration = wanted_variablegeneration;

   453

      wanted_variablegeneration = complextype_base_vg;

   454

      symbol->accept(*this);

   455

      if (search_var_instance_decl->type_is_complex(symbol))

   456

        s4o.print(",");

   457

      wanted_variablegeneration = complextype_suffix_vg;

   458

      symbol->accept(*this);

   459

      s4o.print(")");

   460

      wanted_variablegeneration = old_wanted_variablegeneration;

   461

      return NULL;

   462

    }

   463

   464

    void *print_setter(symbol_c* symbol,

   465

    		symbol_c* type,

   466

    		symbol_c* value,

   467

    		symbol_c* fb_symbol = NULL,

   468

    		symbol_c* fb_value = NULL,

   469

    		bool negative = false) {

   470

   471

      bool type_is_complex = false;

   472

      if (fb_symbol == NULL) {

   473

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

   474

        type_is_complex = search_var_instance_decl->type_is_complex(symbol);

   475

        if (vartype == search_var_instance_decl_c::external_vt)

   476

          s4o.print(SET_EXTERNAL);

   477

        else if (vartype == search_var_instance_decl_c::located_vt)

   478

          s4o.print(SET_LOCATED);

   479

        else

   480

          s4o.print(SET_VAR);

   481

      }

   482

      else

   483

        s4o.print(SET_VAR);

   484

      s4o.print("(");

   485

   486

      if (fb_symbol != NULL) {

   487

        print_variable_prefix();

   488

        fb_symbol->accept(*this);

   489

        s4o.print(".,");

   490

      }

   491

      else if (type_is_complex)

   492

        wanted_variablegeneration = complextype_base_assignment_vg;

   493

      else

   494

        wanted_variablegeneration = assignment_vg;

   495

   496

      symbol->accept(*this);

   497

      s4o.print(",");

   498

      if (negative) {

   500

		  s4o.print("!");

   501

	    else

   502

		  s4o.print("~");

   503

      }

   504

      wanted_variablegeneration = expression_vg;

   505

      print_check_function(type, value, fb_value);

   506

      if (type_is_complex) {

   507

        s4o.print(",");

   508

        wanted_variablegeneration = complextype_suffix_vg;

   509

        symbol->accept(*this);

   510

      }