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

    41

    #define IL_DEFVAR   VAR_LEADER "IL_DEFVAR"

    42

    43

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

    44

     * parenthesised instruction list to the immediately preceding

    45

     * scope ...

    46

     */

    47

    #define IL_DEFVAR_BACK   VAR_LEADER "IL_DEFVAR_BACK"

    48

    il_default_variable_c implicit_variable_current;

    49

    50

    symbol_c* current_array_type;

    51

    52

    int fcall_number;

    53

    bool generating_inlinefunction;

    54

    symbol_c *fbname;

    55

    56

    search_varfb_instance_type_c *search_varfb_instance_type;

    57

    search_var_instance_decl_c   *search_var_instance_decl;

    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_base_and_typeid_c(s4o_ptr),

    64

      implicit_variable_current(IL_DEFVAR, NULL)

    65

    {

    66

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

    67

      search_var_instance_decl   = new search_var_instance_decl_c  (scope);

    68

    69

      this->set_variable_prefix(variable_prefix);

    70

      fcall_number = 0;

    71

      fbname = name;

    72

      wanted_variablegeneration = expression_vg;

    73

      generating_inlinefunction = false;

    74

    }

    75

    76

    virtual ~generate_c_inlinefcall_c(void) {

    77

      delete search_varfb_instance_type;

    78

      delete search_var_instance_decl;

    79

    }

    80

    81

    void print(symbol_c* symbol) {

    82

      function_call_iterator_c fc_iterator(symbol);

    83

      symbol_c* function_call;

    84

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

    85

        function_call->accept(*this);

    86

      }

    87

    }

    88

    89

    90

    91

    void generate_inline(symbol_c *function_name,

    92

            symbol_c *function_type_prefix,

    93

            symbol_c *function_type_suffix,

    94

            std::list<FUNCTION_PARAM*> param_list,

    95

            function_declaration_c *f_decl = NULL) {

    96

    97

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

    98

      generating_inlinefunction = true;

    99

   100

      fcall_number++;

   101

      function_type_prefix = default_literal_type(function_type_prefix);

   102

      if (function_type_suffix) {

   103

        function_type_suffix = default_literal_type(function_type_suffix);

   104

      }

   105

   106

      s4o.print(s4o.indent_spaces);

   107

      s4o.print("static inline ");      

   108

      function_type_prefix->accept(*this);

   109

      s4o.print(" __");

   110

      fbname->accept(*this);

   111

      s4o.print("_");

   112

      function_name->accept(*this);

   113

      if (f_decl != NULL) {

   114

        /* function being called is overloaded! */

   115

        s4o.print("__");

   116

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   117

        f_decl->accept(overloaded_func_suf);

   118

      }

   119

      if (function_type_suffix) {

   120

        function_type_suffix->accept(*this);

   121

      }

   122

      s4o.print(fcall_number);

   123

      s4o.print("(");

   124

      s4o.indent_right();

   125

   126

      PARAM_LIST_ITERATOR() {

   127

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in) {

   128

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

   129

          s4o.print(" ");

   130

          PARAM_NAME->accept(*this);

   131

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

   132

        }

   133

      }

   134

      fbname->accept(*this);

   135

      s4o.print(" *");

   136

      s4o.print(FB_FUNCTION_PARAM);

   137

      s4o.indent_left();

   138

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

   139

      s4o.print("{\n");

   140

      s4o.indent_right();

   141

   142

      s4o.print(s4o.indent_spaces);

   143

      function_type_prefix->accept(*this);

   144

      s4o.print(" "),

   145

      s4o.print(INLINE_RESULT_TEMP_VAR);

   146

      s4o.print(";\n");

   147

   148

      PARAM_LIST_ITERATOR() {

   149

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

   150

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   151

             PARAM_VALUE != NULL) {

   152

          s4o.print(s4o.indent_spaces);

   153

          PARAM_TYPE->accept(*this);

   154

          s4o.print(" ");

   155

          s4o.print(TEMP_VAR);

   156

          PARAM_NAME->accept(*this);

   157

          s4o.print(" = ");

   158

          print_check_function(PARAM_TYPE, PARAM_VALUE);

   159

          s4o.print(";\n");

   160

          }

   161

        }

   162

   163

      s4o.print(s4o.indent_spaces + INLINE_RESULT_TEMP_VAR),

   164

      s4o.print(" = ");

   165

      function_name->accept(*this);

   166

      if (f_decl != NULL) {

   167

        /* function being called is overloaded! */

   168

        s4o.print("__");

   169

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   170

        f_decl->accept(overloaded_func_suf);

   171

      }

   172

   173

      if (function_type_suffix)

   174

        function_type_suffix->accept(*this);

   175

      s4o.print("(");

   176

      s4o.indent_right();

   177

   178

      PARAM_LIST_ITERATOR() {

   179

        if (pt != param_list.begin())

   180

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

   181

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in)

   182

          PARAM_NAME->accept(*this);

   183

        else if (PARAM_VALUE != NULL){

   184

          s4o.print("&");

   185

          s4o.print(TEMP_VAR);

   186

          PARAM_NAME->accept(*this);

   187

        } else {

   188

          s4o.print("NULL");

   189

         }

   190

      }

   191

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

   192

      s4o.indent_left();

   193

   194

      PARAM_LIST_ITERATOR() {

   195

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

   196

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   197

             PARAM_VALUE != NULL) {

   198

          s4o.print(s4o.indent_spaces);

   199

          print_setter(PARAM_VALUE, PARAM_TYPE, PARAM_NAME);

   200

          s4o.print(";\n");

   201

        }

   202

      }

   203

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

   204

      s4o.print(INLINE_RESULT_TEMP_VAR);

   205

      s4o.print(";\n");

   206

   207

      s4o.indent_left();

   208

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

   209

   210

      generating_inlinefunction = false;

   211

    }

   212

   213

  private:

   214

    /* a small helper function */

   215

    symbol_c *default_literal_type(symbol_c *symbol) {

   216

      if (get_datatype_info_c::is_ANY_INT_literal(symbol)) {

   217

        return &get_datatype_info_c::lint_type_name;

   218

      }

   219

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

   220

        return &get_datatype_info_c::lreal_type_name;

   221

      }

   222

      return symbol;

   223

    }

   224

   225

   226

   227

    void *print_getter(symbol_c *symbol) {

   228

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

   229

      if (vartype == search_var_instance_decl_c::external_vt) {

   230

        if (!get_datatype_info_c::is_type_valid    (symbol->datatype)) ERROR;

   231

        if ( get_datatype_info_c::is_function_block(symbol->datatype))

   232

          s4o.print(GET_EXTERNAL_FB);

   233

        else

   234

          s4o.print(GET_EXTERNAL);

   235

      }

   236

      else if (vartype == search_var_instance_decl_c::located_vt)

   237

        s4o.print(GET_LOCATED);

   238

      else

   239

        s4o.print(GET_VAR);

   240

      s4o.print("(");

   241

   242

      wanted_variablegeneration = complextype_base_vg;

   243

      symbol->accept(*this);

   244

      s4o.print(",");

   245

      wanted_variablegeneration = complextype_suffix_vg;

   246

      symbol->accept(*this);

   247

      s4o.print(")");

   248

      wanted_variablegeneration = expression_vg;

   249

      return NULL;

   250

    }

   251

   252

    void *print_setter(symbol_c* symbol,

   253

                       symbol_c* type,

   254

                       symbol_c* value) {

   255

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

   256

      if (vartype == search_var_instance_decl_c::external_vt) {

   257

        if (!get_datatype_info_c::is_type_valid    (symbol->datatype)) ERROR;

   258

        if ( get_datatype_info_c::is_function_block(symbol->datatype))

   259

          s4o.print(SET_EXTERNAL_FB);

   260

         else

   261

          s4o.print(SET_EXTERNAL);

   262

      }

   263

      else if (vartype == search_var_instance_decl_c::located_vt)

   264

        s4o.print(SET_LOCATED);

   265

      else

   266

        s4o.print(SET_VAR);

   267

      s4o.print("(,");

   268

      wanted_variablegeneration = complextype_base_vg;

   269

      symbol->accept(*this);

   270

      s4o.print(",");

   271

      if (analyse_variable_c::contains_complex_type(symbol)) {

   272

        wanted_variablegeneration = complextype_suffix_vg;

   273

        symbol->accept(*this);

   274

      }

   275

      s4o.print(",");

   276

      wanted_variablegeneration = expression_vg;

   277

      print_check_function(type, value, NULL, true);

   278

      s4o.print(")");

   279

      wanted_variablegeneration = expression_vg;

   280

      return NULL;

   281

    }

   282

   283

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

   284

    /* 2.1.6 - Pragmas  */

   285

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

   286

    //SYM_REF0(disable_code_generation_pragma_c)

   287

    //SYM_REF0(enable_code_generation_pragma_c)

   288

    //SYM_TOKEN(pragma_c)

   289

    void *visit(pragma_c *symbol) {return NULL;}

   290

   291

   292

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

   293

    /* B.1 - Common elements */

   294

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

   295

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

   296

    /* B 1.1 - Letters, digits and identifiers */

   297

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

   298

    void *visit(identifier_c *symbol) {

   299

      if (generating_inlinefunction) {

   300

        return generate_c_base_c::visit(symbol); // let the base class handle it...

   301

      }

   302

      return NULL;

   303

    }

   304

   305

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

   306

    /* B 1.4 - Variables */

   307

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

   308

    void *visit(symbolic_variable_c *symbol) {

   309

      unsigned int vartype;

   310

      if (generating_inlinefunction) {

   311

        if (wanted_variablegeneration == complextype_base_vg)

   312

          generate_c_base_c::visit(symbol);

   313

        else if (wanted_variablegeneration == complextype_suffix_vg)

   314

          return NULL;

   315

        else

   316

          print_getter(symbol);

   317

      }

   318

      return NULL;

   319

    }

   320

   321

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

   322

    /* B.1.4.1   Directly Represented Variables */

   323

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

   324

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

   325

    void *visit(direct_variable_c *symbol) {

   326

      TRACE("direct_variable_c");

   327

      if (generating_inlinefunction) {

   328

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

   329

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

   330

        s4o.print(GET_LOCATED);

   331

        s4o.print("(");

   332

        this->print_variable_prefix();

   333

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

   334

        s4o.print(")");

   335

      }

   336

      return NULL;

   337

    }

   338

   339

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

   340

    /* B.1.4.2   Multi-element Variables */

   341

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

   342

   343

    // SYM_REF2(structured_variable_c, record_variable, field_selector)

   344

    void *visit(structured_variable_c *symbol) {

   345

      TRACE("structured_variable_c");

   346

      bool type_is_complex = analyse_variable_c::is_complex_type(symbol->record_variable);

   347

      if (generating_inlinefunction) {

   348

        switch (wanted_variablegeneration) {

   349

          case complextype_base_vg:

   350

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

   351

            if (!type_is_complex) {

   352

                s4o.print(".");

   353

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

   354

            }

   355

            break;

   356

          case complextype_suffix_vg:

   357

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

   358

            if (type_is_complex) {

   359

              s4o.print(".");

   360

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

   361

            }

   362

            break;

   363

          default:

   364

            print_getter(symbol);

   365

            break;

   366

        }

   367

      }

   368

      return NULL;

   369

    }

   370

   371

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

   372

    //SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   373

    void *visit(array_variable_c *symbol) {

   374

      if (generating_inlinefunction) {

   375

        switch (wanted_variablegeneration) {

   376

          case complextype_base_vg:

   377

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

   378

            break;

   379

          case complextype_suffix_vg:

   380

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

   381

   382

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

   383

            if (current_array_type == NULL) ERROR;

   384

   385

            s4o.print(".table");

   386

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

   387

   388

            current_array_type = NULL;

   389

            break;

   390

          default:

   391

            print_getter(symbol);

   392

            break;

   393

        }

   394

      }

   395

      return NULL;

   396

    }

   397

   398

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

   399

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

   400

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

   401

   402

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

   403

    /* B 2.1 Instructions and Operands */

   404

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

   405

   406

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

   407

    // SYM_REF2(il_instruction_c, label, il_instruction)

   408

    void *visit(il_instruction_c *symbol) {

   409

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

   410

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

   411

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

   412

      implicit_variable_current.datatype = NULL;

   413

      return NULL;

   414

    }

   415

   416

   417

    /* | il_simple_operator [il_operand] */

   418

    //SYM_REF2(il_simple_operation_c, il_simple_operator, il_operand)

   419

    void *visit(il_simple_operation_c *symbol) {

   420

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

   421

      return NULL;

   422

    }

   423

   424

    /*  il_jump_operator label */

   425

    // SYM_REF2(il_jump_operation_c, il_jump_operator, label)    

   426

    void *visit(il_jump_operation_c *symbol) {

   427

      return NULL;

   428

    }

   429

   430

    void *visit(il_function_call_c *symbol) {

   431

      symbol_c* function_type_prefix = NULL;

   432

      symbol_c* function_name = NULL;     

   433

      symbol_c* function_type_suffix = NULL;

   434

      DECLARE_PARAM_LIST()

   435

   436

      function_call_param_iterator_c function_call_param_iterator(symbol);

   437

   438

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

   439

      if (f_decl == NULL) ERROR;

   440

   441

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

   442

      function_type_prefix = search_base_type_c::get_basetype_decl(f_decl->type_name);

   443

   444

      function_name = symbol->function_name;      

   445

   446

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

   447

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

   448

       */

   449

   450

      function_param_iterator_c fp_iterator(f_decl);

   451

      identifier_c *param_name;

   452

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

   453

      bool used_defvar = false;       

   454

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

   455

      bool found_first_extensible_parameter = false;  

   456

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

   457

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

   458

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

   459

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

   460

           * function how many extensible parameters we will be passing.

   461

           *

   462

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

   463

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

   464

           * re-use that value.

   465

           */

   466

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

   467

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

   468

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

   469

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

   470

           */

   471

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

   472

          if (tmp == NULL) ERROR;

   473

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

   474

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

   475

          identifier_c *param_value = new identifier_c(tmp);

   476

          uint_type_name_c *param_type  = new uint_type_name_c();

   477

          identifier_c *param_name = new identifier_c(INLINE_PARAM_COUNT);

   478

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

   479

          found_first_extensible_parameter = true;

   480

        }

   481

   482

        symbol_c *param_type = fp_iterator.param_type();

   483

        if (param_type == NULL) ERROR;

   484

   485

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

   486

   487

        symbol_c *param_value = NULL;

   488

   489

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

   490

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

   491

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

   492

         * it will always return NULL.

   493

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