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

	bool generating_inlinefunction;

   104

	symbol_c *fbname;

   105

   106

    search_expression_type_c *search_expression_type;

   107

   108

    search_varfb_instance_type_c *search_varfb_instance_type;

   109

   110

    search_base_type_c search_base_type;

   111

   112

    variablegeneration_t wanted_variablegeneration;

   113

   114

  public:

   115

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

   116

    : generate_c_typedecl_c(s4o_ptr),

   117

      default_variable_name(IL_DEFVAR, NULL),

   118

      default_variable_back_name(IL_DEFVAR_BACK, NULL)

   119

    {

   120

      search_expression_type = new search_expression_type_c(scope);

   121

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

   122

      this->set_variable_prefix(variable_prefix);

   123

      current_operand = NULL;

   124

      current_operand_type = NULL;

   125

      il_default_variable_init_value = NULL;

   126

      fcall_number = 0;

   127

      fbname = name;

   128

      wanted_variablegeneration = expression_vg;

   129

      generating_inlinefunction = false;

   130

    }

   131

   132

    virtual ~generate_c_inlinefcall_c(void) {

   133

      delete search_expression_type;

   134

      delete search_varfb_instance_type;

   135

    }

   136

   137

    void print(symbol_c* symbol) {

   138

      function_call_iterator_c fc_iterator(symbol);

   139

      symbol_c* function_call;

   140

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

   141

    	function_call->accept(*this);

   142

      }

   143

    }

   144

   145

   146

   147

    void generate_inline(symbol_c *function_name,

   148

            symbol_c *function_type_prefix,

   149

            symbol_c *function_type_suffix,

   150

            std::list<FUNCTION_PARAM*> param_list,

   151

            function_declaration_c *f_decl = NULL) {

   152

   153

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

   154

      generating_inlinefunction = true;

   155

   156

      fcall_number++;

   157

      function_type_prefix = search_expression_type->default_literal_type(function_type_prefix);

   158

      if (function_type_suffix) {

   159

        function_type_suffix = search_expression_type->default_literal_type(function_type_suffix);

   160

      }

   161

   162

      s4o.print(s4o.indent_spaces);

   163

      s4o.print("inline ");

   164

      function_type_prefix->accept(*this);

   165

      s4o.print(" __");

   166

      fbname->accept(*this);

   167

      s4o.print("_");

   168

      function_name->accept(*this);

   169

      if (f_decl != NULL) {

   170

        /* function being called is overloaded! */

   171

        s4o.print("__");

   172

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   173

        f_decl->accept(overloaded_func_suf);

   174

      }	

   175

      if (function_type_suffix) {

   176

        function_type_suffix->accept(*this);

   177

      }

   178

      s4o.print_integer(fcall_number);

   179

      s4o.print("(");

   180

      s4o.indent_right();

   181

   182

      PARAM_LIST_ITERATOR() {

   183

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in) {

   184

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

   185

          s4o.print(" ");

   186

          PARAM_NAME->accept(*this);

   187

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

   188

        }

   189

      }

   190

      fbname->accept(*this);

   191

      s4o.print(" *");

   192

      s4o.print(FB_FUNCTION_PARAM);

   193

      s4o.indent_left();

   194

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

   195

      s4o.print("{\n");

   196

      s4o.indent_right();

   197

   198

      s4o.print(s4o.indent_spaces);

   199

      function_type_prefix->accept(*this);

   200

      s4o.print(" "),

   201

      s4o.print(INLINE_RESULT_TEMP_VAR);

   202

      s4o.print(";\n");

   203

   204

      PARAM_LIST_ITERATOR() {

   205

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

   206

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   207

             PARAM_VALUE != NULL) {

   208

          s4o.print(s4o.indent_spaces);

   209

          PARAM_TYPE->accept(*this);

   210

          s4o.print(" ");

   211

          s4o.print(TEMP_VAR);

   212

          PARAM_NAME->accept(*this);

   213

          s4o.print(" = ");

   214

          print_check_function(PARAM_TYPE, PARAM_VALUE);

   215

          s4o.print(";\n");

   216

          }

   217

        }

   218

   219

      s4o.print(s4o.indent_spaces + INLINE_RESULT_TEMP_VAR),

   220

      s4o.print(" = ");

   221

      function_name->accept(*this);

   222

      if (f_decl != NULL) {

   223

    	/* function being called is overloaded! */

   224

    	s4o.print("__");

   225

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   226

        f_decl->accept(overloaded_func_suf);

   227

      }

   228

   229

      if (function_type_suffix)

   230

        function_type_suffix->accept(*this);

   231

      s4o.print("(");

   232

      s4o.indent_right();

   233

   234

      PARAM_LIST_ITERATOR() {

   235

        if (pt != param_list.begin())

   236

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

   237

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in)

   238

          PARAM_NAME->accept(*this);

   239

        else if (PARAM_VALUE != NULL){

   240

          s4o.print("&");

   241

          s4o.print(TEMP_VAR);

   242

          PARAM_NAME->accept(*this);

   243

        } else {

   244

          s4o.print("NULL");

   245

         }

   246

      }

   247

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

   248

      s4o.indent_left();

   249

   250

      PARAM_LIST_ITERATOR() {

   251

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

   252

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   253

             PARAM_VALUE != NULL) {

   254

          s4o.print(s4o.indent_spaces);

   255

          print_setter(PARAM_VALUE, PARAM_TYPE, PARAM_NAME);

   256

          s4o.print(";\n");

   257

        }

   258

      }

   259

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

   260

      s4o.print(INLINE_RESULT_TEMP_VAR);

   261

      s4o.print(";\n");

   262

   263

      s4o.indent_left();

   264

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

   265

   266

      generating_inlinefunction = false;

   267

    }

   268

   269

  private:

   270

   271

    /* A helper function... */

   272

	void CMP_operator_result_type() {

   273

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

   274

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

   275

	}

   276

   277

	/* A helper function... */

   278

    void BYTE_operator_result_type(void) {

   279

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

   280

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

   281

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

   282

		else

   283

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

   284

	  }

   285

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

   286

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

   287

	}

   288

   289

    /* A helper function... */

   290

    void NUM_operator_result_type(void) {

   291

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

   292

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

   293

			search_expression_type->is_literal_real_type(this->current_operand_type))

   294

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

   295

		else

   296

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

   297

	  }

   298

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

   299

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

   300

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

   301

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

   302

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

   303

		else

   304

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

   305

	  }

   306

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

   307

			   search_expression_type->is_literal_real_type(this->current_operand_type))

   308

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

   309

	}

   310

   311

    void *print_getter(symbol_c *symbol) {

   312

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

   313

      if (vartype == search_var_instance_decl_c::external_vt)

   314

    	s4o.print(GET_EXTERNAL);

   315

      else if (vartype == search_var_instance_decl_c::located_vt)

   316

    	s4o.print(GET_LOCATED);

   317

      else

   318

    	s4o.print(GET_VAR);

   319

      s4o.print("(");

   320

   321

      wanted_variablegeneration = complextype_base_vg;

   322

      symbol->accept(*this);

   323

      if (search_varfb_instance_type->type_is_complex())

   324

    	s4o.print(",");

   325

      wanted_variablegeneration = complextype_suffix_vg;

   326

      symbol->accept(*this);

   327

      s4o.print(")");

   328

      wanted_variablegeneration = expression_vg;

   329

      return NULL;

   330

    }

   331

   332

    void *print_setter(symbol_c* symbol,

   333

    		symbol_c* type,

   334

    		symbol_c* value) {

   335

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

   336

      if (vartype == search_var_instance_decl_c::external_vt)

   337

        s4o.print(SET_EXTERNAL);

   338

      else if (vartype == search_var_instance_decl_c::located_vt)

   339

        s4o.print(SET_LOCATED);

   340

      else

   341

        s4o.print(SET_VAR);

   342

      s4o.print("(,");

   343

   344

      wanted_variablegeneration = complextype_base_vg;

   345

      symbol->accept(*this);

   346

      s4o.print(",");

   347

      wanted_variablegeneration = expression_vg;

   348

      print_check_function(type, value, NULL, true);

   349

      if (search_varfb_instance_type->type_is_complex()) {

   350

        s4o.print(",");

   351

        wanted_variablegeneration = complextype_suffix_vg;

   352

        symbol->accept(*this);

   353

      }

   354

      s4o.print(")");

   355

      wanted_variablegeneration = expression_vg;

   356

      return NULL;

   357

    }

   358

   359

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

   360

    /* B 1.4 - Variables */

   361

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

   362

    void *visit(symbolic_variable_c *symbol) {

   363

      unsigned int vartype;

   364

      if (generating_inlinefunction) {

   365

        if (wanted_variablegeneration == complextype_base_vg)

   366

          generate_c_base_c::visit(symbol);

   367

        else if (wanted_variablegeneration == complextype_suffix_vg)

   368

          return NULL;

   369

        else

   370

          print_getter(symbol);

   371

      }

   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

      if (generating_inlinefunction) {

   382

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

   383

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

   384

        s4o.print(GET_LOCATED);

   385

        s4o.print("(");

   386

        this->print_variable_prefix();

   387

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

   388

        s4o.print(")");

   389

      }

   390

      return NULL;

   391

    }

   392

   393

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

   394

    /* B.1.4.2   Multi-element Variables */

   395

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

   396

   397

    // SYM_REF2(structured_variable_c, record_variable, field_selector)

   398

    void *visit(structured_variable_c *symbol) {

   399

      TRACE("structured_variable_c");

   400

      if (generating_inlinefunction) {

   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

      }

   415

      return NULL;

   416

    }

   417

   418

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

   419

    //SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   420

    void *visit(array_variable_c *symbol) {

   421

      if (generating_inlinefunction) {

   422

        switch (wanted_variablegeneration) {

   423

          case complextype_base_vg:

   424

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

   425

            break;

   426

          case complextype_suffix_vg:

   427

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

   428

   429

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

   430

            if (current_array_type == NULL) ERROR;

   431

   432

            s4o.print(".table");

   433

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

   434

   435

            current_array_type = NULL;

   436

            break;

   437

          default:

   438

            print_getter(symbol);

   439

            break;

   440

        }

   441

      }

   442

      return NULL;

   443

    }

   444

   445

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

   446

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

   447

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

   448

   449

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

   450

    /* B 2.1 Instructions and Operands */

   451

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

   452

   453

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

   454

    // SYM_REF2(il_instruction_c, label, il_instruction)

   455

    void *visit(il_instruction_c *symbol) {

   456

      if (NULL != symbol->il_instruction) {

   457

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

   458

      }

   459

      return NULL;

   460

    }

   461

   462

    /* | il_simple_operator [il_operand] */

   463

    //SYM_REF2(il_simple_operation_c, il_simple_operator, il_operand)

   464

    void *visit(il_simple_operation_c *symbol) {

   465

      this->current_operand = symbol->il_operand;

   466

      if (NULL == this->current_operand) {

   467

        this->current_operand_type = NULL;

   468

      } else {

   469

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

   470

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

   471

      }

   472

   473

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

   474

   475

      this->current_operand = NULL;

   476

      this->current_operand_type = NULL;

   477

      return NULL;

   478

    }

   479

   480

    void *visit(il_function_call_c *symbol) {

   481

      symbol_c* function_type_prefix = NULL;

   482

      symbol_c* function_name = NULL;     

   483

      symbol_c* function_type_suffix = NULL;

   484

      DECLARE_PARAM_LIST()

   485

   486

      symbol_c *param_data_type = default_variable_name.current_type;

   487

   488

      function_call_param_iterator_c function_call_param_iterator(symbol);

   489

   490

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

   491

      if (f_decl == NULL) ERROR;

   492

   493

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

   494

      search_base_type_c search_base_type;

   495

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

   496