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

    45

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

    46

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

    47

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

    48

    49

#include "../stage4.hh"

    50

    51

    52

    53

    54

    55

    56

    57

    58

//#define DEBUG

    59

#ifdef DEBUG

    60

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

    61

#else

    62

#define TRACE(classname)

    63

#endif

    64

    65

    66

    67

#define ERROR error_exit(__FILE__,__LINE__)

    68

/* function defined in main.cc */

    69

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

    70

    71

    72

    73

    74

    75

    76

    77

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

    78

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

    79

dsymtable_c<function_declaration_c *, &null_symbol1> function_symtable;

    80

    81

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

    82

function_block_declaration_c null_symbol2(NULL,NULL,NULL);

    83

symtable_c<function_block_declaration_c *, &null_symbol2> function_block_type_symtable;

    84

    85

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

    86

program_declaration_c null_symbol3(NULL,NULL,NULL);

    87

symtable_c<program_declaration_c *, &null_symbol3> program_type_symtable;

    88

    89

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

    90

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

    91

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

    92

 */

    93

symbol_c null_symbol4;

    94

symtable_c<symbol_c *, &null_symbol4> type_symtable;

    95

    96

    97

    98

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

    99

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

   100

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

   101

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

   102

   103

   104

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

   105

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

   106

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

   107

   108

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

   109

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

   110

   111

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

   112

    /* invalid identifiers... */

   113

    return -1;

   114

   115

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

   116

    return 0;

   117

   118

  /* identifiers do not match! */

   119

  return 1;

   120

}

   121

   122

   123

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

   124

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

   125

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

   126

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

   127

   128

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

   129

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

   130

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

   131

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

   132

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

   133

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

   134

 * default variable.

   135

 *

   136

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

   137

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

   138

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

   139

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

   140

 * constant.

   141

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

   142

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

   143

 * in IL and ST.

   144

 *

   145

 * e.g.:  FUNTION_BLOCK TEST

   146

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

   147

 */

   148

   149

#define FB_FUNCTION_SUFFIX "_body__"

   150

   151

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

   152

#define FB_INIT_SUFFIX "_init__"

   153

   154

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

   155

#define FB_RUN_SUFFIX "_run__"

   156

   157

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

   158

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

   159

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

   160

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

   161

 * in IL and ST.

   162

 *

   163

 * e.g.: the body of FUNTION_BLOCK TEST

   164

 * is mapped onto the C function

   165

 *  TEST_body__(TEST *data__)

   166

 */

   167

   168

#define FB_FUNCTION_PARAM "data__"

   169

   170

   171

#define SFC_STEP_ACTION_PREFIX "__SFC_"

   172

   173

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

   174

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

   175

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

   176

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

   177

   178

   179

#include "spec_init_separator.cc"

   180

#include "function_param_iterator.cc"

   181

#include "function_call_iterator.cc"

   182

#include "function_call_param_iterator.cc"

   183

#include "type_initial_value.cc"

   184

#include "search_fb_instance_decl.cc"

   185

#include "search_fb_typedecl.cc"

   186

#include "search_base_type.cc"

   187

#include "search_var_instance_decl.cc"

   188

#include "decompose_var_instance_name.cc"

   189

#include "search_varfb_instance_type.cc"

   190

#include "search_constant_type.cc"

   191

#include "search_expression_type.cc"

   192

   193

#include "generate_c_base.cc"

   194

#include "generate_c_typedecl.cc"

   195

#include "generate_c_sfcdecl.cc"

   196

#include "generate_c_vardecl.cc"

   197

#include "generate_c_configbody.cc"

   198

#include "generate_location_list.cc"

   199

#include "generate_var_list.cc"

   200

   201

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

   202

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

   203

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

   204

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

   205

   206

/* Generate a name for a temporary variable.

   207

 * Each new name generated is appended a different number,

   208

 * starting off from 0.

   209

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

   210

 */

   211

#define VAR_LEADER "__"

   212

#define TEMP_VAR VAR_LEADER "TMP_"

   213

#define SOURCE_VAR VAR_LEADER "SRC_"

   214

   215

#include "generate_c_tempvardecl.cc"

   216

   217

#include "generate_c_st.cc"

   218

#include "generate_c_il.cc"

   219

   220

#include "generate_c.hh"

   221

   222

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

   223

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

   224

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

   225

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

   226

   227

#define MILLISECOND 1000000

   228

#define SECOND 1000 * MILLISECOND

   229

   230

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

   231

class calculate_time_c: public iterator_visitor_c {

   232

  private:

   233

    unsigned long time;

   234

    float current_value;

   235

   236

  public:

   237

    calculate_time_c(void){time = 0;};

   238

   239

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

   240

   241

    void *get_integer_value(token_c *token) {

   242

      std::string str = "";

   243

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

   244

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

   245

          str += token->value[i];

   246

      current_value = atof(str.c_str());

   247

      return NULL;

   248

    }

   249

   250

    void *get_float_value(token_c *token) {

   251

      current_value = atof(token->value);

   252

      return NULL;

   253

    }

   254

   255

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

   256

/* B 1.2.1 - Numeric Literals */

   257

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

   258

   259

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

   260

   261

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

   262

/* B 1.2.3.1 - Duration */

   263

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

   264

   265

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

   266

    void *visit(duration_c *symbol) {

   267

      if (symbol->neg != NULL)

   268

        ERROR;

   269

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

   270

      return NULL;

   271

    }

   272

   273

    /* SYM_TOKEN(fixed_point_c) */

   274

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

   275

   276

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

   277

    void *visit(days_c *symbol) {

   278

      if (symbol->hours)

   279

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

   280

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

   281

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

   282

      return NULL;

   283

    }

   284

   285

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

   286

    void *visit(hours_c *symbol) {

   287

      if (symbol->minutes)

   288

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

   289

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

   290

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

   291

      return NULL;

   292

    }

   293

   294

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

   295

    void *visit(minutes_c *symbol) {

   296

      if (symbol->seconds)

   297

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

   298

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

   299

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

   300

      return NULL;

   301

    }

   302

   303

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

   304

    void *visit(seconds_c *symbol) {

   305

      if (symbol->milliseconds)

   306

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

   307

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

   308

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

   309

      return NULL;

   310

    }

   311

   312

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

   313

    void *visit(milliseconds_c *symbol) {

   314

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

   315

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

   316

      return NULL;

   317

    }

   318

};

   319

   320

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

   321

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

   322

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

   323

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

   324

   325

class calculate_common_ticktime_c: public iterator_visitor_c {

   326

  private:

   327

    unsigned long common_ticktime;

   328

   329

  public:

   330

    calculate_common_ticktime_c(void){common_ticktime = 0;}

   331

   332

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

   333

      unsigned long c = a % b;

   334

      if (c == 0)

   335

        return b;

   336

      else

   337

        return euclide(b, c);

   338

    }

   339

   340

    void update_ticktime(unsigned long time) {

   341

      if (common_ticktime == 0)

   342

        common_ticktime = time;

   343

      else if (time > common_ticktime)

   344

        common_ticktime = euclide(time, common_ticktime);

   345

      else

   346

        common_ticktime = euclide(common_ticktime, time);

   347

    }

   348

   349

    unsigned long get_ticktime(void) {

   350

      return common_ticktime;

   351

    }

   352

   353

/*  TASK task_name task_initialization */

   354

//SYM_REF2(task_configuration_c, task_name, task_initialization)  

   355

    void *visit(task_initialization_c *symbol) {

   356

      calculate_time_c calculate_time;

   357

      unsigned long time = 0;

   358

      if (symbol->interval_data_source != NULL) {

   359

        symbol->interval_data_source->accept(calculate_time);

   360

        time = calculate_time.get_time();

   361

      }

   362

      if (time > 0)

   363

        update_ticktime(time);

   364

      return NULL;

   365

    }

   366

};    

   367

   368

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

   369

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

   370

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

   371

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

   372

   373

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

   374

class generate_c_SFC_IL_ST_c: public null_visitor_c {

   375

  private:

   376

    stage4out_c *s4o_ptr;

   377

    symbol_c *scope;

   378

    const char *variable_prefix;

   379

   380

  public:

   381

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

   382

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

   383

    /* B.1.6  Sequential function chart elements */

   384

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

   385

   386

    /*| sequential_function_chart sfc_network*/

   387

    void *visit(sequential_function_chart_c * symbol);

   388

   389

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

   390

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

   391

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

   392

   393

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

   394

    /* B 2.1 Instructions and Operands */

   395

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

   396

    /*| instruction_list il_instruction */

   397

    void *visit(instruction_list_c *symbol);

   398

   399

    /* Remainder implemented in generate_c_il_c... */

   400

   401

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

   402

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

   403

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

   404

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

   405

    /* B 3.1 - Expressions */

   406

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

   407

    /* Implemented in generate_c_st_c */

   408

   409

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

   410

    /* B 3.2 Statements */

   411

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

   412

    void *visit(statement_list_c *symbol);

   413

   414

/* Remainder implemented in generate_c_st_c... */

   415

};

   416

   417

#include "generate_c_sfc.cc"

   418

   419

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

   420

  if (NULL == scope) ERROR;

   421

  this->s4o_ptr = s4o_ptr;

   422

  this->scope = scope;

   423

  this->variable_prefix = variable_prefix;

   424

}

   425

   426

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

   427

  generate_c_sfc_c generate_c_sfc(s4o_ptr, scope, variable_prefix);

   428

  generate_c_sfc.generate(symbol);

   429

  return NULL;

   430

}

   431

   432

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

   433

  generate_c_il_c generate_c_il(s4o_ptr, scope, variable_prefix);

   434

  generate_c_il.generate(symbol);

   435

  return NULL;

   436

}

   437

   438

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

   439

  generate_c_st_c generate_c_st(s4o_ptr, scope, variable_prefix);

   440

  generate_c_st.generate(symbol);

   441

  return NULL;

   442

}

   443

   444

   445

   446

   447

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

   448

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

   449

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

   450

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

   451

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

   452

   453

   454

class generate_c_pous_c: public generate_c_typedecl_c {

   455

   456

  public:

   457

    generate_c_pous_c(stage4out_c *s4o_ptr)

   458

      : generate_c_typedecl_c(s4o_ptr) {};

   459

    virtual ~generate_c_pous_c(void) {}

   460

   461

   462

  public:

   463

   464

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

   465

/* B.1 - Common elements */

   466

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

   467

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

   468

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

   469

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

   470

  /* done in base class(es) */

   471

   472

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

   473

/* B 1.2 - Constants */

   474

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

   475

  /* originally empty... */

   476

   477

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

   478

/* B 1.2.1 - Numeric Literals */

   479

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

   480

  /* done in base class(es) */

   481

   482

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

   483

/* B.1.2.2   Character Strings */

   484

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

   485

  /* done in base class(es) */

   486

   487

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

   488

/* B 1.2.3 - Time Literals */

   489

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

   490

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

   491

/* B 1.2.3.1 - Duration */

   492

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

   493

  /* done in base class(es) */

   494

   495

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

   496

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

   497

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

   498

  /* done in base class(es) */

   499

   500

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

   501

/* B.1.3 - Data types */

   502

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

   503

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

   504

/* B 1.3.1 - Elementary Data Types */

   505

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

   506

  /* done in base class(es) */

   507

   508

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

   509

/* B.1.3.2 - Generic data types */

   510

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

   511

  /* originally empty... */

   512

   513

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

   514

/* B 1.3.3 - Derived data types */

   515

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

   516

  /* done in base class(es) */

   517

   518

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

   519

/* B 1.4 - Variables */

   520

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

   521

  /* done in base class(es) */

   522

   523

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

   524

/* B.1.4.1   Directly Represented Variables */

   525

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

   526

  /* done in base class(es) */

   527

   528

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

   529

/* B.1.4.2   Multi-element Variables */