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>

    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

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

   108

  identifier_c *name2 = dynamic_cast<identifier_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

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

   154

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

   155

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

   156

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

   157

 * in IL and ST.

   158

 *

   159

 * e.g.: the body of FUNTION_BLOCK TEST

   160

 * is mapped onto the C function

   161

 *  TEST_body__(TEST *data__)

   162

 */

   163

   164

#define FB_FUNCTION_PARAM "data__"

   165

   166

   167

#define SFC_STEP_ACTION_PREFIX "__SFC_"

   168

   169

   170

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

   171

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

   172

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

   173

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

   174

   175

   176

#include "spec_init_separator.cc"

   177

#include "function_param_iterator.cc"

   178

#include "function_call_iterator.cc"

   179

#include "function_call_param_iterator.cc"

   180

#include "type_initial_value.cc"

   181

#include "search_fb_instance_decl.cc"

   182

#include "search_base_type.cc"

   183

#include "search_var_instance_decl.cc"

   184

#include "decompose_var_instance_name.cc"

   185

#include "search_varfb_instance_type.cc"

   186

#include "search_constant_type.cc"

   187

#include "search_expression_type.cc"

   188

   189

#include "generate_cc_base.cc"

   190

#include "generate_cc_sfcdecl.cc"

   191

#include "generate_cc_typedecl.cc"

   192

#include "generate_cc_vardecl.cc"

   193

#include "generate_cc_configbody.cc"

   194

   195

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

   196

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

   197

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

   198

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

   199

   200

/* Generate a name for a temporary variable.

   201

 * Each new name generated is appended a different number,

   202

 * starting off from 0.

   203

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

   204

 */

   205

#define VAR_LEADER "__"

   206

#define TEMP_VAR VAR_LEADER "TMP_"

   207

#define SOURCE_VAR VAR_LEADER "SRC_"

   208

   209

#include "generate_cc_tempvardecl.cc"

   210

   211

#include "generate_cc_st.cc"

   212

#include "generate_cc_il.cc"

   213

   214

#include "generate_cc.hh"

   215

   216

   217

   218

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

   219

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

   220

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

   221

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

   222

   223

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

   224

class generate_cc_SFC_IL_ST_c: public null_visitor_c {

   225

  private:

   226

    stage4out_c *s4o_ptr;

   227

    symbol_c *scope;

   228

    const char *variable_prefix;

   229

   230

  public:

   231

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

   232

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

   233

    /* B.1.6  Sequential function chart elements */

   234

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

   235

   236

    /*| sequential_function_chart sfc_network*/

   237

    void *visit(sequential_function_chart_c * symbol);

   238

   239

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

   240

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

   241

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

   242

   243

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

   244

    /* B 2.1 Instructions and Operands */

   245

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

   246

    /*| instruction_list il_instruction */

   247

    void *visit(instruction_list_c *symbol);

   248

   249

    /* Remainder implemented in generate_cc_il_c... */

   250

   251

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

   252

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

   253

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

   254

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

   255

    /* B 3.1 - Expressions */

   256

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

   257

    /* Implemented in generate_cc_st_c */

   258

   259

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

   260

    /* B 3.2 Statements */

   261

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

   262

    void *visit(statement_list_c *symbol);

   263

   264

/* Remainder implemented in generate_cc_st_c... */

   265

};

   266

   267

#include "generate_cc_sfc.cc"

   268

   269

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

   270

  if (NULL == scope) ERROR;

   271

  this->s4o_ptr = s4o_ptr;

   272

  this->scope = scope;

   273

  this->variable_prefix = variable_prefix;

   274

}

   275

   276

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

   277

  generate_cc_sfc_c generate_cc_sfc(s4o_ptr, scope, variable_prefix);

   278

  generate_cc_sfc.generate(symbol);

   279

  return NULL;

   280

}

   281

   282

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

   283

  generate_cc_il_c generate_cc_il(s4o_ptr, scope, variable_prefix);

   284

  generate_cc_il.generate(symbol);

   285

  return NULL;

   286

}

   287

   288

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

   289

  generate_cc_st_c generate_cc_st(s4o_ptr, scope, variable_prefix);

   290

  generate_cc_st.generate(symbol);

   291

  return NULL;

   292

}

   293

   294

   295

   296

   297

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

   298

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

   299

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

   300

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

   301

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

   302

   303

   305

   306

  public:

   308

      : generate_cc_typedecl_c(s4o_ptr) {};

   310

   311

   312

  public:

   313

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

   314

/* B 0 - Programming Model */

   315

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

   316

void *visit(library_c *symbol) {

   317

  TRACE("library_c");

   318

   319

  /* Insert the header... */

   320

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

   321

  s4o.print("/*     FILE GENERATED BY iec2cc            */\n");

   322

  s4o.print("/* Editing this file is not recommended... */\n");

   323

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

   324

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

   325

  s4o.print("#include \"plciec.h\"\n");

   326

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

   327

   328

  /* now do the actual code... */

   329

  print_list(symbol);

   330

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

   331

   332

  /* Finish off with the main() */

   333

  s4o.print("#include \"plciec.cc\"\n");

   334

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

   335

   336

  // function_symtable.print();

   337

  return NULL;

   338

}

   339

   340

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

   341

/* B.1 - Common elements */

   342

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

   343

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

   344

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

   345

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

   346

  /* done in base class(es) */

   347

   348

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

   349

/* B 1.2 - Constants */

   350

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

   351

  /* originally empty... */

   352

   353

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

   354

/* B 1.2.1 - Numeric Literals */

   355

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

   356

  /* done in base class(es) */

   357

   358

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

   359

/* B.1.2.2   Character Strings */

   360

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

   361

  /* done in base class(es) */

   362

   363

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

   364

/* B 1.2.3 - Time Literals */

   365

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

   366

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

   367

/* B 1.2.3.1 - Duration */

   368

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

   369

  /* done in base class(es) */

   370

   371

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

   372

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

   373

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

   374

  /* done in base class(es) */

   375

   376

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

   377

/* B.1.3 - Data types */

   378

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

   379

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

   380

/* B 1.3.1 - Elementary Data Types */

   381

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

   382

  /* done in base class(es) */

   383

   384

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

   385

/* B.1.3.2 - Generic data types */

   386

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

   387

  /* originally empty... */

   388

   389

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

   390

/* B 1.3.3 - Derived data types */

   391

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

   392

  /* done in base class(es) */

   393

   394

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

   395

/* B 1.4 - Variables */

   396

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

   397

  /* done in base class(es) */

   398

   399

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

   400

/* B.1.4.1   Directly Represented Variables */

   401

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

   402

  /* done in base class(es) */

   403

   404

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

   405

/* B.1.4.2   Multi-element Variables */

   406

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

   407

  /* done in base class(es) */

   408

   409

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

   410

/* B 1.4.3 - Declaration & Initialisation */

   411

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

   412

  /* done in base class(es) */

   413

   414

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

   415

/* B.1.5 - Program organization units */

   416

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

   417

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

   418

/* B 1.5.1 - Functions */

   419

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

   420

   421

public:

   422

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

   423

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

   424

void *visit(function_declaration_c *symbol) {

   425

  generate_cc_vardecl_c *vardecl;

   426

  TRACE("function_declaration_c");

   427

   428

  /* start off by adding this declaration to the global

   429

   * function declaration symbol table...

   430

   */

   431

  function_symtable.insert(symbol->derived_function_name, symbol);

   432

   433

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

   434

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

   435

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

   436

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

   437

  s4o.print(" ");

   438

  /* (A.2) Function name */

   439

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

   440

  s4o.print("(");

   441

   442

  /* (A.3) Function parameters */

   443

  s4o.indent_right();

   444

  vardecl = new generate_cc_vardecl_c(&s4o,

   445

  				      generate_cc_vardecl_c::finterface_vf,

   446

  				      generate_cc_vardecl_c::input_vt |

   447

				      generate_cc_vardecl_c::output_vt |

   448

				      generate_cc_vardecl_c::inoutput_vt);

   449

  vardecl->print(symbol->var_declarations_list);

   450

  delete vardecl;

   451

  s4o.indent_left();

   452

   453

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

   454

   455

  /* (B) Function local variable declaration */

   456

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

   457

  s4o.indent_right();

   458

  vardecl = new generate_cc_vardecl_c(&s4o, generate_cc_vardecl_c::localinit_vf, generate_cc_vardecl_c::private_vt);

   459

  vardecl->print(symbol->var_declarations_list);

   460

  delete vardecl;

   461

   462

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

   463

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

   464

  s4o.print(s4o.indent_spaces);

   465

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

   466

  s4o.print(" ");

   467

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

   468

  s4o.print(" = ");

   469

  {

   470

    /* get the default value of this variable's type */

   471

    symbol_c *default_value = (symbol_c *)symbol->type_name->accept(*type_initial_value_c::instance());

   472

    if (default_value == NULL) ERROR;

   473

    default_value->accept(*this);

   474

  }

   475

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

   476

   477

  /* (C) Function body */

   478

  generate_cc_SFC_IL_ST_c generate_cc_code(&s4o, symbol);

   479

  symbol->function_body->accept(generate_cc_code);

   480

  s4o.print(s4o.indent_spaces + "return ");

   481

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

   482

  s4o.print(";\n");

   483

  s4o.indent_left();

   484

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

   485

   486

  return NULL;

   487

}

   488

   489

   490

/* The remaining var_declarations_list_c, function_var_decls_c

   491

 * and var2_init_decl_list_c are handled in the generate_cc_vardecl_c class

   492

 */

   493

   494

   495

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

   496

/* B 1.5.2 - Function Blocks */

   497

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

   498

public:

   499

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   500

//SYM_REF4(function_block_declaration_c, fblock_name, var_declarations, fblock_body, unused)

   501

void *visit(function_block_declaration_c *symbol) {

   502

  generate_cc_vardecl_c *vardecl;

   503

  TRACE("function_block_declaration_c");

   504

   505

  /* start off by adding this declaration to the global

   506

   * function block declaration symbol table...

   507

   */

   508

  function_block_type_symtable.insert(symbol->fblock_name, symbol);

   509

   510

  /* (A) Function Block data structure declaration... */

   511

  /* (A.1) Data structure declaration */

   512

  s4o.print("// FUNCTION_BLOCK ");

   513

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

   514

  s4o.print("\n// Data part\n");

   515

  s4o.print("typedef struct {\n");

   516

  s4o.indent_right();

   517

  /* (A.2) Public variables: i.e. the function parameters... */

   518

  s4o.print(s4o.indent_spaces + "// FB Interface - IN, OUT, IN_OUT variables\n");

   519

  vardecl = new generate_cc_vardecl_c(&s4o,

   520

  				      generate_cc_vardecl_c::local_vf,

   521

  				      generate_cc_vardecl_c::input_vt |

   522

  				      generate_cc_vardecl_c::output_vt |

   523

  				      generate_cc_vardecl_c::inoutput_vt);