1

/*

     2

 *  matiec - a compiler for the programming languages defined in IEC 61131-3

     3

 *

     4

 *  Copyright (C) 2003-2012  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

	 /* The result of the comparison IL operations (GT, EQ, LT, ...)

    41

	 * is a boolean variable.

    42

	 * This class keeps track of the current data type stored in the

    43

	 * il default variable. This is usually done by keeping a reference

    44

	 * to the data type of the last operand. Nevertheless, in the case of

    45

	 * the comparison IL operators, the data type of the result (a boolean)

    46

	 * is not the data type of the operand. We therefore need an object

    47

	 * of the boolean data type to keep as a reference of the current

    48

	 * data type.

    49

	 * The following object is it...

    50

	 */

    51

	bool_type_name_c bool_type;

    52

	lint_type_name_c lint_type;

    53

	lword_type_name_c lword_type;

    54

	lreal_type_name_c lreal_type;

    55

    56

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

    57

	#define IL_DEFVAR   VAR_LEADER "IL_DEFVAR"

    58

    59

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

    60

	 * parenthesised instruction list to the immediately preceding

    61

	 * scope ...

    62

	 */

    63

    #define IL_DEFVAR_BACK   VAR_LEADER "IL_DEFVAR_BACK"

    64

    il_default_variable_c implicit_variable_current;

    65

    66

    symbol_c* current_array_type;

    67

    68

    int fcall_number;

    69

    bool generating_inlinefunction;

    70

    symbol_c *fbname;

    71

    72

    search_varfb_instance_type_c *search_varfb_instance_type;

    73

    search_var_instance_decl_c   *search_var_instance_decl;

    74

    75

    search_base_type_c search_base_type;

    76

    77

    variablegeneration_t wanted_variablegeneration;

    78

    79

  public:

    80

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

    81

    : generate_c_typedecl_c(s4o_ptr),

    82

      implicit_variable_current(IL_DEFVAR, NULL)

    83

    {

    84

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

    85

      search_var_instance_decl   = new search_var_instance_decl_c  (scope);

    86

    87

      this->set_variable_prefix(variable_prefix);

    88

      fcall_number = 0;

    89

      fbname = name;

    90

      wanted_variablegeneration = expression_vg;

    91

      generating_inlinefunction = false;

    92

    }

    93

    94

    virtual ~generate_c_inlinefcall_c(void) {

    95

      delete search_varfb_instance_type;

    96

      delete search_var_instance_decl;

    97

    }

    98

    99

    void print(symbol_c* symbol) {

   100

      function_call_iterator_c fc_iterator(symbol);

   101

      symbol_c* function_call;

   102

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

   103

    	function_call->accept(*this);

   104

      }

   105

    }

   106

   107

   108

   109

    void generate_inline(symbol_c *function_name,

   110

            symbol_c *function_type_prefix,

   111

            symbol_c *function_type_suffix,

   112

            std::list<FUNCTION_PARAM*> param_list,

   113

            function_declaration_c *f_decl = NULL) {

   114

   115

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

   116

      generating_inlinefunction = true;

   117

   118

      fcall_number++;

   119

      function_type_prefix = default_literal_type(function_type_prefix);

   120

      if (function_type_suffix) {

   121

        function_type_suffix = default_literal_type(function_type_suffix);

   122

      }

   123

   124

      s4o.print(s4o.indent_spaces);

   125

      s4o.print("inline ");

   126

      function_type_prefix->accept(*this);

   127

      s4o.print(" __");

   128

      fbname->accept(*this);

   129

      s4o.print("_");

   130

      function_name->accept(*this);

   131

      if (f_decl != NULL) {

   132

        /* function being called is overloaded! */

   133

        s4o.print("__");

   134

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   135

        f_decl->accept(overloaded_func_suf);

   136

      }	

   137

      if (function_type_suffix) {

   138

        function_type_suffix->accept(*this);

   139

      }

   140

      s4o.print(fcall_number);

   141

      s4o.print("(");

   142

      s4o.indent_right();

   143

   144

      PARAM_LIST_ITERATOR() {

   145

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in) {

   146

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

   147

          s4o.print(" ");

   148

          PARAM_NAME->accept(*this);

   149

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

   150

        }

   151

      }

   152

      fbname->accept(*this);

   153

      s4o.print(" *");

   154

      s4o.print(FB_FUNCTION_PARAM);

   155

      s4o.indent_left();

   156

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

   157

      s4o.print("{\n");

   158

      s4o.indent_right();

   159

   160

      s4o.print(s4o.indent_spaces);

   161

      function_type_prefix->accept(*this);

   162

      s4o.print(" "),

   163

      s4o.print(INLINE_RESULT_TEMP_VAR);

   164

      s4o.print(";\n");

   165

   166

      PARAM_LIST_ITERATOR() {

   167

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

   168

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   169

             PARAM_VALUE != NULL) {

   170

          s4o.print(s4o.indent_spaces);

   171

          PARAM_TYPE->accept(*this);

   172

          s4o.print(" ");

   173

          s4o.print(TEMP_VAR);

   174

          PARAM_NAME->accept(*this);

   175

          s4o.print(" = ");

   176

          print_check_function(PARAM_TYPE, PARAM_VALUE);

   177

          s4o.print(";\n");

   178

          }

   179

        }

   180

   181

      s4o.print(s4o.indent_spaces + INLINE_RESULT_TEMP_VAR),

   182

      s4o.print(" = ");

   183

      function_name->accept(*this);

   184

      if (f_decl != NULL) {

   185

    	/* function being called is overloaded! */

   186

    	s4o.print("__");

   187

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   188

        f_decl->accept(overloaded_func_suf);

   189

      }

   190

   191

      if (function_type_suffix)

   192

        function_type_suffix->accept(*this);

   193

      s4o.print("(");

   194

      s4o.indent_right();

   195

   196

      PARAM_LIST_ITERATOR() {

   197

        if (pt != param_list.begin())

   198

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

   199

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in)

   200

          PARAM_NAME->accept(*this);

   201

        else if (PARAM_VALUE != NULL){

   202

          s4o.print("&");

   203

          s4o.print(TEMP_VAR);

   204

          PARAM_NAME->accept(*this);

   205

        } else {

   206

          s4o.print("NULL");

   207

         }

   208

      }

   209

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

   210

      s4o.indent_left();

   211

   212

      PARAM_LIST_ITERATOR() {

   213

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

   214

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   215

             PARAM_VALUE != NULL) {

   216

          s4o.print(s4o.indent_spaces);

   217

          print_setter(PARAM_VALUE, PARAM_TYPE, PARAM_NAME);

   218

          s4o.print(";\n");

   219

        }

   220

      }

   221

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

   222

      s4o.print(INLINE_RESULT_TEMP_VAR);

   223

      s4o.print(";\n");

   224

   225

      s4o.indent_left();

   226

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

   227

   228

      generating_inlinefunction = false;

   229

    }

   230

   231

  private:

   232

    /* a small helper function */

   233

    symbol_c *default_literal_type(symbol_c *symbol) {

   234

      if (get_datatype_info_c::is_ANY_INT_literal(symbol)) {

   236

      }

   237

      else if (get_datatype_info_c::is_ANY_REAL_literal(symbol)) {

   239

      }

   240

      return symbol;

   241

    }

   242

   243

   244

   245

    void *print_getter(symbol_c *symbol) {

   246

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

   247

      if (vartype == search_var_instance_decl_c::external_vt)

   248

        s4o.print(GET_EXTERNAL);

   249

      else if (vartype == search_var_instance_decl_c::located_vt)

   250

        s4o.print(GET_LOCATED);

   251

      else

   252

        s4o.print(GET_VAR);

   253

      s4o.print("(");

   254

   255

      wanted_variablegeneration = complextype_base_vg;

   256

      symbol->accept(*this);

   257

      if (search_var_instance_decl->type_is_complex(symbol))

   258

        s4o.print(",");

   259

      wanted_variablegeneration = complextype_suffix_vg;

   260

      symbol->accept(*this);

   261

      s4o.print(")");

   262

      wanted_variablegeneration = expression_vg;

   263

      return NULL;

   264

    }

   265

   266

    void *print_setter(symbol_c* symbol,

   267

                       symbol_c* type,

   268

                       symbol_c* value) {

   269

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

   270

      if (vartype == search_var_instance_decl_c::external_vt)

   271

        s4o.print(SET_EXTERNAL);

   272

      else if (vartype == search_var_instance_decl_c::located_vt)

   273

        s4o.print(SET_LOCATED);

   274

      else

   275

        s4o.print(SET_VAR);

   276

      s4o.print("(,");

   277

   278

      wanted_variablegeneration = complextype_base_vg;

   279

      symbol->accept(*this);

   280

      s4o.print(",");

   281

      wanted_variablegeneration = expression_vg;

   282

      print_check_function(type, value, NULL, true);

   283

      if (search_var_instance_decl->type_is_complex(symbol)) {

   284

        s4o.print(",");

   285

        wanted_variablegeneration = complextype_suffix_vg;

   286

        symbol->accept(*this);

   287

      }

   288

      s4o.print(")");

   289

      wanted_variablegeneration = expression_vg;

   290

      return NULL;

   291

    }

   292

   293

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

   294

    /* B 1.4 - Variables */

   295

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

   296

    void *visit(symbolic_variable_c *symbol) {

   297

      unsigned int vartype;

   298

      if (generating_inlinefunction) {

   299

        if (wanted_variablegeneration == complextype_base_vg)

   300

          generate_c_base_c::visit(symbol);

   301

        else if (wanted_variablegeneration == complextype_suffix_vg)

   302

          return NULL;

   303

        else

   304

          print_getter(symbol);

   305

      }

   306

      return NULL;

   307

    }

   308

   309

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

   310

    /* B.1.4.1   Directly Represented Variables */

   311

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

   312

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

   313

    void *visit(direct_variable_c *symbol) {

   314

      TRACE("direct_variable_c");

   315

      if (generating_inlinefunction) {

   316

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

   317

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

   318

        s4o.print(GET_LOCATED);

   319

        s4o.print("(");

   320

        this->print_variable_prefix();

   321

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

   322

        s4o.print(")");

   323

      }

   324

      return NULL;

   325

    }

   326

   327

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

   328

    /* B.1.4.2   Multi-element Variables */

   329

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

   330

   331

    // SYM_REF2(structured_variable_c, record_variable, field_selector)

   332

    void *visit(structured_variable_c *symbol) {

   333

      TRACE("structured_variable_c");

   334

      bool type_is_complex = search_var_instance_decl->type_is_complex(symbol->record_variable);

   335

      if (generating_inlinefunction) {

   336

        switch (wanted_variablegeneration) {

   337

          case complextype_base_vg:

   338

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

   339

            if (!type_is_complex) {

   340

          	  s4o.print(".");

   341

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

   342

            }

   343

            break;

   344

          case complextype_suffix_vg:

   345

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

   346

            if (type_is_complex) {

   347

              s4o.print(".");

   348

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

   349

            }

   350

            break;

   351

          default:

   352

            print_getter(symbol);

   353

            break;

   354

        }

   355

      }

   356

      return NULL;

   357

    }

   358

   359

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

   360

    //SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   361

    void *visit(array_variable_c *symbol) {

   362

      if (generating_inlinefunction) {

   363

        switch (wanted_variablegeneration) {

   364

          case complextype_base_vg:

   365

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

   366

            break;

   367

          case complextype_suffix_vg:

   368

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

   369

   370

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

   371

            if (current_array_type == NULL) ERROR;

   372

   373

            s4o.print(".table");

   374

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

   375

   376

            current_array_type = NULL;

   377

            break;

   378

          default:

   379

            print_getter(symbol);

   380

            break;

   381

        }

   382

      }

   383

      return NULL;

   384

    }

   385

   386

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

   387

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

   388

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

   389

   390

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

   391

    /* B 2.1 Instructions and Operands */

   392

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

   393

   394

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

   395

    // SYM_REF2(il_instruction_c, label, il_instruction)

   396

    void *visit(il_instruction_c *symbol) {

   397

      /* all previous IL instructions should have the same datatype (checked in stage3), so we get the datatype from the first previous IL instruction we find */

   398

      implicit_variable_current.datatype = (symbol->prev_il_instruction.empty())? NULL : symbol->prev_il_instruction[0]->datatype;

   399

      if (NULL != symbol->il_instruction)  symbol->il_instruction->accept(*this); 

   400

      implicit_variable_current.datatype = NULL;

   401

      return NULL;

   402

    }

   403

   404

   405

    /* | il_simple_operator [il_operand] */

   406

    //SYM_REF2(il_simple_operation_c, il_simple_operator, il_operand)

   407

    void *visit(il_simple_operation_c *symbol) {

   408

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

   409

      return NULL;

   410

    }

   411

   412

   413

    void *visit(il_function_call_c *symbol) {

   414

      symbol_c* function_type_prefix = NULL;

   415

      symbol_c* function_name = NULL;     

   416

      symbol_c* function_type_suffix = NULL;

   417

      DECLARE_PARAM_LIST()

   418

   419

      function_call_param_iterator_c function_call_param_iterator(symbol);

   420

   421

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

   422

      if (f_decl == NULL) ERROR;

   423

   424

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

   425

      search_base_type_c search_base_type;

   426

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

   427

   428

      function_name = symbol->function_name;      

   429

   430

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

   431

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

   432

       */

   433

   434

      function_param_iterator_c fp_iterator(f_decl);

   435

      identifier_c *param_name;

   436

        /* flag to remember whether we have already used the value stored in the default variable to pass to the first parameter */

   437

      bool used_defvar = false;       

   438

        /* flag to cirreclty handle calls to extensible standard functions (i.e. functions with variable number of input parameters) */

   439

      bool found_first_extensible_parameter = false;  

   440

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

   441

        if (fp_iterator.is_extensible_param() && (!found_first_extensible_parameter)) {

   442

          /* We are calling an extensible function. Before passing the extensible

   443

           * parameters, we must add a dummy paramater value to tell the called

   444

           * function how many extensible parameters we will be passing.

   445

           *

   446

           * Note that stage 3 has already determined the number of extensible

   447

           * paramters, and stored that info in the abstract syntax tree. We simply

   448

           * re-use that value.

   449

           */

   450

          /* NOTE: we are not freeing the malloc'd memory. This is not really a bug.

   451

           *       Since we are writing a compiler, which runs to termination quickly,

   452

           *       we can consider this as just memory required for the compilation process

   453

           *       that will be free'd when the program terminates.

   454

           */

   455

          char *tmp = (char *)malloc(32); /* enough space for a call with 10^31 (larger than 2^64) input parameters! */

   456

          if (tmp == NULL) ERROR;

   457

          int res = snprintf(tmp, 32, "%d", symbol->extensible_param_count);

   458

          if ((res >= 32) || (res < 0)) ERROR;

   459

          identifier_c *param_value = new identifier_c(tmp);

   460

          uint_type_name_c *param_type  = new uint_type_name_c();

   461

          identifier_c *param_name = new identifier_c(INLINE_PARAM_COUNT);

   462

          ADD_PARAM_LIST(param_name, param_value, param_type, function_param_iterator_c::direction_in)

   463

          found_first_extensible_parameter = true;

   464

        }

   465

   466

        symbol_c *param_type = fp_iterator.param_type();

   467

        if (param_type == NULL) ERROR;

   468

   469

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

   470

   471

        symbol_c *param_value = NULL;

   472

   473

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

   474

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

   475

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

   476

         * it will always return NULL.

   477

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

   478

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

   479

         * the following line...

   480

         */

   481

        if (param_value == NULL)

   482

          param_value = function_call_param_iterator.search_f(param_name);

   483

   484

        /* if it is the first parameter in a non-formal function call (which is the

   485

         * case being handled!), semantics specifies that we should

   486

         * get the value off the IL default variable!

   487

         *

   488

         * However, if the parameter is an implicitly defined EN or ENO parameter, we should not

   489

         * use the default variable as a source of data to pass to those parameters!

   490

         */

   491

        if ((param_value == NULL) && (!used_defvar) && !fp_iterator.is_en_eno_param_implicit()) {

   492

	  if (NULL == implicit_variable_current.datatype) ERROR;

   493

          param_value = &this->implicit_variable_current;

   494

          used_defvar = true;