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

    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

   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

   156

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

   157

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

   158

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

   159

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

   160

 * in IL and ST.

   161

 *

   162

 * e.g.: the body of FUNTION_BLOCK TEST

   163

 * is mapped onto the C function

   164

 *  TEST_body__(TEST *data__)

   165

 */

   166

   167

#define FB_FUNCTION_PARAM "data__"

   168

   169

   170

#define SFC_STEP_ACTION_PREFIX "__SFC_"

   171

   172

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

   173

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

   174

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

   175

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

   176

   177

   178

#include "spec_init_separator.cc"

   179

#include "function_param_iterator.cc"

   180

#include "function_call_iterator.cc"

   181

#include "function_call_param_iterator.cc"

   182

#include "type_initial_value.cc"

   183

#include "search_fb_instance_decl.cc"

   184

#include "search_base_type.cc"

   185

#include "search_var_instance_decl.cc"

   186

#include "decompose_var_instance_name.cc"

   187

#include "search_varfb_instance_type.cc"

   188

#include "search_constant_type.cc"

   189

#include "search_expression_type.cc"

   190

   191

#include "generate_cc_base.cc"

   192

#include "generate_cc_sfcdecl.cc"

   193

#include "generate_cc_typedecl.cc"

   194

#include "generate_cc_vardecl.cc"

   195

#include "generate_cc_configbody.cc"

   196

   197

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

   198

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

   199

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

   200

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

   201

   202

/* Generate a name for a temporary variable.

   203

 * Each new name generated is appended a different number,

   204

 * starting off from 0.

   205

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

   206

 */

   207

#define VAR_LEADER "__"

   208

#define TEMP_VAR VAR_LEADER "TMP_"

   209

#define SOURCE_VAR VAR_LEADER "SRC_"

   210

   211

#include "generate_cc_tempvardecl.cc"

   212

   213

#include "generate_cc_st.cc"

   214

#include "generate_cc_il.cc"

   215

   216

#include "generate_cc.hh"

   217

   363

   364

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

   365

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

   366

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

   367

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

   368

   369

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

   370

class generate_cc_SFC_IL_ST_c: public null_visitor_c {

   371

  private:

   372

    stage4out_c *s4o_ptr;

   373

    symbol_c *scope;

   374

    const char *variable_prefix;

   375

   376

  public:

   377

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

   378

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

   379

    /* B.1.6  Sequential function chart elements */

   380

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

   381

   382

    /*| sequential_function_chart sfc_network*/

   383

    void *visit(sequential_function_chart_c * symbol);

   384

   385

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

   386

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

   387

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

   388

   389

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

   390

    /* B 2.1 Instructions and Operands */

   391

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

   392

    /*| instruction_list il_instruction */

   393

    void *visit(instruction_list_c *symbol);

   394

   395

    /* Remainder implemented in generate_cc_il_c... */

   396

   397

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

   398

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

   399

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

   400

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

   401

    /* B 3.1 - Expressions */

   402

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

   403

    /* Implemented in generate_cc_st_c */

   404

   405

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

   406

    /* B 3.2 Statements */

   407

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

   408

    void *visit(statement_list_c *symbol);

   409

   410

/* Remainder implemented in generate_cc_st_c... */

   411

};

   412

   413

#include "generate_cc_sfc.cc"

   414

   415

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

   416

  if (NULL == scope) ERROR;

   417

  this->s4o_ptr = s4o_ptr;

   418

  this->scope = scope;

   419

  this->variable_prefix = variable_prefix;

   420

}

   421

   422

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

   423

  generate_cc_sfc_c generate_cc_sfc(s4o_ptr, scope, variable_prefix);

   424

  generate_cc_sfc.generate(symbol);

   425

  return NULL;

   426

}

   427

   428

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

   429

  generate_cc_il_c generate_cc_il(s4o_ptr, scope, variable_prefix);

   430

  generate_cc_il.generate(symbol);

   431

  return NULL;

   432

}

   433

   434

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

   435

  generate_cc_st_c generate_cc_st(s4o_ptr, scope, variable_prefix);

   436

  generate_cc_st.generate(symbol);

   437

  return NULL;

   438

}

   439

   440

   441

   442

   443

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

   444

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

   445

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

   446

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

   447

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

   448

   449

   450

class generate_cc_pous_c: public generate_cc_typedecl_c {

   451

   452

  public:

   453

    generate_cc_pous_c(stage4out_c *s4o_ptr)

   454

      : generate_cc_typedecl_c(s4o_ptr) {};

   455

    virtual ~generate_cc_pous_c(void) {}

   456

   457

   458

  public:

   459

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

   460

/* B 0 - Programming Model */

   461

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

   462

void *visit(library_c *symbol) {

   463

  TRACE("library_c");

   464

   465

  /* Insert the header... */

   466

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

   467

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

   468

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

   469

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

   470

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

   471

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

   472

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

   473

   474

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

   475

  print_list(symbol);

   476

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

   477

   478

  /* Finish off with the main() */

   479

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

   480

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

   481

   482

  // function_symtable.print();

   483

  return NULL;

   484

}

   485

   486

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

   487

/* B.1 - Common elements */

   488

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

   489

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

   490

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

   491

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

   492

  /* done in base class(es) */

   493

   494

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

   495

/* B 1.2 - Constants */

   496

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

   497

  /* originally empty... */

   498

   499

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

   500

/* B 1.2.1 - Numeric Literals */

   501

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

   502

  /* done in base class(es) */

   503

   504

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

   505

/* B.1.2.2   Character Strings */

   506

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

   507

  /* done in base class(es) */

   508

   509

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

   510

/* B 1.2.3 - Time Literals */

   511

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

   512

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

   513

/* B 1.2.3.1 - Duration */