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

   140

   141

    void generate_inline(symbol_c *function_name,

   142

            symbol_c *function_type_prefix,

   143

            symbol_c *function_type_suffix,

   144

            std::list<FUNCTION_PARAM*> param_list,

   145

            function_declaration_c *f_decl = NULL) {

   146

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

   147

   148

      fcall_number++;

   149

      function_type_prefix = search_expression_type->default_literal_type(function_type_prefix);

   150

      if (function_type_suffix) {

   151

        function_type_suffix = search_expression_type->default_literal_type(function_type_suffix);

   152

      }

   153

   154

      s4o.print(s4o.indent_spaces);

   155

      s4o.print("inline ");

   156

      function_type_prefix->accept(*this);

   157

      s4o.print(" __");

   158

      fbname->accept(*this);

   159

      s4o.print("_");

   160

      function_name->accept(*this);

   161

      if (f_decl != NULL) {

   162

printf("generate_inline(): calling print_function_parameter_data_types_c !!!!!!!!!!!!!!!!!!!!!!\n");

   163

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   164

        f_decl->accept(overloaded_func_suf);

   165

      }	

   166

      if (function_type_suffix) {

   167

        function_type_suffix->accept(*this);

   168

      }

   169

      s4o.print_integer(fcall_number);

   170

      s4o.print("(");

   171

      s4o.indent_right();

   172

   173

      PARAM_LIST_ITERATOR() {

   174

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in) {

   175

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

   176

          s4o.print(" ");

   177

          PARAM_NAME->accept(*this);

   178

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

   179

        }

   180

      }

   181

      fbname->accept(*this);

   182

      s4o.print(" *");

   183

      s4o.print(FB_FUNCTION_PARAM);

   184

      s4o.indent_left();

   185

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

   186

      s4o.print("{\n");

   187

      s4o.indent_right();

   188

   189

      s4o.print(s4o.indent_spaces);

   190

      function_type_prefix->accept(*this);

   191

      s4o.print(" "),

   192

      s4o.print(INLINE_RESULT_TEMP_VAR);

   193

      s4o.print(";\n");

   194

   195

      PARAM_LIST_ITERATOR() {

   196

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

   197

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   198

             PARAM_VALUE != NULL) {

   199

          s4o.print(s4o.indent_spaces);

   200

          PARAM_TYPE->accept(*this);

   201

          s4o.print(" ");

   202

          s4o.print(TEMP_VAR);

   203

          PARAM_NAME->accept(*this);

   204

          s4o.print(" = ");

   205

          print_check_function(PARAM_TYPE, PARAM_VALUE);

   206

          s4o.print(";\n");

   207

          }

   208

        }

   209

   210

      s4o.print(s4o.indent_spaces + INLINE_RESULT_TEMP_VAR),

   211

      s4o.print(" = ");

   212

      function_name->accept(*this);

   213

      if (f_decl != NULL) {

   214

printf("generate_inline(): calling print_function_parameter_data_types_c !!!!!!!!!!!!!!!!!!!!!!\n");

   215

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   216

        f_decl->accept(overloaded_func_suf);

   217

      }

   218

   219

      if (function_type_suffix)

   220

        function_type_suffix->accept(*this);

   221

      s4o.print("(");

   222

      s4o.indent_right();

   223

   224

      PARAM_LIST_ITERATOR() {

   225

        if (pt != param_list.begin())

   226

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

   227

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in)

   228

          PARAM_NAME->accept(*this);

   229

        else if (PARAM_VALUE != NULL){

   230

          s4o.print("&");

   231

          s4o.print(TEMP_VAR);

   232

          PARAM_NAME->accept(*this);

   233

        } else {

   234

          s4o.print("NULL");

   235

         }

   236

      }

   237

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

   238

      s4o.indent_left();

   239

   240

      PARAM_LIST_ITERATOR() {

   241

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

   242

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   243

             PARAM_VALUE != NULL) {

   244

          s4o.print(s4o.indent_spaces);

   245

          print_setter(PARAM_VALUE, PARAM_TYPE, PARAM_NAME);

   246

          s4o.print(";\n");

   247

        }

   248

      }

   249

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

   250

      s4o.print(INLINE_RESULT_TEMP_VAR);

   251

      s4o.print(";\n");

   252

   253

      s4o.indent_left();

   254

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

   255

    }

   256

   257

  private:

   258

   259

    /* A helper function... */

   260

	void CMP_operator_result_type() {

   261

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

   262

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

   263

	}

   264

   265

	/* A helper function... */

   266

    void BYTE_operator_result_type(void) {

   267

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

   268

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

   269

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

   270

		else

   271

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

   272

	  }

   273

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

   274

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

   275

	}

   276

   277

    /* A helper function... */

   278

    void NUM_operator_result_type(void) {

   279

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

   280

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

   281

			search_expression_type->is_literal_real_type(this->current_operand_type))

   282

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

   283

		else

   284

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

   285

	  }

   286

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

   287

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

   288

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

   289

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

   290

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

   291

		else

   292

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

   293

	  }

   294

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

   295

			   search_expression_type->is_literal_real_type(this->current_operand_type))

   296

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

   297

	}

   298

   299

    void *print_getter(symbol_c *symbol) {

   300

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

   301

      if (vartype == search_var_instance_decl_c::external_vt)

   302

    	s4o.print(GET_EXTERNAL);

   303

      else if (vartype == search_var_instance_decl_c::located_vt)

   304

    	s4o.print(GET_LOCATED);

   305

      else

   306

    	s4o.print(GET_VAR);

   307

      s4o.print("(");

   308

   309

      wanted_variablegeneration = complextype_base_vg;

   310

      symbol->accept(*this);

   311

      if (search_varfb_instance_type->type_is_complex())

   312

    	s4o.print(",");

   313

      wanted_variablegeneration = complextype_suffix_vg;

   314

      symbol->accept(*this);

   315

      s4o.print(")");

   316

      wanted_variablegeneration = expression_vg;

   317

      return NULL;

   318

    }

   319

   320

    void *print_setter(symbol_c* symbol,

   321

    		symbol_c* type,

   322

    		symbol_c* value) {

   323

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

   324

      if (vartype == search_var_instance_decl_c::external_vt) {

   325

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

   326

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

   327

        if (variable != NULL) {

   328

          s4o.print(SET_EXTERNAL);

   329

          s4o.print("(");

   330

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

   331

          s4o.print(",");

   332

        }

   333

        else {

   334

          s4o.print(SET_COMPLEX_EXTERNAL);

   335

          s4o.print("(");

   336

        }

   337

      }

   338

      else {

   339

        if (vartype == search_var_instance_decl_c::located_vt)

   340

          s4o.print(SET_LOCATED);

   341

        else

   342

          s4o.print(SET_VAR);

   343

        s4o.print("(");

   344

      }

   345

   346

      wanted_variablegeneration = complextype_base_vg;

   347

      symbol->accept(*this);

   348

      s4o.print(",");

   349

      wanted_variablegeneration = expression_vg;

   350

      print_check_function(type, value, NULL, true);

   351

      if (search_varfb_instance_type->type_is_complex()) {

   352

        s4o.print(",");

   353

        wanted_variablegeneration = complextype_suffix_vg;

   354

        symbol->accept(*this);

   355

      }

   356

      s4o.print(")");

   357

      wanted_variablegeneration = expression_vg;

   358

      return NULL;

   359

    }

   360

   361

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

   362

    /* B 1.4 - Variables */

   363

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

   364

    void *visit(symbolic_variable_c *symbol) {

   365

      unsigned int vartype;

   366

      if (wanted_variablegeneration == complextype_base_vg)

   367

        generate_c_base_c::visit(symbol);

   368

      else if (wanted_variablegeneration == complextype_suffix_vg)

   369

        return NULL;

   370

      else

   371

        print_getter(symbol);

   372

      return NULL;

   373

    }

   374

   375

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

   376

    /* B.1.4.1   Directly Represented Variables */

   377

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

   378

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

   379

    void *visit(direct_variable_c *symbol) {

   380

      TRACE("direct_variable_c");

   381

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

   382

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

   383

      s4o.print(GET_LOCATED);

   384

      s4o.print("(");

   385

      this->print_variable_prefix();

   386

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

   387

      s4o.print(")");

   388

      return NULL;

   389

    }

   390

   391

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

   392

    /* B.1.4.2   Multi-element Variables */

   393

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

   394

   395

    // SYM_REF2(structured_variable_c, record_variable, field_selector)

   396

    void *visit(structured_variable_c *symbol) {

   397

      TRACE("structured_variable_c");

   398

      switch (wanted_variablegeneration) {

   399

        case complextype_base_vg:

   400

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

   401

          break;

   402

        case complextype_suffix_vg:

   403

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

   404

          s4o.print(".");

   405

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

   406

          break;

   407

        default:

   408

          print_getter(symbol);

   409

          break;

   410

      }

   411

      return NULL;

   412

    }

   413

   414

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

   415

    //SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   416

    void *visit(array_variable_c *symbol) {

   417

      switch (wanted_variablegeneration) {

   418

        case complextype_base_vg:

   419

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

   420

          break;

   421

        case complextype_suffix_vg:

   422

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

   423

   424

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

   425

          if (current_array_type == NULL) ERROR;

   426

   427

          s4o.print(".table");

   428

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

   429

   430

          current_array_type = NULL;

   431

          break;

   432

        default:

   433

          print_getter(symbol);

   434

          break;

   435

      }

   436

      return NULL;

   437

    }

   438

   439

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

   440

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

   441

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

   442

   443

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

   444

    /* B 2.1 Instructions and Operands */

   445

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

   446

   447

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

   448

    // SYM_REF2(il_instruction_c, label, il_instruction)

   449

    void *visit(il_instruction_c *symbol) {

   450

      if (NULL != symbol->il_instruction) {

   451

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

   452

      }

   453

      return NULL;

   454

    }

   455

    /* | il_simple_operator [il_operand] */

   456

    //SYM_REF2(il_simple_operation_c, il_simple_operator, il_operand)

   457

    void *visit(il_simple_operation_c *symbol) {

   458

      this->current_operand = symbol->il_operand;

   459

      if (NULL == this->current_operand) {

   460

        this->current_operand_type = NULL;

   461

      } else {

   462

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

   463

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

   464

      }

   465

   466

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

   467

   468

      this->current_operand = NULL;

   469

      this->current_operand_type = NULL;

   470

      return NULL;

   471

    }

   472

   473

    void *visit(il_function_call_c *symbol) {

   474

      symbol_c* function_type_prefix = NULL;

   475

      symbol_c* function_name = NULL;     

   476

      symbol_c* function_type_suffix = NULL;

   477

      DECLARE_PARAM_LIST()

   478

   479

      symbol_c *param_data_type = default_variable_name.current_type;

   480

   481

      function_call_param_iterator_c function_call_param_iterator(symbol);

   482

   483

      function_declaration_c *f_decl = (function_declaration_c *)symbol->called_function_declaration;

   484

      if (f_decl == NULL) ERROR;

   485

   486

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

   487

      search_base_type_c search_base_type;

   488

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

   489

   490

      function_name = symbol->function_name;      

   491

   492

      /* loop through each function parameter, find the value we should pass

   493

       * to it, and then output the c equivalent...

   494

       */

   495

   496

      function_param_iterator_c fp_iterator(f_decl);

   497

      identifier_c *param_name;

   498