1

/*

     2

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

     3

 *

     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

    41

    /* The initial value that should be given to the IL default variable

    42

	 * imediately after a parenthesis is opened.

    43

	 * This variable is only used to pass data from the

    44

	 * il_expression_c visitor to the simple_instr_list_c visitor.

    45

	 *

    46

	 * e.g.:

    47

	 *         LD var1

    48

	 *         AND ( var2

    49

	 *         OR var3

    50

	 *         )

    51

	 *

    52

	 * In the above code sample, the line 'AND ( var2' constitutes

    53

	 * an il_expression_c, where var2 should be loaded into the

    54

	 * il default variable before continuing with the expression

    55

	 * inside the parenthesis.

    56

	 * Unfortunately, only the simple_instr_list_c may do the

    57

	 * initial laoding of the var2 bariable following the parenthesis,

    58

	 * so the il_expression_c visitor will have to pass 'var2' as a

    59

	 * parameter to the simple_instr_list_c visitor.

    60

	 * Ergo, the existance of the following parameter...!

    61

	 */

    62

	symbol_c *il_default_variable_init_value;

    63

    64

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

    65

	 * is a boolean variable.

    66

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

    67

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

    68

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

    69

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

    70

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

    71

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

    72

	 * data type.

    73

	 * The following object is it...

    74

	 */

    75

	bool_type_name_c bool_type;

    76

	lint_type_name_c lint_type;

    77

	lword_type_name_c lword_type;

    78

	lreal_type_name_c lreal_type;

    79

    80

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

    81

	#define IL_DEFVAR   VAR_LEADER "IL_DEFVAR"

    82

    83

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

    84

	 * parenthesised instruction list to the immediately preceding

    85

	 * scope ...

    86

	 */

    87

    #define IL_DEFVAR_BACK   VAR_LEADER "IL_DEFVAR_BACK"

    95

    96

    search_varfb_instance_type_c *search_varfb_instance_type;

    97

    search_var_instance_decl_c   *search_var_instance_decl;

    98

    99

    search_base_type_c search_base_type;

   100

   101

    variablegeneration_t wanted_variablegeneration;

   102

   103

  public:

   104

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

   105

    : generate_c_typedecl_c(s4o_ptr),

   107

    {

   108

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

   109

      search_var_instance_decl   = new search_var_instance_decl_c  (scope);

   110

   111

      this->set_variable_prefix(variable_prefix);

   112

      il_default_variable_init_value = NULL;

   113

      fcall_number = 0;

   114

      fbname = name;

   115

      wanted_variablegeneration = expression_vg;

   116

      generating_inlinefunction = false;

   117

    }

   118

   119

    virtual ~generate_c_inlinefcall_c(void) {

   120

      delete search_varfb_instance_type;

   121

      delete search_var_instance_decl;

   122

    }

   123

   124

    void print(symbol_c* symbol) {

   125

      function_call_iterator_c fc_iterator(symbol);

   126

      symbol_c* function_call;

   127

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

   128

    	function_call->accept(*this);

   129

      }

   130

    }

   131

   132

   133

   134

    void generate_inline(symbol_c *function_name,

   135

            symbol_c *function_type_prefix,

   136

            symbol_c *function_type_suffix,

   137

            std::list<FUNCTION_PARAM*> param_list,

   138

            function_declaration_c *f_decl = NULL) {

   139

   140

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

   141

      generating_inlinefunction = true;

   142

   143

      fcall_number++;

   144

      function_type_prefix = default_literal_type(function_type_prefix);

   145

      if (function_type_suffix) {

   146

        function_type_suffix = default_literal_type(function_type_suffix);

   147

      }

   148

   149

      s4o.print(s4o.indent_spaces);

   150

      s4o.print("inline ");

   151

      function_type_prefix->accept(*this);

   152

      s4o.print(" __");

   153

      fbname->accept(*this);

   154

      s4o.print("_");

   155

      function_name->accept(*this);

   156

      if (f_decl != NULL) {

   157

        /* function being called is overloaded! */

   158

        s4o.print("__");

   159

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   160

        f_decl->accept(overloaded_func_suf);

   161

      }	

   162

      if (function_type_suffix) {

   163

        function_type_suffix->accept(*this);

   164

      }

   165

      s4o.print(fcall_number);

   166

      s4o.print("(");

   167

      s4o.indent_right();

   168

   169

      PARAM_LIST_ITERATOR() {

   170

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in) {

   171

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

   172

          s4o.print(" ");

   173

          PARAM_NAME->accept(*this);

   174

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

   175

        }

   176

      }

   177

      fbname->accept(*this);

   178

      s4o.print(" *");

   179

      s4o.print(FB_FUNCTION_PARAM);

   180

      s4o.indent_left();

   181

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

   182

      s4o.print("{\n");

   183

      s4o.indent_right();

   184

   185

      s4o.print(s4o.indent_spaces);

   186

      function_type_prefix->accept(*this);

   187

      s4o.print(" "),

   188

      s4o.print(INLINE_RESULT_TEMP_VAR);

   189

      s4o.print(";\n");

   190

   191

      PARAM_LIST_ITERATOR() {

   192

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

   193

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   194

             PARAM_VALUE != NULL) {

   195

          s4o.print(s4o.indent_spaces);

   196

          PARAM_TYPE->accept(*this);

   197

          s4o.print(" ");

   198

          s4o.print(TEMP_VAR);

   199

          PARAM_NAME->accept(*this);

   200

          s4o.print(" = ");

   201

          print_check_function(PARAM_TYPE, PARAM_VALUE);

   202

          s4o.print(";\n");

   203

          }

   204

        }

   205

   206

      s4o.print(s4o.indent_spaces + INLINE_RESULT_TEMP_VAR),

   207

      s4o.print(" = ");

   208

      function_name->accept(*this);

   209

      if (f_decl != NULL) {

   210

    	/* function being called is overloaded! */

   211

    	s4o.print("__");

   212

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   213

        f_decl->accept(overloaded_func_suf);

   214

      }

   215

   216

      if (function_type_suffix)

   217

        function_type_suffix->accept(*this);

   218

      s4o.print("(");

   219

      s4o.indent_right();

   220

   221

      PARAM_LIST_ITERATOR() {

   222

        if (pt != param_list.begin())

   223

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

   224

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in)

   225

          PARAM_NAME->accept(*this);

   226

        else if (PARAM_VALUE != NULL){

   227

          s4o.print("&");

   228

          s4o.print(TEMP_VAR);

   229

          PARAM_NAME->accept(*this);

   230

        } else {

   231

          s4o.print("NULL");

   232

         }

   233

      }

   234

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

   235

      s4o.indent_left();

   236

   237

      PARAM_LIST_ITERATOR() {

   238

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

   239

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   240

             PARAM_VALUE != NULL) {

   241

          s4o.print(s4o.indent_spaces);

   242

          print_setter(PARAM_VALUE, PARAM_TYPE, PARAM_NAME);

   243

          s4o.print(";\n");

   244

        }

   245

      }

   246

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

   247

      s4o.print(INLINE_RESULT_TEMP_VAR);

   248

      s4o.print(";\n");

   249

   250

      s4o.indent_left();

   251

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

   252

   253

      generating_inlinefunction = false;

   254

    }

   255

   256

  private:

   257

    /* a small helper function */

   258

    symbol_c *default_literal_type(symbol_c *symbol) {

   259

      if (get_datatype_info_c::is_ANY_INT_literal(symbol)) {

   260

        return &search_constant_type_c::lint_type_name;

   261

      }

   262

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

   263

        return &search_constant_type_c::lreal_type_name;

   264

      }

   265

      return symbol;

   266

    }

   267

   269

   270

    void *print_getter(symbol_c *symbol) {

   271

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

   272

      if (vartype == search_var_instance_decl_c::external_vt)

   274

      else if (vartype == search_var_instance_decl_c::located_vt)

   276

      else

   278

      s4o.print("(");

   279

   280

      wanted_variablegeneration = complextype_base_vg;

   281

      symbol->accept(*this);

   282

      if (search_var_instance_decl->type_is_complex(symbol))

   284

      wanted_variablegeneration = complextype_suffix_vg;

   285

      symbol->accept(*this);

   286

      s4o.print(")");

   287

      wanted_variablegeneration = expression_vg;

   288

      return NULL;

   289

    }

   290

   291

    void *print_setter(symbol_c* symbol,

   292

                       symbol_c* type,

   293

                       symbol_c* value) {

   294

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

   295

      if (vartype == search_var_instance_decl_c::external_vt)

   296

        s4o.print(SET_EXTERNAL);

   297

      else if (vartype == search_var_instance_decl_c::located_vt)

   298

        s4o.print(SET_LOCATED);

   299

      else

   300

        s4o.print(SET_VAR);

   301

      s4o.print("(,");

   302

   303

      wanted_variablegeneration = complextype_base_vg;

   304

      symbol->accept(*this);

   305

      s4o.print(",");

   306

      wanted_variablegeneration = expression_vg;

   307

      print_check_function(type, value, NULL, true);

   308

      if (search_var_instance_decl->type_is_complex(symbol)) {

   309

        s4o.print(",");

   310

        wanted_variablegeneration = complextype_suffix_vg;

   311

        symbol->accept(*this);

   312

      }

   313

      s4o.print(")");

   314

      wanted_variablegeneration = expression_vg;

   315

      return NULL;

   316

    }

   317

   318

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

   319

    /* B 1.4 - Variables */

   320

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

   321

    void *visit(symbolic_variable_c *symbol) {

   322

      unsigned int vartype;

   323

      if (generating_inlinefunction) {

   324

        if (wanted_variablegeneration == complextype_base_vg)

   325

          generate_c_base_c::visit(symbol);

   326

        else if (wanted_variablegeneration == complextype_suffix_vg)

   327

          return NULL;

   328

        else

   329

          print_getter(symbol);

   330

      }

   331

      return NULL;

   332

    }

   333

   334

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

   335

    /* B.1.4.1   Directly Represented Variables */

   336

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

   337

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

   338

    void *visit(direct_variable_c *symbol) {

   339

      TRACE("direct_variable_c");

   340

      if (generating_inlinefunction) {

   341

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

   342

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

   343

        s4o.print(GET_LOCATED);

   344

        s4o.print("(");

   345

        this->print_variable_prefix();

   346

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

   347

        s4o.print(")");

   348

      }

   349

      return NULL;

   350

    }

   351

   352

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

   353

    /* B.1.4.2   Multi-element Variables */

   354

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

   355

   356

    // SYM_REF2(structured_variable_c, record_variable, field_selector)

   357

    void *visit(structured_variable_c *symbol) {

   358

      TRACE("structured_variable_c");

   359

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

   360

      if (generating_inlinefunction) {

   361

        switch (wanted_variablegeneration) {

   362

          case complextype_base_vg:

   363

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

   364

            if (!type_is_complex) {

   365

          	  s4o.print(".");

   366

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

   367

            }

   368

            break;

   369

          case complextype_suffix_vg:

   370

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

   371

            if (type_is_complex) {

   372

              s4o.print(".");

   373

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

   374

            }

   375

            break;

   376

          default:

   377

            print_getter(symbol);

   378

            break;

   379

        }

   380

      }

   381

      return NULL;

   382

    }

   383

   384

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

   385

    //SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   386

    void *visit(array_variable_c *symbol) {

   387

      if (generating_inlinefunction) {

   388

        switch (wanted_variablegeneration) {

   389

          case complextype_base_vg:

   390

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

   391

            break;

   392

          case complextype_suffix_vg:

   393

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

   394

   395

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

   396

            if (current_array_type == NULL) ERROR;

   397

   398

            s4o.print(".table");

   399

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

   400

   401

            current_array_type = NULL;

   402

            break;

   403

          default:

   404

            print_getter(symbol);

   405

            break;

   406

        }

   407

      }

   408

      return NULL;

   409

    }

   410

   411

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

   412

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

   413

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

   414

   415

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

   416

    /* B 2.1 Instructions and Operands */

   417

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

   418

   419

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

   420

    // SYM_REF2(il_instruction_c, label, il_instruction)

   421

    void *visit(il_instruction_c *symbol) {

   429

   430

    /* | il_simple_operator [il_operand] */

   431

    //SYM_REF2(il_simple_operation_c, il_simple_operator, il_operand)

   432

    void *visit(il_simple_operation_c *symbol) {

   433

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

   437

   438

    void *visit(il_function_call_c *symbol) {

   439

      symbol_c* function_type_prefix = NULL;

   440

      symbol_c* function_name = NULL;     

   441

      symbol_c* function_type_suffix = NULL;

   442

      DECLARE_PARAM_LIST()

   443

   444

      function_call_param_iterator_c function_call_param_iterator(symbol);

   445

   446

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

   447

      if (f_decl == NULL) ERROR;

   448

   449

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

   450

      search_base_type_c search_base_type;

   451

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

   452

   453

      function_name = symbol->function_name;      

   454

   455

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

   456

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

   457

       */

   458

   459

      function_param_iterator_c fp_iterator(f_decl);

   460

      identifier_c *param_name;

   461

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

   462

      bool used_defvar = false;       

   463

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

   464

      bool found_first_extensible_parameter = false;  

   465

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

   466

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

   467

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

   468

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

   469

           * function how many extensible parameters we will be passing.

   470

           *

   471

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

   472

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

   473

           * re-use that value.

   474

           */

   475

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

   476

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

   477

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

   478

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

   479

           */

   480

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

   481

          if (tmp == NULL) ERROR;

   482

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

   483

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

   484

          identifier_c *param_value = new identifier_c(tmp);

   485

          uint_type_name_c *param_type  = new uint_type_name_c();

   486

          identifier_c *param_name = new identifier_c(INLINE_PARAM_COUNT);

   487

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

   488

          found_first_extensible_parameter = true;

   489

        }

   490

   491

        symbol_c *param_type = fp_iterator.param_type();

   492

        if (param_type == NULL) ERROR;

   493

   494

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