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

#define INLINE_RESULT_TEMP_VAR "__res"

    27

    28

class generate_c_inlinefcall_c: public generate_c_typedecl_c {

    29

    30

  public:

    31

    typedef enum {

    32

      expression_vg,

    33

      assignment_vg,

    34

      complextype_base_vg,

    35

      complextype_suffix_vg

    36

    } variablegeneration_t;

    37

    38

  private:

    39

    40

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

    41

	 * imediately after a parenthesis is opened.

    42

	 * This variable is only used to pass data from the

    43

	 * il_expression_c visitor to the simple_instr_list_c visitor.

    44

	 *

    45

	 * e.g.:

    46

	 *         LD var1

    47

	 *         AND ( var2

    48

	 *         OR var3

    49

	 *         )

    50

	 *

    51

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

    52

	 * an il_expression_c, where var2 should be loaded into the

    53

	 * il default variable before continuing with the expression

    54

	 * inside the parenthesis.

    55

	 * Unfortunately, only the simple_instr_list_c may do the

    56

	 * initial laoding of the var2 bariable following the parenthesis,

    57

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

    58

	 * parameter to the simple_instr_list_c visitor.

    59

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

    60

	 */

    61

	symbol_c *il_default_variable_init_value;

    62

    63

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

    64

	/* These variables are used to pass data from the

    65

	 * il_simple_operation_c and il_expression_c visitors

    66

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

    67

	 * LDN_operator_c, ST_operator_c, STN_operator_c, ...)

    68

	 */

    69

	symbol_c *current_operand;

    70

	symbol_c *current_operand_type;

    71

    72

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

    73

	 * is a boolean variable.

    74

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

    75

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

    76

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

    77

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

    78

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

    79

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

    80

	 * data type.

    81

	 * The following object is it...

    82

	 */

    83

	bool_type_name_c bool_type;

    84

	lint_type_name_c lint_type;

    85

	lword_type_name_c lword_type;

    86

	lreal_type_name_c lreal_type;

    87

    88

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

    89

	#define IL_DEFVAR   VAR_LEADER "IL_DEFVAR"

    90

    91

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

    92

	 * parenthesised instruction list to the immediately preceding

    93

	 * scope ...

    94

	 */

    95

    #define IL_DEFVAR_BACK   VAR_LEADER "IL_DEFVAR_BACK"

    96

    il_default_variable_c default_variable_name;

    97

	il_default_variable_c default_variable_back_name;

    98

    99

	symbol_c* current_array_type;

   100

   101

	int fcall_number;

   102

	symbol_c *fbname;

   103

   104

    search_expression_type_c *search_expression_type;

   105

   106

    search_varfb_instance_type_c *search_varfb_instance_type;

   107

   108

    search_base_type_c search_base_type;

   109

   110

    variablegeneration_t wanted_variablegeneration;

   111

   112

  public:

   113

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

   114

    : generate_c_typedecl_c(s4o_ptr),

   115

      default_variable_name(IL_DEFVAR, NULL),

   116

      default_variable_back_name(IL_DEFVAR_BACK, NULL)

   117

    {

   118

      search_expression_type = new search_expression_type_c(scope);

   119

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

   120

      this->set_variable_prefix(variable_prefix);

   121

      fcall_number = 0;

   122

      fbname = name;

   123

      wanted_variablegeneration = expression_vg;

   124

    }

   125

   126

    virtual ~generate_c_inlinefcall_c(void) {

   127

      delete search_expression_type;

   128

      delete search_varfb_instance_type;

   129

    }

   130

   131

    void print(symbol_c* symbol) {

   132

      function_call_iterator_c fc_iterator(symbol);

   133

      symbol_c* function_call;

   134

      while ((function_call = fc_iterator.next()) != NULL) {

   135

    	function_call->accept(*this);

   136

      }

   137

    }

   138

   139

    void generate_inline(symbol_c *function_name,

   140

            symbol_c *function_type_prefix,

   141

            symbol_c *function_type_suffix,

   142

            std::list<FUNCTION_PARAM*> param_list) {

   143

            std::list<FUNCTION_PARAM*>::iterator pt;

   144

   145

      fcall_number++;

   146

      function_type_prefix = search_expression_type->default_literal_type(function_type_prefix);

   147

      if (function_type_suffix) {

   148

        function_type_suffix = search_expression_type->default_literal_type(function_type_suffix);

   149

      }

   150

   151

      s4o.print(s4o.indent_spaces);

   152

      s4o.print("inline ");

   153

      function_type_prefix->accept(*this);

   154

      s4o.print(" __");

   155

      fbname->accept(*this);

   156

      s4o.print("_");

   157

      function_name->accept(*this);

   158

      if (function_type_suffix) {

   159

    	function_type_suffix->accept(*this);

   160

      }

   161

      s4o.print_integer(fcall_number);

   162

      s4o.print("(");

   163

      s4o.indent_right();

   164

   165

      PARAM_LIST_ITERATOR() {

   166

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in) {

   167

          search_expression_type->default_literal_type(PARAM_TYPE)->accept(*this);

   168

          s4o.print(" ");

   169

          PARAM_NAME->accept(*this);

   170

          s4o.print(",\n" + s4o.indent_spaces);

   171

        }

   172

      }

   173

      fbname->accept(*this);

   174

	  s4o.print(" *");

   175

	  s4o.print(FB_FUNCTION_PARAM);

   176

	  s4o.indent_left();

   177

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

   178

	  s4o.print("{\n");

   179

      s4o.indent_right();

   180

   181

      s4o.print(s4o.indent_spaces);

   182

      function_type_prefix->accept(*this);

   183

      s4o.print(" "),

   184

      s4o.print(INLINE_RESULT_TEMP_VAR);

   185

      s4o.print(";\n");

   186

   187

	  PARAM_LIST_ITERATOR() {

   188

		if ((PARAM_DIRECTION == function_param_iterator_c::direction_out ||

   189

		     PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   190

		    PARAM_VALUE != NULL) {

   191

		  s4o.print(s4o.indent_spaces);

   192

		  PARAM_TYPE->accept(*this);

   193

          s4o.print(" ");

   194

          s4o.print(TEMP_VAR);

   195

          PARAM_NAME->accept(*this);

   196

          s4o.print(" = ");

   197

          print_check_function(PARAM_TYPE, PARAM_VALUE);

   198

          s4o.print(";\n");

   199

		}

   200

	  }

   201

   202

	  s4o.print(s4o.indent_spaces + INLINE_RESULT_TEMP_VAR),

   203

			  s4o.print(" = ");

   204

	  function_name->accept(*this);

   205

	  if (function_type_suffix)

   206

        function_type_suffix->accept(*this);

   207

	  s4o.print("(");

   208

	  s4o.indent_right();

   209

   210

	  PARAM_LIST_ITERATOR() {

   211

		if (pt != param_list.begin())

   212

		  s4o.print(",\n" + s4o.indent_spaces);

   213

		if (PARAM_DIRECTION == function_param_iterator_c::direction_in)

   214

		  PARAM_NAME->accept(*this);

   215

		else if (PARAM_VALUE != NULL){

   216

          s4o.print("&");

   217

          s4o.print(TEMP_VAR);

   218

          PARAM_NAME->accept(*this);

   219

        }

   220

		else {

   221

		  s4o.print("NULL");

   222

		}

   223

	  }

   224

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

   225

	  s4o.indent_left();

   226

   227

	  PARAM_LIST_ITERATOR() {

   228

        if ((PARAM_DIRECTION == function_param_iterator_c::direction_out ||

   229

        	 PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   230

        	PARAM_VALUE != NULL) {

   231

   232

          s4o.print(s4o.indent_spaces);

   233

          print_setter(PARAM_VALUE, PARAM_TYPE, PARAM_NAME);

   234

          s4o.print(";\n");

   235

		}

   236

	  }

   237

	  s4o.print(s4o.indent_spaces + "return ");

   238

	  s4o.print(INLINE_RESULT_TEMP_VAR);

   239

	  s4o.print(";\n");

   240

   241

      s4o.indent_left();

   242

      s4o.print(s4o.indent_spaces + "}\n\n");

   243

    }

   244

   245

  private:

   246

   247

    /* A helper function... */

   248

	void CMP_operator_result_type() {

   249

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

   250

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

   251

	}

   252

   253

	/* A helper function... */

   254

    void BYTE_operator_result_type(void) {

   255

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

   256

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

   257

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

   258

		else

   259

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

   260

	  }

   261

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

   262

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

   263

	}

   264

   265

    /* A helper function... */

   266

    void NUM_operator_result_type(void) {

   267

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

   268

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

   269

			search_expression_type->is_literal_real_type(this->current_operand_type))

   270

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

   271

		else

   272

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

   273

	  }

   274

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

   275

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

   276

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

   277

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

   278

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

   279

		else

   280

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

   281

	  }

   282

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

   283

			   search_expression_type->is_literal_real_type(this->current_operand_type))

   284

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

   285

	}

   286

   287

    void *print_getter(symbol_c *symbol) {

   288

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

   289

      if (vartype == search_var_instance_decl_c::external_vt)

   290

    	s4o.print(GET_EXTERNAL);

   291

      else if (vartype == search_var_instance_decl_c::located_vt)

   292

    	s4o.print(GET_LOCATED);

   293

      else

   294

    	s4o.print(GET_VAR);

   295

      s4o.print("(");

   296

   297

      wanted_variablegeneration = complextype_base_vg;

   298

      symbol->accept(*this);

   299

      if (search_varfb_instance_type->type_is_complex())

   300

    	s4o.print(",");

   301

      wanted_variablegeneration = complextype_suffix_vg;

   302

      symbol->accept(*this);

   303

      s4o.print(")");

   304

      wanted_variablegeneration = expression_vg;

   305

      return NULL;

   306

    }

   307

   308

    void *print_setter(symbol_c* symbol,

   309

    		symbol_c* type,

   310

    		symbol_c* value) {

   311

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

   312

      if (vartype == search_var_instance_decl_c::external_vt) {

   313

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

   314

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

   315

        if (variable != NULL) {

   316

          s4o.print(SET_EXTERNAL);

   317

          s4o.print("(");

   318

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

   319

          s4o.print(",");

   320

        }

   321

        else {

   322

          s4o.print(SET_COMPLEX_EXTERNAL);

   323

          s4o.print("(");

   324

        }

   325

      }

   326

      else {

   327

        if (vartype == search_var_instance_decl_c::located_vt)

   328

          s4o.print(SET_LOCATED);

   329

        else

   330

          s4o.print(SET_VAR);

   331

        s4o.print("(");

   332

      }

   333

   334

      wanted_variablegeneration = complextype_base_vg;

   335

      symbol->accept(*this);

   336

      s4o.print(",");

   337

      wanted_variablegeneration = expression_vg;

   338

      print_check_function(type, value, NULL, true);

   339

      if (search_varfb_instance_type->type_is_complex()) {

   340

        s4o.print(",");

   341

        wanted_variablegeneration = complextype_suffix_vg;

   342

        symbol->accept(*this);

   343

      }

   344

      s4o.print(")");

   345

      wanted_variablegeneration = expression_vg;

   346

      return NULL;

   347

    }

   348

   349

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

   350

    /* B 1.4 - Variables */

   351

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

   352

    void *visit(symbolic_variable_c *symbol) {

   353

      unsigned int vartype;

   354

      if (wanted_variablegeneration == complextype_base_vg)

   355

        generate_c_base_c::visit(symbol);

   356

      else if (wanted_variablegeneration == complextype_suffix_vg)

   357

        return NULL;

   358

      else

   359

        print_getter(symbol);

   360

      return NULL;

   361

    }

   362

   363

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

   364

    /* B.1.4.1   Directly Represented Variables */

   365

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

   366

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

   367

    void *visit(direct_variable_c *symbol) {

   368

      TRACE("direct_variable_c");

   369

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

   370

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

   371

      s4o.print(GET_LOCATED);

   372

      s4o.print("(");

   373

      this->print_variable_prefix();

   374

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

   375

      s4o.print(")");

   376

      return NULL;

   377

    }

   378

   379

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

   380

    /* B.1.4.2   Multi-element Variables */

   381

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

   382

   383

    // SYM_REF2(structured_variable_c, record_variable, field_selector)

   384

    void *visit(structured_variable_c *symbol) {

   385

      TRACE("structured_variable_c");

   386

      switch (wanted_variablegeneration) {

   387

        case complextype_base_vg:

   388

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

   389

          break;

   390

        case complextype_suffix_vg:

   391

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

   392

          s4o.print(".");

   393

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

   394

          break;

   395

        default:

   396

          print_getter(symbol);

   397

          break;

   398

      }

   399

      return NULL;

   400

    }

   401

   402

    /*  subscripted_variable '[' subscript_list ']' */

   403

    //SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   404

    void *visit(array_variable_c *symbol) {

   405

      switch (wanted_variablegeneration) {

   406

        case complextype_base_vg:

   407

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

   408

          break;

   409

        case complextype_suffix_vg:

   410

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

   411

   412

          current_array_type = search_varfb_instance_type->get_type_id(symbol->subscripted_variable);

   413

          if (current_array_type == NULL) ERROR;

   414

   415

          s4o.print(".table");

   416

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

   417

   418

          current_array_type = NULL;

   419

          break;

   420

        default:

   421

          print_getter(symbol);

   422

          break;

   423

      }

   424

      return NULL;

   425

    }

   426

   427

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

   428

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

   429

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

   430

   431

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

   432

    /* B 2.1 Instructions and Operands */

   433

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

   434

   435

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

   436

    // SYM_REF2(il_instruction_c, label, il_instruction)

   437

    void *visit(il_instruction_c *symbol) {

   438

      if (NULL != symbol->il_instruction) {

   439

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

   440

      }

   441

      return NULL;

   442

    }

   443

    /* | il_simple_operator [il_operand] */

   444

    //SYM_REF2(il_simple_operation_c, il_simple_operator, il_operand)

   445

    void *visit(il_simple_operation_c *symbol) {

   446

      this->current_operand = symbol->il_operand;

   447

      if (NULL == this->current_operand) {

   448

        this->current_operand_type = NULL;

   449

      } else {

   450

        this->current_operand_type = search_expression_type->get_type(this->current_operand);

   451

        if (NULL == this->current_operand_type) ERROR;

   452

      }

   453

   454

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

   455

   456

      this->current_operand = NULL;

   457

      this->current_operand_type = NULL;

   458

      return NULL;

   459

    }

   460

   461

    void *visit(il_function_call_c *symbol) {

   462

      symbol_c* function_type_prefix = NULL;

   463

      symbol_c* function_name = NULL;

   464

      symbol_c* function_type_suffix = NULL;

   465

      DECLARE_PARAM_LIST()

   466

   467

      symbol_c *param_data_type = default_variable_name.current_type;

   468

   469

      function_call_param_iterator_c function_call_param_iterator(symbol);

   470

   471

      function_declaration_c *f_decl = function_symtable.find_value(symbol->function_name);

   472

	  if (f_decl == function_symtable.end_value()) {

   473

        function_type_t current_function_type = get_function_type((identifier_c *)symbol->function_name);

   474

        if (current_function_type == function_none) ERROR;

   475

   476

        function_type_prefix = (symbol_c *)search_expression_type->compute_standard_function_il(symbol, param_data_type);

   477

   478

        symbol_c *en_param_name = (symbol_c *)(new identifier_c("EN"));

   479

        /* Add the value from EN param */

   480

        ADD_PARAM_LIST(en_param_name,

   481

                       (symbol_c*)(new boolean_literal_c((symbol_c*)(new bool_type_name_c()), new boolean_true_c())),

   482

                       (symbol_c*)(new bool_type_name_c()),

   483

                       function_param_iterator_c::direction_in)

   484

   485

        symbol_c *eno_param_name = (symbol_c *)(new identifier_c("ENO"));

   486

        /* Add the value from ENO param */

   487

        ADD_PARAM_LIST(eno_param_name, NULL, (symbol_c*)(new bool_type_name_c()), function_param_iterator_c::direction_out)

   488

   489

        int nb_param = 1;

   490

        if (symbol->il_operand_list != NULL)

   491

          nb_param += ((list_c *)symbol->il_operand_list)->n;

   492

   493

        #include "il_code_gen.c"

   494

   495

      }

   496

	  else {

   497

		function_name = symbol->function_name;

   498

   499

		/* determine the base data type returned by the function being called... */

   500

		search_base_type_c search_base_type;

   501

		function_type_prefix = (symbol_c *)f_decl->type_name->accept(search_base_type);

   502