1

/*

     2

 * (c) 2003 Mario de Sousa

     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

/*

    27

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

    28

 *

    29

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

    30

 * to the IL and ST code.

    31

 */

    32

    33

    34

    35

    36

    37

    38

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

    39

#include <string>

    40

#include <iostream>

    41

#include <sstream>

    42

#include <typeinfo>

    43

#include <list>

    44

#include <strings.h>

    45

    46

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

    47

#include "../../util/dsymtable.hh"

    48

#include "../../absyntax/visitor.hh"

    50

    51

#include "../stage4.hh"

    52

    53

    54

    55

    56

    57

    58

    59

//#define DEBUG

    60

#ifdef DEBUG

    61

#define TRACE(classname) printf("\n____%s____\n",classname);

    62

#else

    63

#define TRACE(classname)

    64

#endif

    65

    66

    67

    68

#define ERROR error_exit(__FILE__,__LINE__)

    69

/* function defined in main.cc */

    70

extern void error_exit(const char *file_name, int line_no);

    71

    72

    73

    74

    75

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

    76

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

    77

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

    78

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

    79

    80

/* Unlike Programs and Configurations which get mapped onto C++ classes,

    81

 * Function Blocks are mapped onto a C structure containing the variables, and

    82

 * a C function containing the code in the FB's body. This is to allow direct allocation

    83

 * of a FB variable (which is really an instance of the C data structure) to

    84

 * a member of a union variable (note that classes with constructors cannot

    85

 * be mebers of a union), which is done in IL when loading a FB onto IL's

    86

 * default variable.

    87

 *

    88

 * So as not to clash the names of the C data structure and the C function,

    89

 * the C structure is given a name identical to that of the FB name, whereas

    90

 * the name of the function is the FB name with a constant string appended.

    91

 * The value of that constant string which is appended is defined in the following

    92

 * constant.

    93

 * In order not to clash with any variable in the IL and ST source codem the

    94

 * following constant should contain a double underscore, which is not allowed

    95

 * in IL and ST.

    96

 *

    97

 * e.g.:  FUNTION_BLOCK TEST

    98

 * is mapped onto a TEST data structure, and a TEST_body__ function.

    99

 */

   100

   101

#define FB_FUNCTION_SUFFIX "_body__"

   102

   103

/* Idem as body, but for initializer FB function */

   104

#define FB_INIT_SUFFIX "_init__"

   105

   106

/* Idem as body, but for run CONFIG and RESOURCE function */

   107

#define FB_RUN_SUFFIX "_run__"

   108

   109

/* The FB body function is passed as the only parameter a pointer to the FB data

   110

 * structure instance. The name of this parameter is given by the following constant.

   111

 * In order not to clash with any variable in the IL and ST source codem the

   112

 * following constant should contain a double underscore, which is not allowed

   113

 * in IL and ST.

   114

 *

   115

 * e.g.: the body of FUNTION_BLOCK TEST

   116

 * is mapped onto the C function

   117

 *  TEST_body__(TEST *data__)

   118

 */

   119

   120

#define FB_FUNCTION_PARAM "data__"

   121

   122

   123

#define SFC_STEP_ACTION_PREFIX "__SFC_"

   124

   125

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

   126

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

   127

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

   128

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

   129

   130

#include "generate_c_base.cc"

   131

#include "generate_c_typedecl.cc"

   132

#include "generate_c_sfcdecl.cc"

   133

#include "generate_c_vardecl.cc"

   134

#include "generate_c_configbody.cc"

   135

#include "generate_location_list.cc"

   136

#include "generate_var_list.cc"

   137

   138

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

   139

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

   140

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

   141

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

   142

   143

/* Generate a name for a temporary variable.

   144

 * Each new name generated is appended a different number,

   145

 * starting off from 0.

   146

 * After calling reset(), the names will start off again from 0.

   147

 */

   148

#define VAR_LEADER "__"

   149

#define TEMP_VAR VAR_LEADER "TMP_"

   150

#define SOURCE_VAR VAR_LEADER "SRC_"

   151

   152

#include "generate_c_tempvardecl.cc"

   153

   154

#include "generate_c_st.cc"

   155

#include "generate_c_il.cc"

   156

   157

#include "generate_c.hh"

   158

   159

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

   160

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

   161

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

   162

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

   163

   164

#define MILLISECOND 1000000

   165

#define SECOND 1000 * MILLISECOND

   166

   167

/* A helper class that knows how to generate code for both the IL and ST languages... */

   168

class calculate_time_c: public iterator_visitor_c {

   169

  private:

   170

    unsigned long time;

   171

    float current_value;

   172

   173

  public:

   174

    calculate_time_c(void){time = 0;};

   175

   176

    unsigned long get_time(void) {return time;};

   177

   178

    void *get_integer_value(token_c *token) {

   179

      std::string str = "";

   180

      for (unsigned int i = 0; i < strlen(token->value); i++)

   181

        if (token->value[i] != '_')

   182

          str += token->value[i];

   183

      current_value = atof(str.c_str());

   184

      return NULL;

   185

    }

   186

   187

    void *get_float_value(token_c *token) {

   188

      current_value = atof(token->value);

   189

      return NULL;

   190

    }

   191

   192

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

   193

/* B 1.2.1 - Numeric Literals */

   194

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

   195

   196

    void *visit(integer_c *symbol) {return get_integer_value(symbol);}

   197

   198

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

   199

/* B 1.2.3.1 - Duration */

   200

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

   201

   202

    /* SYM_REF2(duration_c, neg, interval) */

   203

    void *visit(duration_c *symbol) {

   204

      if (symbol->neg != NULL)

   205

        ERROR;

   206

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

   207

      return NULL;

   208

    }

   209

   210

    /* SYM_TOKEN(fixed_point_c) */

   211

    void *visit(fixed_point_c *symbol) {return get_float_value(symbol);}

   212

   213

    /* SYM_REF2(days_c, days, hours) */

   214

    void *visit(days_c *symbol) {

   215

      if (symbol->hours)

   216

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

   217

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

   218

      time += (unsigned long)(current_value * 24 * 3600 * SECOND);

   219

      return NULL;

   220

    }

   221

   222

    /* SYM_REF2(hours_c, hours, minutes) */

   223

    void *visit(hours_c *symbol) {

   224

      if (symbol->minutes)

   225

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

   226

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

   227

      time += (unsigned long)(current_value * 3600 * SECOND);

   228

      return NULL;

   229

    }

   230

   231

    /* SYM_REF2(minutes_c, minutes, seconds) */

   232

    void *visit(minutes_c *symbol) {

   233

      if (symbol->seconds)

   234

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

   235

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

   236

      time += (unsigned long)(current_value * 60 * SECOND);

   237

      return NULL;

   238

    }

   239

   240

    /* SYM_REF2(seconds_c, seconds, milliseconds) */

   241

    void *visit(seconds_c *symbol) {

   242

      if (symbol->milliseconds)

   243

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

   244

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

   245

      time += (unsigned long)(current_value * SECOND);

   246

      return NULL;

   247

    }

   248

   249

    /* SYM_REF2(milliseconds_c, milliseconds, unused) */

   250

    void *visit(milliseconds_c *symbol) {

   251

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

   252

      time += (unsigned long)(current_value * MILLISECOND);

   253

      return NULL;

   254

    }

   255

};

   256

   257

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

   258

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

   259

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

   260

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

   261

   262

class calculate_common_ticktime_c: public iterator_visitor_c {

   263

  private:

   264

    unsigned long common_ticktime;

   265

   266

  public:

   267

    calculate_common_ticktime_c(void){common_ticktime = 0;}

   268

   269

    unsigned long euclide(unsigned long a, unsigned long b) {

   270

      unsigned long c = a % b;

   271

      if (c == 0)

   272

        return b;

   273

      else

   274

        return euclide(b, c);

   275

    }

   276

   277

    void update_ticktime(unsigned long time) {

   278

      if (common_ticktime == 0)

   279

        common_ticktime = time;

   280

      else if (time > common_ticktime)

   281

        common_ticktime = euclide(time, common_ticktime);

   282

      else

   283

        common_ticktime = euclide(common_ticktime, time);

   284

    }

   285

   286

    unsigned long get_ticktime(void) {

   287

      return common_ticktime;

   288

    }

   289

   290

/*  TASK task_name task_initialization */

   291

//SYM_REF2(task_configuration_c, task_name, task_initialization)  

   292

    void *visit(task_initialization_c *symbol) {

   293

      calculate_time_c calculate_time;

   294

      unsigned long time = 0;

   295

      if (symbol->interval_data_source != NULL) {

   296

        symbol->interval_data_source->accept(calculate_time);

   297

        time = calculate_time.get_time();

   298

      }

   299

      if (time > 0)

   300

        update_ticktime(time);

   301

      return NULL;

   302

    }

   303

};    

   304

   305

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

   306

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

   307

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

   308

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

   309

   310

/* A helper class that knows how to generate code for both the IL and ST languages... */

   311

class generate_c_SFC_IL_ST_c: public null_visitor_c {

   312

  private:

   313

    stage4out_c *s4o_ptr;

   314

    symbol_c *scope;

   315

    const char *variable_prefix;

   316

   317

  public:

   318

    generate_c_SFC_IL_ST_c(stage4out_c *s4o_ptr, symbol_c *scope, const char *variable_prefix = NULL);

   319

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

   320

    /* B.1.6  Sequential function chart elements */

   321

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

   322

   323

    /*| sequential_function_chart sfc_network*/

   324

    void *visit(sequential_function_chart_c * symbol);

   325

   326

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

   327

    /* B.2 - Language IL (Instruction List) */

   328

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

   329

   330

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

   331

    /* B 2.1 Instructions and Operands */

   332

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

   333

    /*| instruction_list il_instruction */

   334

    void *visit(instruction_list_c *symbol);

   335

   336

    /* Remainder implemented in generate_c_il_c... */

   337

   338

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

   339

    /* B.3 - Language ST (Structured Text) */

   340

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

   341

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

   342

    /* B 3.1 - Expressions */

   343

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

   344

    /* Implemented in generate_c_st_c */

   345

   346

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

   347

    /* B 3.2 Statements */

   348

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

   349

    void *visit(statement_list_c *symbol);

   350

   351

/* Remainder implemented in generate_c_st_c... */

   352

};

   353

   354

#include "generate_c_sfc.cc"

   355

   356

generate_c_SFC_IL_ST_c::generate_c_SFC_IL_ST_c(stage4out_c *s4o_ptr, symbol_c *scope, const char *variable_prefix) {

   357

  if (NULL == scope) ERROR;

   358

  this->s4o_ptr = s4o_ptr;

   359

  this->scope = scope;

   360

  this->variable_prefix = variable_prefix;

   361

}

   362

   363

void *generate_c_SFC_IL_ST_c::visit(sequential_function_chart_c * symbol) {

   364

  generate_c_sfc_c generate_c_sfc(s4o_ptr, scope, variable_prefix);

   365

  generate_c_sfc.generate(symbol);

   366

  return NULL;

   367

}

   368

   369

void *generate_c_SFC_IL_ST_c::visit(instruction_list_c *symbol) {

   370

  generate_c_il_c generate_c_il(s4o_ptr, scope, variable_prefix);

   371

  generate_c_il.generate(symbol);

   372

  return NULL;

   373

}

   374

   375

void *generate_c_SFC_IL_ST_c::visit(statement_list_c *symbol) {

   376

  generate_c_st_c generate_c_st(s4o_ptr, scope, variable_prefix);

   377

  generate_c_st.generate(symbol);

   378

  return NULL;

   379

}

   380

   381

   382

   383

   384

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

   385

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

   386

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

   387

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

   388

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

   389

   390

   391

class generate_c_pous_c: public generate_c_typedecl_c {

   392

   393

  public:

   394

    generate_c_pous_c(stage4out_c *s4o_ptr, stage4out_c *s4o_incl_ptr)

   395

      : generate_c_typedecl_c(s4o_ptr, s4o_incl_ptr) {};

   396

    virtual ~generate_c_pous_c(void) {}

   397

   398

   399

  public:

   400

   401

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

   402

/* B.1 - Common elements */

   403

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

   404

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

   405

/* B 1.1 - Letters, digits and identifiers */

   406

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

   407

  /* done in base class(es) */

   408

   409

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

   410

/* B 1.2 - Constants */

   411

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

   412

  /* originally empty... */

   413

   414

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

   415

/* B 1.2.1 - Numeric Literals */

   416

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

   417

  /* done in base class(es) */

   418

   419

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

   420

/* B.1.2.2   Character Strings */

   421

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

   422

  /* done in base class(es) */

   423

   424

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

   425

/* B 1.2.3 - Time Literals */

   426

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

   427

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

   428

/* B 1.2.3.1 - Duration */

   429

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

   430

  /* done in base class(es) */

   431

   432

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

   433

/* B 1.2.3.2 - Time of day and Date */

   434

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

   435

  /* done in base class(es) */

   436

   437

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

   438

/* B.1.3 - Data types */

   439

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

   440

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

   441

/* B 1.3.1 - Elementary Data Types */

   442

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

   443

  /* done in base class(es) */

   444

   445

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

   446

/* B.1.3.2 - Generic data types */

   447

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

   448

  /* originally empty... */

   449

   450

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

   451

/* B 1.3.3 - Derived data types */

   452

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

   453

  /* done in base class(es) */

   454

   455

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

   456

/* B 1.4 - Variables */

   457

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

   458

  /* done in base class(es) */

   459

   460

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

   461

/* B.1.4.1   Directly Represented Variables */

   462

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

   463

  /* done in base class(es) */

   464

   465

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

   466

/* B.1.4.2   Multi-element Variables */

   467

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

   468

  /* done in base class(es) */

   469

   470

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

   471

/* B 1.4.3 - Declaration & Initialisation */

   472

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

   473

  /* done in base class(es) */

   474

   475

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

   476

/* B.1.5 - Program organization units */

   477

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

   478

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

   479

/* B 1.5.1 - Functions */

   480

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

   481

   482

public:

   483

/*   FUNCTION derived_function_name ':' elementary_type_name io_OR_function_var_declarations_list function_body END_FUNCTION */

   484

/* | FUNCTION derived_function_name ':' derived_type_name io_OR_function_var_declarations_list function_body END_FUNCTION */

   485

void *visit(function_declaration_c *symbol) {

   486

  generate_c_vardecl_c *vardecl;

   487

  TRACE("function_declaration_c");

   488

   489

  /* (A) Function declaration... */

   490

  /* (A.1) Function return type */

   491

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

   492

  symbol->type_name->accept(*this); /* return type */

   493

  s4o.print(" ");

   494

  /* (A.2) Function name */

   495

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

   496

  s4o.print("(");

   497

   498

  /* (A.3) Function parameters */

   499

  s4o.indent_right();

   500

  vardecl = new generate_c_vardecl_c(&s4o,

   501

  				      generate_c_vardecl_c::finterface_vf,

   502

  				      generate_c_vardecl_c::input_vt |

   503

				        generate_c_vardecl_c::output_vt |

   504

				        generate_c_vardecl_c::inoutput_vt |

   505

                generate_c_vardecl_c::eneno_vt);

   506

  vardecl->print(symbol->var_declarations_list);

   507

  if (!vardecl->is_en_declared()) {

   508

    s4o.print(",\n" + s4o.indent_spaces + "BOOL EN");

   509

  }

   510

  if (!vardecl->is_eno_declared()) {

   511

    s4o.print(",\n" + s4o.indent_spaces + "BOOL *ENO");

   512

  }

   513

  delete vardecl;

   514

   515

  s4o.indent_left();

   516

   517

  s4o.print(")\n" + s4o.indent_spaces + "{\n");

   518

   519

  /* (B) Function local variable declaration */

   520

  /* (B.1) Variables declared in ST source code */

   521

  s4o.indent_right();

   522

   523

  vardecl = new generate_c_vardecl_c(&s4o, 

   524

                generate_c_vardecl_c::localinit_vf, 

   525

                generate_c_vardecl_c::output_vt |

   526

                generate_c_vardecl_c::inoutput_vt |

   527

                generate_c_vardecl_c::private_vt);