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

  private:

    70

    symbol_c *current_var_type_symbol;

    71

    unsigned int current_var_number;

    72

    unsigned int step_number;

    73

    unsigned int transition_number;

    74

    unsigned int action_number;

    75

    bool configuration_defined;

    76

    std::list<SYMBOL> current_symbol_list;

    77

    search_base_type_c search_base_type;

    78

    search_fb_typedecl_c *search_fb_typedecl;

    79

    80

  public:

    81

    generate_var_list_c(stage4out_c *s4o_ptr, symbol_c *scope)

    82

    : generate_c_typedecl_c(s4o_ptr) {

    83

      search_fb_typedecl = new search_fb_typedecl_c(scope);

    84

      current_var_number = 0;

    85

      current_var_type_symbol = NULL;

    86

      current_declarationtype = none_dt;

    87

    }

    88

    89

    ~generate_var_list_c(void) {

    90

      delete search_fb_typedecl;

    91

    }

    92

    93

    void update_var_type_symbol(symbol_c *symbol, bool is_fb = false) {

    94

    95

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

    96

      if (this->current_var_type_symbol == NULL)

    97

        ERROR;

    98

    99

      if (is_fb)

   100

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

   101

      else

   102

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

   103

      if (this->current_var_type_symbol == NULL)

   104

        ERROR;

   105

    }

   106

   107

    void reset_var_type_symbol(void) {

   108

      this->current_var_type_symbol = NULL;

   109

    }

   110

   111

    void generate_programs(symbol_c *symbol) {

   112

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

   113

      current_var_number = 0;

   114

      configuration_defined = false;

   115

      current_declarationtype = programs_dt;

   116

      symbol->accept(*this);

   117

      current_declarationtype = none_dt;

   118

      s4o.print("\n");

   119

    }

   120

   121

    void generate_variables(symbol_c *symbol) {

   122

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

   123

      current_var_number = 0;

   124

      configuration_defined = false;

   125

      current_declarationtype = variables_dt;

   126

      symbol->accept(*this);

   127

      current_declarationtype = none_dt;

   128

      s4o.print("\n");

   129

    }

   130

   131

    void declare_variables(symbol_c *symbol, const char* type = "VAR") {

   132

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

   133

      /* should NEVER EVER occur!! */

   134

      if (list == NULL) ERROR;

   135

   136

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

   137

        declare_variable(list->elements[i], type);

   138

      }

   139

    }

   140

   141

    void declare_variable(symbol_c *symbol, const char* type = "VAR") {

   142

      print_var_number();

   143

      s4o.print(";");

   144

      s4o.print(type);

   145

      s4o.print(";");

   146

      print_symbol_list();

   147

      symbol->accept(*this);

   148

      s4o.print(";");

   149

      print_symbol_list();

   150

      symbol->accept(*this);

   151

      s4o.print(";");

   152

      if (strcmp(type, "FB") == 0) {

   153

        SYMBOL *current_name;

   154

        current_name = new SYMBOL;

   155

        current_name->symbol = symbol;

   156

        current_symbol_list.push_back(*current_name);

   157

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

   158

        current_symbol_list.pop_back();

   159

      }

   160

      else {

   161

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

   162

        s4o.print(";\n");

   163

      }

   164

    }

   165

   166

    void print_var_number(void) {

   167

      char str[10];

   168

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

   169

      s4o.print(str);

   170

      current_var_number++;

   171

    }

   172

   173

    void print_step_number(void) {

   174

      char str[10];

   175

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

   176

      s4o.print(str);

   177

    }

   178

   179

    void print_transition_number(void) {

   180

      char str[10];

   181

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

   182

      s4o.print(str);

   183

    }

   184

   185

    void print_action_number(void) {

   186

      char str[10];

   187

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

   188

      s4o.print(str);

   189

    }

   190

   191

    void print_symbol_list(void) {

   192

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

   193

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

   194

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

   195

        s4o.print(".");

   196

      }

   197

    }

   198

   199

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

   200

/* B.1.4.3 - Declaration and initialization */

   201

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

   202

   203

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

   204

    /* variable_name -> may be NULL ! */

   205

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

   206

    void *visit(located_var_decl_c *symbol) {

   207

        /* Start off by setting the current_var_type_symbol and

   208

         * current_var_init_symbol private variables...

   209

         */

   210

        update_var_type_symbol(symbol->located_var_spec_init);

   211

   212

        if (symbol->variable_name != NULL)

   213

          declare_variable(symbol->variable_name, "PT");

   214

   215

        current_var_type_symbol = NULL;

   216

        return NULL;

   217

    }

   218

   219

    /*  var1_list ':' array_spec_init */

   220

    // SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   221

    void *visit(array_var_init_decl_c *symbol) {

   222

      TRACE("array_var_init_decl_c");

   223

      /* Start off by setting the current_var_type_symbol and

   224

       * current_var_init_symbol private variables...

   225

       */

   226

      update_var_type_symbol(symbol->array_spec_init);

   227

   228

      declare_variables(symbol->var1_list);

   229

   230

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

   231

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

   232

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

   233

       */

   234

      reset_var_type_symbol();

   235

   236

      return NULL;

   237

    }

   238

   239

    /*  var1_list ':' initialized_structure */

   240

    // SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   241

    void *visit(structured_var_init_decl_c *symbol) {

   242

      TRACE("structured_var_init_decl_c");

   243

      /* Please read the comments inside the var1_init_decl_c

   244

       * visitor, as they apply here too.

   245

       */

   246

   247

      /* Start off by setting the current_var_type_symbol and

   248

       * current_var_init_symbol private variables...

   249

       */

   250

      update_var_type_symbol(symbol->initialized_structure);

   251

   252

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

   253

      declare_variables(symbol->var1_list);

   254

   255

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

   256

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

   257

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

   258

       */

   259

      reset_var_type_symbol();

   260

   261

      return NULL;

   262

    }

   263

   264

    /* fb_name_list ':' function_block_type_name ASSIGN structure_initialization */

   265

    /* structure_initialization -> may be NULL ! */

   266

    void *visit(fb_name_decl_c *symbol) {

   267

      TRACE("fb_name_decl_c");

   268

      /* Please read the comments inside the var1_init_decl_c

   269

       * visitor, as they apply here too.

   270

       */

   271

   272

      /* Start off by setting the current_var_type_symbol and

   273

       * current_var_init_symbol private variables...

   274

       */

   275

      update_var_type_symbol(symbol, true);

   276

   277

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

   278

      declare_variables(symbol->fb_name_list, "FB");

   279

   280

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

   281

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

   282

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

   283

       */

   284

      reset_var_type_symbol();

   285

   286

      return NULL;

   287

    }

   288

   289

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

   290

    //SYM_REF2(external_declaration_c, global_var_name, specification)

   291

    void *visit(external_declaration_c *symbol) {

   292

      TRACE("external_declaration_c");

   293

      /* Please read the comments inside the var1_init_decl_c

   294

       * visitor, as they apply here too.

   295

       */

   296

   297

      /* Start off by setting the current_var_type_symbol and

   298

       * current_var_init_symbol private variables...

   299

       */

   300

      this->current_var_type_symbol = (symbol_c *)(symbol->specification->accept(*search_fb_typedecl));

   301

      if (this->current_var_type_symbol == NULL) {

   302

        this->current_var_type_symbol = symbol->specification;

   303

   304

        declare_variable(symbol->global_var_name, "PT");

   305

      }

   306

      else

   307

        declare_variable(symbol->global_var_name, "FB");

   308

   309

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

   310

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

   311

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

   312

       */

   313

      reset_var_type_symbol();

   314

   315

      return NULL;

   316

    }

   317

   318

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

   319

    /* type_specification ->may be NULL ! */

   320

    // SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   321

    void *visit(global_var_decl_c *symbol) {

   322

      TRACE("global_var_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->type_specification);

   331

   332

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

   333

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

   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

    void *visit(global_var_list_c *symbol) {

   345

      declare_variables(symbol);

   346

      return NULL;

   347

    }

   348

   349

    /*| global_var_name location */

   350

    // SYM_REF2(global_var_spec_c, global_var_name, location)

   351

    void *visit(global_var_spec_c *symbol) {

   352

      if (symbol->global_var_name != NULL)

   353

        declare_variable(symbol->global_var_name, "PT");

   354

      return NULL;

   355

    }

   356

   357

    void *visit(var1_init_decl_c *symbol) {

   358

      TRACE("var1_init_decl_c");

   359

   360

      /* Start off by setting the current_var_type_symbol and

   361

       * current_var_init_symbol private variables...

   362

       */

   363

      update_var_type_symbol(symbol->spec_init);

   364

   365

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

   366

      declare_variables(symbol->var1_list);

   367

   368

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

   369

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

   370

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

   371

       */

   372

      reset_var_type_symbol();

   373

   374

      return NULL;

   375

    }

   376

   377

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

   378

/* B 1.3.3 - Derived data types */

   379

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

   380

    void *visit(data_type_declaration_c *symbol) {

   381

      return NULL;

   382

    }

   383

   384

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

   385

/* B.1.5 - Program organization units */

   386

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

   387

   388

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

   389

/* B 1.5.1 - Functions */

   390

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

   391

    void *visit(function_declaration_c *symbol) {

   392

      return NULL;

   393

    }

   394

   395

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

   396

/* B 1.5.2 - Function Blocks */

   397

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

   398

    void *visit(function_block_declaration_c *symbol) {

   399

      if (current_declarationtype == variables_dt && configuration_defined) {

   400

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

   401

        s4o.print(";\n");

   402

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

   403

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

   404

      }

   405

      return NULL;

   406

    }

   407

   408

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

   409

/* B 1.5.3 - Programs */

   410

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

   411

    void *visit(program_declaration_c *symbol) {

   412

      if (current_declarationtype == variables_dt && configuration_defined) {

   415

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

   416

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

   417

      }

   418

      return NULL;

   419

    }

   420

   421

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

   422

/* B 1.6 - Sequential function chart elements */

   423

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

   424

   425

    /* | sequential_function_chart sfc_network */

   426

    //SYM_LIST(sequential_function_chart_c)

   427

    void *visit(sequential_function_chart_c *symbol) {

   428

      step_number = 0;

   429

      transition_number = 0;

   430

      action_number = 0;

   431

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

   432

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

   433

      }

   434

      return NULL;

   435

    }

   436

   437

    /* INITIAL_STEP step_name ':' action_association_list END_STEP */

   438

    //SYM_REF2(initial_step_c, step_name, action_association_list)

   439

    void *visit(initial_step_c *symbol) {

   440

      print_var_number();

   441

      s4o.print(";VAR;");

   442

      print_symbol_list();

   443

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

   444

      s4o.print(".X;");

   445

      print_symbol_list();

   446

      s4o.print("__step_list[");

   447

      print_step_number();

   448

      s4o.print("].state;STEP;\n");

   449

      step_number++;

   450

      return NULL;

   451

    }

   452

   453

    /* STEP step_name ':' action_association_list END_STEP */

   454

    //SYM_REF2(step_c, step_name, action_association_list)

   455

    void *visit(step_c *symbol) {

   456

      print_var_number();

   457

      s4o.print(";VAR;");

   458

      print_symbol_list();

   459

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

   460

      s4o.print(".X;");

   461

      print_symbol_list();

   462

      s4o.print("__step_list[");

   463

      print_step_number();

   464

      s4o.print("].state;STEP;\n");

   465

      step_number++;

   466

      return NULL;

   467

    }

   468

   469

    /* TRANSITION [transition_name] ['(' PRIORITY ASSIGN integer ')'] 

   470

     *   FROM steps TO steps 

   471

     *   transition_condition 

   472

     * END_TRANSITION

   473

     */

   474

    /* transition_name -> may be NULL ! */

   475

    /* integer -> may be NULL ! */

   476

    //SYM_REF5(transition_c, transition_name, integer, from_steps, to_steps, transition_condition)

   477

    void *visit(transition_c *symbol) {

   478

      print_var_number();

   479

      s4o.print(";VAR;");

   480

      print_symbol_list();

   481

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

   482

      s4o.print("->");

   483

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

   484

      s4o.print(";");

   485

      print_symbol_list();

   486

      s4o.print("__debug_transition_list[");

   487

      print_transition_number();

   488

      s4o.print("];TRANSITION;\n");

   489

      transition_number++;

   490

      return NULL;

   491

    }

   492

   493

    /* step_name | '(' step_name_list ')' */

   494

    /* step_name      -> may be NULL ! */

   495

    /* step_name_list -> may be NULL ! */

   496

    //SYM_REF2(steps_c, step_name, step_name_list)

   497

    void *visit(steps_c *symbol) {

   498

      if (symbol->step_name != NULL)

   499

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

   500

      if (symbol->step_name_list != NULL)

   501

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

   502

      return NULL;

   503

    }

   504

   505

    /* | step_name_list ',' step_name */

   506

    //SYM_LIST(step_name_list_c)

   507

    void *visit(step_name_list_c *symbol) {

   508

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

   509

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

   510

        if (i < symbol->n - 1)

   511

          s4o.print(",");

   512

      }

   513

      return NULL;

   514

    }

   515

   516

    /* ACTION action_name ':' function_block_body END_ACTION */

   517

    //SYM_REF2(action_c, action_name, function_block_body)

   518

    void *visit(action_c *symbol) {

   519

      print_var_number();

   520

      s4o.print(";VAR;");