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

/*** constant folding ***/

    97

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

    98

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

    99

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

   100

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

   101

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

   102

 * operation assuming each type.

   103

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

   104

 * having more than one entry filled in!

   105

 */    

   106

class const_value_c {

   107

  public:

   108

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

   109

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

   110

                   cs_const_value, /* const value is valid */

   111

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

   112

                 } const_status_t;

   113

   114

    template<typename value_type> class const_value__ {

   115

      const_status_t status;  

   116

      value_type     value;

   117

   118

      public:

   119

      const_value__(void): status(cs_undefined), value(0) {};

   120

   121

      value_type get(void)              {return value;}

   122

      void       set(value_type value_) {status = cs_const_value; value = value_;}

   123

      void       set_overflow(void)     {status = cs_overflow   ;}

   124

      void       set_nonconst(void)     {status = cs_non_const  ;}

   125

      bool       is_valid    (void)     {return (status == cs_const_value);}

   126

      bool       is_overflow (void)     {return (status == cs_overflow   );}

   127

      bool       is_nonconst (void)     {return (status == cs_non_const  );}

   128

      bool       is_undefined(void)     {return (status == cs_undefined  );}

   129

      bool       is_zero     (void)     {return (is_valid() && (get() == 0));}

   130

   131

      /* comparison operator */

   132

      bool operator==(const const_value__ cv) {

   133

        return (    ((status!=cs_const_value) && (status==cv.status)) 

   134

                 || ((status==cs_const_value) && (value ==cv.value )));

   135

      }

   136

   137

    };

   138

   139

    const_value__< int64_t>  _int64; /* status is initialised to UNDEFINED */

   140

    const_value__<uint64_t> _uint64; /* status is initialised to UNDEFINED */

   141

    const_value__<real64_t> _real64; /* status is initialised to UNDEFINED */

   142

    const_value__<bool    >   _bool; /* status is initialised to UNDEFINED */

   143

   144

    /* default constructor and destructor */

   145

     const_value_c(void) {};

   146

    ~const_value_c(void) {};

   147

   148

    /* comparison operator */

   149

    bool operator==(const const_value_c cv)

   150

      {return ((_int64==cv._int64) && (_uint64==cv._uint64) && (_real64==cv._real64) && (_bool==cv._bool));}                                                     

   151

   152

    /* return true if at least one of the const values (int, real, ...) is a valid const value */

   153

    bool is_const(void) 

   154

      {return (_int64.is_valid() || _uint64.is_valid() || _real64.is_valid() || _bool.is_valid());}   

   155

};

   156

   157

   158

   159

/* The base class of all symbols */

   160

class symbol_c {

   161

   162

  public:

   163

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

   164

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

   165

   166

    /*

   167

     * Annotations produced during stage 1_2

   168

     */    

   169

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

   170

    symbol_c *parent; 

   171

   172

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

   173

    int first_line;

   174

    int first_column;

   175

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

   176

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

   177

    int last_line;

   178

    int last_column;

   179

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

   180

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

   181

   182

   183

    /*

   184

     * Annotations produced during stage 3

   185

     */    

   186

    /*** Data type analysis ***/

   187

    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 */

   188

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

   189

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

   190

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

   191

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

   192

     */

   193

    symbol_c *datatype;

   194

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

   195

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

   196

     * This is set in stage 3 by the datatype analyser algorithm (fill/narrow) for the symbols:

   197

     *  symbolic_variable_c, array_variable_c, structured_variable_c

   198

     */

   199

    symbol_c *scope;    

   200

   201

    /*** constant folding ***/

   202

    /* If the symbol has a constant numerical value, this will be set to that value by constant_folding_c */

   203

    const_value_c const_value;

   204

   205

    /*** Enumeration datatype checking ***/    

   206

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

   207

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

   208

     */

   209

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

   210

   211

    /*

   212

     * Annotations produced during stage 4

   213

     */

   214

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

   215

     * possible use would quickly get out of hand.

   216

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

   217

     */

   218

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

   219

    anotations_map_t anotations_map;

   220

   221

   222

  public:

   223

    /* default constructor */

   224

    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 */

   225

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

   226

            );

   227

   228

    /* default destructor */

   229

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

   230

    virtual ~symbol_c(void) {return;};

   231

   232

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

   233

};

   234

   235

   236

   237

   238

class token_c: public symbol_c {

   239

  public:

   240

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

   241

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

   242

   243

    /* the value of the symbol. */

   244

    const char *value;

   245

   246

  public:

   247

    token_c(const char *value, 

   248

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

   249

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

   250

           );

   251

};

   252

   253

   254

   255

   256

 /* a list of symbols... */

   257

class list_c: public symbol_c {

   258

  public:

   259

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

   260

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

   261

   262

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

   264

    symbol_c **elements;

   265

   266

  public:

   267

    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 */

   268

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

   269

          );

   270

   271

    list_c(symbol_c *elem, 

   272

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

   273

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

   274

          );

   277

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

   278

    virtual void add_element(symbol_c *elem);

   279

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

   280

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

   281

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

   282

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

   283

     /* remove element at position pos. */

   284

    virtual void remove_element(int pos = 0);

   285

     /* remove all elements from list. Does not delete the elements in the list! */ 

   286

    virtual void clear(void);

   287

};

   288

   289

   290

   291

   292

   293

   294

   295

   296

   297

#define SYM_LIST(class_name_c, ...)											\

   298

class class_name_c:	public list_c {											\

   299

  public:														\

   300

    __VA_ARGS__														\

   301

  public:														\

   302

    class_name_c(													\

   303

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

   304

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

   305

    class_name_c(symbol_c *elem, 											\

   306

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

   307

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

   308

    virtual void *accept(visitor_c &visitor);										\

   309

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

   310

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

   311

};

   312

   313

   314

#define SYM_TOKEN(class_name_c, ...)											\

   315

class class_name_c: 	public token_c {										\

   316

  public:														\

   317

    __VA_ARGS__														\

   318

  public:														\

   319

    class_name_c(const char *value, 											\

   320

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

   321

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

   322

    virtual void *accept(visitor_c &visitor);										\

   323

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

   324

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

   325

};

   326

   327

   328

#define SYM_REF0(class_name_c, ...)											\

   329

class class_name_c: public symbol_c {											\

   330

  public:														\

   331

    __VA_ARGS__														\

   332

  public:														\

   333

    class_name_c(		 											\

   334

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

   335

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

   336

    virtual void *accept(visitor_c &visitor);										\

   337

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

   338

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

   339

};

   340

   341

   342

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

   343

class class_name_c: public symbol_c {											\

   344

  public:														\

   345

    symbol_c *ref1;													\

   346

    __VA_ARGS__														\

   347

  public:														\

   348

    class_name_c(symbol_c *ref1,											\

   349

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

   350

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

   351

    virtual void *accept(visitor_c &visitor);										\

   352

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

   353

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

   354

};

   355

   356

   357

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

   358

class class_name_c: public symbol_c {											\

   359

  public:														\

   360

    symbol_c *ref1;													\

   361

    symbol_c *ref2;													\

   362

    __VA_ARGS__														\

   363

  public:														\

   364

    class_name_c(symbol_c *ref1,											\

   365

		 symbol_c *ref2 = NULL,											\

   366

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

   367

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

   368

    virtual void *accept(visitor_c &visitor);										\

   369

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

   370

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

   371

};

   372

   373

   374

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

   375

class class_name_c: public symbol_c {											\

   376

  public:														\

   377

    symbol_c *ref1;													\

   378

    symbol_c *ref2;													\

   379

    symbol_c *ref3;													\

   380

    __VA_ARGS__														\

   381

  public:														\

   382

    class_name_c(symbol_c *ref1,											\

   383

		 symbol_c *ref2,											\

   384

		 symbol_c *ref3,											\

   385

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

   386

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

   387

    virtual void *accept(visitor_c &visitor);										\

   388

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

   389

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

   390

};

   391

   392

   393

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

   394

class class_name_c: public symbol_c {											\

   395

  public:														\

   396

    symbol_c *ref1;													\

   397

    symbol_c *ref2;													\

   398

    symbol_c *ref3;													\

   399

    symbol_c *ref4;													\

   400

    __VA_ARGS__														\

   401

  public:														\

   402

    class_name_c(symbol_c *ref1,											\

   403

		 symbol_c *ref2,											\

   404

		 symbol_c *ref3,											\

   405

		 symbol_c *ref4 = NULL,											\

   406

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

   407

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

   408

    virtual void *accept(visitor_c &visitor);										\

   409

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

   410

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

   411

};

   412

   413

   414

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

   415

class class_name_c: public symbol_c {											\

   416

  public:														\

   417

    symbol_c *ref1;													\

   418

    symbol_c *ref2;													\

   419

    symbol_c *ref3;													\

   420

    symbol_c *ref4;													\

   421

    symbol_c *ref5;													\

   422

    __VA_ARGS__														\

   423

  public:														\

   424

    class_name_c(symbol_c *ref1,											\

   425

		 symbol_c *ref2,											\

   426

		 symbol_c *ref3,											\

   427

		 symbol_c *ref4,											\

   428

		 symbol_c *ref5,											\

   429

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

   430

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

   431

    virtual void *accept(visitor_c &visitor);										\

   432

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

   433

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

   434

};

   435

   436

   437

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

   438

class class_name_c: public symbol_c {											\

   439

  public:														\

   440

    symbol_c *ref1;													\

   441

    symbol_c *ref2;													\

   442

    symbol_c *ref3;													\

   443

    symbol_c *ref4;													\

   444

    symbol_c *ref5;													\

   445

    symbol_c *ref6;													\

   446

    __VA_ARGS__														\

   447

  public:														\

   448

    class_name_c(symbol_c *ref1,											\

   449

		 symbol_c *ref2,											\

   450

		 symbol_c *ref3,											\

   451

		 symbol_c *ref4,											\

   452

		 symbol_c *ref5,											\

   453

		 symbol_c *ref6 = NULL,											\

   454

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

   455

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

   456

    virtual void *accept(visitor_c &visitor);										\

   457

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

   458

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

   459

};

   460

   461

   462

#include "absyntax.def"

   463

   464

   465

   466

#undef SYM_LIST

   467

#undef SYM_TOKEN

   468

#undef SYM_REF0

   469

#undef SYM_REF1

   470

#undef SYM_REF2

   471

#undef SYM_REF3

   472

#undef SYM_REF4

   473

#undef SYM_REF5

   474

#undef SYM_REF6

   475

   476

#endif /*  _ABSYNTAX_HH */