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 {

   155

          this->current_var_type_symbol = search_base_type_c::get_basetype_decl(this->current_var_type_name);

   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

      symbol_c *symbol;

   192

    } SYMBOL;

   193

   194

    typedef enum {

   195

      none_dt,

   196

      programs_dt,

   197

      variables_dt

   198

    } declarationtype_t;

   199

   200

    declarationtype_t current_declarationtype;

   201

   202

    typedef enum {

   203

      none_vcc,

   204

      external_vcc,

   205

      located_input_vcc,

   206

      located_memory_vcc,

   207

      located_output_vcc

   208

    } varclasscategory_t;

   209

   210

    varclasscategory_t current_var_class_category;

   211

   212

  private:

   213

    symbol_c *current_var_type_symbol;

   214

    symbol_c *current_var_type_name;

   215

    unsigned int current_var_number;

   216

    unsigned int step_number;

   217

    unsigned int transition_number;

   218

    unsigned int action_number;

   219

    bool configuration_defined;

   220

    std::list<SYMBOL> current_symbol_list;

   221

    search_type_symbol_c *search_type_symbol;

   222

   223

  public:

   224

    generate_var_list_c(stage4out_c *s4o_ptr, symbol_c *scope)

   225

    : generate_c_typedecl_c(s4o_ptr) {

   226

      search_type_symbol = new search_type_symbol_c(scope);

   227

      current_var_number = 0;

   228

      current_var_type_symbol = NULL;

   229

      current_var_type_name = NULL;

   230

      current_declarationtype = none_dt;

   231

      current_var_class_category = none_vcc;

   232

    }

   233

   234

    ~generate_var_list_c(void) {

   235

      delete search_type_symbol;

   236

    }

   237

   238

    void update_var_type_symbol(symbol_c *symbol) {

   239

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

   240

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

   241

    }

   242

   243

    void reset_var_type_symbol(void) {

   244

      this->current_var_type_symbol = NULL;

   245

    }

   246

   247

    void generate_programs(symbol_c *symbol) {

   248

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

   249

      current_var_number = 0;

   250

      configuration_defined = false;

   251

      current_declarationtype = programs_dt;

   252

      symbol->accept(*this);

   253

      current_declarationtype = none_dt;

   254

      s4o.print("\n");

   255

    }

   256

   257

    void generate_variables(symbol_c *symbol) {

   258

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

   259

      current_var_number = 0;

   260

      configuration_defined = false;

   261

      current_declarationtype = variables_dt;

   262

      symbol->accept(*this);

   263

      current_declarationtype = none_dt;

   264

      s4o.print("\n");

   265

    }

   266

   267

    void declare_variables(symbol_c *symbol) {

   268

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

   269

      /* should NEVER EVER occur!! */

   270

      if (list == NULL) ERROR;

   271

   272

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

   273

        declare_variable(list->elements[i]);

   274

      }

   275

    }

   276

   277

    void declare_variable(symbol_c *symbol) {

   278

      // Arrays and structures are not supported in debugging

   279

      switch (search_type_symbol->current_var_type_category) {

   280

          case search_type_symbol_c::array_vtc:

   281

          case search_type_symbol_c::structure_vtc:

   282

          return;

   283

          default:

   284

           break;

   285

      }

   286

      print_var_number();

   287

      s4o.print(";");

   288

      switch (search_type_symbol->current_var_type_category) {

   289

        case search_type_symbol_c::array_vtc:

   290

          s4o.print("ARRAY");

   291

          break;

   292

        case search_type_symbol_c::structure_vtc:

   293

          s4o.print("STRUCT");

   294

          break;

   295

        case search_type_symbol_c::function_block_vtc:

   296

          s4o.print("FB");

   297

          break;

   298

        default:

   299

          switch (this->current_var_class_category) {

   300

            case external_vcc:

   301

             s4o.print("EXT");

   302

             break;

   303

            case located_input_vcc:

   304

             s4o.print("IN");

   305

             break;

   306

            case located_memory_vcc:

   307

             s4o.print("MEM");

   308

             break;

   309

            case located_output_vcc:

   310

             s4o.print("OUT");

   311

             break;

   312

            default:

   313

             s4o.print("VAR");

   314

             break;

   315

          }

   316

          break;

   317

      }

   318

      s4o.print(";");

   319

      print_symbol_list();

   320

      symbol->accept(*this);

   321

      s4o.print(";");

   322

      print_symbol_list();

   323

      symbol->accept(*this);

   324

      s4o.print(";");

   325

      switch (search_type_symbol->current_var_type_category) {

   326

        case search_type_symbol_c::structure_vtc:

   327

        case search_type_symbol_c::function_block_vtc:

   328

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

   329

          s4o.print(";\n");

   330

          if (this->current_var_class_category != external_vcc) {

   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

          }

   341

          break;

   342

        case search_type_symbol_c::array_vtc:

   343

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

   344

          s4o.print(";\n");

   345

          break;

   346

        default:

   347

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

   348

          s4o.print(";\n");

   349

          break;

   350

      }

   351

    }

   352

   353

    void print_var_number(void) {

   354

      char str[10];

   355

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

   356

      s4o.print(str);

   357

      current_var_number++;

   358

    }

   359

   360

    void print_step_number(void) {

   361

      char str[10];

   362

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

   363

      s4o.print(str);

   364

    }

   365

   366

    void print_transition_number(void) {

   367

      char str[10];

   368

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

   369

      s4o.print(str);

   370

    }

   371

   372

    void print_action_number(void) {

   373

      char str[10];

   374

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

   375

      s4o.print(str);

   376

    }

   377

   378

    void print_symbol_list() {

   379

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

   380

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

   381

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

   382

        s4o.print(".");

   383

      }

   384

    }

   385

   386

   387

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

   388

/* B 1.3.3 - Derived data types */

   389

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

   390

    /*  enumerated_type_name ':' enumerated_spec_init */

   391

    void *visit(enumerated_type_declaration_c *symbol) {

   392

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

   393

      return NULL;

   394

    }

   395

   396

    /* enumerated_specification ASSIGN enumerated_value */

   397

    void *visit(enumerated_spec_init_c *symbol) {

   398

      /* search_base_type_c now returns an enumerated_type_declaration_c as the base type of a non-anonymous enumerated type

   399

       * (non-anonymous means it is declared inside a TYPE ... END_TYPE declaration, with a given name/identifier

   400

       *  unlike implicitly defined anonymous datatypes declared inside VAR ... END_VAR declarations!).

   401

       * This means that this method should not get called.

   402

       */

   403

      ERROR;  

   404

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

   405

      return NULL;

   406

    }

   407

   408

    /* enumerated_value_list ',' enumerated_value */

   409

    void *visit(enumerated_value_list_c *symbol) {

   410

      /* search_base_type_c now returns an enumerated_type_declaration_c as the base type of a non-anonymous enumerated type

   411

       * (non-anonymous means it is declared inside a TYPE ... END_TYPE declaration, with a given name/identifier

   412

       *  unlike implicitly defined anonymous datatypes declared inside VAR ... END_VAR declarations!).

   413

       * This means that this method should not get called.

   414

       */

   415

      ERROR;

   416

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

   417

      return NULL;

   418

    }

   419

   420

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

   421

/* B.1.4.3 - Declaration and initialization */

   422

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

   423

   424

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

   425

    /* variable_name -> may be NULL ! */

   426

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

   427

    void *visit(located_var_decl_c *symbol) {

   428

        /* Start off by setting the current_var_type_symbol and

   429

         * current_var_init_symbol private variables...

   430

         */

   431

        update_var_type_symbol(symbol->located_var_spec_init);

   432

   433

        search_location_type_c search_location_type;

   434

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

   435

          case search_location_type_c::input_lt:

   436

            this->current_var_class_category = located_input_vcc;

   437

            break;

   438

          case search_location_type_c::memory_lt:

   439

            this->current_var_class_category = located_memory_vcc;

   440

            break;

   441

          case search_location_type_c::output_lt:

   442

              this->current_var_class_category = located_output_vcc;

   443

              break;

   444

          default:

   445

            ERROR;

   446

            break;

   447

        }

   448

   449

        if (symbol->variable_name != NULL)

   450

          declare_variable(symbol->variable_name);

   451

        else

   452

          declare_variable(symbol->location);

   453

   454

        this->current_var_class_category = none_vcc;

   455

   456

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

   457

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

   458

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

   459

         */

   460

        reset_var_type_symbol();

   461

        return NULL;

   462

    }

   463

   464

    /* variable_name incompl_location ':' var_spec */

   465

    /* variable_name -> may be NULL ! */

   466

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

   467

    void *visit(incompl_located_var_decl_c *symbol) {

   468

        /* Start off by setting the current_var_type_symbol and

   469

         * current_var_init_symbol private variables...

   470

         */

   471

        update_var_type_symbol(symbol->var_spec);

   472

   473

        search_location_type_c search_location_type;

   474

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

   475

          case search_location_type_c::input_lt:

   476

            this->current_var_class_category = located_input_vcc;

   477

            break;

   478

          case search_location_type_c::memory_lt:

   479

            this->current_var_class_category = located_memory_vcc;

   480

            break;

   481

          case search_location_type_c::output_lt:

   482

            this->current_var_class_category = located_output_vcc;

   483

            break;

   484

          default:

   485

            ERROR;

   486

            break;

   487

        }

   488

   489

        if (symbol->variable_name != NULL)

   490

          declare_variable(symbol->variable_name);

   491

        else

   492

          declare_variable(symbol->incompl_location);

   493

   494

        this->current_var_class_category = none_vcc;

   495