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

    88

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

    89

	#define IL_DEFVAR   VAR_LEADER "IL_DEFVAR"

    91

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

    92

	 * parenthesised instruction list to the immediately preceding

    93

	 * scope ...

    94

	 */

    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),

   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

   290

    void *print_getter(symbol_c *symbol) {

   291

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

   292

      if (vartype == search_var_instance_decl_c::external_vt)

   293

    	s4o.print(GET_EXTERNAL);

   294

      else if (vartype == search_var_instance_decl_c::located_vt)

   295

    	s4o.print(GET_LOCATED);

   296

      else

   297

    	s4o.print(GET_VAR);

   298

      s4o.print("(");

   299

   300

      wanted_variablegeneration = complextype_base_vg;

   301

      symbol->accept(*this);

   302

      if (search_varfb_instance_type->type_is_complex())

   303

    	s4o.print(",");

   304

      wanted_variablegeneration = complextype_suffix_vg;

   305

      symbol->accept(*this);

   306

      s4o.print(")");

   307

      wanted_variablegeneration = expression_vg;

   308

      return NULL;

   309

    }

   310

   311

    void *print_setter(symbol_c* symbol,

   312

    		symbol_c* type,

   313

    		symbol_c* value) {

   314

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

   315

      if (vartype == search_var_instance_decl_c::external_vt) {

   316

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

   317

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

   318

        if (variable != NULL) {

   319

          s4o.print(SET_EXTERNAL);

   320

          s4o.print("(");

   321

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

   322

          s4o.print(",");

   323

        }

   324

        else {

   325

          s4o.print(SET_COMPLEX_EXTERNAL);

   326

          s4o.print("(");

   327

        }

   328

      }

   329

      else {

   330

        if (vartype == search_var_instance_decl_c::located_vt)

   331

          s4o.print(SET_LOCATED);

   332

        else

   333

          s4o.print(SET_VAR);

   334

        s4o.print("(");

   335

      }

   336

   337

      wanted_variablegeneration = complextype_base_vg;

   338

      symbol->accept(*this);

   339

      s4o.print(",");

   340

      wanted_variablegeneration = expression_vg;

   341

      print_check_function(type, value, NULL, true);

   342

      if (search_varfb_instance_type->type_is_complex()) {

   343

        s4o.print(",");

   344

        wanted_variablegeneration = complextype_suffix_vg;

   345

        symbol->accept(*this);

   346

      }

   347

      s4o.print(")");

   348

      wanted_variablegeneration = expression_vg;

   349

      return NULL;

   350

    }

   351

   352

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

   353

    /* B 1.4 - Variables */

   354

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

   355

    void *visit(symbolic_variable_c *symbol) {

   356

      unsigned int vartype;

   357

      if (wanted_variablegeneration == complextype_base_vg)

   358

        generate_c_base_c::visit(symbol);

   359

      else if (wanted_variablegeneration == complextype_suffix_vg)

   360

        return NULL;

   361

      else

   362

        print_getter(symbol);

   363

      return NULL;

   364

    }

   365

   366

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

   367

    /* B.1.4.1   Directly Represented Variables */

   368

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

   369

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

   370

    void *visit(direct_variable_c *symbol) {

   371

      TRACE("direct_variable_c");

   372

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

   373

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

   374

      s4o.print(GET_LOCATED);

   375

      s4o.print("(");

   376

      this->print_variable_prefix();

   377

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

   378

      s4o.print(")");

   379

      return NULL;

   380

    }

   381

   382

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

   383

    /* B.1.4.2   Multi-element Variables */

   384

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

   385

   386

    // SYM_REF2(structured_variable_c, record_variable, field_selector)

   387

    void *visit(structured_variable_c *symbol) {

   388

      TRACE("structured_variable_c");

   389

      switch (wanted_variablegeneration) {

   390

        case complextype_base_vg:

   391

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

   392

          break;

   393

        case complextype_suffix_vg:

   394

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

   395

          s4o.print(".");

   396

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

   397

          break;

   398

        default:

   399

          print_getter(symbol);

   400

          break;

   401

      }

   402

      return NULL;

   403

    }

   404

   405

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

   406

    //SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   407

    void *visit(array_variable_c *symbol) {

   408

      switch (wanted_variablegeneration) {

   409

        case complextype_base_vg:

   410

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

   411

          break;

   412

        case complextype_suffix_vg:

   413

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

   414

   415

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

   416

          if (current_array_type == NULL) ERROR;

   417

   418

          s4o.print(".table");

   419

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

   420

   421

          current_array_type = NULL;

   422

          break;

   423

        default:

   424

          print_getter(symbol);

   425

          break;

   426

      }

   427

      return NULL;

   428

    }

   429

   430

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

   431

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

   432

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

   433

   434

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

   435

    /* B 2.1 Instructions and Operands */

   436

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

   437

   464

    void *visit(il_function_call_c *symbol) {

   465

      symbol_c* function_type_prefix = NULL;

   466

      symbol_c* function_name = NULL;

   467

      symbol_c* function_type_suffix = NULL;

   468

      DECLARE_PARAM_LIST()

   469

   470

      symbol_c *param_data_type = default_variable_name.current_type;

   471

   472

      function_call_param_iterator_c function_call_param_iterator(symbol);

   473

   474

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

   475

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

   476

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

   477

        if (current_function_type == function_none) ERROR;

   478

   479

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

   480

   481

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

   482

        /* Add the value from EN param */

   483

        ADD_PARAM_LIST(en_param_name,

   484

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

   485

                       (symbol_c*)(new bool_type_name_c()),

   486

                       function_param_iterator_c::direction_in)

   487

   488

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

   489

        /* Add the value from ENO param */

   490

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

   491

   492

        int nb_param = 1;

   493

        if (symbol->il_operand_list != NULL)

   494

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

   495

   496

        #include "il_code_gen.c"

   497

   498

      }

   499

	  else {

   500

		function_name = symbol->function_name;

   501

   502

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