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

#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

    /* Operand to the IL operation currently being processed... */

    65

	/* These variables are used to pass data from the

    66

	 * il_simple_operation_c and il_expression_c visitors

    67

	 * to the il operator visitors (i.e. LD_operator_c,

    68

	 * LDN_operator_c, ST_operator_c, STN_operator_c, ...)

    69

	 */

    70

	symbol_c *current_operand;

    71

	symbol_c *current_operand_type;

    72

    73

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

    74

	 * is a boolean variable.

    75

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

    76

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

    77

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

    78

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

    79

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

    80

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

    81

	 * data type.

    82

	 * The following object is it...

    83

	 */

    84

	bool_type_name_c bool_type;

    85

	lint_type_name_c lint_type;

    86

	lword_type_name_c lword_type;

    87

	lreal_type_name_c lreal_type;

    88

    89

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

    90

	#define IL_DEFVAR   VAR_LEADER "IL_DEFVAR"

    91

    92

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

    93

	 * parenthesised instruction list to the immediately preceding

    94

	 * scope ...

    95

	 */

    96

    #define IL_DEFVAR_BACK   VAR_LEADER "IL_DEFVAR_BACK"

    97

    il_default_variable_c default_variable_name;

    98

	il_default_variable_c default_variable_back_name;

    99

   100

	symbol_c* current_array_type;

   101

   102

	int fcall_number;

   103

	bool generating_inlinefunction;

   104

	symbol_c *fbname;

   105

   106

    search_varfb_instance_type_c *search_varfb_instance_type;

   107

    search_var_instance_decl_c   *search_var_instance_decl;

   108

   109

    search_base_type_c search_base_type;

   110

   111

    variablegeneration_t wanted_variablegeneration;

   112

   113

  public:

   114

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

   115

    : generate_c_typedecl_c(s4o_ptr),

   116

      default_variable_name(IL_DEFVAR, NULL),

   117

      default_variable_back_name(IL_DEFVAR_BACK, NULL)

   118

    {

   119

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

   121

   122

      this->set_variable_prefix(variable_prefix);

   123

      current_operand = NULL;

   124

      current_operand_type = NULL;

   125

      il_default_variable_init_value = NULL;

   126

      fcall_number = 0;

   127

      fbname = name;

   128

      wanted_variablegeneration = expression_vg;

   129

      generating_inlinefunction = false;

   130

    }

   131

   132

    virtual ~generate_c_inlinefcall_c(void) {

   133

      delete search_varfb_instance_type;

   134

      delete search_var_instance_decl;

   135

    }

   136

   137

    void print(symbol_c* symbol) {

   138

      function_call_iterator_c fc_iterator(symbol);

   139

      symbol_c* function_call;

   140

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

   141

    	function_call->accept(*this);

   142

      }

   143

    }

   144

   145

   146

   147

    void generate_inline(symbol_c *function_name,

   148

            symbol_c *function_type_prefix,

   149

            symbol_c *function_type_suffix,

   150

            std::list<FUNCTION_PARAM*> param_list,

   151

            function_declaration_c *f_decl = NULL) {

   152

   153

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

   154

      generating_inlinefunction = true;

   155

   156

      fcall_number++;

   158

      if (function_type_suffix) {

   160

      }

   161

   162

      s4o.print(s4o.indent_spaces);

   163

      s4o.print("inline ");

   164

      function_type_prefix->accept(*this);

   165

      s4o.print(" __");

   166

      fbname->accept(*this);

   167

      s4o.print("_");

   168

      function_name->accept(*this);

   169

      if (f_decl != NULL) {

   170

        /* function being called is overloaded! */

   171

        s4o.print("__");

   172

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   173

        f_decl->accept(overloaded_func_suf);

   174

      }	

   175

      if (function_type_suffix) {

   176

        function_type_suffix->accept(*this);

   177

      }

   178

      s4o.print(fcall_number);

   179

      s4o.print("(");

   180

      s4o.indent_right();

   181

   182

      PARAM_LIST_ITERATOR() {

   183

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in) {

   185

          s4o.print(" ");

   186

          PARAM_NAME->accept(*this);

   187

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

   188

        }

   189

      }

   190

      fbname->accept(*this);

   191

      s4o.print(" *");

   192

      s4o.print(FB_FUNCTION_PARAM);

   193

      s4o.indent_left();

   194

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

   195

      s4o.print("{\n");

   196

      s4o.indent_right();

   197

   198

      s4o.print(s4o.indent_spaces);

   199

      function_type_prefix->accept(*this);

   200

      s4o.print(" "),

   201

      s4o.print(INLINE_RESULT_TEMP_VAR);

   202

      s4o.print(";\n");

   203

   204

      PARAM_LIST_ITERATOR() {

   205

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

   206

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   207

             PARAM_VALUE != NULL) {

   208

          s4o.print(s4o.indent_spaces);

   209

          PARAM_TYPE->accept(*this);

   210

          s4o.print(" ");

   211

          s4o.print(TEMP_VAR);

   212

          PARAM_NAME->accept(*this);

   213

          s4o.print(" = ");

   214

          print_check_function(PARAM_TYPE, PARAM_VALUE);

   215

          s4o.print(";\n");

   216

          }

   217

        }

   218

   219

      s4o.print(s4o.indent_spaces + INLINE_RESULT_TEMP_VAR),

   220

      s4o.print(" = ");

   221

      function_name->accept(*this);

   222

      if (f_decl != NULL) {

   223

    	/* function being called is overloaded! */

   224

    	s4o.print("__");

   225

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   226

        f_decl->accept(overloaded_func_suf);

   227

      }

   228

   229

      if (function_type_suffix)

   230

        function_type_suffix->accept(*this);

   231

      s4o.print("(");

   232

      s4o.indent_right();

   233

   234

      PARAM_LIST_ITERATOR() {

   235

        if (pt != param_list.begin())

   236

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

   237

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in)

   238

          PARAM_NAME->accept(*this);

   239

        else if (PARAM_VALUE != NULL){

   240

          s4o.print("&");

   241

          s4o.print(TEMP_VAR);

   242

          PARAM_NAME->accept(*this);

   243

        } else {

   244

          s4o.print("NULL");

   245

         }

   246

      }

   247

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

   248

      s4o.indent_left();

   249

   250

      PARAM_LIST_ITERATOR() {

   251

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

   252

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   253

             PARAM_VALUE != NULL) {

   254

          s4o.print(s4o.indent_spaces);

   255

          print_setter(PARAM_VALUE, PARAM_TYPE, PARAM_NAME);

   256

          s4o.print(";\n");

   257

        }

   258

      }

   259

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

   260

      s4o.print(INLINE_RESULT_TEMP_VAR);

   261

      s4o.print(";\n");

   262

   263

      s4o.indent_left();

   264

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

   265

   266

      generating_inlinefunction = false;

   267

    }

   268

   269

  private:

   280

   281

    /* A helper function... */

   282

	void CMP_operator_result_type() {

   283

	  /* the data type resulting from this operation... */

   284

	  this->default_variable_name.current_type = &(this->bool_type);

   285

	}

   286

   287

	/* A helper function... */

   288

    void BYTE_operator_result_type(void) {

   291

		  this->default_variable_name.current_type = &(this->lword_type);

   292

		else

   293

		  this->default_variable_name.current_type = this->current_operand_type;

   294

	  }

   296

		  this->current_operand_type = this->default_variable_name.current_type;

   297

	}

   298

   299

    /* A helper function... */

   300

    void NUM_operator_result_type(void) {

   304

		  this->default_variable_name.current_type = &(this->lreal_type);

   305

		else

   306

		  this->default_variable_name.current_type = this->current_operand_type;

   307

	  }

   310

		  this->default_variable_name.current_type = &(this->lint_type);

   312

		  this->default_variable_name.current_type = &(this->lreal_type);

   313

		else

   314

		  this->default_variable_name.current_type = this->current_operand_type;

   315

	  }

   318

		this->current_operand_type = this->default_variable_name.current_type;

   319

	}

   320

   321

    void *print_getter(symbol_c *symbol) {

   322

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

   323

      if (vartype == search_var_instance_decl_c::external_vt)

   324

    	s4o.print(GET_EXTERNAL);

   325

      else if (vartype == search_var_instance_decl_c::located_vt)

   326

    	s4o.print(GET_LOCATED);

   327

      else

   328

    	s4o.print(GET_VAR);

   329

      s4o.print("(");

   330

   331

      wanted_variablegeneration = complextype_base_vg;

   332

      symbol->accept(*this);

   333

      if (search_var_instance_decl->type_is_complex(symbol))

   334

    	s4o.print(",");

   335

      wanted_variablegeneration = complextype_suffix_vg;

   336

      symbol->accept(*this);

   337

      s4o.print(")");

   338

      wanted_variablegeneration = expression_vg;

   339

      return NULL;

   340

    }

   341

   342

    void *print_setter(symbol_c* symbol,

   345

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

   346

      if (vartype == search_var_instance_decl_c::external_vt)

   347

        s4o.print(SET_EXTERNAL);

   348

      else if (vartype == search_var_instance_decl_c::located_vt)

   349

        s4o.print(SET_LOCATED);

   350

      else

   351

        s4o.print(SET_VAR);

   352

      s4o.print("(,");

   353

   354

      wanted_variablegeneration = complextype_base_vg;

   355

      symbol->accept(*this);

   356

      s4o.print(",");

   357

      wanted_variablegeneration = expression_vg;

   358

      print_check_function(type, value, NULL, true);

   359

      if (search_var_instance_decl->type_is_complex(symbol)) {

   360

        s4o.print(",");

   361

        wanted_variablegeneration = complextype_suffix_vg;

   362

        symbol->accept(*this);

   363

      }

   364

      s4o.print(")");

   365

      wanted_variablegeneration = expression_vg;

   366

      return NULL;

   367

    }

   368

   369

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

   370

    /* B 1.4 - Variables */

   371

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

   372

    void *visit(symbolic_variable_c *symbol) {

   373

      unsigned int vartype;

   374

      if (generating_inlinefunction) {

   375

        if (wanted_variablegeneration == complextype_base_vg)

   376

          generate_c_base_c::visit(symbol);

   377

        else if (wanted_variablegeneration == complextype_suffix_vg)

   378

          return NULL;

   379

        else

   380

          print_getter(symbol);

   381

      }

   382

      return NULL;

   383

    }

   384

   385

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

   386

    /* B.1.4.1   Directly Represented Variables */

   387

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

   388

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

   389

    void *visit(direct_variable_c *symbol) {

   390

      TRACE("direct_variable_c");

   391

      if (generating_inlinefunction) {

   392

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

   393

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

   394

        s4o.print(GET_LOCATED);

   395

        s4o.print("(");

   396

        this->print_variable_prefix();

   397

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

   398

        s4o.print(")");

   399

      }

   400

      return NULL;

   401

    }

   402

   403

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

   404

    /* B.1.4.2   Multi-element Variables */

   405

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

   406

   407

    // SYM_REF2(structured_variable_c, record_variable, field_selector)

   408

    void *visit(structured_variable_c *symbol) {

   409

      TRACE("structured_variable_c");

   410

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

   411

      if (generating_inlinefunction) {

   412

        switch (wanted_variablegeneration) {

   413

          case complextype_base_vg:

   414

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

   415

            if (!type_is_complex) {

   416

          	  s4o.print(".");

   417

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

   418

            }

   419

            break;

   420

          case complextype_suffix_vg:

   421

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

   422

            if (type_is_complex) {

   423

              s4o.print(".");

   424

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

   425

            }

   426

            break;

   427

          default:

   428

            print_getter(symbol);

   429

            break;

   430

        }

   431

      }

   432

      return NULL;

   433

    }

   434

   435

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

   436

    //SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   437

    void *visit(array_variable_c *symbol) {

   438

      if (generating_inlinefunction) {

   439

        switch (wanted_variablegeneration) {

   440

          case complextype_base_vg:

   441

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

   442

            break;

   443

          case complextype_suffix_vg:

   444

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

   445

   446

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

   447

            if (current_array_type == NULL) ERROR;

   448

   449

            s4o.print(".table");

   450

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

   451

   452

            current_array_type = NULL;

   453

            break;

   454

          default:

   455

            print_getter(symbol);

   456

            break;

   457

        }

   458

      }

   459

      return NULL;

   460

    }

   461

   462

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

   463

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

   464

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

   465

   466

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

   467

    /* B 2.1 Instructions and Operands */

   468

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

   469

   470

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

   471

    // SYM_REF2(il_instruction_c, label, il_instruction)

   472

    void *visit(il_instruction_c *symbol) {

   473

      if (NULL != symbol->il_instruction) {

   474

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

   475

      }

   476

      return NULL;

   477

    }

   478

   479

    /* | il_simple_operator [il_operand] */

   480

    //SYM_REF2(il_simple_operation_c, il_simple_operator, il_operand)

   481

    void *visit(il_simple_operation_c *symbol) {

   482

      this->current_operand = symbol->il_operand;

   483

      if (NULL == this->current_operand) {

   484

        this->current_operand_type = NULL;

   485

      } else {

   487

        if (NULL == this->current_operand_type) ERROR;

   488

      }

   489

   490

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

   491

   492

      this->current_operand = NULL;

   493

      this->current_operand_type = NULL;

   494

      return NULL;