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 <typeinfo>

    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"

   180

#include "search_expression_type.cc"

   181

   182

#include "generate_cc_base.cc"

   184

#include "generate_cc_typedecl.cc"

   185

#include "generate_cc_vardecl.cc"

   186

#include "generate_cc_configbody.cc"

   187

   188

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

   189

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

   190

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

   191

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

   192

   193

/* Generate a name for a temporary variable.

   194

 * Each new name generated is appended a different number,

   195

 * starting off from 0.

   196

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

   197

 */

   198

#define VAR_LEADER "__"

   199

#define TEMP_VAR VAR_LEADER "TMP_"

   200

#define SOURCE_VAR VAR_LEADER "SRC_"

   201

   202

#include "generate_cc_tempvardecl.cc"

   203

   204

#include "generate_cc_st.cc"

   205

#include "generate_cc_il.cc"

   206

   207

#include "generate_cc.hh"

   208

   209

   210

   211

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

   212

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

   213

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

   214

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

   215

   216

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

   218

  private:

   219

    stage4out_c *s4o_ptr;

   220

    symbol_c *scope;

   221

    const char *variable_prefix;

   222

   223

  public:

   276

  generate_cc_il_c generate_cc_il(s4o_ptr, scope, variable_prefix);

   277

  generate_cc_il.generate(symbol);

   278

  return NULL;

   279

}

   280

   282

  generate_cc_st_c generate_cc_st(s4o_ptr, scope, variable_prefix);

   283

  generate_cc_st.generate(symbol);

   284

  return NULL;

   285

}

   286

   287

   288

   289

   290

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

   291

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

   292

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

   293

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

   294

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

   295

   296

   297

class generate_cc_c: public generate_cc_typedecl_c {

   298

   299

  public:

   300

    generate_cc_c(stage4out_c *s4o_ptr)

   301

      : generate_cc_typedecl_c(s4o_ptr) {};

   302

    virtual ~generate_cc_c(void) {}

   303

   304

   305

  public:

   306

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

   307

/* B 0 - Programming Model */

   308

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

   309

void *visit(library_c *symbol) {

   310

  TRACE("library_c");

   311

   312

  /* Insert the header... */

   313

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

   314

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

   315

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

   316

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

   317

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

   318

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

   319

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

   320

   321

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

   322

  print_list(symbol);

   323

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

   324

   325

  /* Finish off with the main() */

   326

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

   327

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

   328

   329

  // function_symtable.print();

   330

  return NULL;

   331

}

   332

   333

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

   334

/* B.1 - Common elements */

   335

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

   336

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

   337

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

   338

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

   339

  /* done in base class(es) */

   340

   341

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

   342

/* B 1.2 - Constants */

   343

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

   344

  /* originally empty... */

   345

   346

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

   347

/* B 1.2.1 - Numeric Literals */

   348

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

   349

  /* done in base class(es) */

   350

   351

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

   352

/* B.1.2.2   Character Strings */

   353

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

   354

  /* done in base class(es) */

   355

   356

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

   357

/* B 1.2.3 - Time Literals */

   358

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

   359

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

   360

/* B 1.2.3.1 - Duration */

   361

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

   362

  /* done in base class(es) */

   363

   364

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

   365

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

   366

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

   367

  /* done in base class(es) */

   368

   369

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

   370

/* B.1.3 - Data types */

   371

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

   372

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

   373

/* B 1.3.1 - Elementary Data Types */

   374

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

   375

  /* done in base class(es) */

   376

   377

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

   378

/* B.1.3.2 - Generic data types */

   379

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

   380

  /* originally empty... */

   381

   382

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

   383

/* B 1.3.3 - Derived data types */

   384

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

   385

  /* done in base class(es) */

   386

   387

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

   388

/* B 1.4 - Variables */

   389

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

   390

  /* done in base class(es) */

   391

   392

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

   393

/* B.1.4.1   Directly Represented Variables */

   394

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

   395

  /* done in base class(es) */

   396

   397

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

   398

/* B.1.4.2   Multi-element Variables */

   399

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

   400

  /* done in base class(es) */

   401

   402

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

   403

/* B 1.4.3 - Declaration & Initialisation */

   404

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

   405

  /* done in base class(es) */

   406

   407

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

   408

/* B.1.5 - Program organization units */

   409

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

   410

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

   411

/* B 1.5.1 - Functions */

   412

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

   413

   414

public:

   415

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

   416

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

   417

void *visit(function_declaration_c *symbol) {

   418

  generate_cc_vardecl_c *vardecl;

   419

  TRACE("function_declaration_c");

   420

   421

  /* start off by adding this declaration to the global

   422

   * function declaration symbol table...

   423

   */

   424

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

   425

   426

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

   427

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

   428

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

   429

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

   430

  s4o.print(" ");

   431

  /* (A.2) Function name */

   432

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

   433

  s4o.print("(");

   434

   435

  /* (A.3) Function parameters */

   436

  s4o.indent_right();

   437

  vardecl = new generate_cc_vardecl_c(&s4o,

   438

  				      generate_cc_vardecl_c::finterface_vf,

   439

  				      generate_cc_vardecl_c::input_vt |

   440

				      generate_cc_vardecl_c::output_vt |

   441

				      generate_cc_vardecl_c::inoutput_vt);

   442

  vardecl->print(symbol->var_declarations_list);

   443

  delete vardecl;

   444

  s4o.indent_left();

   445

   446

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

   447

   448

  /* (B) Function local variable declaration */

   449

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

   450

  s4o.indent_right();

   451

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

   452

  vardecl->print(symbol->var_declarations_list);

   453

  delete vardecl;

   454

   455

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

   456

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

   457

  s4o.print(s4o.indent_spaces);

   458

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

   459

  s4o.print(" ");

   460

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

   461

  s4o.print(" = ");

   462

  {

   463

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

   464

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

   465

    if (default_value == NULL) ERROR;

   466

    default_value->accept(*this);

   467

  }

   468

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

   469

   470

  /* (C) Function body */

   472

  symbol->function_body->accept(generate_cc_code);

   473

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

   474

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

   475

  s4o.print(";\n");

   476

  s4o.indent_left();

   477

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

   478

   479

  return NULL;

   480

}

   481

   482

   483

/* The remaining var_declarations_list_c, function_var_decls_c

   484

 * and var2_init_decl_list_c are handled in the generate_cc_vardecl_c class

   485

 */

   486

   487

   488

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

   489

/* B 1.5.2 - Function Blocks */

   490

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

   491

public:

   492

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   493

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

   494

void *visit(function_block_declaration_c *symbol) {

   495

  generate_cc_vardecl_c *vardecl;

   496

  TRACE("function_block_declaration_c");

   497

   498

  /* start off by adding this declaration to the global

   499

   * function block declaration symbol table...

   500

   */

   501

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

   502

   503

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

   504

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

   505

  s4o.print("// FUNCTION_BLOCK ");

   506

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

   507

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

   508

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

   509

  s4o.indent_right();

   510

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

   511

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

   512

  vardecl = new generate_cc_vardecl_c(&s4o,

   513

  				      generate_cc_vardecl_c::local_vf,

   514

  				      generate_cc_vardecl_c::input_vt |

   515

  				      generate_cc_vardecl_c::output_vt |

   516

  				      generate_cc_vardecl_c::inoutput_vt);

   517

  vardecl->print(symbol->var_declarations);

   518

  delete vardecl;

   519

  s4o.print("\n");

   520

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

   521

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

   522

  vardecl = new generate_cc_vardecl_c(&s4o,

   523

  				      generate_cc_vardecl_c::local_vf,

   524

				      generate_cc_vardecl_c::temp_vt |

   525

  				      generate_cc_vardecl_c::private_vt |