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"

    49

#include "../../absyntax_utils/absyntax_utils.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_st.cc"

   153

#include "generate_c_il.cc"

   154

   155

#include "generate_c.hh"

   156

   157

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

   158

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

   159

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

   160

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

   161

   162

#define MILLISECOND 1000000

   163

#define SECOND 1000 * MILLISECOND

   164

   165

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

   166

class calculate_time_c: public iterator_visitor_c {

   167

  private:

   168

    unsigned long time;

   169

    float current_value;

   170

   171

  public:

   172

    calculate_time_c(void){time = 0;};

   173

   174

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

   175

   176

    void *get_integer_value(token_c *token) {

   177

      std::string str = "";

   178

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

   179

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

   180

          str += token->value[i];

   181

      current_value = atof(str.c_str());

   182

      return NULL;

   183

    }

   184

   185

    void *get_float_value(token_c *token) {

   186

      current_value = atof(token->value);

   187

      return NULL;

   188

    }

   189

   190

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

   191

/* B 1.2.1 - Numeric Literals */

   192

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

   193

   194

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

   195

   196

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

   197

/* B 1.2.3.1 - Duration */

   198

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

   199

   200

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

   201

    void *visit(duration_c *symbol) {

   202

      if (symbol->neg != NULL)

   203

        ERROR;

   204

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

   205

      return NULL;

   206

    }

   207

   208

    /* SYM_TOKEN(fixed_point_c) */

   209

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

   210

   211

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

   212

    void *visit(days_c *symbol) {

   213

      if (symbol->hours)

   214

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

   215

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

   216

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

   217

      return NULL;

   218

    }

   219

   220

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

   221

    void *visit(hours_c *symbol) {

   222

      if (symbol->minutes)

   223

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

   224

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

   225

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

   226

      return NULL;

   227

    }

   228

   229

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

   230

    void *visit(minutes_c *symbol) {

   231

      if (symbol->seconds)

   232

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

   233

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

   234

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

   235

      return NULL;

   236

    }

   237

   238

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

   239

    void *visit(seconds_c *symbol) {

   240

      if (symbol->milliseconds)

   241

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

   242

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

   243

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

   244

      return NULL;

   245

    }

   246

   247

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

   248

    void *visit(milliseconds_c *symbol) {

   249

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

   250

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

   251

      return NULL;

   252

    }

   253

};

   254

   255

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

   256

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

   257

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

   258

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

   259

   260

class calculate_common_ticktime_c: public iterator_visitor_c {

   261

  private:

   262

    unsigned long common_ticktime;

   263

   264

  public:

   265

    calculate_common_ticktime_c(void){common_ticktime = 0;}

   266

   267

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

   268

      unsigned long c = a % b;

   269

      if (c == 0)

   270

        return b;

   271

      else

   272

        return euclide(b, c);

   273

    }

   274

   275

    void update_ticktime(unsigned long time) {

   276

      if (common_ticktime == 0)

   277

        common_ticktime = time;

   278

      else if (time > common_ticktime)

   279

        common_ticktime = euclide(time, common_ticktime);

   280

      else

   281

        common_ticktime = euclide(common_ticktime, time);

   282

    }

   283

   284

    unsigned long get_ticktime(void) {

   285

      return common_ticktime;

   286

    }

   287

   288

/*  TASK task_name task_initialization */

   289

//SYM_REF2(task_configuration_c, task_name, task_initialization)  

   290

    void *visit(task_initialization_c *symbol) {

   291

      calculate_time_c calculate_time;

   292

      unsigned long time = 0;

   293

      if (symbol->interval_data_source != NULL) {

   294

        symbol->interval_data_source->accept(calculate_time);

   295

        time = calculate_time.get_time();

   296

      }

   297

      if (time > 0)

   298

        update_ticktime(time);

   299

      return NULL;

   300

    }

   301

};    

   302

   303

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

   304

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

   305

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

   306

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

   307

   308

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

   309

class generate_c_SFC_IL_ST_c: public null_visitor_c {

   310

  private:

   311

    stage4out_c *s4o_ptr;

   312

    symbol_c *scope;

   313

    const char *variable_prefix;

   314

   315

  public:

   316

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

   317

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

   318

    /* B.1.6  Sequential function chart elements */

   319

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

   320

   321

    /*| sequential_function_chart sfc_network*/

   322

    void *visit(sequential_function_chart_c * symbol);

   323

   324

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

   325

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

   326

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

   327

   328

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

   329

    /* B 2.1 Instructions and Operands */

   330

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

   331

    /*| instruction_list il_instruction */

   332

    void *visit(instruction_list_c *symbol);

   333

   334

    /* Remainder implemented in generate_c_il_c... */

   335

   336

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

   337

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

   338

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

   339

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

   340

    /* B 3.1 - Expressions */

   341

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

   342

    /* Implemented in generate_c_st_c */

   343

   344

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

   345

    /* B 3.2 Statements */

   346

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

   347

    void *visit(statement_list_c *symbol);

   348

   349

/* Remainder implemented in generate_c_st_c... */

   350

};

   351

   352

#include "generate_c_sfc.cc"

   353

   354

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

   355

  if (NULL == scope) ERROR;

   356

  this->s4o_ptr = s4o_ptr;

   357

  this->scope = scope;

   358

  this->variable_prefix = variable_prefix;

   359

}

   360

   361

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

   362

  generate_c_sfc_c generate_c_sfc(s4o_ptr, scope, variable_prefix);

   363

  generate_c_sfc.generate(symbol);

   364

  return NULL;

   365

}

   366

   367

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

   368

  generate_c_il_c generate_c_il(s4o_ptr, scope, variable_prefix);

   369

  generate_c_il.generate(symbol);

   370

  return NULL;

   371

}

   372

   373

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

   374

  generate_c_st_c generate_c_st(s4o_ptr, scope, variable_prefix);

   375

  generate_c_st.generate(symbol);

   376

  return NULL;

   377

}

   378

   379

   380

   381

   382

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

   383

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

   384

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

   385

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

   386

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

   387

   388

   389

class generate_c_pous_c: public generate_c_typedecl_c {

   390

   391

  public:

   392

    generate_c_pous_c(stage4out_c *s4o_ptr, stage4out_c *s4o_incl_ptr)

   393

      : generate_c_typedecl_c(s4o_ptr, s4o_incl_ptr) {};

   394

    virtual ~generate_c_pous_c(void) {}

   395

   396

   397

  public:

   398

   399

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

   400

/* B.1 - Common elements */

   401

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

   402

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

   403

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

   404

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

   405

  /* done in base class(es) */

   406

   407

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

   408

/* B 1.2 - Constants */

   409

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

   410

  /* originally empty... */

   411

   412

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

   413

/* B 1.2.1 - Numeric Literals */

   414

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

   415

  /* done in base class(es) */

   416

   417

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

   418

/* B.1.2.2   Character Strings */

   419

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

   420

  /* done in base class(es) */

   421

   422

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

   423

/* B 1.2.3 - Time Literals */

   424

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

   425

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

   426

/* B 1.2.3.1 - Duration */

   427

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

   428

  /* done in base class(es) */

   429

   430

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

   431

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

   432

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

   433

  /* done in base class(es) */

   434

   435

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

   436

/* B.1.3 - Data types */

   437

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

   438

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

   439

/* B 1.3.1 - Elementary Data Types */

   440

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

   441

  /* done in base class(es) */

   442

   443

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

   444

/* B.1.3.2 - Generic data types */

   445

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

   446

  /* originally empty... */

   447

   448

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

   449

/* B 1.3.3 - Derived data types */

   450

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

   451

  /* done in base class(es) */

   452

   453

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

   454

/* B 1.4 - Variables */

   455

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

   456

  /* done in base class(es) */

   457

   458

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

   459

/* B.1.4.1   Directly Represented Variables */

   460

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

   461

  /* done in base class(es) */

   462

   463

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

   464

/* B.1.4.2   Multi-element Variables */

   465

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

   466

  /* done in base class(es) */

   467

   468

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

   469

/* B 1.4.3 - Declaration & Initialisation */

   470

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

   471

  /* done in base class(es) */

   472

   473

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

   474

/* B.1.5 - Program organization units */

   475

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

   476

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

   477

/* B 1.5.1 - Functions */

   478

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

   479

   480

public:

   481

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

   482

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

   483

void *visit(function_declaration_c *symbol) {

   484

  generate_c_vardecl_c *vardecl;

   485

  TRACE("function_declaration_c");

   486

   487

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

   488

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

   489

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

   490

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

   491

  s4o.print(" ");

   492

  /* (A.2) Function name */

   493

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

   494

  s4o.print("(");

   495

   496

  /* (A.3) Function parameters */

   497

  s4o.indent_right();

   498

  vardecl = new generate_c_vardecl_c(&s4o,

   499

                                     generate_c_vardecl_c::finterface_vf,

   500

                                     generate_c_vardecl_c::input_vt    |

   501

                                     generate_c_vardecl_c::output_vt   |

   502

                                     generate_c_vardecl_c::inoutput_vt |

   503

                                     generate_c_vardecl_c::en_vt       |

   504

                                     generate_c_vardecl_c::eno_vt);

   505

  vardecl->print(symbol->var_declarations_list);

   506

  delete vardecl;

   507

   508

  s4o.indent_left();

   509

   510

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

   511

   512

  /* (B) Function local variable declaration */

   513

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

   514

  s4o.indent_right();

   515

   516

  vardecl = new generate_c_vardecl_c(&s4o,

   517

                generate_c_vardecl_c::localinit_vf,

   518

                generate_c_vardecl_c::output_vt   |

   519

                generate_c_vardecl_c::inoutput_vt |

   520

                generate_c_vardecl_c::private_vt  |

   521

                generate_c_vardecl_c::eno_vt);

   522

  vardecl->print(symbol->var_declarations_list);

   523

  delete vardecl;

   524

   525

  /* (B.2) Temporary variable for function's return value */

   526

  /* It will have the same name as the function itself! */