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

    44

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

    45

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

    46

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

    47

    48

#include "../stage4.hh"

    49

    50

    51

    52

    53

    54

    55

    56

    57

//#define DEBUG

    58

#ifdef DEBUG

    59

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

    60

#else

    61

#define TRACE(classname)

    62

#endif

    63

    64

    65

    66

#define ERROR error_exit(__FILE__,__LINE__)

    67

/* function defined in main.cc */

    68

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

    69

    70

    71

    72

    73

    74

    75

    76

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

    77

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

    78

dsymtable_c<function_declaration_c *, &null_symbol1> function_symtable;

    79

    80

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

    81

function_block_declaration_c null_symbol2(NULL,NULL,NULL,NULL);

    82

symtable_c<function_block_declaration_c *, &null_symbol2> function_block_type_symtable;

    83

    84

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

    85

program_declaration_c null_symbol3(NULL,NULL,NULL,NULL);

    86

symtable_c<program_declaration_c *, &null_symbol3> program_type_symtable;

    87

    88

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

    89

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

    90

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

    91

 */

    92

symbol_c null_symbol4;

    93

symtable_c<symbol_c *, &null_symbol4> type_symtable;

    94

    95

    96

    97

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

    98

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

    99

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

   100

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

   101

   102

   103

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

   104

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

   105

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

   106

   107

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

   108

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

   109

   110

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

   111

    /* invalid identifiers... */

   112

    return -1;

   113

   114

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

   115

    return 0;

   116

   117

  /* identifiers do not match! */

   118

  return 1;

   119

}

   120

   121

   122

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

   123

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

   124

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

   125

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

   126

   127

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

   128

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

   129

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

   130

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

   131

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

   132

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

   133

 * default variable.

   134

 *

   135

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

   136

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

   137

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

   138

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

   139

 * constant.

   140

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

   141

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

   142

 * in IL and ST.

   143

 *

   144

 * e.g.:  FUNTION_BLOCK TEST

   145

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

   146

 */

   147

   148

#define FB_FUNCTION_SUFFIX "_body__"

   149

   150

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

   151

#define FB_INIT_SUFFIX "_init__"

   152

   153

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

   154

#define FB_RUN_SUFFIX "_run__"

   155

   156

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

   157

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

   158

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

   159

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

   160

 * in IL and ST.

   161

 *

   162

 * e.g.: the body of FUNTION_BLOCK TEST

   163

 * is mapped onto the C function

   164

 *  TEST_body__(TEST *data__)

   165

 */

   166

   167

#define FB_FUNCTION_PARAM "data__"

   168

   169

   170

#define SFC_STEP_ACTION_PREFIX "__SFC_"

   171

   172

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

   173

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

   174

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

   175

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

   176

   177

   178

#include "spec_init_separator.cc"

   179

#include "function_param_iterator.cc"

   180

#include "function_call_iterator.cc"

   181

#include "function_call_param_iterator.cc"

   182

#include "type_initial_value.cc"

   183

#include "search_fb_instance_decl.cc"

   184

#include "search_base_type.cc"

   185

#include "search_var_instance_decl.cc"

   186

#include "decompose_var_instance_name.cc"

   187

#include "search_varfb_instance_type.cc"

   188

#include "search_constant_type.cc"

   189

#include "search_expression_type.cc"

   190

   191

#include "generate_cc_base.cc"

   192

#include "generate_cc_sfcdecl.cc"

   193

#include "generate_cc_typedecl.cc"

   194

#include "generate_cc_vardecl.cc"

   195

#include "generate_cc_configbody.cc"

   196

#include "generate_location_list.cc"

   197

   198

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

   199

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

   200

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

   201

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

   202

   203

/* Generate a name for a temporary variable.

   204

 * Each new name generated is appended a different number,

   205

 * starting off from 0.

   206

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

   207

 */

   208

#define VAR_LEADER "__"

   209

#define TEMP_VAR VAR_LEADER "TMP_"

   210

#define SOURCE_VAR VAR_LEADER "SRC_"

   211

   212

#include "generate_cc_tempvardecl.cc"

   213

   214

#include "generate_cc_st.cc"

   215

#include "generate_cc_il.cc"

   216

   217

#include "generate_cc.hh"

   218

   219

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

   220

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

   221

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

   222

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

   223

   224

#define MILLISECOND 1000000

   225

#define SECOND 1000 * MILLISECOND

   226

   227

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

   228

class calculate_time_c: public iterator_visitor_c {

   229

  private:

   230

    unsigned long time;

   231

    float current_value;

   232

   233

  public:

   234

    calculate_time_c(void){time = 0;};

   235

   236

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

   237

   238

    void *get_integer_value(token_c *token) {

   239

      std::string str = "";

   240

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

   241

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

   242

          str += token->value[i];

   243

      current_value = atof(str.c_str());

   244

      return NULL;

   245

    }

   246

   247

    void *get_float_value(token_c *token) {

   248

      current_value = atof(token->value);

   249

      return NULL;

   250

    }

   251

   252

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

   253

/* B 1.2.1 - Numeric Literals */

   254

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

   255

   256

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

   257

   258

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

   259

/* B 1.2.3.1 - Duration */

   260

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

   261

   262

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

   263

    void *visit(duration_c *symbol) {

   264

      if (symbol->neg != NULL)

   265

        ERROR;

   266

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

   267

      return NULL;

   268

    }

   269

   270

    /* SYM_TOKEN(fixed_point_c) */

   271

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

   272

   273

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

   274

    void *visit(days_c *symbol) {

   275

      if (symbol->hours)

   276

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

   277

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

   278

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

   279

      return NULL;

   280

    }

   281

   282

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

   283

    void *visit(hours_c *symbol) {

   284

      if (symbol->minutes)

   285

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

   286

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

   287

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

   288

      return NULL;

   289

    }

   290

   291

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

   292

    void *visit(minutes_c *symbol) {

   293

      if (symbol->seconds)

   294

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

   295

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

   296

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

   297

      return NULL;

   298

    }

   299

   300

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

   301

    void *visit(seconds_c *symbol) {

   302

      if (symbol->milliseconds)

   303

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

   304

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

   305

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

   306

      return NULL;

   307

    }

   308

   309

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

   310

    void *visit(milliseconds_c *symbol) {

   311

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

   312

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

   313

      return NULL;

   314

    }

   315

};

   316

   317

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

   318

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

   319

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

   320

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

   321

   322

class calculate_common_ticktime_c: public iterator_visitor_c {

   323

  private:

   324

    unsigned long common_ticktime;

   325

   326

  public:

   327

    calculate_common_ticktime_c(void){common_ticktime = 0;}

   328

   329

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

   330

      unsigned long c = a % b;

   331

      if (c == 0)

   332

        return b;

   333

      else

   334

        return euclide(b, c);

   335

    }

   336

   337

    void update_ticktime(unsigned long time) {

   338

      if (common_ticktime == 0)

   339

        common_ticktime = time;

   340

      else if (time > common_ticktime)

   341

        common_ticktime = euclide(time, common_ticktime);

   342

      else

   343

        common_ticktime = euclide(common_ticktime, time);

   344

    }

   345

   346

    unsigned long get_ticktime(void) {

   347

      return common_ticktime;

   348

    }

   349

   350

/*  TASK task_name task_initialization */

   351

//SYM_REF2(task_configuration_c, task_name, task_initialization)  

   352

    void *visit(task_initialization_c *symbol) {

   353

      calculate_time_c calculate_time;

   354

      unsigned long time = 0;

   355

      if (symbol->interval_data_source != NULL) {

   356

        symbol->interval_data_source->accept(calculate_time);

   357

        time = calculate_time.get_time();

   358

      }

   359

      if (time > 0)

   360

        update_ticktime(time);

   361

      return NULL;

   362

    }

   363

};    

   364

   365

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

   366

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

   367

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

   368

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

   369

   370

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

   371

class generate_cc_SFC_IL_ST_c: public null_visitor_c {

   372

  private:

   373

    stage4out_c *s4o_ptr;

   374

    symbol_c *scope;

   375

    const char *variable_prefix;

   376

   377

  public:

   378

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

   379

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

   380

    /* B.1.6  Sequential function chart elements */

   381

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

   382

   383

    /*| sequential_function_chart sfc_network*/

   384

    void *visit(sequential_function_chart_c * symbol);

   385

   386

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

   387

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

   388

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

   389

   390

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

   391

    /* B 2.1 Instructions and Operands */

   392

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

   393

    /*| instruction_list il_instruction */

   394

    void *visit(instruction_list_c *symbol);

   395

   396

    /* Remainder implemented in generate_cc_il_c... */

   397

   398

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

   399

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

   400

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

   401

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

   402

    /* B 3.1 - Expressions */

   403

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

   404

    /* Implemented in generate_cc_st_c */

   405

   406

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

   407

    /* B 3.2 Statements */

   408

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

   409

    void *visit(statement_list_c *symbol);

   410

   411

/* Remainder implemented in generate_cc_st_c... */

   412

};

   413

   414

#include "generate_cc_sfc.cc"

   415

   416

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

   417

  if (NULL == scope) ERROR;

   418

  this->s4o_ptr = s4o_ptr;

   419

  this->scope = scope;

   420

  this->variable_prefix = variable_prefix;

   421

}

   422

   423

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

   424

  generate_cc_sfc_c generate_cc_sfc(s4o_ptr, scope, variable_prefix);

   425

  generate_cc_sfc.generate(symbol);

   426

  return NULL;

   427

}

   428

   429

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

   430

  generate_cc_il_c generate_cc_il(s4o_ptr, scope, variable_prefix);

   431

  generate_cc_il.generate(symbol);

   432

  return NULL;

   433

}

   434

   435

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

   436

  generate_cc_st_c generate_cc_st(s4o_ptr, scope, variable_prefix);

   437

  generate_cc_st.generate(symbol);

   438

  return NULL;

   439

}

   440

   441

   442

   443

   444

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

   445

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

   446

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

   447

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

   448

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

   449

   450

   451

class generate_cc_pous_c: public generate_cc_typedecl_c {

   452

   453

  public:

   454

    generate_cc_pous_c(stage4out_c *s4o_ptr)

   455

      : generate_cc_typedecl_c(s4o_ptr) {};

   456

    virtual ~generate_cc_pous_c(void) {}

   457

   458

   459

  public:

   460

   461

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

   462

/* B.1 - Common elements */

   463

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

   464

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

   465

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

   466

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

   467

  /* done in base class(es) */

   468

   469

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

   470

/* B 1.2 - Constants */

   471

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

   472

  /* originally empty... */

   473

   474

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

   475

/* B 1.2.1 - Numeric Literals */

   476

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

   477

  /* done in base class(es) */

   478

   479

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

   480

/* B.1.2.2   Character Strings */

   481

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

   482

  /* done in base class(es) */

   483

   484

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

   485

/* B 1.2.3 - Time Literals */

   486

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

   487

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

   488

/* B 1.2.3.1 - Duration */

   489

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

   490

  /* done in base class(es) */

   491

   492

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

   493

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

   494

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

   495

  /* done in base class(es) */

   496

   497

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

   498

/* B.1.3 - Data types */

   499

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

   500

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

   501

/* B 1.3.1 - Elementary Data Types */

   502

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

   503

  /* done in base class(es) */

   504

   505

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

   506

/* B.1.3.2 - Generic data types */

   507

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

   508

  /* originally empty... */

   509

   510

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

   511

/* B 1.3.3 - Derived data types */

   512

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

   513

  /* done in base class(es) */