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

    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

    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;

   100

   101

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

   102

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

   103

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

   104

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

   105

   106

   107

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

   108

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

   109

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

   110

   111

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

   112

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

   113

   114

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

   115

    /* invalid identifiers... */

   116

    return -1;

   117

   118

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

   119

    return 0;

   120

   121

  /* identifiers do not match! */

   122

  return 1;

   123

}

   124

   125

   126

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

   127

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

   128

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

   129

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

   130

   131

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

   132

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

   133

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

   134

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

   135

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

   136

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

   137

 * default variable.

   138

 *

   139

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

   140

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

   141

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

   142

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

   143

 * constant.

   144

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

   145

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

   146

 * in IL and ST.

   147

 *

   148

 * e.g.:  FUNTION_BLOCK TEST

   149

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

   150

 */

   151

   152

#define FB_FUNCTION_SUFFIX "_body__"

   153

   154

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

   155

#define FB_INIT_SUFFIX "_init__"

   156

   157

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

   158

#define FB_RUN_SUFFIX "_run__"

   159

   160

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

   161

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

   162

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

   163

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

   164

 * in IL and ST.

   165

 *

   166

 * e.g.: the body of FUNTION_BLOCK TEST

   167

 * is mapped onto the C function

   168

 *  TEST_body__(TEST *data__)

   169

 */

   170

   171

#define FB_FUNCTION_PARAM "data__"

   172

   173

   174

#define SFC_STEP_ACTION_PREFIX "__SFC_"

   175

   176

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

   177

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

   178

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

   179

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

   180

   181

   182

#include "spec_init_separator.cc"

   183

#include "function_param_iterator.cc"

   184

#include "function_call_iterator.cc"

   185

#include "function_call_param_iterator.cc"

   186

#include "type_initial_value.cc"

   187

#include "search_fb_instance_decl.cc"

   188

#include "search_fb_typedecl.cc"

   189

#include "search_base_type.cc"

   190

#include "search_var_instance_decl.cc"

   191

#include "decompose_var_instance_name.cc"

   192

#include "search_varfb_instance_type.cc"

   193

#include "search_constant_type.cc"

   194

#include "search_expression_type.cc"

   195

   196

#include "generate_c_base.cc"

   197

#include "generate_c_typedecl.cc"

   198

#include "generate_c_sfcdecl.cc"

   199

#include "generate_c_vardecl.cc"

   200

#include "generate_c_configbody.cc"

   201

#include "generate_location_list.cc"

   202

#include "generate_var_list.cc"

   203

   204

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

   205

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

   206

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

   207

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

   208

   209

/* Generate a name for a temporary variable.

   210

 * Each new name generated is appended a different number,

   211

 * starting off from 0.

   212

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

   213

 */

   214

#define VAR_LEADER "__"

   215

#define TEMP_VAR VAR_LEADER "TMP_"

   216

#define SOURCE_VAR VAR_LEADER "SRC_"

   217

   218

#include "generate_c_tempvardecl.cc"

   219

   220

#include "generate_c_st.cc"

   221

#include "generate_c_il.cc"

   222

   223

#include "generate_c.hh"

   224

   225

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

   226

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

   227

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

   228

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

   229

   230

#define MILLISECOND 1000000

   231

#define SECOND 1000 * MILLISECOND

   232

   233

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

   234

class calculate_time_c: public iterator_visitor_c {

   235

  private:

   236

    unsigned long time;

   237

    float current_value;

   238

   239

  public:

   240

    calculate_time_c(void){time = 0;};

   241

   242

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

   243

   244

    void *get_integer_value(token_c *token) {

   245

      std::string str = "";

   246

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

   247

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

   248

          str += token->value[i];

   249

      current_value = atof(str.c_str());

   250

      return NULL;

   251

    }

   252

   253

    void *get_float_value(token_c *token) {

   254

      current_value = atof(token->value);

   255

      return NULL;

   256

    }

   257

   258

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

   259

/* B 1.2.1 - Numeric Literals */

   260

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

   261

   262

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

   263

   264

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

   265

/* B 1.2.3.1 - Duration */

   266

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

   267

   268

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

   269

    void *visit(duration_c *symbol) {

   270

      if (symbol->neg != NULL)

   271

        ERROR;

   272

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

   273

      return NULL;

   274

    }

   275

   276

    /* SYM_TOKEN(fixed_point_c) */

   277

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

   278

   279

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

   280

    void *visit(days_c *symbol) {

   281

      if (symbol->hours)

   282

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

   283

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

   284

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

   285

      return NULL;

   286

    }

   287

   288

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

   289

    void *visit(hours_c *symbol) {

   290

      if (symbol->minutes)

   291

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

   292

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

   293

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

   294

      return NULL;

   295

    }

   296

   297

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

   298

    void *visit(minutes_c *symbol) {

   299

      if (symbol->seconds)

   300

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

   301

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

   302

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

   303

      return NULL;

   304

    }

   305

   306

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

   307

    void *visit(seconds_c *symbol) {

   308

      if (symbol->milliseconds)

   309

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

   310

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

   311

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

   312

      return NULL;

   313

    }

   314

   315

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

   316

    void *visit(milliseconds_c *symbol) {

   317

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

   318

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

   319

      return NULL;

   320

    }

   321

};

   322

   323

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

   324

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

   325

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

   326

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

   327

   328

class calculate_common_ticktime_c: public iterator_visitor_c {

   329

  private:

   330

    unsigned long common_ticktime;

   331

   332

  public:

   333

    calculate_common_ticktime_c(void){common_ticktime = 0;}

   334

   335

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

   336

      unsigned long c = a % b;

   337

      if (c == 0)

   338

        return b;

   339

      else

   340

        return euclide(b, c);

   341

    }

   342

   343

    void update_ticktime(unsigned long time) {

   344

      if (common_ticktime == 0)

   345

        common_ticktime = time;

   346

      else if (time > common_ticktime)

   347

        common_ticktime = euclide(time, common_ticktime);

   348

      else

   349

        common_ticktime = euclide(common_ticktime, time);

   350

    }

   351

   352

    unsigned long get_ticktime(void) {

   353

      return common_ticktime;

   354

    }

   355

   356

/*  TASK task_name task_initialization */

   357

//SYM_REF2(task_configuration_c, task_name, task_initialization)  

   358

    void *visit(task_initialization_c *symbol) {

   359

      calculate_time_c calculate_time;

   360

      unsigned long time = 0;

   361

      if (symbol->interval_data_source != NULL) {

   362

        symbol->interval_data_source->accept(calculate_time);

   363

        time = calculate_time.get_time();

   364

      }

   365

      if (time > 0)

   366

        update_ticktime(time);

   367

      return NULL;

   368

    }

   369

};    

   370

   371

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

   372

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

   373

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

   374

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

   375

   376

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

   377

class generate_c_SFC_IL_ST_c: public null_visitor_c {

   378

  private:

   379

    stage4out_c *s4o_ptr;

   380

    symbol_c *scope;

   381

    const char *variable_prefix;

   382

   383

  public:

   384

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

   385

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

   386

    /* B.1.6  Sequential function chart elements */

   387

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

   388

   389

    /*| sequential_function_chart sfc_network*/

   390

    void *visit(sequential_function_chart_c * symbol);

   391

   392

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

   393

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

   394

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

   395

   396

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

   397

    /* B 2.1 Instructions and Operands */

   398

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

   399

    /*| instruction_list il_instruction */

   400

    void *visit(instruction_list_c *symbol);

   401

   402

    /* Remainder implemented in generate_c_il_c... */

   403

   404

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

   405

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

   406

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

   407

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

   408

    /* B 3.1 - Expressions */

   409

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

   410

    /* Implemented in generate_c_st_c */

   411

   412

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

   413

    /* B 3.2 Statements */

   414

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

   415

    void *visit(statement_list_c *symbol);

   416

   417

/* Remainder implemented in generate_c_st_c... */

   418

};

   419

   420

#include "generate_c_sfc.cc"

   421

   422

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

   423

  if (NULL == scope) ERROR;

   424

  this->s4o_ptr = s4o_ptr;

   425

  this->scope = scope;

   426

  this->variable_prefix = variable_prefix;

   427

}

   428

   429

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

   430

  generate_c_sfc_c generate_c_sfc(s4o_ptr, scope, variable_prefix);

   431

  generate_c_sfc.generate(symbol);

   432

  return NULL;

   433

}

   434

   435

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

   436

  generate_c_il_c generate_c_il(s4o_ptr, scope, variable_prefix);

   437

  generate_c_il.generate(symbol);

   438

  return NULL;

   439

}

   440

   441

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

   442

  generate_c_st_c generate_c_st(s4o_ptr, scope, variable_prefix);

   443

  generate_c_st.generate(symbol);

   444

  return NULL;

   445

}

   446

   447

   448

   449

   450

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

   451

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

   452

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

   453

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

   454

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

   455

   456

   457

class generate_c_pous_c: public generate_c_typedecl_c {

   458

   459

  public:

   460

    generate_c_pous_c(stage4out_c *s4o_ptr, stage4out_c *s4o_incl_ptr)

   461

      : generate_c_typedecl_c(s4o_ptr, s4o_incl_ptr) {};

   462

    virtual ~generate_c_pous_c(void) {}

   463

   464

   465

  public:

   466

   467

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

   468

/* B.1 - Common elements */

   469

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

   470

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

   471

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

   472

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

   473

  /* done in base class(es) */

   474

   475

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

   476

/* B 1.2 - Constants */

   477

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

   478

  /* originally empty... */

   479

   480

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

   481

/* B 1.2.1 - Numeric Literals */

   482

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

   483

  /* done in base class(es) */

   484

   485

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

   486

/* B.1.2.2   Character Strings */

   487

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

   488

  /* done in base class(es) */

   489

   490

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

   491

/* B 1.2.3 - Time Literals */

   492

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

   493

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

   494

/* B 1.2.3.1 - Duration */

   495

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

   496

  /* done in base class(es) */

   497

   498

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

   499

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

   500

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

   501

  /* done in base class(es) */

   502

   503

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

   504

/* B.1.3 - Data types */

   505

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

   506

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

   507

/* B 1.3.1 - Elementary Data Types */

   508

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

   509

  /* done in base class(es) */

   510

   511

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

   512

/* B.1.3.2 - Generic data types */

   513

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

   514

  /* originally empty... */

   515

   516

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

   517

/* B 1.3.3 - Derived data types */

   518

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

   519

  /* done in base class(es) */

   520

   521

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

   522

/* B 1.4 - Variables */

   523

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

   524

  /* done in base class(es) */

   525

   526

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

   527

/* B.1.4.1   Directly Represented Variables */

   528

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