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

    97

      }

    98

    99

      s4o.print(s4o.indent_spaces);

   100

      s4o.print("inline ");

   101

      function_type_prefix->accept(*this);

   102

      s4o.print(" __");

   103

      fbname->accept(*this);

   104

      s4o.print("_");

   105

      function_name->accept(*this);

   109

      s4o.print_integer(fcall_number);

   110

      s4o.print("(");

   111

      s4o.indent_right();

   112

   113

      PARAM_LIST_ITERATOR() {

   114

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in) {

   116

          s4o.print(" ");

   117

          PARAM_NAME->accept(*this);

   118

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

   119

        }

   120

      }

   121

      fbname->accept(*this);

   122

	  s4o.print(" *");

   123

	  s4o.print(FB_FUNCTION_PARAM);

   124

	  s4o.indent_left();

   125

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

   126

	  s4o.print("{\n");

   127

      s4o.indent_right();

   128

   129

      s4o.print(s4o.indent_spaces);

   130

      function_type_prefix->accept(*this);

   131

      s4o.print(" "),

   132

      s4o.print(INLINE_RESULT_TEMP_VAR);

   133

      s4o.print(";\n");

   134

   135

	  PARAM_LIST_ITERATOR() {

   136

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

   137

		     PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   138

		    PARAM_VALUE != NULL) {

   139

		  s4o.print(s4o.indent_spaces);

   140

		  PARAM_TYPE->accept(*this);

   141

          s4o.print(" ");

   142

          s4o.print(TEMP_VAR);

   143

          PARAM_NAME->accept(*this);

   144

          s4o.print(" = ");

   145

          print_check_function(PARAM_TYPE, PARAM_VALUE);

   146

          s4o.print(";\n");

   147

		}

   148

	  }

   149

   150

	  s4o.print(s4o.indent_spaces + INLINE_RESULT_TEMP_VAR),

   151

			  s4o.print(" = ");

   152

	  function_name->accept(*this);

   153

	  if (function_type_suffix)

   154

        function_type_suffix->accept(*this);

   155

	  s4o.print("(");

   156

	  s4o.indent_right();

   157

   158

	  PARAM_LIST_ITERATOR() {

   159

		if (pt != param_list.begin())

   160

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

   161

		if (PARAM_DIRECTION == function_param_iterator_c::direction_in)

   162

		  PARAM_NAME->accept(*this);

   163

		else if (PARAM_VALUE != NULL){

   164

          s4o.print("&");

   165

          s4o.print(TEMP_VAR);

   166

          PARAM_NAME->accept(*this);

   167

        }

   168

		else {

   169

		  s4o.print("NULL");

   170

		}

   171

	  }

   172

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

   173

	  s4o.indent_left();

   174

   175

	  PARAM_LIST_ITERATOR() {

   176

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

   177

        	 PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   178

        	PARAM_VALUE != NULL) {

   179

   180

          s4o.print(s4o.indent_spaces);

   181

          print_setter(PARAM_VALUE, PARAM_TYPE, PARAM_NAME);

   182

          s4o.print(";\n");

   183

		}

   184

	  }

   185

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

   186

	  s4o.print(INLINE_RESULT_TEMP_VAR);

   187

	  s4o.print(";\n");

   188

   189

      s4o.indent_left();

   190

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

   191

    }

   192

   193

  private:

   194

   195

    void *print_getter(symbol_c *symbol) {

   196

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

   197

      if (vartype == search_var_instance_decl_c::external_vt)

   198

    	s4o.print(GET_EXTERNAL);

   199

      else if (vartype == search_var_instance_decl_c::located_vt)

   200

    	s4o.print(GET_LOCATED);

   201

      else

   202

    	s4o.print(GET_VAR);

   203

      s4o.print("(");

   204

   205

      wanted_variablegeneration = complextype_base_vg;

   206

      symbol->accept(*this);

   207

      if (search_varfb_instance_type->type_is_complex())

   208

    	s4o.print(",");

   209

      wanted_variablegeneration = complextype_suffix_vg;

   210

      symbol->accept(*this);

   211

      s4o.print(")");

   212

      wanted_variablegeneration = expression_vg;

   213

      return NULL;

   214

    }

   215

   216

    void *print_setter(symbol_c* symbol,

   217

    		symbol_c* type,

   218

    		symbol_c* value) {

   219

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

   220

      if (vartype == search_var_instance_decl_c::external_vt) {

   221

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

   222

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

   223

        if (variable != NULL) {

   224

          s4o.print(SET_EXTERNAL);

   225

          s4o.print("(");

   226

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

   227

          s4o.print(",");

   228

        }

   229

        else {

   230

          s4o.print(SET_COMPLEX_EXTERNAL);

   231

          s4o.print("(");

   232

        }

   233

      }

   234

      else {

   235

        if (vartype == search_var_instance_decl_c::located_vt)

   236

          s4o.print(SET_LOCATED);

   237

        else

   238

          s4o.print(SET_VAR);

   239

        s4o.print("(");

   240

      }

   241

   242

      wanted_variablegeneration = complextype_base_vg;

   243

      symbol->accept(*this);

   244

      s4o.print(",");

   245

      wanted_variablegeneration = expression_vg;

   246

      print_check_function(type, value, NULL, true);

   247

      if (search_varfb_instance_type->type_is_complex()) {

   248

        s4o.print(",");

   249

        wanted_variablegeneration = complextype_suffix_vg;

   250

        symbol->accept(*this);

   251

      }

   252

      s4o.print(")");

   253

      wanted_variablegeneration = expression_vg;

   254

      return NULL;

   255

    }

   256

   257

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

   258

    /* B 1.4 - Variables */

   259

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

   260

    void *visit(symbolic_variable_c *symbol) {

   261

      unsigned int vartype;

   262

      if (wanted_variablegeneration == complextype_base_vg)

   263

        generate_c_base_c::visit(symbol);

   264

      else if (wanted_variablegeneration == complextype_suffix_vg)

   265

        return NULL;

   266

      else

   267

        print_getter(symbol);

   268

      return NULL;

   269

    }

   270

   271

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

   272

    /* B.1.4.1   Directly Represented Variables */

   273

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

   274

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

   275

    void *visit(direct_variable_c *symbol) {

   276

      TRACE("direct_variable_c");

   277

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

   278

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

   279

      s4o.print(GET_LOCATED);

   280

      s4o.print("(");

   281

      this->print_variable_prefix();

   282

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

   283

      s4o.print(")");

   284

      return NULL;

   285

    }

   286

   287

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

   288

    /* B.1.4.2   Multi-element Variables */

   289

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

   290

   291

    // SYM_REF2(structured_variable_c, record_variable, field_selector)

   292

    void *visit(structured_variable_c *symbol) {

   293

      TRACE("structured_variable_c");

   294

      switch (wanted_variablegeneration) {

   295

        case complextype_base_vg:

   296

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

   297

          break;

   298

        case complextype_suffix_vg:

   299

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

   300

          s4o.print(".");

   301

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

   302

          break;

   303

        default:

   304

          print_getter(symbol);

   305

          break;

   306

      }

   307

      return NULL;

   308

    }

   309

   310

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

   311

    //SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   312

    void *visit(array_variable_c *symbol) {

   313

      switch (wanted_variablegeneration) {

   314

        case complextype_base_vg:

   315

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

   316

          break;

   317

        case complextype_suffix_vg:

   318

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

   319

   320

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

   321

          if (current_array_type == NULL) ERROR;

   322

   323

          s4o.print(".table");

   324

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

   325

   326

          current_array_type = NULL;

   327

          break;

   328

        default:

   329

          print_getter(symbol);

   330

          break;

   331

      }

   332

      return NULL;

   333

    }

   334

   335

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

   336

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

   337

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

   338

   339

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

   340

    /* B 2.1 Instructions and Operands */

   341

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

   342

   343

    void *visit(il_function_call_c *symbol) {

   344

      symbol_c* function_type_prefix = NULL;

   345

      symbol_c* function_name = NULL;

   346

      symbol_c* function_type_suffix = NULL;

   347

      DECLARE_PARAM_LIST()

   348

   349

      symbol_c *param_data_type = default_variable_name.current_type;

   350

   351

      function_call_param_iterator_c function_call_param_iterator(symbol);

   352

   353

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

   354

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

   355

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

   356

        if (current_function_type == function_none) ERROR;

   357

   358

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

   359

   360

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

   361

        /* Add the value from EN param */

   362

        ADD_PARAM_LIST(en_param_name,

   363

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

   364

                       (symbol_c*)(new bool_type_name_c()),

   365

                       function_param_iterator_c::direction_in)

   366

   367

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

   368

        /* Add the value from ENO param */

   369

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

   370

   371

        int nb_param = 1;

   372

        if (symbol->il_operand_list != NULL)

   373

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

   374

   375

        #include "il_code_gen.c"

   376

   377

      }

   378

	  else {

   379

		function_name = symbol->function_name;

   380

   381

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

   382

		search_base_type_c search_base_type;

   383

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

   384

   385

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

   386

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

   387

		 */

   388

   389

		function_param_iterator_c fp_iterator(f_decl);

   390

		identifier_c *param_name;

   391

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

   392

		  symbol_c *param_type = fp_iterator.param_type();

   393

		  if (param_type == NULL) ERROR;

   394

   395

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

   396

   397

		  symbol_c *param_value = NULL;

   398

   399

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

   400

		   * get the value off the IL default variable!

   401

		   */

   402

		  if (1 == i)

   403

		    param_value = &this->default_variable_name;

   404

   405

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

   406

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

   407

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

   408

		   * it will always return NULL.

   409

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

   410

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

   411

		   * the following line...

   412

		   */

   413

		  if (param_value == NULL)

   414

			param_value = function_call_param_iterator.search_f(param_name);

   415

   416

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

   417

          if (param_value == NULL) {

   418

            param_value = function_call_param_iterator.next_nf();

   419

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

   420

          }

   421

   422

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

   423

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

   424

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

   425

			param_value = fp_iterator.default_value();

   426

		  }

   427

   428

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

   429

		} /* for(...) */

   430

	  }

   431

   432

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

   433

      if (NULL == function_type_prefix) ERROR;

   434

   435

      bool has_output_params = false;

   436

   437

      PARAM_LIST_ITERATOR() {

   438

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

   439

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   440

             PARAM_VALUE != NULL) {

   441

          has_output_params = true;

   442

        }

   443

      }

   444

   445

      if (has_output_params)

   446

        generate_inline(function_name, function_type_prefix, function_type_suffix, param_list);

   447

   448

      CLEAR_PARAM_LIST()

   449

   450

      return NULL;

   451

    }

   452

   453

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

   454

    // SYM_REF2(il_formal_funct_call_c, function_name, il_param_list)

   455

    void *visit(il_formal_funct_call_c *symbol) {

   456

      symbol_c* function_type_prefix = NULL;

   457

      symbol_c* function_name = NULL;

   458

      symbol_c* function_type_suffix = NULL;

   459

      DECLARE_PARAM_LIST()

   460

   461

      function_call_param_iterator_c function_call_param_iterator(symbol);

   462

   463

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

   464

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

   465

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

   466

        if (current_function_type == function_none) ERROR;

   467

   468

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

   469

   470

        int nb_param = 0;

   471

        if (symbol->il_param_list != NULL)

   472

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

   473

   474

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

   475

        /* Get the value from EN param */

   476

        symbol_c *EN_param_value = function_call_param_iterator.search_f(en_param_name);

   477

        if (EN_param_value == NULL)

   478

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

   479

        else

   480

          nb_param --;

   481

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

   482

   483

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

   484

        /* Get the value from ENO param */

   485

        symbol_c *ENO_param_value = function_call_param_iterator.search_f(eno_param_name);

   486

        if (ENO_param_value != NULL)

   487

          nb_param --;

   488

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

   489

   490

        #include "st_code_gen.c"

   491

   492

      }

   493

      else {

   494

        function_name = symbol->function_name;

   495

   496

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

   497

		search_base_type_c search_base_type;

   498

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

   499

   500

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

   501

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

   502

		 */

   503

   504

		function_param_iterator_c fp_iterator(f_decl);

   505

		identifier_c *param_name;