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

/* TODO: Delete this helper class search_type_symbol_c, as well as the search_fb_typedecl_c

    94

 *       in the absyntac_utils directory. They are no longer usefull, now that we have

    95

 *       datatype analysis working!

    96

 */

    97

class search_type_symbol_c: public iterator_visitor_c {

    98

    99

  public:

   100

    typedef enum {

   101

      none_vtc,

   102

      variable_vtc,

   103

      array_vtc,

   104

      structure_vtc,

   105

      function_block_vtc

   106

    } vartypecategory_t;

   107

   108

    vartypecategory_t current_var_type_category;

   109

   110

  private:

   111

    symbol_c *current_var_type_symbol;

   112

    symbol_c *current_var_type_name;

   113

    search_fb_typedecl_c *search_fb_typedecl;

   114

   115

  public:

   116

    search_type_symbol_c(symbol_c *scope) {

   117

      search_fb_typedecl = new search_fb_typedecl_c(scope);

   118

    }

   119

   120

    virtual ~search_type_symbol_c(void) {

   121

      delete search_fb_typedecl;

   122

    }

   123

   124

    symbol_c *get_type_symbol(symbol_c* symbol) {

   125

      this->current_var_type_category = variable_vtc;

   126

      this->current_var_type_symbol = NULL;

   127

      this->current_var_type_name = NULL;

   128

   129

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

   130

      if (var_type_symbol == NULL) {

   131

        var_type_symbol = symbol;

   132

      }

   133

   134

      var_type_symbol->accept(*this);

   135

   136

      if (this->current_var_type_symbol == NULL)

   137

        this->current_var_type_symbol = var_type_symbol;

   138

   139

      return (this->current_var_type_symbol);

   140

    }

   141

   142

    symbol_c *get_current_type_name(void) {

   143

      if (this->current_var_type_name == NULL)

   144

        return (this->current_var_type_symbol);

   145

   146

      return (this->current_var_type_name);

   147

    }

   148

   149

    void *visit(derived_datatype_identifier_c* symbol) {

   150

      if (this->current_var_type_name == NULL) {

   151

        this->current_var_type_name = symbol;

   152

   153

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

   154

        if (this->current_var_type_symbol != NULL)

   155

          this->current_var_type_category = function_block_vtc;

   156

   157

        else {

   158

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

   159

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

   160

        }

   161

      }

   162

      return NULL;

   163

    }

   164

   165

    void *visit(poutype_identifier_c* symbol) {

   166

      if (this->current_var_type_name == NULL) {

   167

        this->current_var_type_name = symbol;

   168

   169

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

   170

        if (this->current_var_type_symbol != NULL)

   171

          this->current_var_type_category = function_block_vtc;

   172

   173

        else {

   174

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

   175

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

   176

        }

   177

      }

   178

      return NULL;

   179

    }

   180

   181

    void *visit(array_specification_c* symbol) {

   182

      this->current_var_type_category = array_vtc;

   183

   184

      if (this->current_var_type_name == NULL)

   185

        this->current_var_type_name = symbol->non_generic_type_name;

   186

   187

      return NULL;

   188

    }

   189

   190

    void *visit(structure_element_declaration_list_c* symbol) {

   191

      this->current_var_type_category = structure_vtc;

   192

      return NULL;

   193

    }

   194

   195

};

   196

   197

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

   198

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

   199

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

   200

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

   201

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

   202

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

   203

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

   204

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

   205

   206

class generate_var_list_c: protected generate_c_base_and_typeid_c {

   207

   208

  public:

   209

    typedef struct {

   210

      symbol_c *symbol;

   211

    } SYMBOL;

   212

   213

    typedef enum {

   214

      none_dt,

   215

      programs_dt,

   216

      variables_dt

   217

    } declarationtype_t;

   218

   219

    declarationtype_t current_declarationtype;

   220

   221

    typedef enum {

   222

      none_vcc,

   223

      external_vcc,

   224

      located_input_vcc,

   225

      located_memory_vcc,

   226

      located_output_vcc

   227

    } varclasscategory_t;

   228

   229

    varclasscategory_t current_var_class_category;

   230

   231

  private:

   232

    symbol_c *current_var_type_symbol;

   233

    symbol_c *current_var_type_name;

   234

    unsigned int current_var_number;

   235

    unsigned int step_number;

   236

    unsigned int transition_number;

   237

    unsigned int action_number;

   238

    bool configuration_defined;

   239

    std::list<SYMBOL> current_symbol_list;

   240

    search_type_symbol_c *search_type_symbol;

   241

    unsigned int is_retain;

   242

   243

  public:

   244

    generate_var_list_c(stage4out_c *s4o_ptr, symbol_c *scope)

   245

    : generate_c_base_and_typeid_c(s4o_ptr) {

   246

      search_type_symbol = new search_type_symbol_c(scope);

   247

      current_var_number = 0;

   248

      current_var_type_symbol = NULL;

   249

      current_var_type_name = NULL;

   250

      current_declarationtype = none_dt;

   251

      current_var_class_category = none_vcc;

   252

      is_retain = 0;

   253

    }

   254

   255

    ~generate_var_list_c(void) {

   256

      delete search_type_symbol;

   257

    }

   258

   259

    void update_var_type_symbol(symbol_c *symbol) {

   260

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

   261

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

   262

    }

   263

   264

    void reset_var_type_symbol(void) {

   265

      this->current_var_type_symbol = NULL;

   266

    }

   267

   268

    void generate_programs(symbol_c *symbol) {

   269

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

   270

      current_var_number = 0;

   271

      configuration_defined = false;

   272

      current_declarationtype = programs_dt;

   273

      symbol->accept(*this);

   274

      current_declarationtype = none_dt;

   275

      s4o.print("\n");

   276

    }

   277

   278

    void generate_variables(symbol_c *symbol) {

   279

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

   280

      current_var_number = 0;

   281

      configuration_defined = false;

   282

      current_declarationtype = variables_dt;

   283

      symbol->accept(*this);

   284

      current_declarationtype = none_dt;

   285

      s4o.print("\n");

   286

    }

   287

   288

    void declare_variables(symbol_c *symbol) {

   289

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

   290

      /* should NEVER EVER occur!! */

   291

      if (list == NULL) ERROR;

   292

   293

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

   294

        declare_variable(list->get_element(i));

   295

      }

   296

    }

   297

   298

    void declare_variable(symbol_c *symbol) {

   299

      // Arrays and structures are not supported in debugging

   300

      switch (search_type_symbol->current_var_type_category) {

   301

          case search_type_symbol_c::array_vtc:

   302

          case search_type_symbol_c::structure_vtc:

   303

          return;

   304

          default:

   305

           break;

   306

      }

   307

      print_var_number();

   308

      s4o.print(";");

   309

      switch (search_type_symbol->current_var_type_category) {

   310

        case search_type_symbol_c::array_vtc:

   311

          s4o.print("ARRAY");

   312

          break;

   313

        case search_type_symbol_c::structure_vtc:

   314

          s4o.print("STRUCT");

   315

          break;

   316

        case search_type_symbol_c::function_block_vtc:

   317

          s4o.print("FB");

   318

          break;

   319

        default:

   320

          switch (this->current_var_class_category) {

   321

            case external_vcc:

   322

             s4o.print("EXT");

   323

             break;

   324

            case located_input_vcc:

   325

             s4o.print("IN");

   326

             break;

   327

            case located_memory_vcc:

   328

             s4o.print("MEM");

   329

             break;

   330

            case located_output_vcc:

   331

             s4o.print("OUT");

   332

             break;

   333

            default:

   334

             s4o.print("VAR");

   335

             break;

   336

          }

   337

          break;

   338

      }

   339

      s4o.print(";");

   340

      print_symbol_list();

   341

      symbol->accept(*this);

   342

      s4o.print(";");

   343

      print_symbol_list();

   344

      symbol->accept(*this);

   345

      s4o.print(";");

   346

      switch (search_type_symbol->current_var_type_category) {

   347

        case search_type_symbol_c::structure_vtc:

   348

        case search_type_symbol_c::function_block_vtc:

   349

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

   350

          s4o.print(";;");

   351

          print_retain();

   352

          s4o.print(";\n");

   353

          if (this->current_var_class_category != external_vcc) {

   354

              SYMBOL *current_name;

   355

              symbol_c *tmp_var_type;

   356

              current_name = new SYMBOL;

   357

              current_name->symbol = symbol;

   358

              tmp_var_type = this->current_var_type_symbol;

   359

              current_symbol_list.push_back(*current_name);

   360

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

   361

              current_symbol_list.pop_back();

   362

              this->current_var_type_symbol = tmp_var_type;

   363

          }

   364

          break;

   365

        case search_type_symbol_c::array_vtc:

   366

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

   367

          s4o.print(";;");

   368

          print_retain();

   369

          s4o.print(";\n");

   370

          break;

   371

        default:

   372

          // base type name

   373

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

   374

          s4o.print(";");

   375

          // type name (eventualy derived)

   376

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

   377

          s4o.print(";");

   378

          print_retain();

   379

          s4o.print(";\n");

   380

          break;

   381

      }

   382

    }

   383

    void print_retain() {

   384

      if(is_retain)

   385

          s4o.print("1");

   386

      else

   387

          s4o.print("0");

   388

    }

   389

   390

    void print_var_number(void) {

   391

      char str[10];

   392

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

   393

      s4o.print(str);

   394

      current_var_number++;

   395

    }

   396

   397

    void print_step_number(void) {

   398

      char str[10];

   399

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

   400

      s4o.print(str);

   401

    }

   402

   403

    void print_transition_number(void) {

   404

      char str[10];

   405

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

   406

      s4o.print(str);

   407

    }

   408

   409

    void print_action_number(void) {

   410

      char str[10];

   411

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

   412

      s4o.print(str);

   413

    }

   414

   415

    void print_symbol_list() {

   416

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

   417

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

   418

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

   419

        s4o.print(".");

   420

      }

   421

    }

   422

   423

   424

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

   425

/* B 1.3.3 - Derived data types */

   426

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

   427

    /*  enumerated_type_name ':' enumerated_spec_init */

   428

    void *visit(enumerated_type_declaration_c *symbol) {

   429

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

   430

      return NULL;

   431

    }

   432

   433

    /* enumerated_specification ASSIGN enumerated_value */

   434

    void *visit(enumerated_spec_init_c *symbol) {

   435

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

   436

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

   437

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

   438

       * This means that this method should not get called.

   439

       */

   440

      ERROR;  

   441

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

   442

      return NULL;

   443

    }

   444

   445

    /* enumerated_value_list ',' enumerated_value */

   446

    void *visit(enumerated_value_list_c *symbol) {

   447

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

   448

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

   449

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

   450

       * This means that this method should not get called.

   451

       */

   452

      ERROR;

   453

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

   454

      return NULL;

   455

    }

   456

   457

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

   458

/* B.1.4.3 - Declaration and initialization */

   459

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

   460

   461

    void *visit(retain_option_c *symbol) {

   462

      is_retain = 1;

   463

      return NULL;

   464

    }

   465

   466

    void *visit(non_retain_option_c *symbol) {

   467

      is_retain = 0;

   468

      return NULL;

   469

    }

   470

   471

    /* VAR_OUTPUT [RETAIN | NON_RETAIN] var_init_decl_list END_VAR */

   472

    void *visit(output_declarations_c *symbol) {

   473

      unsigned int was_retain = is_retain;

   474

      if (symbol->option != NULL)

   475

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

   476

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

   477

      is_retain = was_retain;

   478

      return NULL;

   479

    }

   480

   481

    /*  VAR RETAIN var_init_decl_list END_VAR */

   482

    void *visit(retentive_var_declarations_c *symbol) {

   483

      unsigned int was_retain = is_retain;

   484

      is_retain = 1;

   485

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

   486

      is_retain = was_retain;

   487

      return NULL;

   488

    }

   489

   490

    /*  VAR [CONSTANT|RETAIN|NON_RETAIN] located_var_decl_list END_VAR */

   491

    void *visit(located_var_declarations_c *symbol) {

   492

      unsigned int was_retain = is_retain;

   493

      if (symbol->option != NULL)

   494

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