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

    99

   100

   101

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

   102

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

   103

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

   104

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

   105

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

   106

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

   107

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

   108

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

   109

   110

class generate_var_list_c: protected generate_c_typedecl_c {

   111

   112

  public:

   113

    typedef enum {

   114

      none_dt,

   115

      programs_dt,

   116

      variables_dt

   117

    } declarationtype_t;

   118

   119

    declarationtype_t current_declarationtype;

   120

   121

    typedef enum {

   122

      none_vtc,

   123

      variable_vtc,

   127

      array_vtc,

   128

      structure_vtc,

   129

      function_block_vtc

   130

    } vartypecategory_t;

   131

   132

    vartypecategory_t current_var_type_category;

   133

   134

  private:

   135

    symbol_c *current_var_type_symbol;

   136

    symbol_c *current_var_type_name;

   137

    unsigned int current_var_number;

   138

    unsigned int step_number;

   139

    unsigned int transition_number;

   140

    unsigned int action_number;

   141

    bool configuration_defined;

   142

    std::list<SYMBOL> current_symbol_list;

   143

    search_base_type_c search_base_type;

   144

    search_fb_typedecl_c *search_fb_typedecl;

   145

   146

  public:

   147

    generate_var_list_c(stage4out_c *s4o_ptr, symbol_c *scope)

   148

    : generate_c_typedecl_c(s4o_ptr) {

   149

      search_fb_typedecl = new search_fb_typedecl_c(scope);

   150

      current_var_number = 0;

   151

      current_var_type_symbol = current_var_type_name = NULL;

   152

      current_declarationtype = none_dt;

   153

      current_var_type_category = none_vtc;

   154

    }

   155

   156

    ~generate_var_list_c(void) {

   157

      delete search_fb_typedecl;

   158

    }

   159

   160

    void update_var_type_symbol(symbol_c *symbol) {

   161

   162

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

   163

      if (this->current_var_type_name == NULL) {

   164

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

   165

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

   166

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

   167

        }

   168

        ERROR;

   169

      }

   170

   171

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

   172

      if (this->current_var_type_symbol != NULL)

   173

        this->current_var_type_category = function_block_vtc;

   174

      else {

   175

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

   176

   177

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

   178

        if (structure_symbol != NULL)

   179

          this->current_var_type_category = structure_vtc;

   180

        else

   181

          this->current_var_type_category = variable_vtc;

   182

      }

   183

   184

      if (this->current_var_type_symbol == NULL)

   185

        ERROR;

   186

    }

   187

   188

    void reset_var_type_symbol(void) {

   189

      this->current_var_type_symbol = NULL;

   190

    }

   191

   192

    void generate_programs(symbol_c *symbol) {

   193

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

   194

      current_var_number = 0;

   195

      configuration_defined = false;

   196

      current_declarationtype = programs_dt;

   197

      symbol->accept(*this);

   198

      current_declarationtype = none_dt;

   199

      s4o.print("\n");

   200

    }

   201

   202

    void generate_variables(symbol_c *symbol) {

   203

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

   204

      current_var_number = 0;

   205

      configuration_defined = false;

   206

      current_declarationtype = variables_dt;

   207

      symbol->accept(*this);

   208

      current_declarationtype = none_dt;

   209

      s4o.print("\n");

   210

    }

   211

   212

    void declare_variables(symbol_c *symbol) {

   213

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

   214

      /* should NEVER EVER occur!! */

   215

      if (list == NULL) ERROR;

   216

   217

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

   218

        declare_variable(list->elements[i]);

   219

      }

   220

    }

   221

   222

    void declare_variable(symbol_c *symbol) {

   223

      print_var_number();

   224

      s4o.print(";");

   225

      switch (this->current_var_type_category) {

   234

          break;

   235

        case array_vtc:

   236

          s4o.print("ARRAY");

   237

          break;

   238

        case structure_vtc:

   239

          s4o.print("STRUCT");

   240

          break;

   241

        case function_block_vtc:

   242

          s4o.print("FB");

   243

          break;

   244

        default:

   245

          s4o.print("VAR");

   246

          break;

   247

      }

   248

      s4o.print(";");

   249

      print_symbol_list();

   250

      symbol->accept(*this);

   251

      s4o.print(";");

   252

      print_symbol_list();

   253

      symbol->accept(*this);

   254

      s4o.print(";");

   255

      switch (this->current_var_type_category) {

   256

        case structure_vtc:

   257

        case function_block_vtc:

   258

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

   259

          s4o.print(";\n");

   260

          SYMBOL *current_name;

   261

          current_name = new SYMBOL;

   262

          current_name->symbol = symbol;

   263

          current_symbol_list.push_back(*current_name);

   264

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

   265

          current_symbol_list.pop_back();

   266

          break;

   267

        case array_vtc:

   268

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

   269

          s4o.print(";\n");

   270

          break;

   271

        default:

   272

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

   273

          s4o.print(";\n");

   274

          break;

   275

      }

   276

    }

   277

   278

    void print_var_number(void) {

   279

      char str[10];

   280

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

   281

      s4o.print(str);

   282

      current_var_number++;

   283

    }

   284

   285

    void print_step_number(void) {

   286

      char str[10];

   287

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

   288

      s4o.print(str);

   289

    }

   290

   291

    void print_transition_number(void) {

   292

      char str[10];

   293

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

   294

      s4o.print(str);

   295

    }

   296

   297

    void print_action_number(void) {

   298

      char str[10];

   299

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

   300

      s4o.print(str);

   301

    }

   302

   303

    void print_symbol_list(void) {

   304

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

   305

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

   306

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

   307

        s4o.print(".");

   308

      }

   309

    }

   310

   311

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

   312

/* B.1.4.3 - Declaration and initialization */

   313

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

   314

   315

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

   316

    /* variable_name -> may be NULL ! */

   317

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

   318

    void *visit(located_var_decl_c *symbol) {

   319

        /* Start off by setting the current_var_type_symbol and

   320

         * current_var_init_symbol private variables...

   321

         */

   322

        update_var_type_symbol(symbol->located_var_spec_init);

   323

   332

          declare_variable(symbol->variable_name);

   335

   336

        current_var_type_symbol = NULL;

   337

        return NULL;

   338

    }

   364

   365

    /*  var1_list ':' array_spec_init */

   366

    // SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   367

    void *visit(array_var_init_decl_c *symbol) {

   368

      TRACE("array_var_init_decl_c");

   369

      /* Start off by setting the current_var_type_symbol and

   370

       * current_var_init_symbol private variables...

   371

       */

   372

      update_var_type_symbol(symbol->array_spec_init);

   373

   374

      this->current_var_type_category = array_vtc;

   375

      //declare_variables(symbol->var1_list);

   376

   377

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

   378

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

   379

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

   380

       */

   381

      reset_var_type_symbol();

   382

   383

      return NULL;

   384

    }

   385

   386

    /*  var1_list ':' initialized_structure */

   387

    // SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   388

    void *visit(structured_var_init_decl_c *symbol) {

   389

      TRACE("structured_var_init_decl_c");

   390

      /* Please read the comments inside the var1_init_decl_c

   391

       * visitor, as they apply here too.

   392

       */

   393

   394

      /* Start off by setting the current_var_type_symbol and

   395

       * current_var_init_symbol private variables...

   396

       */

   397

      update_var_type_symbol(symbol->initialized_structure);

   398

   399

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

   400

      //declare_variables(symbol->var1_list);

   401

   402

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

   403

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

   404

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

   405

       */

   406

      reset_var_type_symbol();

   407

   408

      return NULL;

   409

    }

   410

   411

    /* fb_name_list ':' function_block_type_name ASSIGN structure_initialization */

   412

    /* structure_initialization -> may be NULL ! */

   413

    void *visit(fb_name_decl_c *symbol) {

   414

      TRACE("fb_name_decl_c");

   415

      /* Please read the comments inside the var1_init_decl_c

   416

       * visitor, as they apply here too.

   417

       */

   418

   419

      /* Start off by setting the current_var_type_symbol and

   420

       * current_var_init_symbol private variables...

   421

       */

   422

      update_var_type_symbol(symbol);

   423

   424

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

   425

      declare_variables(symbol->fb_name_list);

   426

   427

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

   428

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

   429

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

   430

       */

   431

      reset_var_type_symbol();

   432

   433

      return NULL;

   434

    }

   435

   436

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

   437

    //SYM_REF2(external_declaration_c, global_var_name, specification)

   438

    void *visit(external_declaration_c *symbol) {

   439

      TRACE("external_declaration_c");

   440

      /* Please read the comments inside the var1_init_decl_c

   441

       * visitor, as they apply here too.

   442

       */

   443

   444

      /* Start off by setting the current_var_type_symbol and

   445

       * current_var_init_symbol private variables...

   446

       */

   447

      update_var_type_symbol(symbol->specification);

   448

   449

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

   451

      declare_variable(symbol->global_var_name);

   452

   453

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

   454

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

   455

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

   456

       */

   457

      reset_var_type_symbol();

   458

   459

      return NULL;

   460

    }

   461

   462

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

   463

    /* type_specification ->may be NULL ! */

   464

    // SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   465

    void *visit(global_var_decl_c *symbol) {

   466

      TRACE("global_var_decl_c");

   467

      /* Please read the comments inside the var1_init_decl_c

   468

       * visitor, as they apply here too.

   469

       */

   470

   471

      /* Start off by setting the current_var_type_symbol and

   472

       * current_var_init_symbol private variables...

   473

       */

   474

      update_var_type_symbol(symbol->type_specification);

   475

   476

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

   477

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

   478

   479

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

   480

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

   481

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

   482

       */

   483

      reset_var_type_symbol();

   484

   485

      return NULL;

   486

    }

   487

   488

    void *visit(global_var_list_c *symbol) {

   489

      declare_variables(symbol);

   490

      return NULL;

   491

    }

   492

   493

    /*| global_var_name location */

   494

    // SYM_REF2(global_var_spec_c, global_var_name, location)

   495

    void *visit(global_var_spec_c *symbol) {

   504

        declare_variable(symbol->global_var_name);

   507

      return NULL;

   508

    }

   509