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

 * This code is made available on the understanding that it will not be

    21

 * used in safety-critical situations without a full and competent review.

    22

 *

    23

 * Based on the

    24

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    25

 *

    26

 */

    27

    28

    29

    30

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

    31

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

    32

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

    33

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

    34

    35

class search_location_type_c: public iterator_visitor_c {

    36

    37

  public:

    38

    typedef enum {

    39

      none_lt,

    40

      input_lt,

    41

      output_lt,

    42

      memory_lt

    43

    } locationtype_t;

    44

    45

    locationtype_t current_location_type;

    46

    47

  public:

    48

    search_location_type_c(void) {}

    49

    50

    virtual ~search_location_type_c(void) {}

    51

    52

    locationtype_t get_location_type(symbol_c *symbol) {

    53

      current_location_type = none_lt;

    54

      symbol->accept(*this);

    55

      if (current_location_type == none_lt) ERROR;

    56

      return current_location_type;

    57

    }

    58

    59

  private:

    60

    61

    void *visit(incompl_location_c* symbol) {

    62

      if (symbol->value[1] == 'I')

    63

        current_location_type = input_lt;

    64

     else if (symbol->value[1] == 'Q')

    65

        current_location_type = output_lt;

    66

     else if (symbol->value[1] == 'M')

    67

        current_location_type = memory_lt;

    68

      return NULL;

    69

    }

    70

    71

    void *visit(direct_variable_c *symbol) {

    72

      if (symbol->value[1] == 'I')

    73

        current_location_type = input_lt;

    74

     else if (symbol->value[1] == 'Q')

    75

        current_location_type = output_lt;

    76

     else if (symbol->value[1] == 'M')

    77

        current_location_type = memory_lt;

    78

      return NULL;

    79

    }

    80

};

    81

    82

    83

    84

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

    85

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

    86

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

    87

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

    88

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

    89

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

    90

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

    91

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

    92

    93

    94

class search_type_symbol_c: public iterator_visitor_c {

    95

    96

  public:

    97

    typedef enum {

    98

      none_vtc,

    99

      variable_vtc,

   100

      array_vtc,

   101

      structure_vtc,

   102

      function_block_vtc

   103

    } vartypecategory_t;

   104

   105

    vartypecategory_t current_var_type_category;

   106

   107

  private:

   108

    symbol_c *current_var_type_symbol;

   109

    symbol_c *current_var_type_name;

   110

    search_fb_typedecl_c *search_fb_typedecl;

   111

   112

  public:

   113

    search_type_symbol_c(symbol_c *scope) {

   114

      search_fb_typedecl = new search_fb_typedecl_c(scope);

   115

    }

   116

   117

    virtual ~search_type_symbol_c(void) {

   118

      delete search_fb_typedecl;

   119

    }

   120

   121

    symbol_c *get_type_symbol(symbol_c* symbol) {

   122

      this->current_var_type_category = variable_vtc;

   123

      this->current_var_type_symbol = NULL;

   124

      this->current_var_type_name = NULL;

   125

   126

      symbol_c* var_type_symbol = spec_init_sperator_c::get_spec(symbol);

   127

      if (var_type_symbol == NULL) {

   128

        var_type_symbol = symbol;

   129

      }

   130

   131

      var_type_symbol->accept(*this);

   132

   133

      if (this->current_var_type_symbol == NULL)

   134

    	this->current_var_type_symbol = var_type_symbol;

   135

   136

      return (this->current_var_type_symbol);

   137

    }

   138

   139

    symbol_c *get_current_type_name(void) {

   140

      if (this->current_var_type_name == NULL)

   141

    	return (this->current_var_type_symbol);

   142

   143

      return (this->current_var_type_name);

   144

    }

   145

   146

    void *visit(identifier_c* symbol) {

   147

      if (this->current_var_type_name == NULL) {

   148

        this->current_var_type_name = symbol;

   149

   150

        this->current_var_type_symbol = search_fb_typedecl->get_decl(this->current_var_type_name);

   151

        if (this->current_var_type_symbol != NULL)

   152

          this->current_var_type_category = function_block_vtc;

   153

   154

        else {

   156

          this->current_var_type_symbol->accept(*this);

   157

        }

   158

      }

   159

      return NULL;

   160

    }

   161

   162

    void *visit(array_specification_c* symbol) {

   163

      this->current_var_type_category = array_vtc;

   164

   165

      if (this->current_var_type_name == NULL)

   166

        this->current_var_type_name = symbol->non_generic_type_name;

   167

   168

      return NULL;

   169

    }

   170

   171

    void *visit(structure_element_declaration_list_c* symbol) {

   172

      this->current_var_type_category = structure_vtc;

   173

      return NULL;

   174

    }

   175

   176

};

   177

   178

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

   179

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

   180

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

   181

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

   182

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

   183

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

   184

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

   185

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

   186

   187

class generate_var_list_c: protected generate_c_typedecl_c {

   188

   189

  public:

   190

    typedef struct

   191

    {

   192

      symbol_c *symbol;

   193

    } SYMBOL;

   194

   195

    typedef enum {

   196

      none_dt,

   197

      programs_dt,

   198

      variables_dt

   199

    } declarationtype_t;

   200

   201

    declarationtype_t current_declarationtype;

   202

   203

    typedef enum {

   204

      none_vcc,

   205

      external_vcc,

   206

      located_input_vcc,

   207

      located_memory_vcc,

   208

      located_output_vcc

   209

    } varclasscategory_t;

   210

   211

    varclasscategory_t current_var_class_category;

   212

   213

  private:

   214

    symbol_c *current_var_type_symbol;

   215

    symbol_c *current_var_type_name;

   216

    unsigned int current_var_number;

   217

    unsigned int step_number;

   218

    unsigned int transition_number;

   219

    unsigned int action_number;

   220

    bool configuration_defined;

   221

    std::list<SYMBOL> current_symbol_list;

   222

    search_type_symbol_c *search_type_symbol;

   223

   224

  public:

   225

    generate_var_list_c(stage4out_c *s4o_ptr, symbol_c *scope)

   226

    : generate_c_typedecl_c(s4o_ptr) {

   227

      search_type_symbol = new search_type_symbol_c(scope);

   228

      current_var_number = 0;

   229

      current_var_type_symbol = NULL;

   230

      current_var_type_name = NULL;

   231

      current_declarationtype = none_dt;

   232

      current_var_class_category = none_vcc;

   233

    }

   234

   235

    ~generate_var_list_c(void) {

   236

      delete search_type_symbol;

   237

    }

   238

   239

    void update_var_type_symbol(symbol_c *symbol) {

   240

      this->current_var_type_symbol = search_type_symbol->get_type_symbol(symbol);

   241

      this->current_var_type_name = search_type_symbol->get_current_type_name();

   242

    }

   243

   244

    void reset_var_type_symbol(void) {

   245

      this->current_var_type_symbol = NULL;

   246

    }

   247

   248

    void generate_programs(symbol_c *symbol) {

   249

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

   250

      current_var_number = 0;

   251

      configuration_defined = false;

   252

      current_declarationtype = programs_dt;

   253

      symbol->accept(*this);

   254

      current_declarationtype = none_dt;

   255

      s4o.print("\n");

   256

    }

   257

   258

    void generate_variables(symbol_c *symbol) {

   259

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

   260

      current_var_number = 0;

   261

      configuration_defined = false;

   262

      current_declarationtype = variables_dt;

   263

      symbol->accept(*this);

   264

      current_declarationtype = none_dt;

   265

      s4o.print("\n");

   266

    }

   267

   268

    void declare_variables(symbol_c *symbol) {

   269

      list_c *list = dynamic_cast<list_c *>(symbol);

   270

      /* should NEVER EVER occur!! */

   271

      if (list == NULL) ERROR;

   272

   273

      for(int i = 0; i < list->n; i++) {

   274

        declare_variable(list->elements[i]);

   275

      }

   276

    }

   277

   278

    void declare_variable(symbol_c *symbol) {

   279

      // Arrays and structures are not supported in debugging

   280

      switch (search_type_symbol->current_var_type_category) {

   281

          case search_type_symbol_c::array_vtc:

   282

          case search_type_symbol_c::structure_vtc:

   283

          return;

   284

          default:

   285

           break;

   286

      }

   287

      print_var_number();

   288

      s4o.print(";");

   289

      switch (search_type_symbol->current_var_type_category) {

   290

        case search_type_symbol_c::array_vtc:

   291

          s4o.print("ARRAY");

   292

          break;

   293

        case search_type_symbol_c::structure_vtc:

   294

          s4o.print("STRUCT");

   295

          break;

   296

        case search_type_symbol_c::function_block_vtc:

   297

          s4o.print("FB");

   298

          break;

   299

        default:

   300

          switch (this->current_var_class_category) {

   301

            case external_vcc:

   302

             s4o.print("EXT");

   303

             break;

   304

            case located_input_vcc:

   305

             s4o.print("IN");

   306

             break;

   307

            case located_memory_vcc:

   308

             s4o.print("MEM");

   309

             break;

   310

            case located_output_vcc:

   311

             s4o.print("OUT");

   312

             break;

   313

            default:

   314

             s4o.print("VAR");

   315

             break;

   316

          }

   317

          break;

   318

      }

   319

      s4o.print(";");

   320

      print_symbol_list();

   321

      symbol->accept(*this);

   322

      s4o.print(";");

   323

      print_symbol_list();

   324

      symbol->accept(*this);

   325

      s4o.print(";");

   326

      switch (search_type_symbol->current_var_type_category) {

   327

        case search_type_symbol_c::structure_vtc:

   328

        case search_type_symbol_c::function_block_vtc:

   329

          this->current_var_type_name->accept(*this);

   330

          s4o.print(";\n");

   331

          SYMBOL *current_name;

   332

          symbol_c *tmp_var_type;

   333

          current_name = new SYMBOL;

   334

          current_name->symbol = symbol;

   335

          tmp_var_type = this->current_var_type_symbol;

   336

          current_symbol_list.push_back(*current_name);

   337

          this->current_var_type_symbol->accept(*this);

   338

          current_symbol_list.pop_back();

   339

          this->current_var_type_symbol = tmp_var_type;

   340

          break;

   341

        case search_type_symbol_c::array_vtc:

   342

          this->current_var_type_name->accept(*this);

   343

          s4o.print(";\n");

   344

          break;

   345

        default:

   346

          this->current_var_type_symbol->accept(*this);

   347

          s4o.print(";\n");

   348

          break;

   349

      }

   350

    }

   351

   352

    void print_var_number(void) {

   353

      char str[10];

   354

      sprintf(str, "%d", current_var_number);

   355

      s4o.print(str);

   356

      current_var_number++;

   357

    }

   358

   359

    void print_step_number(void) {

   360

      char str[10];

   361

      sprintf(str, "%d", step_number);

   362

      s4o.print(str);

   363

    }

   364

   365

    void print_transition_number(void) {

   366

      char str[10];

   367

      sprintf(str, "%d", transition_number);

   368

      s4o.print(str);

   369

    }

   370

   371

    void print_action_number(void) {

   372

      char str[10];

   373

      sprintf(str, "%d", action_number);

   374

      s4o.print(str);

   375

    }

   376

   377

    void print_symbol_list(void) {

   378

      std::list<SYMBOL>::iterator pt;

   379

      for(pt = current_symbol_list.begin(); pt != current_symbol_list.end(); pt++) {

   380

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

   381

        s4o.print(".");

   382

      }

   383

    }

   384

   385

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

   386

/* B.1.4.3 - Declaration and initialization */

   387

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

   388

   389

    /*  [variable_name] location ':' located_var_spec_init */

   390

    /* variable_name -> may be NULL ! */

   391

    //SYM_REF4(located_var_decl_c, variable_name, location, located_var_spec_init, unused)

   392

    void *visit(located_var_decl_c *symbol) {

   393

        /* Start off by setting the current_var_type_symbol and

   394

         * current_var_init_symbol private variables...

   395

         */

   396

        update_var_type_symbol(symbol->located_var_spec_init);

   397

   398

        search_location_type_c search_location_type;

   399

        switch (search_location_type.get_location_type(symbol->location)) {

   400

          case search_location_type_c::input_lt:

   401

            this->current_var_class_category = located_input_vcc;

   402

            break;

   403

          case search_location_type_c::memory_lt:

   404

            this->current_var_class_category = located_memory_vcc;

   405

            break;

   406

          case search_location_type_c::output_lt:

   407

              this->current_var_class_category = located_output_vcc;

   408

              break;

   409

          default:

   410

            ERROR;

   411

            break;

   412

        }

   413

   414

        if (symbol->variable_name != NULL)

   415

          declare_variable(symbol->variable_name);

   416

        else

   417

          declare_variable(symbol->location);

   418

   419

        this->current_var_class_category = none_vcc;

   420

   421

        /* Values no longer in scope, and therefore no longer used.

   422

         * Make an effort to keep them set to NULL when not in use

   423

         * in order to catch bugs as soon as possible...

   424

         */

   425

        reset_var_type_symbol();

   426

        return NULL;

   427

    }

   428

   429

    /* variable_name incompl_location ':' var_spec */

   430

    /* variable_name -> may be NULL ! */

   431

    //SYM_REF3(incompl_located_var_decl_c, variable_name, incompl_location, var_spec)

   432

    void *visit(incompl_located_var_decl_c *symbol) {

   433

        /* Start off by setting the current_var_type_symbol and

   434

         * current_var_init_symbol private variables...

   435

         */

   436

        update_var_type_symbol(symbol->var_spec);

   437

   438

        search_location_type_c search_location_type;

   439

        switch (search_location_type.get_location_type(symbol->incompl_location)) {

   440

          case search_location_type_c::input_lt:

   441

            this->current_var_class_category = located_input_vcc;

   442

            break;

   443

          case search_location_type_c::memory_lt:

   444

            this->current_var_class_category = located_memory_vcc;

   445

            break;

   446

          case search_location_type_c::output_lt:

   447

            this->current_var_class_category = located_output_vcc;

   448

            break;

   449

          default:

   450

            ERROR;

   451

            break;

   452

        }

   453

   454

        if (symbol->variable_name != NULL)

   455

          declare_variable(symbol->variable_name);

   456

        else

   457

          declare_variable(symbol->incompl_location);

   458

   459

        this->current_var_class_category = none_vcc;

   460

   461

        /* Values no longer in scope, and therefore no longer used.

   462

        * Make an effort to keep them set to NULL when not in use

   463

        * in order to catch bugs as soon as possible...

   464

        */

   465

       reset_var_type_symbol();

   466

        return NULL;

   467

    }

   468

   469

    /*  var1_list ':' array_spec_init */

   470

    // SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   471

    void *visit(array_var_init_decl_c *symbol) {

   472

      TRACE("array_var_init_decl_c");

   473

      /* Start off by setting the current_var_type_symbol and

   474

       * current_var_init_symbol private variables...

   475

       */

   476

      update_var_type_symbol(symbol->array_spec_init);

   477

   478

      declare_variables(symbol->var1_list);

   479

   480

      /* Values no longer in scope, and therefore no longer used.

   481

       * Make an effort to keep them set to NULL when not in use

   482

       * in order to catch bugs as soon as possible...

   483

       */

   484

      reset_var_type_symbol();

   485

   486

      return NULL;

   487

    }

   488

   489

    /*  var1_list ':' array_specification */

   490

    //SYM_REF2(array_var_declaration_c, var1_list, array_specification)

   491

    void *visit(array_var_declaration_c *symbol) {

   492

       TRACE("array_var_declaration_c");

   493

       /* Start off by setting the current_var_type_symbol and

   494

        * current_var_init_symbol private variables...

   495

        */

   496

       update_var_type_symbol(symbol->array_specification);

   497