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

  private:

    61

    symbol_c *current_var_type_symbol;

    62

    unsigned int current_var_number;

    63

    unsigned int step_number;

    64

    unsigned int transition_number;

    65

    unsigned int action_number;

    66

    std::list<SYMBOL> current_symbol_list;

    67

    search_base_type_c search_base_type;

    68

    search_fb_typedecl_c *search_fb_typedecl;

    69

    70

  public:

    71

    generate_var_list_c(stage4out_c *s4o_ptr, symbol_c *scope)

    72

    : generate_c_typedecl_c(s4o_ptr) {

    73

      search_fb_typedecl = new search_fb_typedecl_c(scope);

    74

      current_var_type_symbol = NULL;

    75

      current_var_number = 0;

    76

    }

    77

    78

    ~generate_var_list_c(void) {

    79

      delete search_fb_typedecl;

    80

    }

    81

    82

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

    83

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

    84

      if (this->current_var_type_symbol == NULL)

    85

        ERROR;

    86

    87

      if (is_fb)

    88

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

    89

      else

    90

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

    91

      if (this->current_var_type_symbol == NULL)

    92

        ERROR;

    93

    }

    94

    95

    void reset_var_type_symbol(void) {

    96

      this->current_var_type_symbol = NULL;

    97

    }

    98

   100

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

   101

      /* should NEVER EVER occur!! */

   102

      if (list == NULL) ERROR;

   103

   104

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

   111

        SYMBOL *current_name;

   112

        current_name = new SYMBOL;

   113

        current_name->symbol = symbol;

   114

        current_symbol_list.push_back(*current_name);

   115

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

   116

        current_symbol_list.pop_back();

   117

      }

   118

      else {

   119

        print_var_number();

   120

        s4o.print(";");

   123

        print_symbol_list();

   124

        symbol->accept(*this);

   125

        s4o.print(";");

   126

        print_symbol_list();

   127

        symbol->accept(*this);

   128

        s4o.print(";");

   129

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

   130

        s4o.print(";\n");

   131

      }

   132

    }

   133

   134

    void print_var_number(void) {

   135

      char str[10];

   136

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

   137

      s4o.print(str);

   138

      current_var_number++;

   139

    }

   140

   141

    void print_step_number(void) {

   142

      char str[10];

   143

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

   144

      s4o.print(str);

   145

    }

   146

   147

    void print_transition_number(void) {

   148

      char str[10];

   149

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

   150

      s4o.print(str);

   151

    }

   152

   153

    void print_action_number(void) {

   154

      char str[10];

   155

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

   156

      s4o.print(str);

   157

    }

   158

   159

    void print_symbol_list(void) {

   160

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

   161

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

   162

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

   163

        s4o.print(".");

   164

      }

   165

    }

   166

   167

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

   168

    /* B.1.4.3   Declaration and initilization  */

   169

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

   170

   171

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

   172

    /* variable_name -> may be NULL ! */

   173

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

   174

    void *visit(located_var_decl_c *symbol) {

   175

        /* Start off by setting the current_var_type_symbol and

   176

         * current_var_init_symbol private variables...

   177

         */

   178

        update_var_type_symbol(symbol->located_var_spec_init);

   179

   180

        if (symbol->variable_name != NULL)

   182

   183

        current_var_type_symbol = NULL;

   184

        return NULL;

   185

    }

   186

   187

    /*  var1_list ':' array_spec_init */

   188

    // SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   189

    void *visit(array_var_init_decl_c *symbol) {

   190

      TRACE("array_var_init_decl_c");

   191

      /* Start off by setting the current_var_type_symbol and

   192

       * current_var_init_symbol private variables...

   193

       */

   194

      update_var_type_symbol(symbol->array_spec_init);

   195

   196

      declare_variables(symbol->var1_list);

   197

   198

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

   199

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

   200

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

   201

       */

   202

      reset_var_type_symbol();

   203

   204

      return NULL;

   205

    }

   206

   207

    /*  var1_list ':' initialized_structure */

   208

    // SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   209

    void *visit(structured_var_init_decl_c *symbol) {

   210

      TRACE("structured_var_init_decl_c");

   211

      /* Please read the comments inside the var1_init_decl_c

   212

       * visitor, as they apply here too.

   213

       */

   214

   215

      /* Start off by setting the current_var_type_symbol and

   216

       * current_var_init_symbol private variables...

   217

       */

   218

      update_var_type_symbol(symbol->initialized_structure);

   219

   220

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

   221

      declare_variables(symbol->var1_list);

   222

   223

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

   224

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

   225

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

   226

       */

   227

      reset_var_type_symbol();

   228

   229

      return NULL;

   230

    }

   231

   232

    /* fb_name_list ':' function_block_type_name ASSIGN structure_initialization */

   233

    /* structure_initialization -> may be NULL ! */

   234

    void *visit(fb_name_decl_c *symbol) {

   235

      TRACE("fb_name_decl_c");

   236

      /* Please read the comments inside the var1_init_decl_c

   237

       * visitor, as they apply here too.

   238

       */

   239

   240

      /* Start off by setting the current_var_type_symbol and

   241

       * current_var_init_symbol private variables...

   242

       */

   243

      update_var_type_symbol(symbol, true);

   244

   245

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

   247

   248

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

   249

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

   250

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

   251

       */

   252

      reset_var_type_symbol();

   253

   254

      return NULL;

   255

    }

   256

   257

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

   258

    //SYM_REF2(external_declaration_c, global_var_name, specification)

   259

    void *visit(external_declaration_c *symbol) {

   260

      TRACE("external_declaration_c");

   261

      /* Please read the comments inside the var1_init_decl_c

   262

       * visitor, as they apply here too.

   263

       */

   264

   265

      /* Start off by setting the current_var_type_symbol and

   266

       * current_var_init_symbol private variables...

   267

       */

   268

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

   269

      if (this->current_var_type_symbol == NULL) {

   270

        this->current_var_type_symbol = symbol->specification;

   271

   273

      }

   274

      else

   276

   277

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

   278

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

   279

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

   280

       */

   281

      reset_var_type_symbol();

   282

   283

      return NULL;

   284

    }

   285

   286

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

   287

    /* type_specification ->may be NULL ! */

   288

    // SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   289

    void *visit(global_var_decl_c *symbol) {

   290

      TRACE("global_var_decl_c");

   291

      /* Please read the comments inside the var1_init_decl_c

   292

       * visitor, as they apply here too.

   293

       */

   294

   295

      /* Start off by setting the current_var_type_symbol and

   296

       * current_var_init_symbol private variables...

   297

       */

   298

      update_var_type_symbol(symbol->type_specification);

   299

   300

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

   301

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

   302

   303

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

   304

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

   305

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

   306

       */

   307

      reset_var_type_symbol();

   308

   309

      return NULL;

   310

    }

   311

   312

    void *visit(global_var_list_c *symbol) {

   313

      declare_variables(symbol);

   314

      return NULL;

   315

    }

   316

   317

    /*| global_var_name location */

   318

    // SYM_REF2(global_var_spec_c, global_var_name, location)

   319

    void *visit(global_var_spec_c *symbol) {

   320

      if (symbol->global_var_name != NULL)

   321

        declare_variable(symbol->global_var_name);

   322

      return NULL;

   323

    }

   324

   325

    void *visit(var1_init_decl_c *symbol) {

   326

      TRACE("var1_init_decl_c");

   327

   328

      /* Start off by setting the current_var_type_symbol and

   329

       * current_var_init_symbol private variables...

   330

       */

   331

      update_var_type_symbol(symbol->spec_init);

   332

   333

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

   334

      declare_variables(symbol->var1_list);

   335

   336

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

   337

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

   338

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

   339

       */

   340

      reset_var_type_symbol();

   341

   342

      return NULL;

   343

    }

   344

   345

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

   346

/* B.1.5 - Program organization units */

   347

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

   348

   349

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

   350

/* B 1.5.2 - Function Blocks */

   351

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

   352

    void *visit(function_block_declaration_c *symbol) {

   353

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

   354

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

   355

      return NULL;

   356

    }

   357

   358

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

   359

/* B 1.5.3 - Programs */

   360

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

   361

    void *visit(program_declaration_c *symbol) {

   362

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

   363

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

   364

      return NULL;

   365

    }

   366

   367

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

   368

/* B 1.6 - Sequential function chart elements */

   369

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

   370

   371

    /* | sequential_function_chart sfc_network */

   372

    //SYM_LIST(sequential_function_chart_c)

   373

    void *visit(sequential_function_chart_c *symbol) {

   374

      step_number = 0;

   375

      transition_number = 0;

   376

      action_number = 0;

   377

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

   378

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

   379

      }

   380

      return NULL;

   381

    }

   382

   383

    /* INITIAL_STEP step_name ':' action_association_list END_STEP */

   384

    //SYM_REF2(initial_step_c, step_name, action_association_list)

   385

    void *visit(initial_step_c *symbol) {

   386

      print_var_number();

   388

      print_symbol_list();

   389

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

   390

      s4o.print(".X;");

   391

      print_symbol_list();

   392

      s4o.print("step_list[");

   393

      print_step_number();

   394

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

   395

      step_number++;

   396

      return NULL;

   397

    }

   398

   399

    /* STEP step_name ':' action_association_list END_STEP */

   400

    //SYM_REF2(step_c, step_name, action_association_list)

   401

    void *visit(step_c *symbol) {

   402

      print_var_number();

   404

      print_symbol_list();

   405

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

   406

      s4o.print(".X;");

   407

      print_symbol_list();

   408

      s4o.print("step_list[");

   409

      print_step_number();

   410

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

   411

      step_number++;

   412

      return NULL;

   413

    }

   414

   415

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

   416

     *   FROM steps TO steps 

   417

     *   transition_condition 

   418

     * END_TRANSITION

   419

     */

   420

    /* transition_name -> may be NULL ! */

   421

    /* integer -> may be NULL ! */

   422

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

   423

    void *visit(transition_c *symbol) {

   424

      print_var_number();

   426

      print_symbol_list();

   427

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

   428

      s4o.print("->");

   429

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

   430

      s4o.print(";");

   431

      print_symbol_list();

   432

      s4o.print("transition_list[");

   433

      print_transition_number();

   434

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

   435

      transition_number++;

   436

      return NULL;

   437

    }

   438

   439

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

   440

    /* step_name      -> may be NULL ! */

   441

    /* step_name_list -> may be NULL ! */

   442

    //SYM_REF2(steps_c, step_name, step_name_list)

   443

    void *visit(steps_c *symbol) {

   444

      if (symbol->step_name != NULL)

   445

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

   446

      if (symbol->step_name_list != NULL)

   447

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

   448

      return NULL;

   449

    }

   450

   451

    /* | step_name_list ',' step_name */

   452

    //SYM_LIST(step_name_list_c)

   453

    void *visit(step_name_list_c *symbol) {

   454

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

   455

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

   456

        if (i < symbol->n - 1)

   457

          s4o.print(",");

   458

      }

   459

      return NULL;

   460

    }

   461

   462

    /* ACTION action_name ':' function_block_body END_ACTION */

   463

    //SYM_REF2(action_c, action_name, function_block_body)

   464

    void *visit(action_c *symbol) {

   465

      print_var_number();

   467

      print_symbol_list();

   468

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

   469

      s4o.print(".Q;");

   470

      print_symbol_list();

   471

      s4o.print("action_list[");

   472

      print_action_number();

   473

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

   474

      action_number++;

   475

      return NULL;

   476

    }

   477

   478

   479

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

   480

/* B.1.7 - Configuration elements     */

   481

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

   482

   483

    /*  PROGRAM [RETAIN | NON_RETAIN] program_name [WITH task_name] ':' program_type_name ['(' prog_conf_elements ')'] */

   484

    //SYM_REF6(program_configuration_c, retain_option, program_name, task_name, program_type_name, prog_conf_elements, unused)

   485

    void *visit(program_configuration_c *symbol) {

   486

   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->program_type_name, true);

   491

   493

   494

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

   495

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

   496

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

   497

       */

   498

      reset_var_type_symbol();

   499

   500

      return NULL;

   501

    }

   502

   503

    /* CONFIGURATION configuration_name

   504

     *   optional_global_var_declarations

   505

     *   (resource_declaration_list | single_resource_declaration)

   506

     *   optional_access_declarations

   507

     *   optional_instance_specific_initializations

   508

     * END_CONFIGURATION

   509

     */

   510

    //SYM_REF5(configuration_declaration_c, configuration_name, global_var_declarations, resource_declarations, access_declarations, instance_specific_initializations)

   511

    void *visit(configuration_declaration_c *symbol) {

   512

      SYMBOL *current_name;

   513

      current_name = new SYMBOL;

   514

      current_name->symbol = symbol->configuration_name;

   515

      current_symbol_list.push_back(*current_name);

   516

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

   517

      current_symbol_list.pop_back();

   518

      return NULL;

   519

    }

   520

   521

    /* RESOURCE resource_name ON resource_type_name

   522

     *   optional_global_var_declarations

   523

     *   single_resource_declaration

   524

     * END_RESOURCE

   525

     */

   526

    //SYM_REF4(resource_declaration_c, resource_name, resource_type_name, global_var_declarations, resource_declaration)

   527

    void *visit(resource_declaration_c *symbol) {