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

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

   113

    int first_line;

   114

    int first_column;

   115

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

   116

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

   117

    int last_line;

   118

    int last_column;

   119

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

   120

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

   121

   122

   123

    /*

   124

     * Annotations produced during stage 3

   125

     */    

   126

    /*** Data type analysis ***/

   127

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

   128

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

   129

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

   130

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

   131

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

   132

     */

   133

    symbol_c *datatype;

   134

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

   135

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

   136

     */

   137

    symbol_c *scope;    

   138

   139

    /*** constant folding ***/

   140

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

   141

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

   142

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

   143

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

   144

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

   145

     * operation assuming each type.

   146

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

   147

     * having more than one entry filled in!

   148

     */

   149

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

   150

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

   151

                   cs_const_value, /* const value is valid */

   152

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

   153

                 } const_status_t;

   154

   155

    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;

   156

    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;

   157

    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;

   158

    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;

   159

   160

    typedef struct {

   161

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

   162

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

   163

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

   164

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

   165

    } const_value_t;

   166

    const_value_t const_value;

   167

   168

    /*** Enumeration datatype checking ***/    

   169

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

   170

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

   171

     */

   172

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

   173

   174

    /*

   175

     * Annotations produced during stage 4

   176

     */

   177

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

   178

     * possible use would quickly get out of hand.

   179

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

   180

     */

   181

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

   182

    anotations_map_t anotations_map;

   183

   184

   185

  public:

   186

    /* default constructor */

   187

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

   188

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

   189

            );

   190

   191

    /* default destructor */

   192

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

   193

    virtual ~symbol_c(void) {return;};

   194

   195

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

   196

};

   197

   198

   199

   200

   201

class token_c: public symbol_c {

   202

  public:

   203

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

   204

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

   205

   206

    /* the value of the symbol. */

   207

    const char *value;

   208

   209

  public:

   210

    token_c(const char *value, 

   211

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

   212

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

   213

           );

   214

};

   215

   216

   217

   218

   219

 /* a list of symbols... */

   220

class list_c: public symbol_c {

   221

  public:

   222

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

   223

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

   224

   225

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

   226

    symbol_c **elements;

   227

   228

  public:

   229

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

   230

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

   231

          );

   232

   233

    list_c(symbol_c *elem, 

   234

           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

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

   238

    virtual void add_element(symbol_c *elem);

   239

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

   240

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

   241

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

   242

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

   243

     /* remove element at position pos. */

   244

    virtual void remove_element(int pos = 0);

   245

};

   246

   247

   248

   249

   250

   251

   252

   253

   254

   255

#define SYM_LIST(class_name_c, ...)											\

   256

class class_name_c:	public list_c {											\

   257

  public:														\

   258

    __VA_ARGS__														\

   259

  public:														\

   260

    class_name_c(													\

   261

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

   262

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

   263

    class_name_c(symbol_c *elem, 											\

   264

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

   265

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

   266

    virtual void *accept(visitor_c &visitor);										\

   267

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

   268

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

   269

};

   270

   271

   272

#define SYM_TOKEN(class_name_c, ...)											\

   273

class class_name_c: 	public token_c {										\

   274

  public:														\

   275

    __VA_ARGS__														\

   276

  public:														\

   277

    class_name_c(const char *value, 											\

   278

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

   279

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

   280

    virtual void *accept(visitor_c &visitor);										\

   281

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

   282

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

   283

};

   284

   285

   286

#define SYM_REF0(class_name_c, ...)											\

   287

class class_name_c: public symbol_c {											\

   288

  public:														\

   289

    __VA_ARGS__														\

   290

  public:														\

   291

    class_name_c(		 											\

   292

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

   293

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

   294

    virtual void *accept(visitor_c &visitor);										\

   295

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

   296

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

   297

};

   298

   299

   300

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

   301

class class_name_c: public symbol_c {											\

   302

  public:														\

   303

    symbol_c *ref1;													\

   304

    __VA_ARGS__														\

   305

  public:														\

   306

    class_name_c(symbol_c *ref1,											\

   307

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

   308

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

   309

    virtual void *accept(visitor_c &visitor);										\

   310

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

   311

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

   312

};

   313

   314

   315

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

   316

class class_name_c: public symbol_c {											\

   317

  public:														\

   318

    symbol_c *ref1;													\

   319

    symbol_c *ref2;													\

   320

    __VA_ARGS__														\

   321

  public:														\

   322

    class_name_c(symbol_c *ref1,											\

   323

		 symbol_c *ref2 = NULL,											\

   324

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

   325

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

   326

    virtual void *accept(visitor_c &visitor);										\

   327

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

   328

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

   329

};

   330

   331

   332

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

   333

class class_name_c: public symbol_c {											\

   334

  public:														\

   335

    symbol_c *ref1;													\

   336

    symbol_c *ref2;													\

   337

    symbol_c *ref3;													\

   338

    __VA_ARGS__														\

   339

  public:														\

   340

    class_name_c(symbol_c *ref1,											\

   341

		 symbol_c *ref2,											\

   342

		 symbol_c *ref3,											\

   343

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

   344

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

   345

    virtual void *accept(visitor_c &visitor);										\

   346

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

   347

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

   348

};

   349

   350

   351

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

   352

class class_name_c: public symbol_c {											\

   353

  public:														\

   354

    symbol_c *ref1;													\

   355

    symbol_c *ref2;													\

   356

    symbol_c *ref3;													\

   357

    symbol_c *ref4;													\

   358

    __VA_ARGS__														\

   359

  public:														\

   360

    class_name_c(symbol_c *ref1,											\

   361

		 symbol_c *ref2,											\

   362

		 symbol_c *ref3,											\

   363

		 symbol_c *ref4 = NULL,											\

   364

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

   365

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

   366

    virtual void *accept(visitor_c &visitor);										\

   367

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

   368

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

   369

};

   370

   371

   372

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

   373

class class_name_c: public symbol_c {											\

   374

  public:														\

   375

    symbol_c *ref1;													\

   376

    symbol_c *ref2;													\

   377

    symbol_c *ref3;													\

   378

    symbol_c *ref4;													\

   379

    symbol_c *ref5;													\

   380

    __VA_ARGS__														\

   381

  public:														\

   382

    class_name_c(symbol_c *ref1,											\

   383

		 symbol_c *ref2,											\

   384

		 symbol_c *ref3,											\

   385

		 symbol_c *ref4,											\

   386

		 symbol_c *ref5,											\

   387

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

   388

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

   389

    virtual void *accept(visitor_c &visitor);										\

   390

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

   391

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

   392

};

   393

   394

   395

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

   396

class class_name_c: public symbol_c {											\

   397

  public:														\

   398

    symbol_c *ref1;													\

   399

    symbol_c *ref2;													\

   400

    symbol_c *ref3;													\

   401

    symbol_c *ref4;													\

   402

    symbol_c *ref5;													\

   403

    symbol_c *ref6;													\

   404

    __VA_ARGS__														\

   405

  public:														\

   406

    class_name_c(symbol_c *ref1,											\

   407

		 symbol_c *ref2,											\

   408

		 symbol_c *ref3,											\

   409

		 symbol_c *ref4,											\

   410

		 symbol_c *ref5,											\

   411

		 symbol_c *ref6 = NULL,											\

   412

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

   413

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

   414

    virtual void *accept(visitor_c &visitor);										\

   415

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

   416

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

   417

};

   418

   419

   420

#include "absyntax.def"

   421

   422

   423

   424

#undef SYM_LIST

   425

#undef SYM_TOKEN

   426

#undef SYM_REF0

   427

#undef SYM_REF1

   428

#undef SYM_REF2

   429

#undef SYM_REF3

   430

#undef SYM_REF4

   431

#undef SYM_REF5

   432

#undef SYM_REF6

   433

   434

#endif /*  _ABSYNTAX_HH */