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

    28

class generate_c_inlinefcall_c: public generate_c_typedecl_c {

    29

    30

  public:

    31

    typedef enum {

    32

      expression_vg,

    33

      assignment_vg,

    34

      complextype_base_vg,

    35

      complextype_suffix_vg

    36

    } variablegeneration_t;

    37

    38

  private:

    39

    40

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

    41

	#define IL_DEFVAR   VAR_LEADER "IL_DEFVAR"

    42

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

    43

	 * parenthesised instruction list to the immediately preceding

    44

	 * scope ...

    45

	 */

    46

	il_default_variable_c default_variable_name;

    47

    48

	symbol_c* current_array_type;

    49

    50

	int fcall_number;

    51

	symbol_c *fbname;

    52

    53

    search_expression_type_c *search_expression_type;

    54

    55

    search_varfb_instance_type_c *search_varfb_instance_type;

    56

    57

    search_base_type_c search_base_type;

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

    64

      default_variable_name(IL_DEFVAR, NULL)

    65

    {

    66

      search_expression_type = new search_expression_type_c(scope);

    67

      search_varfb_instance_type = new search_varfb_instance_type_c(scope);

    68

      this->set_variable_prefix(variable_prefix);

    69

      fcall_number = 0;

    70

      fbname = name;

    71

      wanted_variablegeneration = expression_vg;

    72

    }

    73

    74

    virtual ~generate_c_inlinefcall_c(void) {

    75

      delete search_expression_type;

    76

      delete search_varfb_instance_type;

    77

    }

    78

    79

    void print(symbol_c* symbol) {

    80

      function_call_iterator_c fc_iterator(symbol);

    81

      symbol_c* function_call;

    82

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

    83

    	function_call->accept(*this);

    84

      }

    85

    }

    86

    89

    void generate_inline(symbol_c *function_name,

    90

            symbol_c *function_type_prefix,

    91

            symbol_c *function_type_suffix,

    94

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

    95

    96

      fcall_number++;

    97

      function_type_prefix = search_expression_type->default_literal_type(function_type_prefix);

    98

      if (function_type_suffix) {

    99

        function_type_suffix = search_expression_type->default_literal_type(function_type_suffix);

   100

      }

   101

   102

      s4o.print(s4o.indent_spaces);

   103

      s4o.print("inline ");

   104

      function_type_prefix->accept(*this);

   105

      s4o.print(" __");

   106

      fbname->accept(*this);

   107

      s4o.print("_");

   108

      function_name->accept(*this);

   114

      if (function_type_suffix) {

   116

      }

   117

      s4o.print_integer(fcall_number);

   118

      s4o.print("(");

   119

      s4o.indent_right();

   120

   121

      PARAM_LIST_ITERATOR() {

   122

        if (PARAM_DIRECTION == function_param_iterator_c::direction_in) {

   123

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

   124

          s4o.print(" ");

   125

          PARAM_NAME->accept(*this);

   126

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

   127

        }

   128

      }

   129

      fbname->accept(*this);

   135

      s4o.indent_right();

   136

   137

      s4o.print(s4o.indent_spaces);

   138

      function_type_prefix->accept(*this);

   139

      s4o.print(" "),

   140

      s4o.print(INLINE_RESULT_TEMP_VAR);

   141

      s4o.print(";\n");

   142

   149

          s4o.print(" ");

   150

          s4o.print(TEMP_VAR);

   151

          PARAM_NAME->accept(*this);

   152

          s4o.print(" = ");

   153

          print_check_function(PARAM_TYPE, PARAM_VALUE);

   154

          s4o.print(";\n");

   168

        function_type_suffix->accept(*this);

   178

          s4o.print("&");

   179

          s4o.print(TEMP_VAR);

   180

          PARAM_NAME->accept(*this);

   189

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

   192

          s4o.print(s4o.indent_spaces);

   193

          print_setter(PARAM_VALUE, PARAM_TYPE, PARAM_NAME);

   194

          s4o.print(";\n");

   200

   201

      s4o.indent_left();

   202

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

   203

    }

   204

   205

  private:

   206

   207

    void *print_getter(symbol_c *symbol) {

   208

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

   209

      if (vartype == search_var_instance_decl_c::external_vt)

   210

    	s4o.print(GET_EXTERNAL);

   211

      else if (vartype == search_var_instance_decl_c::located_vt)

   212

    	s4o.print(GET_LOCATED);

   213

      else

   214

    	s4o.print(GET_VAR);

   215

      s4o.print("(");

   216

   217

      wanted_variablegeneration = complextype_base_vg;

   218

      symbol->accept(*this);

   219

      if (search_varfb_instance_type->type_is_complex())

   220

    	s4o.print(",");

   221

      wanted_variablegeneration = complextype_suffix_vg;

   222

      symbol->accept(*this);

   223

      s4o.print(")");

   224

      wanted_variablegeneration = expression_vg;

   225

      return NULL;

   226

    }

   227

   228

    void *print_setter(symbol_c* symbol,

   229

    		symbol_c* type,

   230

    		symbol_c* value) {

   231

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

   232

      if (vartype == search_var_instance_decl_c::external_vt) {

   233

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

   234

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

   235

        if (variable != NULL) {

   236

          s4o.print(SET_EXTERNAL);

   237

          s4o.print("(");

   238

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

   239

          s4o.print(",");

   240

        }

   241

        else {

   242

          s4o.print(SET_COMPLEX_EXTERNAL);

   243

          s4o.print("(");

   244

        }

   245

      }

   246

      else {

   247

        if (vartype == search_var_instance_decl_c::located_vt)

   248

          s4o.print(SET_LOCATED);

   249

        else

   250

          s4o.print(SET_VAR);

   251

        s4o.print("(");

   252

      }

   253

   254

      wanted_variablegeneration = complextype_base_vg;

   255

      symbol->accept(*this);

   256

      s4o.print(",");

   257

      wanted_variablegeneration = expression_vg;

   258

      print_check_function(type, value, NULL, true);

   259

      if (search_varfb_instance_type->type_is_complex()) {

   260

        s4o.print(",");

   261

        wanted_variablegeneration = complextype_suffix_vg;

   262

        symbol->accept(*this);

   263

      }

   264

      s4o.print(")");

   265

      wanted_variablegeneration = expression_vg;

   266

      return NULL;

   267

    }

   268

   269

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

   270

    /* B 1.4 - Variables */

   271

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

   272

    void *visit(symbolic_variable_c *symbol) {

   273

      unsigned int vartype;

   274

      if (wanted_variablegeneration == complextype_base_vg)

   275

        generate_c_base_c::visit(symbol);

   276

      else if (wanted_variablegeneration == complextype_suffix_vg)

   277

        return NULL;

   278

      else

   279

        print_getter(symbol);

   280

      return NULL;

   281

    }

   282

   283

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

   284

    /* B.1.4.1   Directly Represented Variables */

   285

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

   286

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

   287

    void *visit(direct_variable_c *symbol) {

   288

      TRACE("direct_variable_c");

   289

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

   290

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

   291

      s4o.print(GET_LOCATED);

   292

      s4o.print("(");

   293

      this->print_variable_prefix();

   294

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

   295

      s4o.print(")");

   296

      return NULL;

   297

    }

   298

   299

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

   300

    /* B.1.4.2   Multi-element Variables */

   301

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

   302

   303

    // SYM_REF2(structured_variable_c, record_variable, field_selector)

   304

    void *visit(structured_variable_c *symbol) {

   305

      TRACE("structured_variable_c");

   306

      switch (wanted_variablegeneration) {

   307

        case complextype_base_vg:

   308

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

   309

          break;

   310

        case complextype_suffix_vg:

   311

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

   312

          s4o.print(".");

   313

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

   314

          break;

   315

        default:

   316

          print_getter(symbol);

   317

          break;

   318

      }

   319

      return NULL;

   320

    }

   321

   322

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

   323

    //SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   324

    void *visit(array_variable_c *symbol) {

   325

      switch (wanted_variablegeneration) {

   326

        case complextype_base_vg:

   327

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

   328

          break;

   329

        case complextype_suffix_vg:

   330

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

   331

   332

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

   333

          if (current_array_type == NULL) ERROR;

   334

   335

          s4o.print(".table");

   336

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

   337

   338

          current_array_type = NULL;

   339

          break;

   340

        default:

   341

          print_getter(symbol);

   342

          break;

   343

      }

   344

      return NULL;

   345

    }

   346

   347

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

   348

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

   349

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

   350

   351

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

   352

    /* B 2.1 Instructions and Operands */

   353

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

   354

   355

    void *visit(il_function_call_c *symbol) {

   356

      symbol_c* function_type_prefix = NULL;

   358

      symbol_c* function_type_suffix = NULL;

   359

      DECLARE_PARAM_LIST()

   360

   361

      symbol_c *param_data_type = default_variable_name.current_type;

   362

   363

      function_call_param_iterator_c function_call_param_iterator(symbol);

   364

   463

      if (NULL == function_type_prefix) ERROR;

   464

   465

      bool has_output_params = false;

   466

   467

      PARAM_LIST_ITERATOR() {

   468

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

   469

             PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&

   470

             PARAM_VALUE != NULL) {

   471

          has_output_params = true;

   472

        }

   473

      }

   474

   483

      if (has_output_params)

   485

   486

      CLEAR_PARAM_LIST()

   487

   488

      return NULL;

   489

    }

   490

   491

    /* | function_name '(' eol_list [il_param_list] ')' */

   492

    // SYM_REF2(il_formal_funct_call_c, function_name, il_param_list)

   493

    void *visit(il_formal_funct_call_c *symbol) {

   494

      symbol_c* function_type_prefix = NULL;

   495

      symbol_c* function_name = NULL;

   496

      symbol_c* function_type_suffix = NULL;

   497

      DECLARE_PARAM_LIST()

   498

   499