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++;

    94

    95

      s4o.print(s4o.indent_spaces);

    96

      s4o.print("inline ");

    97

      function_type_prefix->accept(*this);

    98

      s4o.print(" __");

    99

      fbname->accept(*this);

   100

      s4o.print("_");

   101

      function_name->accept(*this);

   102

      if (function_type_suffix)

   103

        function_type_suffix->accept(*this);

   104

      s4o.print_integer(fcall_number);

   105

      s4o.print("(");

   106

      s4o.indent_right();

   107

   108

      PARAM_LIST_ITERATOR() {

   109

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in) {

   110

          PARAM_TYPE->accept(*this);

   111

          s4o.print(" ");

   112

          PARAM_NAME->accept(*this);

   113

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

   114

        }

   115

      }

   116

      fbname->accept(*this);

   117

	  s4o.print(" *");

   118

	  s4o.print(FB_FUNCTION_PARAM);

   119

	  s4o.indent_left();

   120

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

   121

	  s4o.print("{\n");

   122

      s4o.indent_right();

   123

   124

      s4o.print(s4o.indent_spaces);

   125

      function_type_prefix->accept(*this);

   126

      s4o.print(" "),

   127

      s4o.print(INLINE_RESULT_TEMP_VAR);

   128

      s4o.print(";\n");

   129

   130

	  PARAM_LIST_ITERATOR() {

   131

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

   132

		     PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   133

		    PARAM_VALUE != NULL) {

   134

		  s4o.print(s4o.indent_spaces);

   135

		  PARAM_TYPE->accept(*this);

   136

          s4o.print(" ");

   137

          s4o.print(TEMP_VAR);

   138

          PARAM_NAME->accept(*this);

   139

          s4o.print(" = ");

   140

          print_check_function(PARAM_TYPE, PARAM_VALUE);

   141

          s4o.print(";\n");

   142

		}

   143

	  }

   144

   145

	  s4o.print(s4o.indent_spaces + INLINE_RESULT_TEMP_VAR),

   146

			  s4o.print(" = ");

   147

	  function_name->accept(*this);

   148

	  if (function_type_suffix)

   149

        function_type_suffix->accept(*this);

   150

	  s4o.print("(");

   151

	  s4o.indent_right();

   152

   153

	  PARAM_LIST_ITERATOR() {

   154

		if (pt != param_list.begin())

   155

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

   156

		if (PARAM_DIRECTION == function_param_iterator_c::direction_in)

   157

		  PARAM_NAME->accept(*this);

   158

		else if (PARAM_VALUE != NULL){

   159

          s4o.print("&");

   160

          s4o.print(TEMP_VAR);

   161

          PARAM_NAME->accept(*this);

   162

        }

   163

		else {

   164

		  s4o.print("NULL");

   165

		}

   166

	  }

   167

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

   168

	  s4o.indent_left();

   169

   170

	  PARAM_LIST_ITERATOR() {

   171

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

   172

        	 PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   173

        	PARAM_VALUE != NULL) {

   174

   175

          s4o.print(s4o.indent_spaces);

   176

          print_setter(PARAM_VALUE, PARAM_TYPE, PARAM_NAME);

   177

          s4o.print(";\n");

   178

		}

   179

	  }

   180

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

   181

	  s4o.print(INLINE_RESULT_TEMP_VAR);

   182

	  s4o.print(";\n");

   183

   184

      s4o.indent_left();

   185

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

   186

    }

   187

   188

  private:

   189

   190

    void *print_getter(symbol_c *symbol) {

   191

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

   192

      if (vartype == search_var_instance_decl_c::external_vt)

   193

    	s4o.print(GET_EXTERNAL);

   194

      else if (vartype == search_var_instance_decl_c::located_vt)

   195

    	s4o.print(GET_LOCATED);

   196

      else

   197

    	s4o.print(GET_VAR);

   198

      s4o.print("(");

   199

   200

      wanted_variablegeneration = complextype_base_vg;

   201

      symbol->accept(*this);

   202

      if (search_varfb_instance_type->type_is_complex())

   203

    	s4o.print(",");

   204

      wanted_variablegeneration = complextype_suffix_vg;

   205

      symbol->accept(*this);

   206

      s4o.print(")");

   207

      wanted_variablegeneration = expression_vg;

   208

      return NULL;

   209

    }

   210

   211

    void *print_setter(symbol_c* symbol,

   212

    		symbol_c* type,

   213

    		symbol_c* value) {

   214

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

   215

      if (vartype == search_var_instance_decl_c::external_vt) {

   216

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

   217

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

   218

        if (variable != NULL) {

   219

          s4o.print(SET_EXTERNAL);

   220

          s4o.print("(");

   221

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

   222

          s4o.print(",");

   223

        }

   224

        else {

   225

          s4o.print(SET_COMPLEX_EXTERNAL);

   226

          s4o.print("(");

   227

        }

   228

      }

   229

      else {

   230

        if (vartype == search_var_instance_decl_c::located_vt)

   231

          s4o.print(SET_LOCATED);

   232

        else

   233

          s4o.print(SET_VAR);

   234

        s4o.print("(");

   235

      }

   236

   237

      wanted_variablegeneration = complextype_base_vg;

   238

      symbol->accept(*this);

   239

      s4o.print(",");

   240

      wanted_variablegeneration = expression_vg;

   241

      print_check_function(type, value, NULL, true);

   242

      if (search_varfb_instance_type->type_is_complex()) {

   243

        s4o.print(",");

   244

        wanted_variablegeneration = complextype_suffix_vg;

   245

        symbol->accept(*this);

   246

      }

   247

      s4o.print(")");

   248

      wanted_variablegeneration = expression_vg;

   249

      return NULL;

   250

    }

   251

   252

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

   253

    /* B 1.4 - Variables */

   254

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

   255

    void *visit(symbolic_variable_c *symbol) {

   256

      unsigned int vartype;

   257

      if (wanted_variablegeneration == complextype_base_vg)

   258

        generate_c_base_c::visit(symbol);

   259

      else if (wanted_variablegeneration == complextype_suffix_vg)

   260

        return NULL;

   261

      else

   262

        print_getter(symbol);

   263

      return NULL;

   264

    }

   265

   266

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

   267

    /* B.1.4.1   Directly Represented Variables */

   268

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

   269

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

   270

    void *visit(direct_variable_c *symbol) {

   271

      TRACE("direct_variable_c");

   272

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

   273

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

   274

      s4o.print(GET_LOCATED);

   275

      s4o.print("(");

   276

      this->print_variable_prefix();

   277

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

   278

      s4o.print(")");

   279

      return NULL;

   280

    }

   281

   282

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

   283

    /* B.1.4.2   Multi-element Variables */

   284

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

   285

   286

    // SYM_REF2(structured_variable_c, record_variable, field_selector)

   287

    void *visit(structured_variable_c *symbol) {

   288

      TRACE("structured_variable_c");

   289

      switch (wanted_variablegeneration) {

   290

        case complextype_base_vg:

   291

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

   292

          break;

   293

        case complextype_suffix_vg:

   294

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

   295

          s4o.print(".");

   296

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

   297

          break;

   298

        default:

   299

          print_getter(symbol);

   300

          break;

   301

      }

   302

      return NULL;

   303

    }

   304

   305

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

   306

    //SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   307

    void *visit(array_variable_c *symbol) {

   308

      switch (wanted_variablegeneration) {

   309

        case complextype_base_vg:

   310

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

   311

          break;

   312

        case complextype_suffix_vg:

   313

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

   314

   315

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

   316

          if (current_array_type == NULL) ERROR;

   317

   318

          s4o.print(".table");

   319

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

   320

   321

          current_array_type = NULL;

   322

          break;

   323

        default:

   324

          print_getter(symbol);

   325

          break;

   326

      }

   327

      return NULL;

   328

    }

   329

   330

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

   331

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

   332

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

   333

   334

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

   335

    /* B 2.1 Instructions and Operands */

   336

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

   337

   338

    void *visit(il_function_call_c *symbol) {

   339

      symbol_c* function_type_prefix = NULL;

   340

      symbol_c* function_name = NULL;

   341

      symbol_c* function_type_suffix = NULL;

   342

      DECLARE_PARAM_LIST()

   343

   344

      symbol_c *param_data_type = default_variable_name.current_type;

   345

   346

      function_call_param_iterator_c function_call_param_iterator(symbol);

   347

   348

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

   349

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

   350

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

   351

        if (current_function_type == function_none) ERROR;

   352

   353

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

   354

   355

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

   356

        /* Add the value from EN param */

   357

        ADD_PARAM_LIST(en_param_name,

   358

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

   359

                       (symbol_c*)(new bool_type_name_c()),

   360

                       function_param_iterator_c::direction_in)

   361

   362

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

   363

        /* Add the value from ENO param */

   364

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

   365

   366

        int nb_param = 1;

   367

        if (symbol->il_operand_list != NULL)

   368

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

   369

   370

        #include "il_code_gen.c"

   371

   372

      }

   373

	  else {

   374

		function_name = symbol->function_name;

   375

   376

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

   377

		search_base_type_c search_base_type;

   378

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

   379

   380

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

   381

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

   382

		 */

   383

   384

		function_param_iterator_c fp_iterator(f_decl);

   385

		identifier_c *param_name;

   386

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

   387

		  symbol_c *param_type = fp_iterator.param_type();

   388

		  if (param_type == NULL) ERROR;

   389

   390

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

   391

   392

		  symbol_c *param_value = NULL;

   393

   394

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

   395

		   * get the value off the IL default variable!

   396

		   */

   397

		  if (1 == i)

   398

		    param_value = &this->default_variable_name;

   399

   400

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

   401

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

   402

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

   403

		   * it will always return NULL.

   404

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

   405

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

   406

		   * the following line...

   407

		   */

   408

		  if (param_value == NULL)

   409

			param_value = function_call_param_iterator.search_f(param_name);

   410

   411

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

   412

          if (param_value == NULL) {

   413

            param_value = function_call_param_iterator.next_nf();

   414

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

   415

          }

   416

   417

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

   418

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

   419

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

   420

			param_value = fp_iterator.default_value();

   421

		  }

   422

   423

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

   424

		} /* for(...) */

   425

	  }

   426

   427

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

   428

      if (NULL == function_type_prefix) ERROR;

   429

   430

      bool has_output_params = false;

   431

   432

      PARAM_LIST_ITERATOR() {

   433

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

   434

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   435

             PARAM_VALUE != NULL) {

   436

          has_output_params = true;

   437

        }

   438

      }

   439

   440

      if (has_output_params)

   441

        generate_inline(function_name, function_type_prefix, function_type_suffix, param_list);

   442

   443

      CLEAR_PARAM_LIST()

   444

   445

      return NULL;

   446

    }

   447

   448

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

   449

    // SYM_REF2(il_formal_funct_call_c, function_name, il_param_list)

   450

    void *visit(il_formal_funct_call_c *symbol) {

   451

      symbol_c* function_type_prefix = NULL;

   452

      symbol_c* function_name = NULL;

   453

      symbol_c* function_type_suffix = NULL;

   454

      DECLARE_PARAM_LIST()

   455

   456

      function_call_param_iterator_c function_call_param_iterator(symbol);

   457

   458

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

   459

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

   460

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

   461

        if (current_function_type == function_none) ERROR;

   462

   463

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

   464

   465

        int nb_param = 0;

   466

        if (symbol->il_param_list != NULL)

   467

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

   468

   469

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

   470

        /* Get the value from EN param */

   471

        symbol_c *EN_param_value = function_call_param_iterator.search_f(en_param_name);

   472

        if (EN_param_value == NULL)

   473

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

   474

        else

   475

          nb_param --;

   476

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

   477

   478

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

   479

        /* Get the value from ENO param */

   480

        symbol_c *ENO_param_value = function_call_param_iterator.search_f(eno_param_name);

   481

        if (ENO_param_value != NULL)

   482

          nb_param --;

   483

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

   484

   485

        #include "st_code_gen.c"

   486

   487

      }

   488

      else {

   489

        function_name = symbol->function_name;

   490

   491

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

   492

		search_base_type_c search_base_type;

   493

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

   494

   495

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

   496

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

   497

		 */

   498

   499

		function_param_iterator_c fp_iterator(f_decl);

   500

		identifier_c *param_name;

   501

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

   502

		  symbol_c *param_type = fp_iterator.param_type();

   503

		  if (param_type == NULL) ERROR;

   504

   505

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

   506