1

/*

     2

 * (c) 2007 Mario de Sousa and Laurent Bessard

     3

 *

     4

 * Offered to the public under the terms of the GNU General Public License

     5

 * as published by the Free Software Foundation; either version 2 of the

     6

 * License, or (at your option) any later version.

     7

 *

     8

 * This program is distributed in the hope that it will be useful, but

     9

 * WITHOUT ANY WARRANTY; without even the implied warranty of

    10

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General

    11

 * Public License for more details.

    12

 *

    13

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

    14

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

    15

 */

    16

    17

/*

    18

 * An IEC 61131-3 IL and ST compiler.

    19

 *

    20

 * Based on the

    21

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

    22

 *

    23

 */

    24

    25

/*

    26

 * This is one of the versions available for the 4th stage.

    27

 *

    28

 * This 4th stage generates a c++ source program equivalent

    29

 * to the IL and ST code.

    30

 */

    31

    32

//#include <stdio.h>  /* required for NULL */

    33

//#include <string>

    34

//#include <iostream>

    35

    36

//#include "../../util/symtable.hh"

    37

    38

    39

    40

    41

typedef struct

    42

{

    43

  symbol_c *symbol;

    44

} SYMBOL;

    45

    46

    47

    48

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

    58

class generate_var_list_c: protected generate_c_typedecl_c {

    59

    60

  public:

    61

    typedef enum {

    62

      none_dt,

    63

      programs_dt,

    64

      variables_dt

    65

    } declarationtype_t;

    66

    67

    declarationtype_t current_declarationtype;

    68

    69

    typedef enum {

    70

      none_vtc,

    71

      variable_vtc,

    72

      pointer_vtc,

    73

      array_vtc,

    74

      structure_vtc,

    75

      function_block_vtc

    76

    } vartypecategory_t;

    77

    78

    vartypecategory_t current_var_type_category;

    79

    80

  private:

    81

    symbol_c *current_var_type_symbol;

    82

    symbol_c *current_var_type_name;

    83

    unsigned int current_var_number;

    84

    unsigned int step_number;

    85

    unsigned int transition_number;

    86

    unsigned int action_number;

    87

    bool configuration_defined;

    88

    std::list<SYMBOL> current_symbol_list;

    89

    search_base_type_c search_base_type;

    90

    search_fb_typedecl_c *search_fb_typedecl;

    91

    92

  public:

    93

    generate_var_list_c(stage4out_c *s4o_ptr, symbol_c *scope)

    94

    : generate_c_typedecl_c(s4o_ptr) {

    95

      search_fb_typedecl = new search_fb_typedecl_c(scope);

    96

      current_var_number = 0;

    97

      current_var_type_symbol = current_var_type_name = NULL;

    98

      current_declarationtype = none_dt;

    99

      current_var_type_category = none_vtc;

   100

    }

   101

   102

    ~generate_var_list_c(void) {

   103

      delete search_fb_typedecl;

   104

    }

   105

   106

    void update_var_type_symbol(symbol_c *symbol) {

   107

   108

      this->current_var_type_name = spec_init_sperator_c::get_spec(symbol);

   109

      if (this->current_var_type_name == NULL) {

   110

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

   111

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

   112

          fprintf(stderr, "%s.", ((identifier_c*)(pt->symbol))->value);

   113

        }

   114

        ERROR;

   115

      }

   116

   117

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

   118

      if (this->current_var_type_symbol != NULL)

   119

        this->current_var_type_category = function_block_vtc;

   120

      else {

   121

        this->current_var_type_symbol = (symbol_c *)(this->current_var_type_name->accept(search_base_type));

   122

   123

        structure_element_declaration_list_c *structure_symbol = dynamic_cast<structure_element_declaration_list_c *>(this->current_var_type_symbol);

   124

        if (structure_symbol != NULL)

   125

          this->current_var_type_category = structure_vtc;

   126

        else

   127

          this->current_var_type_category = variable_vtc;

   128

      }

   129

   130

      if (this->current_var_type_symbol == NULL)

   131

        ERROR;

   132

    }

   133

   134

    void reset_var_type_symbol(void) {

   135

      this->current_var_type_symbol = NULL;

   136

    }

   137

   138

    void generate_programs(symbol_c *symbol) {

   139

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

   140

      current_var_number = 0;

   141

      configuration_defined = false;

   142

      current_declarationtype = programs_dt;

   143

      symbol->accept(*this);

   144

      current_declarationtype = none_dt;

   145

      s4o.print("\n");

   146

    }

   147

   148

    void generate_variables(symbol_c *symbol) {

   149

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

   150

      current_var_number = 0;

   151

      configuration_defined = false;

   152

      current_declarationtype = variables_dt;

   153

      symbol->accept(*this);

   154

      current_declarationtype = none_dt;

   155

      s4o.print("\n");

   156

    }

   157

   158

    void declare_variables(symbol_c *symbol) {

   159

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

   160

      /* should NEVER EVER occur!! */

   161

      if (list == NULL) ERROR;

   162

   163

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

   164

        declare_variable(list->elements[i]);

   165

      }

   166

    }

   167

   168

    void declare_variable(symbol_c *symbol) {

   169

      print_var_number();

   170

      s4o.print(";");

   171

      switch (this->current_var_type_category) {

   172

        case pointer_vtc:

   173

          s4o.print("PT");

   174

          break;

   175

        case array_vtc:

   176

          s4o.print("ARRAY");

   177

          break;

   178

        case structure_vtc:

   179

          s4o.print("STRUCT");

   180

          break;

   181

        case function_block_vtc:

   182

          s4o.print("FB");

   183

          break;

   184

        default:

   185

          s4o.print("VAR");

   186

          break;

   187

      }

   188

      s4o.print(";");

   189

      print_symbol_list();

   190

      symbol->accept(*this);

   191

      s4o.print(";");

   192

      print_symbol_list();

   193

      symbol->accept(*this);

   194

      s4o.print(";");

   195

      switch (this->current_var_type_category) {

   196

        case structure_vtc:

   197

        case function_block_vtc:

   198

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

   199

          s4o.print(";\n");

   200

          SYMBOL *current_name;

   201

          current_name = new SYMBOL;

   202

          current_name->symbol = symbol;

   203

          current_symbol_list.push_back(*current_name);

   204

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

   205

          current_symbol_list.pop_back();

   206

          break;

   207

        case array_vtc:

   208

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

   209

          s4o.print(";\n");

   210

          break;

   211

        default:

   212

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

   213

          s4o.print(";\n");

   214

          break;

   215

      }

   216

    }

   217

   218

    void print_var_number(void) {

   219

      char str[10];

   220

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

   221

      s4o.print(str);

   222

      current_var_number++;

   223

    }

   224

   225

    void print_step_number(void) {

   226

      char str[10];

   227

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

   228

      s4o.print(str);

   229

    }

   230

   231

    void print_transition_number(void) {

   232

      char str[10];

   233

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

   234

      s4o.print(str);

   235

    }

   236

   237

    void print_action_number(void) {

   238

      char str[10];

   239

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

   240

      s4o.print(str);

   241

    }

   242

   243

    void print_symbol_list(void) {

   244

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

   245

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

   246

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

   247

        s4o.print(".");

   248

      }

   249

    }

   250

   251

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

   252

/* B.1.4.3 - Declaration and initialization */

   253

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

   254

   255

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

   256

    /* variable_name -> may be NULL ! */

   257

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

   258

    void *visit(located_var_decl_c *symbol) {

   259

        /* Start off by setting the current_var_type_symbol and

   260

         * current_var_init_symbol private variables...

   261

         */

   262

        update_var_type_symbol(symbol->located_var_spec_init);

   263

   264

        if (symbol->variable_name != NULL) {

   265

          this->current_var_type_category = pointer_vtc;

   266

          declare_variable(symbol->variable_name);

   267

        }

   268

   269

        current_var_type_symbol = NULL;

   270

        return NULL;

   271

    }

   272

   273

    /*  var1_list ':' array_spec_init */

   274

    // SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   275

    void *visit(array_var_init_decl_c *symbol) {

   276

      TRACE("array_var_init_decl_c");

   277

      /* Start off by setting the current_var_type_symbol and

   278

       * current_var_init_symbol private variables...

   279

       */

   280

      update_var_type_symbol(symbol->array_spec_init);

   281

   282

      this->current_var_type_category = array_vtc;

   283

      declare_variables(symbol->var1_list);

   284

   285

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

   286

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

   287

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

   288

       */

   289

      reset_var_type_symbol();

   290

   291

      return NULL;

   292

    }

   293

   294

    /*  var1_list ':' initialized_structure */

   295

    // SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   296

    void *visit(structured_var_init_decl_c *symbol) {

   297

      TRACE("structured_var_init_decl_c");

   298

      /* Please read the comments inside the var1_init_decl_c

   299

       * visitor, as they apply here too.

   300

       */

   301

   302

      /* Start off by setting the current_var_type_symbol and

   303

       * current_var_init_symbol private variables...

   304

       */

   305

      update_var_type_symbol(symbol->initialized_structure);

   306

   307

      /* now to produce the c equivalent... */

   308

      declare_variables(symbol->var1_list);

   309

   310

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

   311

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

   312

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

   313

       */

   314

      reset_var_type_symbol();

   315

   316

      return NULL;

   317

    }

   318

   319

    /* fb_name_list ':' function_block_type_name ASSIGN structure_initialization */

   320

    /* structure_initialization -> may be NULL ! */

   321

    void *visit(fb_name_decl_c *symbol) {

   322

      TRACE("fb_name_decl_c");

   323

      /* Please read the comments inside the var1_init_decl_c

   324

       * visitor, as they apply here too.

   325

       */

   326

   327

      /* Start off by setting the current_var_type_symbol and

   328

       * current_var_init_symbol private variables...

   329

       */

   330

      update_var_type_symbol(symbol);

   331

   332

      /* now to produce the c equivalent... */

   333

      declare_variables(symbol->fb_name_list);

   334

   335

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

   336

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

   337

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

   338

       */

   339

      reset_var_type_symbol();

   340

   341

      return NULL;

   342

    }

   343

   344

    /*  global_var_name ':' (simple_specification|subrange_specification|enumerated_specification|array_specification|prev_declared_structure_type_name|function_block_type_name */

   345

    //SYM_REF2(external_declaration_c, global_var_name, specification)

   346

    void *visit(external_declaration_c *symbol) {

   347

      TRACE("external_declaration_c");

   348

      /* Please read the comments inside the var1_init_decl_c

   349

       * visitor, as they apply here too.

   350

       */

   351

   352

      /* Start off by setting the current_var_type_symbol and

   353

       * current_var_init_symbol private variables...

   354

       */

   355

      update_var_type_symbol(symbol->specification);

   356

   357

      /* now to produce the c equivalent... */

   358

      if (this->current_var_type_category == variable_vtc)

   359

        this->current_var_type_category = pointer_vtc;

   360

      declare_variable(symbol->global_var_name);

   361

   362

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

   363

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

   364

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

   365

       */

   366

      reset_var_type_symbol();

   367

   368

      return NULL;

   369

    }

   370

   371

    /*| global_var_spec ':' [located_var_spec_init|function_block_type_name] */

   372

    /* type_specification ->may be NULL ! */

   373

    // SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   374

    void *visit(global_var_decl_c *symbol) {

   375

      TRACE("global_var_decl_c");

   376

      /* Please read the comments inside the var1_init_decl_c

   377

       * visitor, as they apply here too.

   378

       */

   379

   380

      /* Start off by setting the current_var_type_symbol and

   381

       * current_var_init_symbol private variables...

   382

       */

   383

      update_var_type_symbol(symbol->type_specification);

   384

   385

      /* now to produce the c equivalent... */

   386

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

   387

   388

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

   389

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

   390

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

   391

       */

   392

      reset_var_type_symbol();

   393

   394

      return NULL;

   395

    }

   396

   397

    void *visit(global_var_list_c *symbol) {

   398

      declare_variables(symbol);

   399

      return NULL;

   400

    }

   401

   402

    /*| global_var_name location */

   403

    // SYM_REF2(global_var_spec_c, global_var_name, location)

   404

    void *visit(global_var_spec_c *symbol) {

   405

      if (symbol->global_var_name != NULL) {

   406

        this->current_var_type_category = pointer_vtc;

   407

        declare_variable(symbol->global_var_name);

   408

      }

   409

      return NULL;

   410

    }

   411

   412

    void *visit(var1_init_decl_c *symbol) {

   413

      TRACE("var1_init_decl_c");

   414

   415

      /* Start off by setting the current_var_type_symbol and

   416

       * current_var_init_symbol private variables...

   417

       */

   418

      update_var_type_symbol(symbol->spec_init);

   419

   420

      /* now to produce the c equivalent... */

   421

      declare_variables(symbol->var1_list);

   422

   423

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

   424

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

   425

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

   426

       */

   427

      reset_var_type_symbol();

   428

   429

      return NULL;

   430

    }

   431

   432

    void *visit(en_param_declaration_c *symbol) {

   433

      TRACE("en_param_declaration_c");

   434

   435

      /* Start off by setting the current_var_type_symbol and

   436

       * current_var_init_symbol private variables...

   437

       */

   438

      this->current_var_type_symbol = symbol->type;

   439

   440

      /* now to produce the c equivalent... */

   441

      declare_variable(symbol->name);

   442

   443

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

   444

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

   445

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

   446

       */

   447

      reset_var_type_symbol();

   448

   449

      return NULL;

   450

    }

   451

   452

    void *visit(eno_param_declaration_c *symbol) {

   453

      TRACE("eno_param_declaration_c");

   454

   455

      /* Start off by setting the current_var_type_symbol and

   456

       * current_var_init_symbol private variables...

   457

       */

   458

      this->current_var_type_symbol = symbol->type;

   459

   460

      /* now to produce the c equivalent... */

   461

      declare_variable(symbol->name);

   462

   463

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

   464

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

   465

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

   466

       */

   467

      reset_var_type_symbol();

   468

   469

      return NULL;

   470

    }

   471

   472

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

   473

/* B 1.3.3 - Derived data types */

   474

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

   475

    void *visit(data_type_declaration_c *symbol) {

   476

      return NULL;

   477

    }

   478

   479

    void *visit(structure_element_declaration_list_c *symbol) {

   480

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

   481

        symbol->elements[i]->accept(*this);

   482

      }

   483

      return NULL;

   484

    }

   485

   486

    void *visit(structure_element_declaration_c *symbol) {

   487

      /* Start off by setting the current_var_type_symbol and

   488

       * current_var_init_symbol private variables...

   489

       */

   490

      update_var_type_symbol(symbol->spec_init);

   491

   492

      /* now to produce the c equivalent... */

   493

      declare_variable(symbol->structure_element_name);

   494

   495

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

   496

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

   497

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

   498

       */

   499

      reset_var_type_symbol();

   500

   501

      return NULL;

   502

    }

   503

   504

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

   505

/* B.1.5 - Program organization units */

   506

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

   507

   508

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

   509

/* B 1.5.1 - Functions */

   510

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

   511

    void *visit(function_declaration_c *symbol) {

   512