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_expression_type_c *search_expression_type;

   107

   108

    search_varfb_instance_type_c *search_varfb_instance_type;

   109

    search_var_instance_decl_c   *search_var_instance_decl;

   110

   111

    search_base_type_c search_base_type;

   112

   113

    variablegeneration_t wanted_variablegeneration;

   114

   115

  public:

   116

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

   117

    : generate_c_typedecl_c(s4o_ptr),

   118

      default_variable_name(IL_DEFVAR, NULL),

   119

      default_variable_back_name(IL_DEFVAR_BACK, NULL)

   120

    {

   121

      search_expression_type = new search_expression_type_c(scope);

   122

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

   123

      search_var_instance_decl   = new search_var_instance_decl_c(scope);

   124

   125

      this->set_variable_prefix(variable_prefix);

   126

      current_operand = NULL;

   127

      current_operand_type = NULL;

   128

      il_default_variable_init_value = NULL;

   129

      fcall_number = 0;

   130

      fbname = name;

   131

      wanted_variablegeneration = expression_vg;

   132

      generating_inlinefunction = false;

   133

    }

   134

   135

    virtual ~generate_c_inlinefcall_c(void) {

   136

      delete search_expression_type;

   137

      delete search_varfb_instance_type;

   138

      delete search_var_instance_decl;

   139

    }

   140

   141

    void print(symbol_c* symbol) {

   142

      function_call_iterator_c fc_iterator(symbol);

   143

      symbol_c* function_call;

   144

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

   145

    	function_call->accept(*this);

   146

      }

   147

    }

   148

   149

   150

   151

    void generate_inline(symbol_c *function_name,

   152

            symbol_c *function_type_prefix,

   153

            symbol_c *function_type_suffix,

   154

            std::list<FUNCTION_PARAM*> param_list,

   155

            function_declaration_c *f_decl = NULL) {

   156

   157

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

   158

      generating_inlinefunction = true;

   159

   160

      fcall_number++;

   161

      function_type_prefix = search_expression_type->default_literal_type(function_type_prefix);

   162

      if (function_type_suffix) {

   163

        function_type_suffix = search_expression_type->default_literal_type(function_type_suffix);

   164

      }

   165

   166

      s4o.print(s4o.indent_spaces);

   167

      s4o.print("inline ");

   168

      function_type_prefix->accept(*this);

   169

      s4o.print(" __");

   170

      fbname->accept(*this);

   171

      s4o.print("_");

   172

      function_name->accept(*this);

   173

      if (f_decl != NULL) {

   174

        /* function being called is overloaded! */

   175

        s4o.print("__");

   176

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   177

        f_decl->accept(overloaded_func_suf);

   178

      }	

   179

      if (function_type_suffix) {

   180

        function_type_suffix->accept(*this);

   181

      }

   182

      s4o.print(fcall_number);

   183

      s4o.print("(");

   184

      s4o.indent_right();

   185

   186

      PARAM_LIST_ITERATOR() {

   187

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in) {

   188

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

   189

          s4o.print(" ");

   190

          PARAM_NAME->accept(*this);

   191

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

   192

        }

   193

      }

   194

      fbname->accept(*this);

   195

      s4o.print(" *");

   196

      s4o.print(FB_FUNCTION_PARAM);

   197

      s4o.indent_left();

   198

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

   199

      s4o.print("{\n");

   200

      s4o.indent_right();

   201

   202

      s4o.print(s4o.indent_spaces);

   203

      function_type_prefix->accept(*this);

   204

      s4o.print(" "),

   205

      s4o.print(INLINE_RESULT_TEMP_VAR);

   206

      s4o.print(";\n");

   207

   208

      PARAM_LIST_ITERATOR() {

   209

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

   210

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   211

             PARAM_VALUE != NULL) {

   212

          s4o.print(s4o.indent_spaces);

   213

          PARAM_TYPE->accept(*this);

   214

          s4o.print(" ");

   215

          s4o.print(TEMP_VAR);

   216

          PARAM_NAME->accept(*this);

   217

          s4o.print(" = ");

   218

          print_check_function(PARAM_TYPE, PARAM_VALUE);

   219

          s4o.print(";\n");

   220

          }

   221

        }

   222

   223

      s4o.print(s4o.indent_spaces + INLINE_RESULT_TEMP_VAR),

   224

      s4o.print(" = ");

   225

      function_name->accept(*this);

   226

      if (f_decl != NULL) {

   227

    	/* function being called is overloaded! */

   228

    	s4o.print("__");

   229

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   230

        f_decl->accept(overloaded_func_suf);

   231

      }

   232

   233

      if (function_type_suffix)

   234

        function_type_suffix->accept(*this);

   235

      s4o.print("(");

   236

      s4o.indent_right();

   237

   238

      PARAM_LIST_ITERATOR() {

   239

        if (pt != param_list.begin())

   240

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

   241

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in)

   242

          PARAM_NAME->accept(*this);

   243

        else if (PARAM_VALUE != NULL){

   244

          s4o.print("&");

   245

          s4o.print(TEMP_VAR);

   246

          PARAM_NAME->accept(*this);

   247

        } else {

   248

          s4o.print("NULL");

   249

         }

   250

      }

   251

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

   252

      s4o.indent_left();

   253

   254

      PARAM_LIST_ITERATOR() {

   255

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

   256

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   257

             PARAM_VALUE != NULL) {

   258

          s4o.print(s4o.indent_spaces);

   259

          print_setter(PARAM_VALUE, PARAM_TYPE, PARAM_NAME);

   260

          s4o.print(";\n");

   261

        }

   262

      }

   263

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

   264

      s4o.print(INLINE_RESULT_TEMP_VAR);

   265

      s4o.print(";\n");

   266

   267

      s4o.indent_left();

   268

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

   269

   270

      generating_inlinefunction = false;

   271

    }

   272

   273

  private:

   274

   275

    /* A helper function... */

   276

	void CMP_operator_result_type() {

   277

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

   278

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

   279

	}

   280

   281

	/* A helper function... */

   282

    void BYTE_operator_result_type(void) {

   283

	  if (search_expression_type->is_literal_integer_type(this->default_variable_name.current_type)) {

   284

		if (search_expression_type->is_literal_integer_type(this->current_operand_type))

   285

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

   286

		else

   287

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

   288

	  }

   289

	  else if (search_expression_type->is_literal_integer_type(this->current_operand_type))

   290

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

   291

	}

   292

   293

    /* A helper function... */

   294

    void NUM_operator_result_type(void) {

   295

	  if (search_expression_type->is_literal_real_type(this->default_variable_name.current_type)) {

   296

		if (search_expression_type->is_literal_integer_type(this->current_operand_type) ||

   297

			search_expression_type->is_literal_real_type(this->current_operand_type))

   298

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

   299

		else

   300

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

   301

	  }

   302

	  else if (search_expression_type->is_literal_integer_type(this->default_variable_name.current_type)) {

   303

		if (search_expression_type->is_literal_integer_type(this->current_operand_type))

   304

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

   305

		else if (search_expression_type->is_literal_real_type(this->current_operand_type))

   306

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

   307

		else

   308

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

   309

	  }

   310

	  else if (search_expression_type->is_literal_integer_type(this->current_operand_type) ||

   311

			   search_expression_type->is_literal_real_type(this->current_operand_type))

   312

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

   313

	}

   314

   315

    void *print_getter(symbol_c *symbol) {

   316

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

   317

      if (vartype == search_var_instance_decl_c::external_vt)

   318

    	s4o.print(GET_EXTERNAL);

   319

      else if (vartype == search_var_instance_decl_c::located_vt)

   320

    	s4o.print(GET_LOCATED);

   321

      else

   322

    	s4o.print(GET_VAR);

   323

      s4o.print("(");

   324

   325

      wanted_variablegeneration = complextype_base_vg;

   326

      symbol->accept(*this);

   327

      if (search_var_instance_decl->type_is_complex(symbol))

   328

    	s4o.print(",");

   329

      wanted_variablegeneration = complextype_suffix_vg;

   330

      symbol->accept(*this);

   331

      s4o.print(")");

   332

      wanted_variablegeneration = expression_vg;

   333

      return NULL;

   334

    }

   335

   336

    void *print_setter(symbol_c* symbol,

   337

    		symbol_c* type,

   338

    		symbol_c* value) {

   339

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

   340

      if (vartype == search_var_instance_decl_c::external_vt)

   341

        s4o.print(SET_EXTERNAL);

   342

      else if (vartype == search_var_instance_decl_c::located_vt)

   343

        s4o.print(SET_LOCATED);

   344

      else

   345

        s4o.print(SET_VAR);

   346

      s4o.print("(,");

   347

   348

      wanted_variablegeneration = complextype_base_vg;

   349

      symbol->accept(*this);

   350

      s4o.print(",");

   351

      wanted_variablegeneration = expression_vg;

   352

      print_check_function(type, value, NULL, true);

   353

      if (search_var_instance_decl->type_is_complex(symbol)) {

   354

        s4o.print(",");

   355

        wanted_variablegeneration = complextype_suffix_vg;

   356

        symbol->accept(*this);

   357

      }

   358

      s4o.print(")");

   359

      wanted_variablegeneration = expression_vg;

   360

      return NULL;

   361

    }

   362

   363

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

   364

    /* B 1.4 - Variables */

   365

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

   366

    void *visit(symbolic_variable_c *symbol) {

   367

      unsigned int vartype;

   368

      if (generating_inlinefunction) {

   369

        if (wanted_variablegeneration == complextype_base_vg)

   370

          generate_c_base_c::visit(symbol);

   371

        else if (wanted_variablegeneration == complextype_suffix_vg)

   372

          return NULL;

   373

        else

   374

          print_getter(symbol);

   375

      }

   376

      return NULL;

   377

    }

   378

   379

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

   380

    /* B.1.4.1   Directly Represented Variables */

   381

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

   382

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

   383

    void *visit(direct_variable_c *symbol) {

   384

      TRACE("direct_variable_c");

   385

      if (generating_inlinefunction) {

   386

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

   387

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

   388

        s4o.print(GET_LOCATED);

   389

        s4o.print("(");

   390

        this->print_variable_prefix();

   391

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

   392

        s4o.print(")");

   393

      }

   394

      return NULL;

   395

    }

   396

   397

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

   398

    /* B.1.4.2   Multi-element Variables */

   399

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

   400

   401

    // SYM_REF2(structured_variable_c, record_variable, field_selector)

   402

    void *visit(structured_variable_c *symbol) {

   403

      TRACE("structured_variable_c");

   404

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

   405

      if (generating_inlinefunction) {

   406

        switch (wanted_variablegeneration) {

   407

          case complextype_base_vg:

   408

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

   409

            if (!type_is_complex) {

   410

          	  s4o.print(".");

   411

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

   412

            }

   413

            break;

   414

          case complextype_suffix_vg:

   415

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

   416

            if (type_is_complex) {

   417

              s4o.print(".");

   418

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

   419

            }

   420

            break;

   421

          default:

   422

            print_getter(symbol);

   423

            break;

   424

        }

   425

      }

   426

      return NULL;

   427

    }

   428

   429

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

   430

    //SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   431

    void *visit(array_variable_c *symbol) {

   432

      if (generating_inlinefunction) {

   433

        switch (wanted_variablegeneration) {

   434

          case complextype_base_vg:

   435

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

   436

            break;

   437

          case complextype_suffix_vg:

   438

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

   439

   440

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

   441

            if (current_array_type == NULL) ERROR;

   442

   443

            s4o.print(".table");

   444

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

   445

   446

            current_array_type = NULL;

   447

            break;

   448

          default:

   449

            print_getter(symbol);

   450

            break;

   451

        }

   452

      }

   453

      return NULL;

   454

    }

   455

   456

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

   457

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

   458

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

   459

   460

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

   461

    /* B 2.1 Instructions and Operands */

   462

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

   463

   464

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

   465

    // SYM_REF2(il_instruction_c, label, il_instruction)

   466

    void *visit(il_instruction_c *symbol) {

   467

      if (NULL != symbol->il_instruction) {

   468

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

   469

      }

   470

      return NULL;

   471

    }

   472

   473

    /* | il_simple_operator [il_operand] */

   474

    //SYM_REF2(il_simple_operation_c, il_simple_operator, il_operand)

   475

    void *visit(il_simple_operation_c *symbol) {

   476

      this->current_operand = symbol->il_operand;

   477

      if (NULL == this->current_operand) {

   478

        this->current_operand_type = NULL;

   479

      } else {

   480

        this->current_operand_type = search_expression_type->get_type(this->current_operand);

   481

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

   482

      }

   483

   484

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

   485

   486

      this->current_operand = NULL;

   487

      this->current_operand_type = NULL;

   488

      return NULL;

   489

    }

   490

   491

    void *visit(il_function_call_c *symbol) {

   492

      symbol_c* function_type_prefix = NULL;

   493

      symbol_c* function_name = NULL;     

   494

      symbol_c* function_type_suffix = NULL;

   495

      DECLARE_PARAM_LIST()