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

#define INLINE_PARAM_COUNT "__PARAM_COUNT"

    28

    29

class generate_c_inlinefcall_c: public generate_c_typedecl_c {

    30

    31

  public:

    32

    typedef enum {

    33

      expression_vg,

    34

      assignment_vg,

    35

      complextype_base_vg,

    36

      complextype_suffix_vg

    37

    } variablegeneration_t;

    38

    39

  private:

    40

    41

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

    42

	 * imediately after a parenthesis is opened.

    43

	 * This variable is only used to pass data from the

    44

	 * il_expression_c visitor to the simple_instr_list_c visitor.

    45

	 *

    46

	 * e.g.:

    47

	 *         LD var1

    48

	 *         AND ( var2

    49

	 *         OR var3

    50

	 *         )

    51

	 *

    52

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

    53

	 * an il_expression_c, where var2 should be loaded into the

    54

	 * il default variable before continuing with the expression

    55

	 * inside the parenthesis.

    56

	 * Unfortunately, only the simple_instr_list_c may do the

    57

	 * initial laoding of the var2 bariable following the parenthesis,

    58

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

    59

	 * parameter to the simple_instr_list_c visitor.

    60

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

    61

	 */

    62

	symbol_c *il_default_variable_init_value;

    63

    64

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

    65

	/* These variables are used to pass data from the

    66

	 * il_simple_operation_c and il_expression_c visitors

    67

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

    68

	 * LDN_operator_c, ST_operator_c, STN_operator_c, ...)

    69

	 */

    70

	symbol_c *current_operand;

    71

	symbol_c *current_operand_type;

    72

    73

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

    74

	 * is a boolean variable.

    75

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

    76

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

    77

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

    78

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

    79

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

    80

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

    81

	 * data type.

    82

	 * The following object is it...

    83

	 */

    84

	bool_type_name_c bool_type;

    85

	lint_type_name_c lint_type;

    86

	lword_type_name_c lword_type;

    87

	lreal_type_name_c lreal_type;

    88

    89

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

    90

	#define IL_DEFVAR   VAR_LEADER "IL_DEFVAR"

    91

    92

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

    93

	 * parenthesised instruction list to the immediately preceding

    94

	 * scope ...

    95

	 */

    96

    #define IL_DEFVAR_BACK   VAR_LEADER "IL_DEFVAR_BACK"

    97

    il_default_variable_c default_variable_name;

    98

	il_default_variable_c default_variable_back_name;

    99

   100

	symbol_c* current_array_type;

   101

   102

	int fcall_number;

   103

	symbol_c *fbname;

   104

   105

    search_expression_type_c *search_expression_type;

   106

   107

    search_varfb_instance_type_c *search_varfb_instance_type;

   108

   109

    search_base_type_c search_base_type;

   110

   111

    variablegeneration_t wanted_variablegeneration;

   112

   113

  public:

   114

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

   115

    : generate_c_typedecl_c(s4o_ptr),

   116

      default_variable_name(IL_DEFVAR, NULL),

   117

      default_variable_back_name(IL_DEFVAR_BACK, NULL)

   118

    {

   119

      search_expression_type = new search_expression_type_c(scope);

   120

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

   121

      this->set_variable_prefix(variable_prefix);

   122

      fcall_number = 0;

   123

      fbname = name;

   124

      wanted_variablegeneration = expression_vg;

   125

    }

   126

   127

    virtual ~generate_c_inlinefcall_c(void) {

   128

      delete search_expression_type;

   129

      delete search_varfb_instance_type;

   130

    }

   131

   132

    void print(symbol_c* symbol) {

   133

      function_call_iterator_c fc_iterator(symbol);

   134

      symbol_c* function_call;

   135

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

   136

    	function_call->accept(*this);

   137

      }

   138

    }

   139

   140

   141

   142

    void generate_inline(symbol_c *function_name,

   143

            symbol_c *function_type_prefix,

   144

            symbol_c *function_type_suffix,

   145

            std::list<FUNCTION_PARAM*> param_list,

   146

            function_declaration_c *f_decl = NULL) {

   147

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

   148

   149

      fcall_number++;

   150

      function_type_prefix = search_expression_type->default_literal_type(function_type_prefix);

   151

      if (function_type_suffix) {

   152

        function_type_suffix = search_expression_type->default_literal_type(function_type_suffix);

   153

      }

   154

   155

      s4o.print(s4o.indent_spaces);

   156

      s4o.print("inline ");

   157

      function_type_prefix->accept(*this);

   158

      s4o.print(" __");

   159

      fbname->accept(*this);

   160

      s4o.print("_");

   161

      function_name->accept(*this);

   162

      if (f_decl != NULL) {

   165

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   166

        f_decl->accept(overloaded_func_suf);

   167

      }	

   168

      if (function_type_suffix) {

   169

        function_type_suffix->accept(*this);

   170

      }

   171

      s4o.print_integer(fcall_number);

   172

      s4o.print("(");

   173

      s4o.indent_right();

   174

   175

      PARAM_LIST_ITERATOR() {

   176

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in) {

   177

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

   178

          s4o.print(" ");

   179

          PARAM_NAME->accept(*this);

   180

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

   181

        }

   182

      }

   183

      fbname->accept(*this);

   184

      s4o.print(" *");

   185

      s4o.print(FB_FUNCTION_PARAM);

   186

      s4o.indent_left();

   187

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

   188

      s4o.print("{\n");

   189

      s4o.indent_right();

   190

   191

      s4o.print(s4o.indent_spaces);

   192

      function_type_prefix->accept(*this);

   193

      s4o.print(" "),

   194

      s4o.print(INLINE_RESULT_TEMP_VAR);

   195

      s4o.print(";\n");

   196

   197

      PARAM_LIST_ITERATOR() {

   198

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

   199

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   200

             PARAM_VALUE != NULL) {

   201

          s4o.print(s4o.indent_spaces);

   202

          PARAM_TYPE->accept(*this);

   203

          s4o.print(" ");

   204

          s4o.print(TEMP_VAR);

   205

          PARAM_NAME->accept(*this);

   206

          s4o.print(" = ");

   207

          print_check_function(PARAM_TYPE, PARAM_VALUE);

   208

          s4o.print(";\n");

   209

          }

   210

        }

   211

   212

      s4o.print(s4o.indent_spaces + INLINE_RESULT_TEMP_VAR),

   213

      s4o.print(" = ");

   214

      function_name->accept(*this);

   215

      if (f_decl != NULL) {

   218

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   219

        f_decl->accept(overloaded_func_suf);

   220

      }

   221

   222

      if (function_type_suffix)

   223

        function_type_suffix->accept(*this);

   224

      s4o.print("(");

   225

      s4o.indent_right();

   226

   227

      PARAM_LIST_ITERATOR() {

   228

        if (pt != param_list.begin())

   229

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

   230

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in)

   231

          PARAM_NAME->accept(*this);

   232

        else if (PARAM_VALUE != NULL){

   233

          s4o.print("&");

   234

          s4o.print(TEMP_VAR);

   235

          PARAM_NAME->accept(*this);

   236

        } else {

   237

          s4o.print("NULL");

   238

         }

   239

      }

   240

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

   241

      s4o.indent_left();

   242

   243

      PARAM_LIST_ITERATOR() {

   244

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

   245

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   246

             PARAM_VALUE != NULL) {

   247

          s4o.print(s4o.indent_spaces);

   248

          print_setter(PARAM_VALUE, PARAM_TYPE, PARAM_NAME);

   249

          s4o.print(";\n");

   250

        }

   251

      }

   252

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

   253

      s4o.print(INLINE_RESULT_TEMP_VAR);

   254

      s4o.print(";\n");

   255

   256

      s4o.indent_left();

   257

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

   258

    }

   259

   260

  private:

   261

   262

    /* A helper function... */

   263

	void CMP_operator_result_type() {

   264

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

   265

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

   266

	}

   267

   268

	/* A helper function... */

   269

    void BYTE_operator_result_type(void) {

   270

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

   271

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

   272

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

   273

		else

   274

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

   275

	  }

   276

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

   277

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

   278

	}

   279

   280

    /* A helper function... */

   281

    void NUM_operator_result_type(void) {

   282

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

   283

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

   284

			search_expression_type->is_literal_real_type(this->current_operand_type))

   285

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

   286

		else

   287

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

   288

	  }

   289

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

   290

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

   291

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

   292

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

   293

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

   294

		else

   295

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

   296

	  }

   297

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

   298

			   search_expression_type->is_literal_real_type(this->current_operand_type))

   299

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

   300

	}

   301

   302

    void *print_getter(symbol_c *symbol) {

   303

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

   304

      if (vartype == search_var_instance_decl_c::external_vt)

   305

    	s4o.print(GET_EXTERNAL);

   306

      else if (vartype == search_var_instance_decl_c::located_vt)

   307

    	s4o.print(GET_LOCATED);

   308

      else

   309

    	s4o.print(GET_VAR);

   310

      s4o.print("(");

   311

   312

      wanted_variablegeneration = complextype_base_vg;

   313

      symbol->accept(*this);

   314

      if (search_varfb_instance_type->type_is_complex())

   315

    	s4o.print(",");

   316

      wanted_variablegeneration = complextype_suffix_vg;

   317

      symbol->accept(*this);

   318

      s4o.print(")");

   319

      wanted_variablegeneration = expression_vg;

   320

      return NULL;

   321

    }

   322

   323

    void *print_setter(symbol_c* symbol,

   324

    		symbol_c* type,

   325

    		symbol_c* value) {

   326

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

   327

      if (vartype == search_var_instance_decl_c::external_vt) {

   328

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

   329

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

   330

        if (variable != NULL) {

   331

          s4o.print(SET_EXTERNAL);

   332

          s4o.print("(");

   333

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

   334

          s4o.print(",");

   335

        }

   336

        else {

   337

          s4o.print(SET_COMPLEX_EXTERNAL);

   338

          s4o.print("(");

   339

        }

   340

      }

   341

      else {

   342

        if (vartype == search_var_instance_decl_c::located_vt)

   343

          s4o.print(SET_LOCATED);

   344

        else

   345

          s4o.print(SET_VAR);

   346

        s4o.print("(");

   347

      }

   348

   349

      wanted_variablegeneration = complextype_base_vg;

   350

      symbol->accept(*this);

   351

      s4o.print(",");

   352

      wanted_variablegeneration = expression_vg;

   353

      print_check_function(type, value, NULL, true);

   354

      if (search_varfb_instance_type->type_is_complex()) {

   355

        s4o.print(",");

   356

        wanted_variablegeneration = complextype_suffix_vg;

   357

        symbol->accept(*this);

   358

      }

   359

      s4o.print(")");

   360

      wanted_variablegeneration = expression_vg;

   361

      return NULL;

   362

    }

   363

   364

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

   365

    /* B 1.4 - Variables */

   366

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

   367

    void *visit(symbolic_variable_c *symbol) {

   368

      unsigned int vartype;

   369

      if (wanted_variablegeneration == complextype_base_vg)

   370

        generate_c_base_c::visit(symbol);

   371

      else if (wanted_variablegeneration == complextype_suffix_vg)

   372

        return NULL;

   373

      else

   374

        print_getter(symbol);

   375

      return NULL;

   376

    }

   377

   378

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

   379

    /* B.1.4.1   Directly Represented Variables */

   380

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

   381

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

   382

    void *visit(direct_variable_c *symbol) {

   383

      TRACE("direct_variable_c");

   384

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

   385

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

   386

      s4o.print(GET_LOCATED);

   387

      s4o.print("(");

   388

      this->print_variable_prefix();

   389

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

   390

      s4o.print(")");

   391

      return NULL;

   392

    }

   393

   394

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

   395

    /* B.1.4.2   Multi-element Variables */

   396

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

   397

   398

    // SYM_REF2(structured_variable_c, record_variable, field_selector)

   399

    void *visit(structured_variable_c *symbol) {

   400

      TRACE("structured_variable_c");

   401

      switch (wanted_variablegeneration) {

   402

        case complextype_base_vg:

   403

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

   404

          break;

   405

        case complextype_suffix_vg:

   406

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

   407

          s4o.print(".");

   408

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

   409

          break;

   410

        default:

   411

          print_getter(symbol);

   412

          break;

   413

      }

   414

      return NULL;

   415

    }

   416

   417

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

   418

    //SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   419

    void *visit(array_variable_c *symbol) {

   420

      switch (wanted_variablegeneration) {

   421

        case complextype_base_vg:

   422

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

   423

          break;

   424

        case complextype_suffix_vg:

   425

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

   426

   427

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

   428

          if (current_array_type == NULL) ERROR;

   429

   430

          s4o.print(".table");

   431

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

   432

   433

          current_array_type = NULL;

   434

          break;

   435

        default:

   436

          print_getter(symbol);

   437

          break;

   438

      }

   439

      return NULL;

   440

    }

   441

   442

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

   443

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

   444

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

   445

   446

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

   447

    /* B 2.1 Instructions and Operands */

   448

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

   449

   450

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

   451

    // SYM_REF2(il_instruction_c, label, il_instruction)

   452

    void *visit(il_instruction_c *symbol) {

   453

      if (NULL != symbol->il_instruction) {

   454

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

   455

      }

   456

      return NULL;

   457

    }

   458

    /* | il_simple_operator [il_operand] */

   459

    //SYM_REF2(il_simple_operation_c, il_simple_operator, il_operand)

   460

    void *visit(il_simple_operation_c *symbol) {

   461

      this->current_operand = symbol->il_operand;

   462

      if (NULL == this->current_operand) {

   463

        this->current_operand_type = NULL;

   464

      } else {

   465

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

   466

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

   467

      }

   468

   469

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

   470

   471

      this->current_operand = NULL;

   472

      this->current_operand_type = NULL;

   473

      return NULL;

   474

    }

   475

   476

    void *visit(il_function_call_c *symbol) {

   477

      symbol_c* function_type_prefix = NULL;

   478

      symbol_c* function_name = NULL;     

   479

      symbol_c* function_type_suffix = NULL;

   480

      DECLARE_PARAM_LIST()

   481

   482

      symbol_c *param_data_type = default_variable_name.current_type;

   483

   484

      function_call_param_iterator_c function_call_param_iterator(symbol);

   485

   486

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

   487

      if (f_decl == NULL) ERROR;

   488

   489

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

   490

      search_base_type_c search_base_type;

   491

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

   492

   493

      function_name = symbol->function_name;      

   494

   495

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

   496

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

   497

       */

   498