1

/*

     2

 *  matiec - a compiler for the programming languages defined in IEC 61131-3

     3

 *  Copyright (C) 2003-2011  Mario de Sousa (msousa@fe.up.pt)

     4

 *  Copyright (C) 2007-2011  Laurent Bessard and Edouard Tisserant

     5

 *

     6

 *  This program is free software: you can redistribute it and/or modify

     7

 *  it under the terms of the GNU General Public License as published by

     8

 *  the Free Software Foundation, either version 3 of the License, or

     9

 *  (at your option) any later version.

    10

 *

    11

 *  This program is distributed in the hope that it will be useful,

    12

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    13

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    14

 *  GNU General Public License for more details.

    15

 *

    16

 *  You should have received a copy of the GNU General Public License

    17

 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.

    18

 *

    19

 *

    20

 * This code is made available on the understanding that it will not be

    21

 * used in safety-critical situations without a full and competent review.

    22

 */

    23

    24

/*

    25

 * An IEC 61131-3 compiler.

    26

 *

    27

 * Based on the

    28

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    29

 *

    30

 */

    31

    32

/*

    33

 * Declaration of the Abstract Syntax data structure components

    34

 */

    35

    36

/*

    37

 * ABSYNTAX.H

    38

 *

    39

 * This generates the parse tree structure used to bind the components

    40

 * identified by Bison in the correct syntax order. At the end of the

    41

 * Bison analysis the tree is walked in a sequential fashion generating

    42

 * the relavent code.

    43

 */

    44

    45

#ifndef _ABSYNTAX_HH

    46

#define _ABSYNTAX_HH

    47

    48

    49

#include <stdio.h> // required for NULL

    50

#include <vector>

    51

#include <map>

    52

#include <string>

    53

#include <stdint.h>  // required for uint64_t, etc...

    54

#include "../main.hh" // required for uint8_t, real_64_t, ..., and the macros INT8_MAX, REAL32_MAX, ... */

    55

    56

    57

    58

    59

/* Forward declaration of the visitor interface

    60

 * declared in the visitor.hh file

    61

 * We cannot include the visitor.hh file, as it will

    62

 * include this same file first, as it too requires references

    63

 * to the abstract syntax classes defined here.

    64

 */

    65

class visitor_c; // forward declaration

    66

    67

    68

class symbol_c; // forward declaration

    69

    70

    71

    72

    73

    74

    75

    76

/* Case insensitive string compare */

    77

  /* Case insensitive string compare copied from

    78

   * "The C++ Programming Language" - 3rd Edition

    79

   * by Bjarne Stroustrup, ISBN 0201889544.

    80

   */

    81

class nocasecmp_c {

    82

    public:

    83

      bool operator() (const std::string& x, const std::string& y) const {

    84

        std::string::const_iterator ix = x.begin();

    85

        std::string::const_iterator iy = y.begin();

    86

    87

        for(; (ix != x.end()) && (iy != y.end()) && (toupper(*ix) == toupper(*iy)); ++ix, ++iy);

    88

        if (ix == x.end()) return (iy != y.end());

    89

        if (iy == y.end()) return false;

    90

        return (toupper(*ix) < toupper(*iy));

    91

      };

    92

  };

    93

    94

    95

    96

    97

    98

    99

   100

   101

   102

/* The base class of all symbols */

   103

class symbol_c {

   104

   105

  public:

   106

    /* WARNING: only use this method for debugging purposes!! */

   107

    virtual const char *absyntax_cname(void) {return "symbol_c";};

   108

   109

    /*

   110

     * Annotations produced during stage 1_2

   111

     */    

   112

    /* Points to the parent symbol in the AST, i.e. the symbol in the AST that will contain the current symbol */

   113

    symbol_c *parent; 

   114

   115

    /* Line number for the purposes of error checking.  */

   116

    int first_line;

   117

    int first_column;

   118

    const char *first_file;  /* filename referenced by first line/column */

   119

    long int first_order;    /* relative order in which it is read by lexcial analyser */

   120

    int last_line;

   121

    int last_column;

   122

    const char *last_file;  /* filename referenced by last line/column */

   123

    long int last_order;    /* relative order in which it is read by lexcial analyser */

   124

   125

   126

    /*

   127

     * Annotations produced during stage 3

   128

     */    

   129

    /*** Data type analysis ***/

   130

    std::vector <symbol_c *> candidate_datatypes; /* All possible data types the expression/literal/etc. may take. Filled in stage3 by fill_candidate_datatypes_c class */

   131

    /* Data type of the expression/literal/etc. Filled in stage3 by narrow_candidate_datatypes_c 

   132

     * If set to NULL, it means it has not yet been evaluated.

   133

     * If it points to an object of type invalid_type_name_c, it means it is invalid.

   134

     * Otherwise, it points to an object of the apropriate data type (e.g. int_type_name_c, bool_type_name_c, ...)

   135

     */

   136

    symbol_c *datatype;

   137

    /* The POU in which the symbolic variable (or structured variable, or array variable, or located variable, - any more?)

   138

     * was declared. This will point to a Configuration, Resource, Program, FB, or Function.

   141

     */

   142

    symbol_c *scope;    

   143

   144

    /*** constant folding ***/

   145

    /* During stage 3 (semantic analysis/checking) we will be doing constant folding.

   146

     * That algorithm will anotate the abstract syntax tree with the result of operations

   147

     * on literals (i.e. 44 + 55 will store the result 99).

   148

     * Since the same source code (e.g. 1 + 0) may actually be a BOOL or an ANY_INT,

   149

     * or an ANY_BIT, we need to handle all possibilities, and determine the result of the

   150

     * operation assuming each type.

   151

     * For this reason, we have one entry for each possible type, with some expressions

   152

     * having more than one entry filled in!

   153

     */

   154

    typedef enum { cs_undefined,   /* not defined/not yet evaluated --> const_value is not valid! */

   155

                   cs_non_const,   /* we have determined that expression is not a const value --> const_value is not valid! */

   156

                   cs_const_value, /* const value is valid */

   157

                   cs_overflow     /* result produced overflow or underflow --> const_value is not valid! */

   158

                 } const_status_t;

   159

   160

    typedef struct const_value_real64_s {const_status_t status;  real64_t  value;  const_value_real64_s (): status(cs_undefined), value(0.0)   {} } const_value_real64_t;

   161

    typedef struct const_value_int64_s  {const_status_t status;   int64_t  value;  const_value_int64_s  (): status(cs_undefined), value(0)     {} } const_value_int64_t;

   162

    typedef struct const_value_uint64_s {const_status_t status;  uint64_t  value;  const_value_uint64_s (): status(cs_undefined), value(0)     {} } const_value_uint64_t;

   163

    typedef struct const_value_bool_s   {const_status_t status;      bool  value;  const_value_bool_s   (): status(cs_undefined), value(false) {} } const_value_bool_t;

   164

   165

    typedef struct {

   166

      const_value_real64_t _real64; /* status is initialised to UNDEFINED */

   167

      const_value_int64_t   _int64; /* status is initialised to UNDEFINED */

   168

      const_value_uint64_t _uint64; /* status is initialised to UNDEFINED */

   169

      const_value_bool_t     _bool; /* status is initialised to UNDEFINED */

   170

    } const_value_t;

   171

    const_value_t const_value;

   172

   173

    /*** Enumeration datatype checking ***/    

   174

    /* Not all symbols will contain the following anotations, which is why they are not declared here in symbol_c

   175

     * They will be declared only inside the symbols that require them (have a look at absyntax.def)

   176

     */

   177

    typedef std::multimap<std::string, symbol_c *, nocasecmp_c> enumvalue_symtable_t;

   178

   179

    /*

   180

     * Annotations produced during stage 4

   181

     */

   182

    /* Since we support several distinct stage_4 implementations, having explicit entries for each

   183

     * possible use would quickly get out of hand.

   184

     * We therefore simply add a map, that each stage 4 may use for all its needs.

   185

     */

   186

    typedef std::map<std::string, symbol_c *> anotations_map_t;

   187

    anotations_map_t anotations_map;

   188

   189

   190

  public:

   191

    /* default constructor */

   192

    symbol_c(int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0, /* order in which it is read by lexcial analyser */

   193

             int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0  /* order in which it is read by lexcial analyser */

   194

            );

   195

   196

    /* default destructor */

   197

    /* must be virtual so compiler does not complain... */ 

   198

    virtual ~symbol_c(void) {return;};

   199

   200

    virtual void *accept(visitor_c &visitor) {return NULL;};

   201

};

   202

   203

   204

   205

   206

class token_c: public symbol_c {

   207

  public:

   208

    /* WARNING: only use this method for debugging purposes!! */

   209

    virtual const char *absyntax_cname(void) {return "token_c";};

   210

   211

    /* the value of the symbol. */

   212

    const char *value;

   213

   214

  public:

   215

    token_c(const char *value, 

   216

            int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0, /* order in which it is read by lexcial analyser */

   217

            int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0  /* order in which it is read by lexcial analyser */

   218

           );

   219

};

   220

   221

   222

   223

   224

 /* a list of symbols... */

   225

class list_c: public symbol_c {

   226

  public:

   227

    /* WARNING: only use this method for debugging purposes!! */

   228

    virtual const char *absyntax_cname(void) {return "list_c";};

   229

   230

    int c,n; /* c: current capacity of list (malloc'd memory);  n: current number of elements in list */

   231

    symbol_c **elements;

   232

   233

  public:

   234

    list_c(int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0, /* order in which it is read by lexcial analyser */

   235

           int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0  /* order in which it is read by lexcial analyser */

   236

          );

   237

   238

    list_c(symbol_c *elem, 

   239

           int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0, /* order in which it is read by lexcial analyser */

   240

           int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0  /* order in which it is read by lexcial analyser */

   241

          );

   242

     /* append a new element to the end of the list */

   243

    virtual void add_element(symbol_c *elem);

   244

     /* insert a new element before position pos. */

   245

     /* To insert into the begining of list, call with pos=0  */

   246

     /* To insert into the end of list, call with pos=list->n */

   247

    virtual void insert_element(symbol_c *elem, int pos = 0);

   248

     /* remove element at position pos. */

   249

    virtual void remove_element(int pos = 0);

   250

};

   251

   252

   253

   254

   255

   256

   257

   258

   259

   260

#define SYM_LIST(class_name_c, ...)											\

   261

class class_name_c:	public list_c {											\

   262

  public:														\

   263

    __VA_ARGS__														\

   264

  public:														\

   265

    class_name_c(													\

   266

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   267

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   268

    class_name_c(symbol_c *elem, 											\

   269

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   270

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   271

    virtual void *accept(visitor_c &visitor);										\

   272

    /* WARNING: only use this method for debugging purposes!! */							\

   273

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   274

};

   275

   276

   277

#define SYM_TOKEN(class_name_c, ...)											\

   278

class class_name_c: 	public token_c {										\

   279

  public:														\

   280

    __VA_ARGS__														\

   281

  public:														\

   282

    class_name_c(const char *value, 											\

   283

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   284

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   285

    virtual void *accept(visitor_c &visitor);										\

   286

    /* WARNING: only use this method for debugging purposes!! */							\

   287

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   288

};

   289

   290

   291

#define SYM_REF0(class_name_c, ...)											\

   292

class class_name_c: public symbol_c {											\

   293

  public:														\

   294

    __VA_ARGS__														\

   295

  public:														\

   296

    class_name_c(		 											\

   297

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   298

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   299

    virtual void *accept(visitor_c &visitor);										\

   300

    /* WARNING: only use this method for debugging purposes!! */							\

   301

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   302

};

   303

   304

   305

#define SYM_REF1(class_name_c, ref1, ...)										\

   306

class class_name_c: public symbol_c {											\

   307

  public:														\

   308

    symbol_c *ref1;													\

   309

    __VA_ARGS__														\

   310

  public:														\

   311

    class_name_c(symbol_c *ref1,											\

   312

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   313

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   314

    virtual void *accept(visitor_c &visitor);										\

   315

    /* WARNING: only use this method for debugging purposes!! */							\

   316

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   317

};

   318

   319

   320

#define SYM_REF2(class_name_c, ref1, ref2, ...)										\

   321

class class_name_c: public symbol_c {											\

   322

  public:														\

   323

    symbol_c *ref1;													\

   324

    symbol_c *ref2;													\

   325

    __VA_ARGS__														\

   326

  public:														\

   327

    class_name_c(symbol_c *ref1,											\

   328

		 symbol_c *ref2 = NULL,											\

   329

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   330

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   331

    virtual void *accept(visitor_c &visitor);										\

   332

    /* WARNING: only use this method for debugging purposes!! */							\

   333

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   334

};

   335

   336

   337

#define SYM_REF3(class_name_c, ref1, ref2, ref3, ...)									\

   338

class class_name_c: public symbol_c {											\

   339

  public:														\

   340

    symbol_c *ref1;													\

   341

    symbol_c *ref2;													\

   342

    symbol_c *ref3;													\

   343

    __VA_ARGS__														\

   344

  public:														\

   345

    class_name_c(symbol_c *ref1,											\

   346

		 symbol_c *ref2,											\

   347

		 symbol_c *ref3,											\

   348

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   349

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   350

    virtual void *accept(visitor_c &visitor);										\

   351

    /* WARNING: only use this method for debugging purposes!! */							\

   352

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   353

};

   354

   355

   356

#define SYM_REF4(class_name_c, ref1, ref2, ref3, ref4, ...)								\

   357

class class_name_c: public symbol_c {											\

   358

  public:														\

   359

    symbol_c *ref1;													\

   360

    symbol_c *ref2;													\

   361

    symbol_c *ref3;													\

   362

    symbol_c *ref4;													\

   363

    __VA_ARGS__														\

   364

  public:														\

   365

    class_name_c(symbol_c *ref1,											\

   366

		 symbol_c *ref2,											\

   367

		 symbol_c *ref3,											\

   368

		 symbol_c *ref4 = NULL,											\

   369

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   370

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   371

    virtual void *accept(visitor_c &visitor);										\

   372

    /* WARNING: only use this method for debugging purposes!! */							\

   373

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   374

};

   375

   376

   377

#define SYM_REF5(class_name_c, ref1, ref2, ref3, ref4, ref5, ...)							\

   378

class class_name_c: public symbol_c {											\

   379

  public:														\

   380

    symbol_c *ref1;													\

   381

    symbol_c *ref2;													\

   382

    symbol_c *ref3;													\

   383

    symbol_c *ref4;													\

   384

    symbol_c *ref5;													\

   385

    __VA_ARGS__														\

   386

  public:														\

   387

    class_name_c(symbol_c *ref1,											\

   388

		 symbol_c *ref2,											\

   389

		 symbol_c *ref3,											\

   390

		 symbol_c *ref4,											\

   391

		 symbol_c *ref5,											\

   392

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   393

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   394

    virtual void *accept(visitor_c &visitor);										\

   395

    /* WARNING: only use this method for debugging purposes!! */							\

   396

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   397

};

   398

   399

   400

#define SYM_REF6(class_name_c, ref1, ref2, ref3, ref4, ref5, ref6, ...)							\

   401

class class_name_c: public symbol_c {											\

   402

  public:														\

   403

    symbol_c *ref1;													\

   404

    symbol_c *ref2;													\

   405

    symbol_c *ref3;													\

   406

    symbol_c *ref4;													\

   407

    symbol_c *ref5;													\

   408

    symbol_c *ref6;													\

   409

    __VA_ARGS__														\

   410

  public:														\

   411

    class_name_c(symbol_c *ref1,											\

   412

		 symbol_c *ref2,											\

   413

		 symbol_c *ref3,											\

   414

		 symbol_c *ref4,											\

   415

		 symbol_c *ref5,											\

   416

		 symbol_c *ref6 = NULL,											\

   417

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   418

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   419

    virtual void *accept(visitor_c &visitor);										\

   420

    /* WARNING: only use this method for debugging purposes!! */							\

   421

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   422

};

   423

   424

   425

#include "absyntax.def"

   426

   427

   428

   429

#undef SYM_LIST

   430

#undef SYM_TOKEN

   431

#undef SYM_REF0

   432

#undef SYM_REF1

   433

#undef SYM_REF2

   434

#undef SYM_REF3

   435

#undef SYM_REF4

   436

#undef SYM_REF5

   437

#undef SYM_REF6

   438

   439

#endif /*  _ABSYNTAX_HH */