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

    42

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

    43

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

    44

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

    45

    46

#include "../stage4.hh"

    47

    48

    49

    50

    51

    52

    53

    54

    55

//#define DEBUG

    56

#ifdef DEBUG

    57

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

    58

#else

    59

#define TRACE(classname)

    60

#endif

    61

    62

    63

    64

#define ERROR error_exit(__FILE__,__LINE__)

    65

/* function defined in main.cc */

    66

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

    67

    68

    69

    70

    71

    72

    73

    74

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

    75

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

    76

dsymtable_c<function_declaration_c *, &null_symbol1> function_symtable;

    77

    78

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

    79

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

    80

symtable_c<function_block_declaration_c *, &null_symbol2> function_block_type_symtable;

    81

    82

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

    83

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

    84

symtable_c<program_declaration_c *, &null_symbol3> program_type_symtable;

    85

    86

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

    87

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

    88

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

    89

 */

    90

symbol_c null_symbol4;

    91

symtable_c<symbol_c *, &null_symbol4> type_symtable;

    92

    93

    94

    95

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

    96

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

    97

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

    98

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

    99

   100

   101

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

   102

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

   103

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

   104

   105

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

   106

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

   107

   108

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

   109

    /* invalid identifiers... */

   110

    return -1;

   111

   112

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

   113

    return 0;

   114

   115

  /* identifiers do not match! */

   116

  return 1;

   117

}

   118

   119

   120

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

   121

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

   122

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

   123

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

   124

   125

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

   126

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

   127

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

   128

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

   129

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

   130

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

   131

 * default variable.

   132

 *

   133

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

   134

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

   135

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

   136

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

   137

 * constant.

   138

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

   139

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

   140

 * in IL and ST.

   141

 *

   142

 * e.g.:  FUNTION_BLOCK TEST

   143

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

   144

 */

   145

   146

#define FB_FUNCTION_SUFFIX "_body__"

   147

   148

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

   149

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

   150

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

   151

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

   152

 * in IL and ST.

   153

 *

   154

 * e.g.: the body of FUNTION_BLOCK TEST

   155

 * is mapped onto the C function

   156

 *  TEST_body__(TEST *data__)

   157

 */

   158

   159

#define FB_FUNCTION_PARAM "data__"

   160

   161

   162

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

   163

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

   164

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

   165

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

   166

   167

   168

#include "spec_init_separator.cc"

   169

#include "function_param_iterator.cc"

   170

#include "function_call_iterator.cc"

   171

#include "function_call_param_iterator.cc"

   172

#include "type_initial_value.cc"

   173

#include "search_fb_instance_decl.cc"

   174

#include "search_base_type.cc"

   175

#include "search_var_instance_decl.cc"

   176

#include "decompose_var_instance_name.cc"

   177

#include "search_varfb_instance_type.cc"

   178

#include "search_constant_type.cc"

   179

   180

#include "generate_cc_base.cc"

   181

#include "generate_cc_typedecl.cc"

   182

#include "generate_cc_vardecl.cc"

   183

#include "generate_cc_configbody.cc"

   184

   185

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

   186

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

   187

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

   188

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

   189

   190

/* Generate a name for a temporary variable.

   191

 * Each new name generated is appended a different number,

   192

 * starting off from 0.

   193

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

   194

 */

   195

#define VAR_LEADER "__"

   196

#define TEMP_VAR VAR_LEADER "TMP_"

   197

#define SOURCE_VAR VAR_LEADER "SRC_"

   198

   199

#include "generate_cc_tempvardecl.cc"

   200

   201

#include "generate_cc_st.cc"

   202

#include "generate_cc_il.cc"

   203

   204

#include "generate_cc.hh"

   205

   206

   207

   208

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

   209

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

   210

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

   211

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

   212

   213

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

   214

class generate_cc_IL_and_ST_c: public null_visitor_c {

   215

  private:

   216

    stage4out_c *s4o_ptr;

   217

    symbol_c *scope;

   218

    const char *variable_prefix;

   219

   220

  public:

   221

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

   222

      if (NULL == scope) ERROR;

   223

      this->s4o_ptr = s4o_ptr;

   224

      this->scope = scope;

   225

      this->variable_prefix = variable_prefix;

   226

    }

   227

   228

   229

  public:

   230

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

   231

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

   232

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

   233

   234

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

   235

/* B 2.1 Instructions and Operands */

   236

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

   237

/*| instruction_list il_instruction */

   238

void *visit(instruction_list_c *symbol) {

   239

  generate_cc_il_c generate_cc_il(s4o_ptr, scope, variable_prefix);

   240

  generate_cc_il.generate(symbol);

   241

  return NULL;

   242

}

   243

   244

/* Remainder implemented in generate_cc_il_c... */

   245

   246

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

   247

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

   248

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

   249

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

   250

/* B 3.1 - Expressions */

   251

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

   252

/* Implemented in generate_cc_st_c */

   253

   254

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

   255

/* B 3.2 Statements */

   256

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

   257

void *visit(statement_list_c *symbol) {

   258

  generate_cc_st_c generate_cc_st(s4o_ptr, scope, variable_prefix);

   259

  generate_cc_st.generate(symbol);

   260

  return NULL;

   261

}

   262

   263

/* Remainder implemented in generate_cc_st_c... */

   264

};

   265

   266

   267

   268

   269

   270

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

   271

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

   272

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

   273

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

   274

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

   275

   276

   277

class generate_cc_c: public generate_cc_typedecl_c {

   278

   279

  public:

   280

    generate_cc_c(stage4out_c *s4o_ptr)

   281

      : generate_cc_typedecl_c(s4o_ptr) {};

   282

    virtual ~generate_cc_c(void) {}

   283

   284

   285

  public:

   286

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

   287

/* B 0 - Programming Model */

   288

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

   289

void *visit(library_c *symbol) {

   290

  TRACE("library_c");

   291

   292

  /* Insert the header... */

   293

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

   294

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

   295

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

   296

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

   297

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

   298

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

   299

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

   300

   301

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

   302

  print_list(symbol);

   303

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

   304

   305

  /* Finish off with the main() */

   306

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

   307

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

   308

   309

  // function_symtable.print();

   310

  return NULL;

   311

}

   312

   313

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

   314

/* B.1 - Common elements */

   315

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

   316

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

   317

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

   318

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

   319

  /* done in base class(es) */

   320

   321

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

   322

/* B 1.2 - Constants */

   323

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

   324

  /* originally empty... */

   325

   326

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

   327

/* B 1.2.1 - Numeric Literals */

   328

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

   329

  /* done in base class(es) */

   330

   331

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

   332

/* B.1.2.2   Character Strings */

   333

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

   334

  /* done in base class(es) */

   335

   336

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

   337

/* B 1.2.3 - Time Literals */

   338

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

   339

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

   340

/* B 1.2.3.1 - Duration */

   341

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

   342

  /* done in base class(es) */

   343

   344

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

   345

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

   346

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

   347

  /* done in base class(es) */

   348

   349

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

   350

/* B.1.3 - Data types */

   351

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

   352

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

   353

/* B 1.3.1 - Elementary Data Types */

   354

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

   355

  /* done in base class(es) */

   356

   357

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

   358

/* B.1.3.2 - Generic data types */

   359

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

   360

  /* originally empty... */

   361

   362

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

   363

/* B 1.3.3 - Derived data types */

   364

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

   365

  /* done in base class(es) */

   366

   367

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

   368

/* B 1.4 - Variables */

   369

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

   370

  /* done in base class(es) */

   371

   372

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

   373

/* B.1.4.1   Directly Represented Variables */

   374

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

   375

  /* done in base class(es) */

   376

   377

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

   378

/* B.1.4.2   Multi-element Variables */

   379

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

   380

  /* done in base class(es) */

   381

   382

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

   383

/* B 1.4.3 - Declaration & Initialisation */

   384

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

   385

  /* done in base class(es) */

   386

   387

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

   388

/* B.1.5 - Program organization units */

   389

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

   390

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

   391

/* B 1.5.1 - Functions */

   392

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

   393

   394

public:

   395

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

   396

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

   397

void *visit(function_declaration_c *symbol) {

   398

  generate_cc_vardecl_c *vardecl;

   399

  TRACE("function_declaration_c");

   400

   401

  /* start off by adding this declaration to the global

   402

   * function declaration symbol table...

   403

   */

   404

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

   405

   406

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

   407

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

   408

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

   409

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

   410

  s4o.print(" ");

   411

  /* (A.2) Function name */

   412

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

   413

  s4o.print("(");

   414

   415

  /* (A.3) Function parameters */

   416

  s4o.indent_right();

   417

  vardecl = new generate_cc_vardecl_c(&s4o,

   418

  				      generate_cc_vardecl_c::finterface_vf,

   419

  				      generate_cc_vardecl_c::input_vt |

   420

				      generate_cc_vardecl_c::output_vt |

   421

				      generate_cc_vardecl_c::inoutput_vt);

   422

  vardecl->print(symbol->var_declarations_list);

   423

  delete vardecl;

   424

  s4o.indent_left();

   425

   426

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

   427

   428

  /* (B) Function local variable declaration */

   429

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

   430

  s4o.indent_right();

   431

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

   432

  vardecl->print(symbol->var_declarations_list);

   433

  delete vardecl;

   434

   435

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

   436

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

   437

  s4o.print(s4o.indent_spaces);

   438

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

   439

  s4o.print(" ");

   440

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

   441

  s4o.print(" = ");

   442

  {

   443

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

   444

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

   445

    if (default_value == NULL) ERROR;

   446

    default_value->accept(*this);

   447

  }

   448

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

   449

   450

  /* (C) Function body */

   451

  generate_cc_IL_and_ST_c generate_cc_code(&s4o, symbol);

   452

  symbol->function_body->accept(generate_cc_code);

   453

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

   454

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

   455

  s4o.print(";\n");

   456

  s4o.indent_left();

   457

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

   458

   459

  return NULL;

   460

}

   461

   462

   463

/* The remaining var_declarations_list_c, function_var_decls_c

   464

 * and var2_init_decl_list_c are handled in the generate_cc_vardecl_c class

   465

 */

   466

   467

   468

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

   469

/* B 1.5.2 - Function Blocks */

   470

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

   471

public:

   472

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   473

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

   474

void *visit(function_block_declaration_c *symbol) {

   475

  generate_cc_vardecl_c *vardecl;

   476

  TRACE("function_block_declaration_c");

   477

   478

  /* start off by adding this declaration to the global

   479

   * function block declaration symbol table...

   480

   */

   481

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

   482

   483

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

   484

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

   485

  s4o.print("// FUNCTION_BLOCK ");

   486

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

   487

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

   488

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

   489

  s4o.indent_right();

   490

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

   491

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

   492

  vardecl = new generate_cc_vardecl_c(&s4o,

   493

  				      generate_cc_vardecl_c::local_vf,

   494

  				      generate_cc_vardecl_c::input_vt |

   495

  				      generate_cc_vardecl_c::output_vt |

   496

  				      generate_cc_vardecl_c::inoutput_vt);

   497

  vardecl->print(symbol->var_declarations);

   498

  delete vardecl;

   499

  s4o.print("\n");

   500

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

   501

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

   502

  vardecl = new generate_cc_vardecl_c(&s4o,

   503

  				      generate_cc_vardecl_c::local_vf,

   504

				      generate_cc_vardecl_c::temp_vt |

   505

  				      generate_cc_vardecl_c::private_vt |

   506

  				      generate_cc_vardecl_c::located_vt);

   507

  vardecl->print(symbol->var_declarations);

   508

  delete vardecl;

   509

  s4o.print("\n");

   510

   511

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

   512

  s4o.indent_left();

   513

  s4o.print("} ");

   514

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

   515

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

   516

   517

   518

  /* (B) Function with FB body */

   519

  /* (B.1) Function declaration */

   520

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

   521

  /* function interface */

   522

  s4o.print("void ");

   523

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

   524

  s4o.print(FB_FUNCTION_SUFFIX);

   525

  s4o.print("(");

   526

    /* first and only parameter is a pointer to the data */

   527

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

   528

  s4o.print(" *");

   529

  s4o.print(FB_FUNCTION_PARAM);

   530