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

    52

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

    53

    54

    55

/* Determine, for the current platform, which data type (float, double or long double) uses 64 bits. */

    56

/* NOTE: we cant use sizeof() in pre-processor directives, so we do it another way... */

    57

#include <float.h>

    58

#if    (LDBL_MANT_DIG == 53) /* NOTE: 64 bit IEC559 real has 53 bits for mantissa! */

    59

  #define long_double long double

    60

  #define real64_t long_double /* so we can later use #if (real64_t == long_double) directives in the code! */

    61

#elif  ( DBL_MANT_DIG == 53) /* NOTE: 64 bit IEC559 real has 53 bits for mantissa! */

    62

  #define real64_t double

    63

#elif  ( FLT_MANT_DIG == 53) /* NOTE: 64 bit IEC559 real has 53 bits for mantissa! */

    64

  #define real64_t float

    65

#else 

    66

  #error Could not find a 64 bit floating point data type on this platform. Aborting...

    67

#endif

    68

    69

    70

/* Forward declaration of the visitor interface

    71

 * declared in the visitor.hh file

    72

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

    73

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

    74

 * to the abstract syntax classes defined here.

    75

 */

    76

class visitor_c; // forward declaration

    77

    78

    79

class symbol_c; // forward declaration

    80

    81

    82

    83

    84

    85

    86

    87

    88

    89

    90

    91

/* The base class of all symbols */

    92

class symbol_c {

    93

    94

  public:

    95

    /*

    96

     * Line number for the purposes of error checking.

    97

     * Annotated (inserted) by stage1_2

    98

     */

    99

    int first_line;

   100

    int first_column;

   101

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

   102

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

   103

    int last_line;

   104

    int last_column;

   105

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

   106

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

   107

   108

   109

    /*

   110

     * Annotations produced during stage 3

   111

     */

   112

    /*** Data type analysis ***/

   113

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

   114

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

   115

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

   116

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

   117

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

   118

     */

   119

    symbol_c *datatype;

   120

   121

    /*** constant folding ***/

   122

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

   123

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

   124

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

   125

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

   126

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

   127

     * operation assuming each type.

   128

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

   129

     * having more than one entry filled in!

   130

     */

   131

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

   132

                   cs_const_value, /* const value is valid */

   133

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

   134

                 } const_status_t;

   135

   136

    typedef struct {

   137

        const_status_t status;

   138

        real64_t       value; 

   139

    } const_value_real64_t;

   140

    const_value_real64_t *const_value_real64; /* when NULL --> UNDEFINED */

   141

   142

    typedef struct {

   143

        const_status_t status;

   144

        int64_t        value; 

   145

    } const_value_int64_t;

   146

    const_value_int64_t *const_value_int64; /* when NULL --> UNDEFINED */

   147

   148

    typedef struct {

   149

        const_status_t status;

   150

        uint64_t       value; 

   151

    } const_value_uint64_t;

   152

    const_value_uint64_t *const_value_uint64; /* when NULL --> UNDEFINED */

   153

   154

    typedef struct {

   155

        const_status_t status;

   156

        bool           value; 

   157

    } const_value_bool_t;

   158

    const_value_bool_t *const_value_bool; /* when NULL --> UNDEFINED */

   159

   160

   161

  public:

   162

    /* default constructor */

   163

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

   164

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

   165

            );

   166

   167

    /* default destructor */

   168

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

   169

    virtual ~symbol_c(void) {return;};

   170

   171

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

   172

};

   173

   174

   175

class token_c: public symbol_c {

   176

  public:

   177

    /* the value of the symbol. */

   178

    const char *value;

   179

   180

  public:

   181

    token_c(const char *value, 

   182

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

   183

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

   184

           );

   185

};

   186

   187

   188

 /* a list of symbols... */

   189

class list_c: public symbol_c {

   190

  public:

   191

    int n;

   192

    symbol_c **elements;

   193

   194

  public:

   195

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

   196

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

   197

          );

   198

   199

    list_c(symbol_c *elem, 

   200

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

   201

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

   202

          );

   203

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

   204

    virtual void add_element(symbol_c *elem);

   205

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

   206

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

   207

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

   208

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

   209

     /* remove element at position pos. */

   210

    virtual void remove_element(int pos = 0);

   211

};

   212

   213

   214

   215

   216

#define SYM_LIST(class_name_c, ...)											\

   217

class class_name_c:	public list_c {											\

   218

  public:														\

   219

    __VA_ARGS__														\

   220

  public:														\

   221

    class_name_c(													\

   222

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

   223

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

   224

    class_name_c(symbol_c *elem, 											\

   225

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

   226

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

   227

    virtual void *accept(visitor_c &visitor);										\

   228

};

   229

   230

   231

#define SYM_TOKEN(class_name_c, ...)											\

   232

class class_name_c: 	public token_c {										\

   233

  public:														\

   234

    __VA_ARGS__														\

   235

  public:														\

   236

    class_name_c(const char *value, 											\

   237

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

   238

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

   239

    virtual void *accept(visitor_c &visitor);										\

   240

};

   241

   242

   243

#define SYM_REF0(class_name_c, ...)											\

   244

class class_name_c: public symbol_c {											\

   245

  public:														\

   246

    __VA_ARGS__														\

   247

  public:														\

   248

    class_name_c(		 											\

   249

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

   250

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

   251

    virtual void *accept(visitor_c &visitor);										\

   252

};

   253

   254

   255

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

   256

class class_name_c: public symbol_c {											\

   257

  public:														\

   258

    symbol_c *ref1;													\

   259

    __VA_ARGS__														\

   260

  public:														\

   261

    class_name_c(symbol_c *ref1,											\

   262

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

   263

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

   264

    virtual void *accept(visitor_c &visitor);										\

   265

};

   266

   267

   268

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

   269

class class_name_c: public symbol_c {											\

   270

  public:														\

   271

    symbol_c *ref1;													\

   272

    symbol_c *ref2;													\

   273

    __VA_ARGS__														\

   274

  public:														\

   275

    class_name_c(symbol_c *ref1,											\

   276

		 symbol_c *ref2 = NULL,											\

   277

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

   278

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

   279

    virtual void *accept(visitor_c &visitor);										\

   280

};

   281

   282

   283

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

   284

class class_name_c: public symbol_c {											\

   285

  public:														\

   286

    symbol_c *ref1;													\

   287

    symbol_c *ref2;													\

   288

    symbol_c *ref3;													\

   289

    __VA_ARGS__														\

   290

  public:														\

   291

    class_name_c(symbol_c *ref1,											\

   292

		 symbol_c *ref2,											\

   293

		 symbol_c *ref3,											\

   294

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

   295

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

   296

    virtual void *accept(visitor_c &visitor);										\

   297

};

   298

   299

   300

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

   301

class class_name_c: public symbol_c {											\

   302

  public:														\

   303

    symbol_c *ref1;													\

   304

    symbol_c *ref2;													\

   305

    symbol_c *ref3;													\

   306

    symbol_c *ref4;													\

   307

    __VA_ARGS__														\

   308

  public:														\

   309

    class_name_c(symbol_c *ref1,											\

   310

		 symbol_c *ref2,											\

   311

		 symbol_c *ref3,											\

   312

		 symbol_c *ref4 = NULL,											\

   313

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

   314

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

   315

    virtual void *accept(visitor_c &visitor);										\

   316

};

   317

   318

   319

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

   320

class class_name_c: public symbol_c {											\

   321

  public:														\

   322

    symbol_c *ref1;													\

   323

    symbol_c *ref2;													\

   324

    symbol_c *ref3;													\

   325

    symbol_c *ref4;													\

   326

    symbol_c *ref5;													\

   327

    __VA_ARGS__														\

   328

  public:														\

   329

    class_name_c(symbol_c *ref1,											\

   330

		 symbol_c *ref2,											\

   331

		 symbol_c *ref3,											\

   332

		 symbol_c *ref4,											\

   333

		 symbol_c *ref5,											\

   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

};

   338

   339

   340

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

   341

class class_name_c: public symbol_c {											\

   342

  public:														\

   343

    symbol_c *ref1;													\

   344

    symbol_c *ref2;													\

   345

    symbol_c *ref3;													\

   346

    symbol_c *ref4;													\

   347

    symbol_c *ref5;													\

   348

    symbol_c *ref6;													\

   349

    __VA_ARGS__														\

   350

  public:														\

   351

    class_name_c(symbol_c *ref1,											\

   352

		 symbol_c *ref2,											\

   353

		 symbol_c *ref3,											\

   354

		 symbol_c *ref4,											\

   355

		 symbol_c *ref5,											\

   356

		 symbol_c *ref6 = NULL,											\

   357

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

   358

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

   359

    virtual void *accept(visitor_c &visitor);										\

   360

};

   361

   362

   363

#include "absyntax.def"

   364

   365

   366

   367

#undef SYM_LIST

   368

#undef SYM_TOKEN

   369

#undef SYM_REF0

   370

#undef SYM_REF1

   371

#undef SYM_REF2

   372

#undef SYM_REF3

   373

#undef SYM_REF4

   374

#undef SYM_REF5

   375

#undef SYM_REF6

   376

   377

#endif /*  _ABSYNTAX_HH */