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>

    45

    46

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

    47

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

    48

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

    49

    50

#include "../stage4.hh"

    51

    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

/* A symbol table with all globally declared functions... */

    79

function_declaration_c null_symbol1(NULL,NULL,NULL,NULL);

    80

dsymtable_c<function_declaration_c *, &null_symbol1> function_symtable;

    81

    82

/* A symbol table with all globally declared functions block types... */

    83

function_block_declaration_c null_symbol2(NULL,NULL,NULL);

    84

symtable_c<function_block_declaration_c *, &null_symbol2> function_block_type_symtable;

    85

    86

/* A symbol table with all globally declared program types... */

    87

program_declaration_c null_symbol3(NULL,NULL,NULL);

    88

symtable_c<program_declaration_c *, &null_symbol3> program_type_symtable;

    89

    90

/* A symbol table with all user declared type definitions... */

    91

/* Note that function block types and program types have their

    92

 * own symbol tables, so do not get placed in this symbol table!

    93

 */

    94

symbol_c null_symbol4;

    95

symtable_c<symbol_c *, &null_symbol4> type_symtable;

    96

    97

    98

    99

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

   100

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

   101

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

   102

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

   103

   104

   105

/* returns 0 if the names are equal!! */

   106

/* NOTE: it must ignore case!! */

   107

static int compare_identifiers(symbol_c *ident1, symbol_c *ident2) {

   108

   109

  token_c *name1 = dynamic_cast<token_c *>(ident1);

   110

  token_c *name2 = dynamic_cast<token_c *>(ident2);

   111

   112

  if ((name1 == NULL) || (name2 == NULL))

   113

    /* invalid identifiers... */

   114

    return -1;

   115

   116

  if (strcasecmp(name1->value, name2->value) == 0)

   117

    return 0;

   118

   119

  /* identifiers do not match! */

   120

  return 1;

   121

}

   122

   123

   124

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

   125

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

   126

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

   127

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

   128

   129

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

   130

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

   131

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

   132

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

   133

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

   134

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

   135

 * default variable.

   136

 *

   137

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

   138

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

   139

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

   140

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

   141

 * constant.

   142

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

   143

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

   144

 * in IL and ST.

   145

 *

   146

 * e.g.:  FUNTION_BLOCK TEST

   147

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

   148

 */

   149

   150

#define FB_FUNCTION_SUFFIX "_body__"

   151

   152

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

   153

#define FB_INIT_SUFFIX "_init__"

   154

   155

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

   156

#define FB_RUN_SUFFIX "_run__"

   157

   158

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

   159

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

   160

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

   161

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

   162

 * in IL and ST.

   163

 *

   164

 * e.g.: the body of FUNTION_BLOCK TEST

   165

 * is mapped onto the C function

   166

 *  TEST_body__(TEST *data__)

   167

 */

   168

   169

#define FB_FUNCTION_PARAM "data__"

   170

   171

   172

#define SFC_STEP_ACTION_PREFIX "__SFC_"

   173

   174

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

   175

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

   176

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

   177

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

   178

   179

   180

#include "spec_init_separator.cc"

   181

#include "function_param_iterator.cc"

   182

#include "function_call_iterator.cc"

   183

#include "function_call_param_iterator.cc"

   184

#include "type_initial_value.cc"

   185

#include "search_fb_instance_decl.cc"

   186

#include "search_fb_typedecl.cc"

   187

#include "search_base_type.cc"

   188

#include "search_var_instance_decl.cc"

   189

#include "decompose_var_instance_name.cc"

   190

#include "search_varfb_instance_type.cc"

   191

#include "search_constant_type.cc"

   192

#include "search_expression_type.cc"

   193

   194

#include "generate_c_base.cc"

   195

#include "generate_c_typedecl.cc"

   196

#include "generate_c_sfcdecl.cc"

   197

#include "generate_c_vardecl.cc"

   198

#include "generate_c_configbody.cc"

   199

#include "generate_location_list.cc"

   200

#include "generate_var_list.cc"

   201

   202

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

   203

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

   204

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

   205

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

   206

   207

/* Generate a name for a temporary variable.

   208

 * Each new name generated is appended a different number,

   209

 * starting off from 0.

   210

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

   211

 */

   212

#define VAR_LEADER "__"

   213

#define TEMP_VAR VAR_LEADER "TMP_"

   214

#define SOURCE_VAR VAR_LEADER "SRC_"

   215

   216

#include "generate_c_tempvardecl.cc"

   217

   218

#include "generate_c_st.cc"

   219

#include "generate_c_il.cc"

   220

   221

#include "generate_c.hh"

   222

   223

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

   224

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

   225

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

   226

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

   227

   228

#define MILLISECOND 1000000

   229

#define SECOND 1000 * MILLISECOND

   230

   231

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

   232

class calculate_time_c: public iterator_visitor_c {

   233

  private:

   234

    unsigned long time;

   235

    float current_value;

   236

   237

  public:

   238

    calculate_time_c(void){time = 0;};

   239

   240

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

   241

   242

    void *get_integer_value(token_c *token) {

   243

      std::string str = "";

   244

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

   245

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

   246

          str += token->value[i];

   247

      current_value = atof(str.c_str());

   248

      return NULL;

   249

    }

   250

   251

    void *get_float_value(token_c *token) {

   252

      current_value = atof(token->value);

   253

      return NULL;

   254

    }

   255

   256

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

   257

/* B 1.2.1 - Numeric Literals */

   258

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

   259

   260

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

   261

   262

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

   263

/* B 1.2.3.1 - Duration */

   264

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

   265

   266

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

   267

    void *visit(duration_c *symbol) {

   268

      if (symbol->neg != NULL)

   269

        ERROR;

   270

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

   271

      return NULL;

   272

    }

   273

   274

    /* SYM_TOKEN(fixed_point_c) */

   275

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

   276

   277

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

   278

    void *visit(days_c *symbol) {

   279

      if (symbol->hours)

   280

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

   281

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

   282

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

   283

      return NULL;

   284

    }

   285

   286

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

   287

    void *visit(hours_c *symbol) {

   288

      if (symbol->minutes)

   289

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

   290

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

   291

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

   292

      return NULL;

   293

    }

   294

   295

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

   296

    void *visit(minutes_c *symbol) {

   297

      if (symbol->seconds)

   298

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

   299

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

   300

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

   301

      return NULL;

   302

    }

   303

   304

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

   305

    void *visit(seconds_c *symbol) {

   306

      if (symbol->milliseconds)

   307

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

   308

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

   309

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

   310

      return NULL;

   311

    }

   312

   313

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

   314

    void *visit(milliseconds_c *symbol) {

   315

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

   316

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

   317

      return NULL;

   318

    }

   319

};

   320

   321

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

   322

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

   323

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

   324

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

   325

   326

class calculate_common_ticktime_c: public iterator_visitor_c {

   327

  private:

   328

    unsigned long common_ticktime;

   329

   330

  public:

   331

    calculate_common_ticktime_c(void){common_ticktime = 0;}

   332

   333

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

   334

      unsigned long c = a % b;

   335

      if (c == 0)

   336

        return b;

   337

      else

   338

        return euclide(b, c);

   339

    }

   340

   341

    void update_ticktime(unsigned long time) {

   342

      if (common_ticktime == 0)

   343

        common_ticktime = time;

   344

      else if (time > common_ticktime)

   345

        common_ticktime = euclide(time, common_ticktime);

   346

      else

   347

        common_ticktime = euclide(common_ticktime, time);

   348

    }

   349

   350

    unsigned long get_ticktime(void) {

   351

      return common_ticktime;

   352

    }

   353

   354

/*  TASK task_name task_initialization */

   355

//SYM_REF2(task_configuration_c, task_name, task_initialization)  

   356

    void *visit(task_initialization_c *symbol) {

   357

      calculate_time_c calculate_time;

   358

      unsigned long time = 0;

   359

      if (symbol->interval_data_source != NULL) {

   360

        symbol->interval_data_source->accept(calculate_time);

   361

        time = calculate_time.get_time();

   362

      }

   363

      if (time > 0)

   364

        update_ticktime(time);

   365

      return NULL;

   366

    }

   367

};    

   368

   369

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

   370

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

   371

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

   372

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

   373

   374

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

   375

class generate_c_SFC_IL_ST_c: public null_visitor_c {

   376

  private:

   377

    stage4out_c *s4o_ptr;

   378

    symbol_c *scope;

   379

    const char *variable_prefix;

   380

   381

  public:

   382

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

   383

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

   384

    /* B.1.6  Sequential function chart elements */

   385

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

   386

   387

    /*| sequential_function_chart sfc_network*/

   388

    void *visit(sequential_function_chart_c * symbol);

   389

   390

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

   391

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

   392

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

   393

   394

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

   395

    /* B 2.1 Instructions and Operands */

   396

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

   397

    /*| instruction_list il_instruction */

   398

    void *visit(instruction_list_c *symbol);

   399

   400

    /* Remainder implemented in generate_c_il_c... */

   401

   402

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

   403

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

   404

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

   405

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

   406

    /* B 3.1 - Expressions */

   407

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

   408

    /* Implemented in generate_c_st_c */

   409

   410

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

   411

    /* B 3.2 Statements */

   412

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

   413

    void *visit(statement_list_c *symbol);

   414

   415

/* Remainder implemented in generate_c_st_c... */

   416

};

   417

   418

#include "generate_c_sfc.cc"

   419

   420

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

   421

  if (NULL == scope) ERROR;

   422

  this->s4o_ptr = s4o_ptr;

   423

  this->scope = scope;

   424

  this->variable_prefix = variable_prefix;

   425

}

   426

   427

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

   428

  generate_c_sfc_c generate_c_sfc(s4o_ptr, scope, variable_prefix);

   429

  generate_c_sfc.generate(symbol);

   430

  return NULL;

   431

}

   432

   433

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

   434

  generate_c_il_c generate_c_il(s4o_ptr, scope, variable_prefix);

   435

  generate_c_il.generate(symbol);

   436

  return NULL;

   437

}

   438

   439

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

   440

  generate_c_st_c generate_c_st(s4o_ptr, scope, variable_prefix);

   441

  generate_c_st.generate(symbol);

   442

  return NULL;

   443

}

   444

   445

   446

   447

   448

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

   449

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

   450

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

   451

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

   452

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

   453

   454

   455

class generate_c_pous_c: public generate_c_typedecl_c {

   456

   457

  public:

   458

    generate_c_pous_c(stage4out_c *s4o_ptr, stage4out_c *s4o_incl_ptr)

   459

      : generate_c_typedecl_c(s4o_ptr, s4o_incl_ptr) {};

   460

    virtual ~generate_c_pous_c(void) {}

   461

   462

   463

  public:

   464

   465

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

   466

/* B.1 - Common elements */

   467

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

   468

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

   469

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

   470

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

   471

  /* done in base class(es) */

   472

   473

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

   474

/* B 1.2 - Constants */

   475

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

   476

  /* originally empty... */

   477

   478

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

   479

/* B 1.2.1 - Numeric Literals */

   480

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

   481

  /* done in base class(es) */

   482

   483

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

   484

/* B.1.2.2   Character Strings */

   485

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

   486

  /* done in base class(es) */

   487

   488

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

   489

/* B 1.2.3 - Time Literals */

   490

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

   491

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

   492

/* B 1.2.3.1 - Duration */

   493

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

   494

  /* done in base class(es) */

   495

   496

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

   497

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

   498

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

   499

  /* done in base class(es) */

   500

   501

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

   502

/* B.1.3 - Data types */

   503

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

   504

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

   505

/* B 1.3.1 - Elementary Data Types */

   506

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

   507

  /* done in base class(es) */

   508

   509

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

   510

/* B.1.3.2 - Generic data types */

   511

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

   512

  /* originally empty... */

   513

   514

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

   515

/* B 1.3.3 - Derived data types */

   516

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

   517

  /* done in base class(es) */

   518

   519

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

   520

/* B 1.4 - Variables */

   521

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

   522

  /* done in base class(es) */

   523

   524

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

   525

/* B.1.4.1   Directly Represented Variables */

   526

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

   527

  /* done in base class(es) */

   528

   529