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 name of the IL default variable... */

    41

	#define IL_DEFVAR   VAR_LEADER "IL_DEFVAR"

    42

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

    43

	 * parenthesised instruction list to the immediately preceding

    44

	 * scope ...

    45

	 */

    46

	il_default_variable_c default_variable_name;

    47

    48

	symbol_c* current_array_type;

    49

    50

	int fcall_number;

    51

	symbol_c *fbname;

    52

    53

    search_expression_type_c *search_expression_type;

    54

    55

    search_varfb_instance_type_c *search_varfb_instance_type;

    56

    57

    search_base_type_c search_base_type;

    58

    59

    variablegeneration_t wanted_variablegeneration;

    60

    61

  public:

    62

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

    63

    : generate_c_typedecl_c(s4o_ptr),

    64

      default_variable_name(IL_DEFVAR, NULL)

    65

    {

    66

      search_expression_type = new search_expression_type_c(scope);

    67

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

    68

      this->set_variable_prefix(variable_prefix);

    69

      fcall_number = 0;

    70

      fbname = name;

    71

      wanted_variablegeneration = expression_vg;

    72

    }

    73

    74

    virtual ~generate_c_inlinefcall_c(void) {

    75

      delete search_expression_type;

    76

      delete search_varfb_instance_type;

    77

    }

    78

    79

    void print(symbol_c* symbol) {

    80

      function_call_iterator_c fc_iterator(symbol);

    81

      symbol_c* function_call;

    82

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

    83

    	function_call->accept(*this);

    84

      }

    85

    }

    86

    87

    void generate_inline(symbol_c *function_name,

    88

            symbol_c *function_type_prefix,

    89

            symbol_c *function_type_suffix,

    90

            std::list<FUNCTION_PARAM*> param_list) {

    91

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

    92

    93

      fcall_number++;

   100

   101

      s4o.print(s4o.indent_spaces);

   102

      s4o.print("inline ");

   103

      function_type_prefix->accept(*this);

   104

      s4o.print(" __");

   105

      fbname->accept(*this);

   106

      s4o.print("_");

   107

      function_name->accept(*this);

   108

      if (function_type_suffix)

   109

        function_type_suffix->accept(*this);

   110

      s4o.print_integer(fcall_number);

   111

      s4o.print("(");

   112

      s4o.indent_right();

   113

   114

      PARAM_LIST_ITERATOR() {

   115

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in) {

   125

          s4o.print(" ");

   126

          PARAM_NAME->accept(*this);

   127

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

   128

        }

   129

      }

   130

      fbname->accept(*this);

   131

	  s4o.print(" *");

   132

	  s4o.print(FB_FUNCTION_PARAM);

   133

	  s4o.indent_left();

   134

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

   135

	  s4o.print("{\n");

   136

      s4o.indent_right();

   137

   138

      s4o.print(s4o.indent_spaces);

   139

      function_type_prefix->accept(*this);

   140

      s4o.print(" "),

   141

      s4o.print(INLINE_RESULT_TEMP_VAR);

   142

      s4o.print(";\n");

   143

   144

	  PARAM_LIST_ITERATOR() {

   145

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

   146

		     PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   147

		    PARAM_VALUE != NULL) {

   148

		  s4o.print(s4o.indent_spaces);

   149

		  PARAM_TYPE->accept(*this);

   150

          s4o.print(" ");

   151

          s4o.print(TEMP_VAR);

   152

          PARAM_NAME->accept(*this);

   153

          s4o.print(" = ");

   154

          print_check_function(PARAM_TYPE, PARAM_VALUE);

   155

          s4o.print(";\n");

   156

		}

   157

	  }

   158

   159

	  s4o.print(s4o.indent_spaces + INLINE_RESULT_TEMP_VAR),

   160

			  s4o.print(" = ");

   161

	  function_name->accept(*this);

   162

	  if (function_type_suffix)

   163

        function_type_suffix->accept(*this);

   164

	  s4o.print("(");

   165

	  s4o.indent_right();

   166

   167

	  PARAM_LIST_ITERATOR() {

   168

		if (pt != param_list.begin())

   169

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

   170

		if (PARAM_DIRECTION == function_param_iterator_c::direction_in)

   171

		  PARAM_NAME->accept(*this);

   172

		else if (PARAM_VALUE != NULL){

   173

          s4o.print("&");

   174

          s4o.print(TEMP_VAR);

   175

          PARAM_NAME->accept(*this);

   176

        }

   177

		else {

   178

		  s4o.print("NULL");

   179

		}

   180

	  }

   181

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

   182

	  s4o.indent_left();

   183

   184

	  PARAM_LIST_ITERATOR() {

   185

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

   186

        	 PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   187

        	PARAM_VALUE != NULL) {

   188

   189

          s4o.print(s4o.indent_spaces);

   190

          print_setter(PARAM_VALUE, PARAM_TYPE, PARAM_NAME);

   191

          s4o.print(";\n");

   192

		}

   193

	  }

   194

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

   195

	  s4o.print(INLINE_RESULT_TEMP_VAR);

   196

	  s4o.print(";\n");

   197

   198

      s4o.indent_left();

   199

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

   200

    }

   201

   202

  private:

   203

   204

    void *print_getter(symbol_c *symbol) {

   205

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

   206

      if (vartype == search_var_instance_decl_c::external_vt)

   207

    	s4o.print(GET_EXTERNAL);

   208

      else if (vartype == search_var_instance_decl_c::located_vt)

   209

    	s4o.print(GET_LOCATED);

   210

      else

   211

    	s4o.print(GET_VAR);

   212

      s4o.print("(");

   213

   214

      wanted_variablegeneration = complextype_base_vg;

   215

      symbol->accept(*this);

   216

      if (search_varfb_instance_type->type_is_complex())

   217

    	s4o.print(",");

   218

      wanted_variablegeneration = complextype_suffix_vg;

   219

      symbol->accept(*this);

   220

      s4o.print(")");

   221

      wanted_variablegeneration = expression_vg;

   222

      return NULL;

   223

    }

   224

   225

    void *print_setter(symbol_c* symbol,

   226

    		symbol_c* type,

   227

    		symbol_c* value) {

   228

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

   229

      if (vartype == search_var_instance_decl_c::external_vt) {

   230

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

   231

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

   232

        if (variable != NULL) {

   233

          s4o.print(SET_EXTERNAL);

   234

          s4o.print("(");

   235

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

   236

          s4o.print(",");

   237

        }

   238

        else {

   239

          s4o.print(SET_COMPLEX_EXTERNAL);

   240

          s4o.print("(");

   241

        }

   242

      }

   243

      else {

   244

        if (vartype == search_var_instance_decl_c::located_vt)

   245

          s4o.print(SET_LOCATED);

   246

        else

   247

          s4o.print(SET_VAR);

   248

        s4o.print("(");

   249

      }

   250

   251

      wanted_variablegeneration = complextype_base_vg;

   252

      symbol->accept(*this);

   253

      s4o.print(",");

   254

      wanted_variablegeneration = expression_vg;

   255

      print_check_function(type, value, NULL, true);

   256

      if (search_varfb_instance_type->type_is_complex()) {

   257

        s4o.print(",");

   258

        wanted_variablegeneration = complextype_suffix_vg;

   259

        symbol->accept(*this);

   260

      }

   261

      s4o.print(")");

   262

      wanted_variablegeneration = expression_vg;

   263

      return NULL;

   264

    }

   265

   266

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

   267

    /* B 1.4 - Variables */

   268

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

   269

    void *visit(symbolic_variable_c *symbol) {

   270

      unsigned int vartype;

   271

      if (wanted_variablegeneration == complextype_base_vg)

   272

        generate_c_base_c::visit(symbol);

   273

      else if (wanted_variablegeneration == complextype_suffix_vg)

   274

        return NULL;

   275

      else

   276

        print_getter(symbol);

   277

      return NULL;

   278

    }

   279

   280

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

   281

    /* B.1.4.1   Directly Represented Variables */

   282

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

   283

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

   284

    void *visit(direct_variable_c *symbol) {

   285

      TRACE("direct_variable_c");

   286

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

   287

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

   288

      s4o.print(GET_LOCATED);

   289

      s4o.print("(");

   290

      this->print_variable_prefix();

   291

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

   292

      s4o.print(")");

   293

      return NULL;

   294

    }

   295

   296

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

   297

    /* B.1.4.2   Multi-element Variables */

   298

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

   299

   300

    // SYM_REF2(structured_variable_c, record_variable, field_selector)

   301

    void *visit(structured_variable_c *symbol) {

   302

      TRACE("structured_variable_c");

   303

      switch (wanted_variablegeneration) {

   304

        case complextype_base_vg:

   305

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

   306

          break;

   307

        case complextype_suffix_vg:

   308

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

   309

          s4o.print(".");

   310

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

   311

          break;

   312

        default:

   313

          print_getter(symbol);

   314

          break;

   315

      }

   316

      return NULL;

   317

    }

   318

   319

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

   320

    //SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   321

    void *visit(array_variable_c *symbol) {

   322

      switch (wanted_variablegeneration) {

   323

        case complextype_base_vg:

   324

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

   325

          break;

   326

        case complextype_suffix_vg:

   327

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

   328

   329

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

   330

          if (current_array_type == NULL) ERROR;

   331

   332

          s4o.print(".table");

   333

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

   334

   335

          current_array_type = NULL;

   336

          break;

   337

        default:

   338

          print_getter(symbol);

   339

          break;

   340

      }

   341

      return NULL;

   342

    }

   343

   344

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

   345

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

   346

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

   347

   348

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

   349

    /* B 2.1 Instructions and Operands */

   350

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

   351

   352

    void *visit(il_function_call_c *symbol) {

   353

      symbol_c* function_type_prefix = NULL;

   354

      symbol_c* function_name = NULL;

   355

      symbol_c* function_type_suffix = NULL;

   356

      DECLARE_PARAM_LIST()

   357

   358

      symbol_c *param_data_type = default_variable_name.current_type;

   359

   360

      function_call_param_iterator_c function_call_param_iterator(symbol);

   361

   362

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

   363

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

   364

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

   365

        if (current_function_type == function_none) ERROR;

   366

   367

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

   368

   369

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

   370

        /* Add the value from EN param */

   371

        ADD_PARAM_LIST(en_param_name,

   372

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

   373

                       (symbol_c*)(new bool_type_name_c()),

   374

                       function_param_iterator_c::direction_in)

   375

   376

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

   377

        /* Add the value from ENO param */

   378

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

   379

   380

        int nb_param = 1;

   381

        if (symbol->il_operand_list != NULL)

   382

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

   383

   384

        #include "il_code_gen.c"

   385

   386

      }

   387

	  else {

   388

		function_name = symbol->function_name;

   389

   390

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

   391

		search_base_type_c search_base_type;

   392

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

   393

   394

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

   395

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

   396

		 */

   397

   398

		function_param_iterator_c fp_iterator(f_decl);

   399

		identifier_c *param_name;

   400

		for(int i = 1; (param_name = fp_iterator.next()) != NULL; i++) {

   401

		  symbol_c *param_type = fp_iterator.param_type();

   402

		  if (param_type == NULL) ERROR;

   403

   404

		  function_param_iterator_c::param_direction_t param_direction = fp_iterator.param_direction();

   405

   406

		  symbol_c *param_value = NULL;

   407

   408

		  /* if it is the first parameter, semantics specifies that we should

   409

		   * get the value off the IL default variable!

   410

		   */

   411

		  if (1 == i)

   412

		    param_value = &this->default_variable_name;

   413

   414

		  /* Get the value from a foo(<param_name> = <param_value>) style call */

   415

		  /* NOTE: the following line of code is not required in this case, but it doesn't

   416

		   * harm to leave it in, as in the case of a non-formal syntax function call,

   417

		   * it will always return NULL.

   418

		   * We leave it in in case we later decide to merge this part of the code together

   419

		   * with the function calling code in generate_c_st_c, which does require

   420

		   * the following line...

   421

		   */

   422

		  if (param_value == NULL)

   423

			param_value = function_call_param_iterator.search_f(param_name);

   424

   425

		  /* Get the value from a foo(<param_value>) style call */

   426

          if (param_value == NULL) {

   427

            param_value = function_call_param_iterator.next_nf();

   428

            if (param_value != NULL && fp_iterator.is_en_eno_param_implicit()) ERROR;

   429

          }

   430

   431

		  if (param_value == NULL && param_direction == function_param_iterator_c::direction_in) {

   432

			/* No value given for parameter, so we must use the default... */

   433

			/* First check whether default value specified in function declaration...*/

   434

			param_value = fp_iterator.default_value();

   435

		  }

   436

   437

		  ADD_PARAM_LIST(param_name, param_value, param_type, fp_iterator.param_direction())

   438

		} /* for(...) */

   439

	  }

   440

   441

	  if (function_call_param_iterator.next_nf() != NULL) ERROR;

   442

      if (NULL == function_type_prefix) ERROR;

   443

   444

      bool has_output_params = false;

   445

   446

      PARAM_LIST_ITERATOR() {

   447

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

   448

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   449

             PARAM_VALUE != NULL) {

   450

          has_output_params = true;

   451

        }

   452

      }

   453

   454

      if (has_output_params)

   455

        generate_inline(function_name, function_type_prefix, function_type_suffix, param_list);

   456

   457

      CLEAR_PARAM_LIST()

   458

   459

      return NULL;

   460

    }

   461

   462

    /* | function_name '(' eol_list [il_param_list] ')' */

   463

    // SYM_REF2(il_formal_funct_call_c, function_name, il_param_list)

   464

    void *visit(il_formal_funct_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

      function_call_param_iterator_c function_call_param_iterator(symbol);

   471

   472

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

   473

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

   474

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

   475

        if (current_function_type == function_none) ERROR;

   476

   477

        function_type_prefix = (symbol_c *)search_expression_type->compute_standard_function_default(NULL, symbol);

   478

   479

        int nb_param = 0;

   480

        if (symbol->il_param_list != NULL)

   481

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

   482

   483

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

   484

        /* Get the value from EN param */

   485

        symbol_c *EN_param_value = function_call_param_iterator.search_f(en_param_name);

   486

        if (EN_param_value == NULL)

   487

          EN_param_value = (symbol_c*)(new boolean_literal_c((symbol_c*)(new bool_type_name_c()), new boolean_true_c()));

   488

        else

   489

          nb_param --;

   490

        ADD_PARAM_LIST(en_param_name, EN_param_value, (symbol_c*)(new bool_type_name_c()), function_param_iterator_c::direction_in)

   491

   492

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

   493

        /* Get the value from ENO param */

   494

        symbol_c *ENO_param_value = function_call_param_iterator.search_f(eno_param_name);

   495

        if (ENO_param_value != NULL)

   496

          nb_param --;

   497

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

   498

   499

        #include "st_code_gen.c"

   500

   501

      }

   502

      else {

   503

        function_name = symbol->function_name;

   504

   505

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