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;

   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

   110

    search_base_type_c search_base_type;

   111

   112

    variablegeneration_t wanted_variablegeneration;

   113

   114

  public:

   115

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

   116

    : generate_c_typedecl_c(s4o_ptr),

   117

      default_variable_name(IL_DEFVAR, NULL),

   118

      default_variable_back_name(IL_DEFVAR_BACK, NULL)

   119

    {

   120

      search_expression_type = new search_expression_type_c(scope);

   121

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

   122

      this->set_variable_prefix(variable_prefix);

   123

      fcall_number = 0;

   124

      fbname = name;

   125

      wanted_variablegeneration = expression_vg;

   127

    }

   128

   129

    virtual ~generate_c_inlinefcall_c(void) {

   130

      delete search_expression_type;

   131

      delete search_varfb_instance_type;

   132

    }

   133

   134

    void print(symbol_c* symbol) {

   135

      function_call_iterator_c fc_iterator(symbol);

   136

      symbol_c* function_call;

   137

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

   138

    	function_call->accept(*this);

   139

      }

   140

    }

   141

   142

   143

   144

    void generate_inline(symbol_c *function_name,

   145

            symbol_c *function_type_prefix,

   146

            symbol_c *function_type_suffix,

   147

            std::list<FUNCTION_PARAM*> param_list,

   148

            function_declaration_c *f_decl = NULL) {

   152

   153

      fcall_number++;

   154

      function_type_prefix = search_expression_type->default_literal_type(function_type_prefix);

   155

      if (function_type_suffix) {

   156

        function_type_suffix = search_expression_type->default_literal_type(function_type_suffix);

   157

      }

   158

   159

      s4o.print(s4o.indent_spaces);

   160

      s4o.print("inline ");

   161

      function_type_prefix->accept(*this);

   162

      s4o.print(" __");

   163

      fbname->accept(*this);

   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

      if (function_type_suffix) {

   173

        function_type_suffix->accept(*this);

   174

      }

   175

      s4o.print_integer(fcall_number);

   176

      s4o.print("(");

   177

      s4o.indent_right();

   178

   179

      PARAM_LIST_ITERATOR() {

   180

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in) {

   181

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

   182

          s4o.print(" ");

   183

          PARAM_NAME->accept(*this);

   184

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

   185

        }

   186

      }

   187

      fbname->accept(*this);

   188

      s4o.print(" *");

   189

      s4o.print(FB_FUNCTION_PARAM);

   190

      s4o.indent_left();

   191

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

   192

      s4o.print("{\n");

   193

      s4o.indent_right();

   194

   195

      s4o.print(s4o.indent_spaces);

   196

      function_type_prefix->accept(*this);

   197

      s4o.print(" "),

   198

      s4o.print(INLINE_RESULT_TEMP_VAR);

   199

      s4o.print(";\n");

   200

   201

      PARAM_LIST_ITERATOR() {

   202

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

   203

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   204

             PARAM_VALUE != NULL) {

   205

          s4o.print(s4o.indent_spaces);

   206

          PARAM_TYPE->accept(*this);

   207

          s4o.print(" ");

   208

          s4o.print(TEMP_VAR);

   209

          PARAM_NAME->accept(*this);

   210

          s4o.print(" = ");

   211

          print_check_function(PARAM_TYPE, PARAM_VALUE);

   212

          s4o.print(";\n");

   213

          }

   214

        }

   215

   216

      s4o.print(s4o.indent_spaces + INLINE_RESULT_TEMP_VAR),

   217

      s4o.print(" = ");

   218

      function_name->accept(*this);

   219

      if (f_decl != NULL) {

   220

    	/* function being called is overloaded! */

   221

    	s4o.print("__");

   222

        print_function_parameter_data_types_c overloaded_func_suf(&s4o);

   223

        f_decl->accept(overloaded_func_suf);

   224

      }

   225

   226

      if (function_type_suffix)

   227

        function_type_suffix->accept(*this);

   228

      s4o.print("(");

   229

      s4o.indent_right();

   230

   231

      PARAM_LIST_ITERATOR() {

   232

        if (pt != param_list.begin())

   233

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

   234

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in)

   235

          PARAM_NAME->accept(*this);

   236

        else if (PARAM_VALUE != NULL){

   237

          s4o.print("&");

   238

          s4o.print(TEMP_VAR);

   239

          PARAM_NAME->accept(*this);

   240

        } else {

   241

          s4o.print("NULL");

   242

         }

   243

      }

   244

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

   245

      s4o.indent_left();

   246

   247

      PARAM_LIST_ITERATOR() {

   248

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

   249

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   250

             PARAM_VALUE != NULL) {

   251

          s4o.print(s4o.indent_spaces);

   252

          print_setter(PARAM_VALUE, PARAM_TYPE, PARAM_NAME);

   253

          s4o.print(";\n");

   254

        }

   255

      }

   256

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

   257

      s4o.print(INLINE_RESULT_TEMP_VAR);

   258

      s4o.print(";\n");

   259

   260

      s4o.indent_left();

   261

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

   264

    }

   265

   266

  private:

   267

   268

    /* A helper function... */

   269

	void CMP_operator_result_type() {

   270

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

   271

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

   272

	}

   273

   274

	/* A helper function... */

   275

    void BYTE_operator_result_type(void) {

   276

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

   277

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

   278

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

   279

		else

   280

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

   281

	  }

   282

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

   283

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

   284

	}

   285

   286

    /* A helper function... */

   287

    void NUM_operator_result_type(void) {

   288

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

   289

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

   290

			search_expression_type->is_literal_real_type(this->current_operand_type))

   291

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

   292

		else

   293

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

   294

	  }

   295

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

   296

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

   297

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

   298

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

   299

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

   300

		else

   301

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

   302

	  }

   303

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

   304

			   search_expression_type->is_literal_real_type(this->current_operand_type))

   305

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

   306

	}

   307

   308

    void *print_getter(symbol_c *symbol) {

   309

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

   310

      if (vartype == search_var_instance_decl_c::external_vt)

   311

    	s4o.print(GET_EXTERNAL);

   312

      else if (vartype == search_var_instance_decl_c::located_vt)

   313

    	s4o.print(GET_LOCATED);

   314

      else

   315

    	s4o.print(GET_VAR);

   316

      s4o.print("(");

   317

   318

      wanted_variablegeneration = complextype_base_vg;

   319

      symbol->accept(*this);

   320

      if (search_varfb_instance_type->type_is_complex())

   321

    	s4o.print(",");

   322

      wanted_variablegeneration = complextype_suffix_vg;

   323

      symbol->accept(*this);

   324

      s4o.print(")");

   325

      wanted_variablegeneration = expression_vg;

   326

      return NULL;

   327

    }

   328

   329

    void *print_setter(symbol_c* symbol,

   330

    		symbol_c* type,

   331

    		symbol_c* value) {

   332

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

   333

      if (vartype == search_var_instance_decl_c::external_vt) {

   334

        symbolic_variable_c *variable = dynamic_cast<symbolic_variable_c *>(symbol);

   335

        /* TODO Find a solution for forcing global complex variables */

   336

        if (variable != NULL) {

   337

          s4o.print(SET_EXTERNAL);

   338

          s4o.print("(");

   339

          variable->var_name->accept(*this);

   340

          s4o.print(",");

   341

        }

   342

        else {

   343

          s4o.print(SET_COMPLEX_EXTERNAL);

   344

          s4o.print("(");

   345

        }

   346

      }

   347

      else {

   348

        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

   355

      wanted_variablegeneration = complextype_base_vg;

   356

      symbol->accept(*this);

   357

      s4o.print(",");

   358

      wanted_variablegeneration = expression_vg;

   359

      print_check_function(type, value, NULL, true);

   360

      if (search_varfb_instance_type->type_is_complex()) {

   361

        s4o.print(",");

   362

        wanted_variablegeneration = complextype_suffix_vg;

   363

        symbol->accept(*this);

   364

      }

   365

      s4o.print(")");

   366

      wanted_variablegeneration = expression_vg;

   367

      return NULL;

   368

    }

   369

   370

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

   371

    /* B 1.4 - Variables */

   372

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

   373

    void *visit(symbolic_variable_c *symbol) {

   374

      unsigned int vartype;

   383

      return NULL;

   384

    }

   385

   386

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

   387

    /* B.1.4.1   Directly Represented Variables */

   388

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

   389

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

   390

    void *visit(direct_variable_c *symbol) {

   391

      TRACE("direct_variable_c");

   401

      return NULL;

   402

    }

   403

   404

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

   405

    /* B.1.4.2   Multi-element Variables */

   406

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

   407

   408

    // SYM_REF2(structured_variable_c, record_variable, field_selector)

   409

    void *visit(structured_variable_c *symbol) {

   410

      TRACE("structured_variable_c");

   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) {

   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

    /* | il_simple_operator [il_operand] */

   473

    //SYM_REF2(il_simple_operation_c, il_simple_operator, il_operand)

   474

    void *visit(il_simple_operation_c *symbol) {

   475

      this->current_operand = symbol->il_operand;

   476

      if (NULL == this->current_operand) {

   477

        this->current_operand_type = NULL;

   478

      } else {

   479

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

   480

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

   481

      }

   482

   483

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

   484

   485

      this->current_operand = NULL;

   486

      this->current_operand_type = NULL;

   487

      return NULL;

   488

    }

   489

   490

    void *visit(il_function_call_c *symbol) {

   491

      symbol_c* function_type_prefix = NULL;

   492

      symbol_c* function_name = NULL;     

   493

      symbol_c* function_type_suffix = NULL;

   494

      DECLARE_PARAM_LIST()

   495

   496

      symbol_c *param_data_type = default_variable_name.current_type;

   497