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

    variablegeneration_t wanted_variablegeneration;

    76

    77

  public:

    78

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

    79

    : generate_c_typedecl_c(s4o_ptr),

    80

      implicit_variable_current(IL_DEFVAR, NULL)

    81

    {

    82

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

    83

      search_var_instance_decl   = new search_var_instance_decl_c  (scope);

    84

    85

      this->set_variable_prefix(variable_prefix);

    86

      fcall_number = 0;

    87

      fbname = name;

    88

      wanted_variablegeneration = expression_vg;

    89

      generating_inlinefunction = false;

    90

    }

    91

    92

    virtual ~generate_c_inlinefcall_c(void) {

    93

      delete search_varfb_instance_type;

    94

      delete search_var_instance_decl;

    95

    }

    96

    97

    void print(symbol_c* symbol) {

    98

      function_call_iterator_c fc_iterator(symbol);

    99

      symbol_c* function_call;

   100

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

   101

    	function_call->accept(*this);

   102

      }

   103

    }

   104

   105

   106

   107

    void generate_inline(symbol_c *function_name,

   108

            symbol_c *function_type_prefix,

   109

            symbol_c *function_type_suffix,

   110

            std::list<FUNCTION_PARAM*> param_list,

   111

            function_declaration_c *f_decl = NULL) {

   112

   113

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

   114

      generating_inlinefunction = true;

   115

   116

      fcall_number++;

   117

      function_type_prefix = default_literal_type(function_type_prefix);

   118

      if (function_type_suffix) {

   119

        function_type_suffix = default_literal_type(function_type_suffix);

   120

      }

   121

   122

      s4o.print(s4o.indent_spaces);

   123

      s4o.print("inline ");

   124

      function_type_prefix->accept(*this);

   125

      s4o.print(" __");

   126

      fbname->accept(*this);

   127

      s4o.print("_");

   128

      function_name->accept(*this);

   129

      if (f_decl != NULL) {

   130

        /* function being called is overloaded! */

   131

        s4o.print("__");

   132

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   133

        f_decl->accept(overloaded_func_suf);

   134

      }	

   135

      if (function_type_suffix) {

   136

        function_type_suffix->accept(*this);

   137

      }

   138

      s4o.print(fcall_number);

   139

      s4o.print("(");

   140

      s4o.indent_right();

   141

   142

      PARAM_LIST_ITERATOR() {

   143

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in) {

   144

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

   145

          s4o.print(" ");

   146

          PARAM_NAME->accept(*this);

   147

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

   148

        }

   149

      }

   150

      fbname->accept(*this);

   151

      s4o.print(" *");

   152

      s4o.print(FB_FUNCTION_PARAM);

   153

      s4o.indent_left();

   154

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

   155

      s4o.print("{\n");

   156

      s4o.indent_right();

   157

   158

      s4o.print(s4o.indent_spaces);

   159

      function_type_prefix->accept(*this);

   160

      s4o.print(" "),

   161

      s4o.print(INLINE_RESULT_TEMP_VAR);

   162

      s4o.print(";\n");

   163

   164

      PARAM_LIST_ITERATOR() {

   165

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

   166

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   167

             PARAM_VALUE != NULL) {

   168

          s4o.print(s4o.indent_spaces);

   169

          PARAM_TYPE->accept(*this);

   170

          s4o.print(" ");

   171

          s4o.print(TEMP_VAR);

   172

          PARAM_NAME->accept(*this);

   173

          s4o.print(" = ");

   174

          print_check_function(PARAM_TYPE, PARAM_VALUE);

   175

          s4o.print(";\n");

   176

          }

   177

        }

   178

   179

      s4o.print(s4o.indent_spaces + INLINE_RESULT_TEMP_VAR),

   180

      s4o.print(" = ");

   181

      function_name->accept(*this);

   182

      if (f_decl != NULL) {

   183

    	/* function being called is overloaded! */

   184

    	s4o.print("__");

   185

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   186

        f_decl->accept(overloaded_func_suf);

   187

      }

   188

   189

      if (function_type_suffix)

   190

        function_type_suffix->accept(*this);

   191

      s4o.print("(");

   192

      s4o.indent_right();

   193

   194

      PARAM_LIST_ITERATOR() {

   195

        if (pt != param_list.begin())

   196

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

   197

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in)

   198

          PARAM_NAME->accept(*this);

   199

        else if (PARAM_VALUE != NULL){

   200

          s4o.print("&");

   201

          s4o.print(TEMP_VAR);

   202

          PARAM_NAME->accept(*this);

   203

        } else {

   204

          s4o.print("NULL");

   205

         }

   206

      }

   207

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

   208

      s4o.indent_left();

   209

   210

      PARAM_LIST_ITERATOR() {

   211

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

   212

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   213

             PARAM_VALUE != NULL) {

   214

          s4o.print(s4o.indent_spaces);

   215

          print_setter(PARAM_VALUE, PARAM_TYPE, PARAM_NAME);

   216

          s4o.print(";\n");

   217

        }

   218

      }

   219

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

   220

      s4o.print(INLINE_RESULT_TEMP_VAR);

   221

      s4o.print(";\n");

   222

   223

      s4o.indent_left();

   224

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

   225

   226

      generating_inlinefunction = false;

   227

    }

   228

   229

  private:

   230

    /* a small helper function */

   231

    symbol_c *default_literal_type(symbol_c *symbol) {

   232

      if (get_datatype_info_c::is_ANY_INT_literal(symbol)) {

   233

        return &get_datatype_info_c::lint_type_name;

   234

      }

   235

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

   236

        return &get_datatype_info_c::lreal_type_name;

   237

      }

   238

      return symbol;

   239

    }

   240

   241

   242

   243

    void *print_getter(symbol_c *symbol) {

   244

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

   245

      if (vartype == search_var_instance_decl_c::external_vt)

   246

        s4o.print(GET_EXTERNAL);

   247

      else if (vartype == search_var_instance_decl_c::located_vt)

   248

        s4o.print(GET_LOCATED);

   249

      else

   250

        s4o.print(GET_VAR);

   251

      s4o.print("(");

   252

   253

      wanted_variablegeneration = complextype_base_vg;

   254

      symbol->accept(*this);

   255

      if (search_var_instance_decl->type_is_complex(symbol))

   256

        s4o.print(",");

   257

      wanted_variablegeneration = complextype_suffix_vg;

   258

      symbol->accept(*this);

   259

      s4o.print(")");

   260

      wanted_variablegeneration = expression_vg;

   261

      return NULL;

   262

    }

   263

   264

    void *print_setter(symbol_c* symbol,

   265

                       symbol_c* type,

   266

                       symbol_c* value) {

   267

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

   268

      if (vartype == search_var_instance_decl_c::external_vt)

   269

        s4o.print(SET_EXTERNAL);

   270

      else if (vartype == search_var_instance_decl_c::located_vt)

   271

        s4o.print(SET_LOCATED);

   272

      else

   273

        s4o.print(SET_VAR);

   274

      s4o.print("(,");

   275

   276

      wanted_variablegeneration = complextype_base_vg;

   277

      symbol->accept(*this);

   278

      s4o.print(",");

   279

      wanted_variablegeneration = expression_vg;

   280

      print_check_function(type, value, NULL, true);

   281

      if (search_var_instance_decl->type_is_complex(symbol)) {

   282

        s4o.print(",");

   283

        wanted_variablegeneration = complextype_suffix_vg;

   284

        symbol->accept(*this);

   285

      }

   286

      s4o.print(")");

   287

      wanted_variablegeneration = expression_vg;

   288

      return NULL;

   289

    }

   290

   291

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

   292

    /* B 1.4 - Variables */

   293

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

   294

    void *visit(symbolic_variable_c *symbol) {

   295

      unsigned int vartype;

   296

      if (generating_inlinefunction) {

   297

        if (wanted_variablegeneration == complextype_base_vg)

   298

          generate_c_base_c::visit(symbol);

   299

        else if (wanted_variablegeneration == complextype_suffix_vg)

   300

          return NULL;

   301

        else

   302

          print_getter(symbol);

   303

      }

   304

      return NULL;

   305

    }

   306

   307

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

   308

    /* B.1.4.1   Directly Represented Variables */

   309

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

   310

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

   311

    void *visit(direct_variable_c *symbol) {

   312

      TRACE("direct_variable_c");

   313

      if (generating_inlinefunction) {

   314

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

   315

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

   316

        s4o.print(GET_LOCATED);

   317

        s4o.print("(");

   318

        this->print_variable_prefix();

   319

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

   320

        s4o.print(")");

   321

      }

   322

      return NULL;

   323

    }

   324

   325

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

   326

    /* B.1.4.2   Multi-element Variables */

   327

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

   328

   329

    // SYM_REF2(structured_variable_c, record_variable, field_selector)

   330

    void *visit(structured_variable_c *symbol) {

   331

      TRACE("structured_variable_c");

   332

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

   333

      if (generating_inlinefunction) {

   334

        switch (wanted_variablegeneration) {

   335

          case complextype_base_vg:

   336

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

   337

            if (!type_is_complex) {

   338

          	  s4o.print(".");

   339

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

   340

            }

   341

            break;

   342

          case complextype_suffix_vg:

   343

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

   344

            if (type_is_complex) {

   345

              s4o.print(".");

   346

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

   347

            }

   348

            break;

   349

          default:

   350

            print_getter(symbol);

   351

            break;

   352

        }

   353

      }

   354

      return NULL;

   355

    }

   356

   357

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

   358

    //SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   359

    void *visit(array_variable_c *symbol) {

   360

      if (generating_inlinefunction) {

   361

        switch (wanted_variablegeneration) {

   362

          case complextype_base_vg:

   363

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

   364

            break;

   365

          case complextype_suffix_vg:

   366

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

   367

   368

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

   369

            if (current_array_type == NULL) ERROR;

   370

   371

            s4o.print(".table");

   372

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

   373

   374

            current_array_type = NULL;

   375

            break;

   376

          default:

   377

            print_getter(symbol);

   378

            break;

   379

        }

   380

      }

   381

      return NULL;

   382

    }

   383

   384

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

   385

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

   386

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

   387

   388

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

   389

    /* B 2.1 Instructions and Operands */

   390

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

   391

   392

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

   393

    // SYM_REF2(il_instruction_c, label, il_instruction)

   394

    void *visit(il_instruction_c *symbol) {

   395

      /* 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 */

   396

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

   397

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

   398

      implicit_variable_current.datatype = NULL;

   399

      return NULL;

   400

    }

   401

   402

   403

    /* | il_simple_operator [il_operand] */

   404

    //SYM_REF2(il_simple_operation_c, il_simple_operator, il_operand)

   405

    void *visit(il_simple_operation_c *symbol) {

   406

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

   407

      return NULL;

   408

    }

   409

   410

   411

    void *visit(il_function_call_c *symbol) {

   412

      symbol_c* function_type_prefix = NULL;

   413

      symbol_c* function_name = NULL;     

   414

      symbol_c* function_type_suffix = NULL;

   415

      DECLARE_PARAM_LIST()

   416

   417

      function_call_param_iterator_c function_call_param_iterator(symbol);

   418

   419

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

   420

      if (f_decl == NULL) ERROR;

   421

   422

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

   424

   425

      function_name = symbol->function_name;      

   426

   427

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

   428

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

   429

       */

   430

   431

      function_param_iterator_c fp_iterator(f_decl);

   432

      identifier_c *param_name;

   433

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

   434

      bool used_defvar = false;       

   435

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

   436

      bool found_first_extensible_parameter = false;  

   437

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

   438

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

   439

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

   440

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

   441

           * function how many extensible parameters we will be passing.

   442

           *

   443

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

   444

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

   445

           * re-use that value.

   446

           */

   447

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

   448

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

   449

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

   450

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

   451

           */

   452

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

   453

          if (tmp == NULL) ERROR;

   454

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

   455

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

   456

          identifier_c *param_value = new identifier_c(tmp);

   457

          uint_type_name_c *param_type  = new uint_type_name_c();

   458

          identifier_c *param_name = new identifier_c(INLINE_PARAM_COUNT);

   459

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

   460

          found_first_extensible_parameter = true;

   461

        }

   462

   463

        symbol_c *param_type = fp_iterator.param_type();

   464

        if (param_type == NULL) ERROR;

   465

   466

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

   467

   468

        symbol_c *param_value = NULL;

   469

   470

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

   471

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

   472

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

   473

         * it will always return NULL.

   474

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

   475

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

   476

         * the following line...

   477

         */

   478

        if (param_value == NULL)

   479

          param_value = function_call_param_iterator.search_f(param_name);

   480

   481

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

   482

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

   483

         * get the value off the IL default variable!

   484

         *

   485

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

   486

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

   487

         */

   488

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

   489

	  if (NULL == implicit_variable_current.datatype) ERROR;

   490

          param_value = &this->implicit_variable_current;

   491

          used_defvar = true;

   492

        }

   493

   494