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

    43

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

    44

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

    45

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

    46

    47

#include "../stage4.hh"

    48

    49

    50

    51

    52

    53

    54

    55

    56

//#define DEBUG

    57

#ifdef DEBUG

    58

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

    59

#else

    60

#define TRACE(classname)

    61

#endif

    62

    63

    64

    65

#define ERROR error_exit(__FILE__,__LINE__)

    66

/* function defined in main.cc */

    67

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

    68

    69

    70

    71

    72

    73

    74

    75

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

    76

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

    77

dsymtable_c<function_declaration_c *, &null_symbol1> function_symtable;

    78

    79

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

    80

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

    81

symtable_c<function_block_declaration_c *, &null_symbol2> function_block_type_symtable;

    82

    83

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

    84

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

    85

symtable_c<program_declaration_c *, &null_symbol3> program_type_symtable;

    86

    87

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

    88

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

    89

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

    90

 */

    91

symbol_c null_symbol4;

    92

symtable_c<symbol_c *, &null_symbol4> type_symtable;

    93

    94

    95

    96

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

    97

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

    98

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

    99

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

   100

   101

   102

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

   103

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

   104

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

   105

   106

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

   107

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

   108

   109

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

   110

    /* invalid identifiers... */

   111

    return -1;

   112

   113

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

   114

    return 0;

   115

   116

  /* identifiers do not match! */

   117

  return 1;

   118

}

   119

   120

   121

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

   122

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

   123

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

   124

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

   125

   126

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

   127

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

   128

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

   129

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

   130

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

   131

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

   132

 * default variable.

   133

 *

   134

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

   135

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

   136

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

   137

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

   138

 * constant.

   139

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

   140

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

   141

 * in IL and ST.

   142

 *

   143

 * e.g.:  FUNTION_BLOCK TEST

   144

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

   145

 */

   146

   147

#define FB_FUNCTION_SUFFIX "_body__"

   148

   149

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

   150

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

   151

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

   152

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

   153

 * in IL and ST.

   154

 *

   155

 * e.g.: the body of FUNTION_BLOCK TEST

   156

 * is mapped onto the C function

   157

 *  TEST_body__(TEST *data__)

   158

 */

   159

   160

#define FB_FUNCTION_PARAM "data__"

   161

   162

   163

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

   164

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

   165

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

   166

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

   167

   168

   169

#include "spec_init_separator.cc"

   170

#include "function_param_iterator.cc"

   171

#include "function_call_iterator.cc"

   172

#include "function_call_param_iterator.cc"

   173

#include "type_initial_value.cc"

   174

#include "search_fb_instance_decl.cc"

   175

#include "search_base_type.cc"

   176

#include "search_var_instance_decl.cc"

   177

#include "decompose_var_instance_name.cc"

   178

#include "search_varfb_instance_type.cc"

   179

#include "search_constant_type.cc"

   181

   182

#include "generate_cc_base.cc"

   183

#include "generate_cc_typedecl.cc"

   184

#include "generate_cc_vardecl.cc"

   185

#include "generate_cc_configbody.cc"

   186

   187

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

   188

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

   189

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

   190

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

   191

   192

/* Generate a name for a temporary variable.

   193

 * Each new name generated is appended a different number,

   194

 * starting off from 0.

   195

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

   196

 */

   197

#define VAR_LEADER "__"

   198

#define TEMP_VAR VAR_LEADER "TMP_"

   199

#define SOURCE_VAR VAR_LEADER "SRC_"

   200

   201

#include "generate_cc_tempvardecl.cc"

   202

   203

#include "generate_cc_st.cc"

   204

#include "generate_cc_il.cc"

   205

   206

#include "generate_cc.hh"

   207

   208

   209

   210

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

   211

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

   212

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

   213

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

   214

   215

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

   216

class generate_cc_IL_and_ST_c: public null_visitor_c {

   217

  private:

   218

    stage4out_c *s4o_ptr;

   219

    symbol_c *scope;

   220

    const char *variable_prefix;

   221

   222

  public:

   223

    generate_cc_IL_and_ST_c(stage4out_c *s4o_ptr, symbol_c *scope, const char *variable_prefix = NULL) {

   224

      if (NULL == scope) ERROR;

   225

      this->s4o_ptr = s4o_ptr;

   226

      this->scope = scope;

   227

      this->variable_prefix = variable_prefix;

   228

    }

   229

   230

   231

  public:

   232

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

   233

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

   234

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

   235

   236

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

   237

/* B 2.1 Instructions and Operands */

   238

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

   239

/*| instruction_list il_instruction */

   240

void *visit(instruction_list_c *symbol) {

   241

  generate_cc_il_c generate_cc_il(s4o_ptr, scope, variable_prefix);

   242

  generate_cc_il.generate(symbol);

   243

  return NULL;

   244

}

   245

   246

/* Remainder implemented in generate_cc_il_c... */

   247

   248

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

   249

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

   250

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

   251

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

   252

/* B 3.1 - Expressions */

   253

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

   254

/* Implemented in generate_cc_st_c */

   255

   256

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

   257

/* B 3.2 Statements */

   258

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

   259

void *visit(statement_list_c *symbol) {

   260

  generate_cc_st_c generate_cc_st(s4o_ptr, scope, variable_prefix);

   261

  generate_cc_st.generate(symbol);

   262

  return NULL;

   263

}

   264

   265

/* Remainder implemented in generate_cc_st_c... */

   266

};

   267

   268

   269

   270

   271

   272

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

   273

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

   274

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

   275

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

   276

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

   277

   278

   279

class generate_cc_c: public generate_cc_typedecl_c {

   280

   281

  public:

   282

    generate_cc_c(stage4out_c *s4o_ptr)

   283

      : generate_cc_typedecl_c(s4o_ptr) {};

   284

    virtual ~generate_cc_c(void) {}

   285

   286

   287

  public:

   288

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

   289

/* B 0 - Programming Model */

   290

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

   291

void *visit(library_c *symbol) {

   292

  TRACE("library_c");

   293

   294

  /* Insert the header... */

   295

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

   296

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

   297

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

   298

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

   299

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

   300

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

   301

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

   302

   303

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

   304

  print_list(symbol);

   305

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

   306

   307

  /* Finish off with the main() */

   308

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

   309

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

   310

   311

  // function_symtable.print();

   312

  return NULL;

   313

}

   314

   315

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

   316

/* B.1 - Common elements */

   317

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

   318

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

   319

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

   320

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

   321

  /* done in base class(es) */

   322

   323

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

   324

/* B 1.2 - Constants */

   325

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

   326

  /* originally empty... */

   327

   328

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

   329

/* B 1.2.1 - Numeric Literals */

   330

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

   331

  /* done in base class(es) */

   332

   333

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

   334

/* B.1.2.2   Character Strings */

   335

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

   336

  /* done in base class(es) */

   337

   338

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

   339

/* B 1.2.3 - Time Literals */

   340

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

   341

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

   342

/* B 1.2.3.1 - Duration */

   343

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

   344

  /* done in base class(es) */

   345

   346

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

   347

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

   348

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

   349

  /* done in base class(es) */

   350

   351

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

   352

/* B.1.3 - Data types */

   353

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

   354

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

   355

/* B 1.3.1 - Elementary Data Types */

   356

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

   357

  /* done in base class(es) */

   358

   359

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

   360

/* B.1.3.2 - Generic data types */

   361

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

   362

  /* originally empty... */

   363

   364

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

   365

/* B 1.3.3 - Derived data types */

   366

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

   367

  /* done in base class(es) */

   368

   369

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

   370

/* B 1.4 - Variables */

   371

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

   372

  /* done in base class(es) */

   373

   374

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

   375

/* B.1.4.1   Directly Represented Variables */

   376

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

   377

  /* done in base class(es) */

   378

   379

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

   380

/* B.1.4.2   Multi-element Variables */

   381

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

   382

  /* done in base class(es) */

   383

   384

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

   385

/* B 1.4.3 - Declaration & Initialisation */

   386

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

   387

  /* done in base class(es) */

   388

   389

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

   390

/* B.1.5 - Program organization units */

   391

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

   392

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

   393

/* B 1.5.1 - Functions */

   394

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

   395

   396

public:

   397

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

   398

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

   399

void *visit(function_declaration_c *symbol) {

   400

  generate_cc_vardecl_c *vardecl;

   401

  TRACE("function_declaration_c");

   402

   403

  /* start off by adding this declaration to the global

   404

   * function declaration symbol table...

   405

   */

   406

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

   407

   408

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

   409

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

   410

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

   411

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

   412

  s4o.print(" ");

   413

  /* (A.2) Function name */

   414

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

   415

  s4o.print("(");

   416

   417

  /* (A.3) Function parameters */

   418

  s4o.indent_right();

   419

  vardecl = new generate_cc_vardecl_c(&s4o,

   420

  				      generate_cc_vardecl_c::finterface_vf,

   421

  				      generate_cc_vardecl_c::input_vt |

   422

				      generate_cc_vardecl_c::output_vt |

   423

				      generate_cc_vardecl_c::inoutput_vt);

   424

  vardecl->print(symbol->var_declarations_list);

   425

  delete vardecl;

   426

  s4o.indent_left();

   427

   428

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

   429

   430

  /* (B) Function local variable declaration */

   431

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

   432

  s4o.indent_right();

   433

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

   434

  vardecl->print(symbol->var_declarations_list);

   435

  delete vardecl;

   436

   437

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

   438

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

   439

  s4o.print(s4o.indent_spaces);

   440

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

   441

  s4o.print(" ");

   442

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

   443

  s4o.print(" = ");

   444

  {

   445

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

   446

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

   447

    if (default_value == NULL) ERROR;

   448

    default_value->accept(*this);

   449

  }

   450

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

   451

   452

  /* (C) Function body */

   453

  generate_cc_IL_and_ST_c generate_cc_code(&s4o, symbol);

   454

  symbol->function_body->accept(generate_cc_code);

   455

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

   456

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

   457

  s4o.print(";\n");

   458

  s4o.indent_left();

   459

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

   460

   461

  return NULL;

   462

}

   463

   464

   465

/* The remaining var_declarations_list_c, function_var_decls_c

   466

 * and var2_init_decl_list_c are handled in the generate_cc_vardecl_c class

   467

 */

   468

   469

   470

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

   471

/* B 1.5.2 - Function Blocks */

   472

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

   473

public:

   474

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   475

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

   476

void *visit(function_block_declaration_c *symbol) {

   477

  generate_cc_vardecl_c *vardecl;

   478

  TRACE("function_block_declaration_c");

   479

   480

  /* start off by adding this declaration to the global

   481

   * function block declaration symbol table...

   482

   */

   483

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

   484

   485

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

   486

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

   487

  s4o.print("// FUNCTION_BLOCK ");

   488

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

   489

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

   490

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

   491

  s4o.indent_right();

   492

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

   493

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

   494

  vardecl = new generate_cc_vardecl_c(&s4o,

   495

  				      generate_cc_vardecl_c::local_vf,

   496

  				      generate_cc_vardecl_c::input_vt |

   497

  				      generate_cc_vardecl_c::output_vt |

   498

  				      generate_cc_vardecl_c::inoutput_vt);

   499

  vardecl->print(symbol->var_declarations);

   500

  delete vardecl;

   501

  s4o.print("\n");

   502

  /* (A.3) Private internal variables */

   503

  s4o.print(s4o.indent_spaces + "// FB private variables - TEMP, private and located variables\n");

   504

  vardecl = new generate_cc_vardecl_c(&s4o,

   505

  				      generate_cc_vardecl_c::local_vf,

   506

				      generate_cc_vardecl_c::temp_vt |

   507

  				      generate_cc_vardecl_c::private_vt |

   508

  				      generate_cc_vardecl_c::located_vt);

   509

  vardecl->print(symbol->var_declarations);

   510

  delete vardecl;

   511

  s4o.print("\n");

   512

   513

  /* (A.4) Function Block data structure type name. */

   514

  s4o.indent_left();

   515

  s4o.print("} ");

   516

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

   517

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

   518

   519

   520

  /* (B) Function with FB body */

   521

  /* (B.1) Function declaration */

   522

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

   523

  /* function interface */

   524

  s4o.print("void ");

   525

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

   526

  s4o.print(FB_FUNCTION_SUFFIX);

   527

  s4o.print("(");

   529

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